Export (0) Print
Expand All
This topic has not yet been rated - Rate this topic

SPWorkItemJobDefinition Members

Windows SharePoint Services 3

Serves as the base class for deriving definitions of work-item timer jobs. This class works with the timer job (SPTimerService) to process work items (SPWorkItem).

The SPWorkItemJobDefinition type exposes the following members.

  NameDescription
Public method SPWorkItemJobDefinition() Instantiates a nonparameterized instance of the SPWorkItemJobDefinition class.
Public method SPWorkItemJobDefinition(String, SPWebApplication, SPServer, SPJobLockType) Instantiates a new instance of the SPWorkItemJobDefinition class that specifies the name of the work-item job definition, associated Web application, hosting server, and processing lock type.
Top
  NameDescription
Public property AutoDeleteWorkItemWhenException Gets a Boolean that specifies whether to automatically delete a work item (SPWorkItem object) from the processing queue when an exception occurs when attempting to process that work item.
Public property BatchFetchLimit Gets an integer specifying the limit imposed on the batch size of the work-item collection.
Public property DisplayName Gets the display name that describes the persisted object instance within the administrative user interface. (Inherited from SPPersistedObject.)
Public property Farm Gets the server farm where the object lives. (Inherited from SPPersistedObject.)
Public property Id Gets or sets the GUID that is associated with the object. (Inherited from SPPersistedObject.)
Public property IsDisabled Gets or sets whether the job definition should be disabled. (Inherited from SPJobDefinition.)
Public property LastRunTime Gets the last run time of the job definition. (Inherited from SPJobDefinition.)
Public property LockType Gets the lock type for the job definition. (Inherited from SPJobDefinition.)
Public property Name Gets or sets the name that identifies a particular instance of the object. (Inherited from SPPersistedObject.)
Public property Parent Gets the ID of the parent class that declares the object. (Inherited from SPPersistedObject.)
Public property Properties Gets a property bag that is used to store properties for the persisted object. (Inherited from SPPersistedObject.)
Public property Retry Gets or sets whether the job definition should be retried if it ends abnormally. (Inherited from SPJobDefinition.)
Public property Schedule Gets or sets the schedule of the job definition. (Inherited from SPJobDefinition.)
Public property Server Gets the server of the job definition. (Inherited from SPJobDefinition.)
Public property Service Gets the service for this job definition. (Inherited from SPJobDefinition.)
Public property Status Gets or sets the status of the object that the class represents. (Inherited from SPPersistedObject.)
Public property Title Gets or sets the title of the job definition. (Inherited from SPJobDefinition.)
Public property TypeName Gets the display name that describes the object type in the administrative user interface. (Inherited from SPPersistedObject.)
Public property UpgradedPersistedProperties Gets the collection of field names and values for fields that were deleted or changed. (Inherited from SPAutoSerializingObject.)
Public property Version Gets the time that the object was last updated. (Inherited from SPPersistedObject.)
Public property WebApplication Gets the web application for this job definition. (Inherited from SPJobDefinition.)
Top
  NameDescription
Public method Clone Returns a clone of the object that does not come from the in-memory cache, which enables calling code to help ensure thread safety. (Inherited from SPPersistedObject.)
Public method Delete Deletes the job definition. (Inherited from SPJobDefinition.)
Public method Equals Determines whether the current persisted object equals the specified object. (Inherited from SPPersistedObject.)
Public method Execute Executes a query against the processing queue to obtain available work items.. (Overrides SPJobDefinition.Execute(Guid).)
Protected method Finalize (Inherited from Object.)
Public method GetChild<T>() Returns the child of the persisted object based on the specified type. (Inherited from SPPersistedObject.)
Public method GetChild<T>(String) Returns the child object of the persisted object based on the specified name. (Inherited from SPPersistedObject.)
Public method GetHashCode Serves as a hash function for the persisted object. (Inherited from SPPersistedObject.)
Public method GetObjectData Retrieves the data required to serialize the object. (Inherited from SPAutoSerializingObject.)
Public method GetType (Inherited from Object.)
Protected method MemberwiseClone (Inherited from Object.)
Protected method OnDeserialization Called immediately after the base class deserializes itself to do additional work. (Inherited from SPPersistedObject.)
Public method ProcessWorkItems(SPContentDatabase, SPWorkItemCollection) Launches the processing of work items as specified by the job definition and specifies the content database (SPContentDatabase) and work-item collection (SPWorkItemCollection) for processing.
Public method ProcessWorkItems(SPContentDatabase, SPWorkItemCollection, Boolean) Launches the processing of work items as specified by the job definition and specifies the content database (SPContentDatabase) and work-item collection (SPWorkItemCollection) for processing. Also specifies whether to continue fetching work items when an error is encountered.
Public method Provision Makes the necessary changes to the local server to use the object. (Inherited from SPPersistedObject.)
Public method ToString Returns the type and name of an object and of all its ancestors (parent, grandparent, and so on). (Inherited from SPPersistedObject.)
Public method Uncache Frees the memory cache that is used by the object. (Inherited from SPPersistedObject.)
Public method Unprovision Makes the necessary changes to the local server to clean up after deleting the object. (Inherited from SPPersistedObject.)
Public method Update() Causes the work-item job definition to save its current state and propagate changes, if any. (Overrides SPJobDefinition.Update().)
Public method Update(Boolean) Causes the object to save its state and propagate changes to all the computers in the server farm based on a Boolean value that specifies whether to raise an exception if the object already exists. (Inherited from SPPersistedObject.)
Protected method UpdateParent Causes the containing SPPersistedObject, if one exists, to update its state. (Inherited from SPAutoSerializingObject.)
Public method UpdateProgress Updates the percentage of the running job that is completed for the job definition running on the current server. (Inherited from SPJobDefinition.)
Protected method Validate Validates the state of all fields before persisting the object. (Inherited from SPPersistedObject.)
Public method WorkItemType Returns a globally unique identifier (GUID) that identifies the type of a specified work item (SPWorkItem) or work-item batch.
Top
Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

ADD
Show:
© 2014 Microsoft. All rights reserved.