SPWorkItemJobDefinition members

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 instances).

The SPWorkItemJobDefinition type exposes the following members.

Constructors

	Name	Description
	SPWorkItemJobDefinition()	Initializes a new instance of the SPWorkItemJobDefinition class.
	SPWorkItemJobDefinition(String, SPWebApplication)	Initializes a new instance of the SPWorkItemJobDefinition class that specifies the name of the work item job definition and the associated Web application.
	SPWorkItemJobDefinition(String, SPWebApplication, SPJobLockType)
	SPWorkItemJobDefinition(String, SPService, SPServer, SPJobLockType)	Obsolete. Initializes a new instance of the SPWorkItemJobDefinition class that specifies the name of the work-item job definition, associated service, hosting server, and processing lock type.
	SPWorkItemJobDefinition(String, SPWebApplication, SPServer, SPJobLockType)	Obsolete. Initializes 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

Properties

	Name	Description
	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.
	BatchFetchLimit	Gets an integer specifying the limit imposed on the batch size of the work-item collection.
	CanRenameOnRestore	Gets a Boolean value that indicates whether this object can be renamed at restore time. (Inherited from SPJobDefinition.)
	CanSelectForBackup	Gets and sets a Boolean value that indicates whether this object can be selected for backup. (Inherited from SPJobDefinition.)
	CanSelectForRestore	Gets and sets a Boolean value that indicates whether this object can be selected for backup. (Inherited from SPJobDefinition.)
	DeploymentLocked	(Inherited from SPPersistedObject.)
	Description	Gets a localized description of the job definition. (Inherited from SPJobDefinition.)
	DiskSizeRequired	Gets the disk sized required for backup. (Inherited from SPJobDefinition.)
	DisplayName	Gets the localized name of the job definition. (Inherited from SPJobDefinition.)
	EnableBackup	Gets a Boolean value that indicates whether the job can be involved in the backup/restore process. (Inherited from SPJobDefinition.)
	Farm	Gets the server farm where the object resides. (Inherited from SPPersistedObject.)
	HistoryEntries	Enumerate the job history entries for this job definition. (Inherited from SPJobDefinition.)
	Id	Gets or sets the GUID that is associated with the object. (Inherited from SPPersistedObject.)
	IsDisabled	Gets or sets whether the job definition should be disabled. (Inherited from SPJobDefinition.)
	IsServiceJob	(Inherited from SPJobDefinition.)
	LastRunTime	Gets the last run time of the job definition. (Inherited from SPJobDefinition.)
	LockType	Gets the lock type for the job definition. (Inherited from SPJobDefinition.)
	Name	Gets or sets a name that is used to uniquely identify two objects that have the same parent and class. (Inherited from SPPersistedObject.)
	Parent	Gets the parent in the logical hierarchy of the configuration object tree. (Inherited from SPPersistedObject.)
	Properties	Gets metadata for the persisted object. (Inherited from SPPersistedObject.)
	Retry	Gets or sets whether the job definition should be retried if it ends abnormally. (Inherited from SPJobDefinition.)
	Schedule	Gets or sets the schedule of the job definition. (Inherited from SPJobDefinition.)
	Server	Gets the server of the job definition. (Inherited from SPJobDefinition.)
	Service	Gets the service for this job definition. (Inherited from SPJobDefinition.)
	Status	Gets or sets the status of the object that the class represents. (Inherited from SPPersistedObject.)
	Title	Gets or sets the title of the job definition. (Inherited from SPJobDefinition.)
	TypeName	Gets the display name that describes the object type in the administrative user interface. (Inherited from SPPersistedObject.)
	UpgradedPersistedProperties	Gets the collection of field names and values for fields that were deleted or changed. (Inherited from SPAutoSerializingObject.)
	VerboseTracingEnabled	Gets and sets a Boolean value that indicates whether verbose tracing is enabled. (Inherited from SPJobDefinition.)
	Version	Gets a value that is incremented each time the object is updated. (Inherited from SPPersistedObject.)
	WasCreated	Gets a Boolean value that indicates whether the object is initialized and can be found in the database. (Inherited from SPPersistedObject.)
	WebApplication	Gets the web application for this job definition. (Inherited from SPJobDefinition.)

Top

Methods

	Name	Description
	AddBackupObjects	Adds this SPJobDefinition object to the backup/restore operation. (Inherited from SPJobDefinition.)
	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.)
	Delete	Deletes the job definition. (Inherited from SPJobDefinition.)
	Equals	Determines whether the current persisted object equals the specified object. (Inherited from SPPersistedObject.)
	Execute(Guid)	Execute the job definition based on the given job instance identifier. (Inherited from SPPausableJobDefinition.)
	Execute(SPJobState)	Executes a job definition by processing work items. (Overrides SPPausableJobDefinition.Execute(SPJobState).)
	Finalize	(Inherited from Object.)
	GetChild<T>()	Returns the child of the persisted object based on the specified type. (Inherited from SPPersistedObject.)
	GetChild<T>(String)	Returns the child object of the persisted object based on the specified name. (Inherited from SPPersistedObject.)
	GetHashCode	Serves as a hash function for the persisted object. (Inherited from SPPersistedObject.)
	GetObjectData	Gets the serialized state of the object. (Inherited from SPAutoSerializingObject.)
	GetType	(Inherited from Object.)
	GetWorkItems
	HasAdditionalUpdateAccess	Override this method to allow more users to update the object. (Inherited from SPPersistedObject.)
	LegacyUpdate	(Inherited from SPPersistedObject.)
	MemberwiseClone	(Inherited from Object.)
	OnAbort	Called when a user cancels the operation. (Inherited from SPJobDefinition.)
	OnBackup	Called when the system is being backed up. (Inherited from SPJobDefinition.)
	OnBackupComplete	Called when a backup operation is complete. (Inherited from SPJobDefinition.)
	OnDeserialization	Called immediately after the base class deserializes itself to do additional work. (Inherited from SPPersistedObject.)
	OnPostCreate	(Inherited from SPPersistedObject.)
	OnPostRestore	Called when the system is done restoring a backup. (Inherited from SPJobDefinition.)
	OnPreCreate	(Inherited from SPJobDefinition.)
	OnPrepareBackup	Called when the system is preparing for a backup operation. (Inherited from SPJobDefinition.)
	OnPreRestore	Called when the system is preparing to restore a backup. (Inherited from SPJobDefinition.)
	OnRestore	Called when the system is being restored. (Inherited from SPJobDefinition.)
	ProcessWorkItem	Launches the processing of a specific work item and specifies the content database, the work item collection that contains the work item, the specific work item itself, and the current state of the pausable timer job.
	ProcessWorkItems(SPContentDatabase, SPWorkItemCollection)	Obsolete. 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.
	ProcessWorkItems(SPContentDatabase, SPWorkItemCollection, SPJobState)	Launches the processing of work items and specifies the content database, the work item collection that contains the work items, and the current state of the pausable timer jobs.
	ProcessWorkItems(SPContentDatabase, SPWorkItemCollection, Boolean)	Obsolete. 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.
	Provision	Makes the changes to the local server that are needed before the object can be used. (Inherited from SPPersistedObject.)
	RunNow	Schedules the job for immediate execution. (Inherited from SPJobDefinition.)
	RunWithConcurrencyRetries	(Inherited from SPPersistedObject.)
	ToString	Returns the type and name of an object and of all its ancestors (parent, grandparent, and so on). (Inherited from SPPersistedObject.)
	Uncache	Frees the memory cache that is used by the object. (Inherited from SPPersistedObject.)
	Unprovision	Makes the changes to the local server that are needed to clean up after deleting the object. (Inherited from SPPersistedObject.)
	Update()	Causes the job definition to save its state and propagate changes to all machines in the farm. (Inherited from SPJobDefinition.)
	Update(Boolean)	Causes the object to save its state and propagate changes to all the computers in the server farm, optionally throwing an exception if the object already exists in the configuration store. (Inherited from SPPersistedObject.)
	UpdateParent	Causes the containing SPPersistedObject, if one exists, to update its state. (Inherited from SPAutoSerializingObject.)
	UpdateProgress	Updates the percentage of the running job that is completed for the job definition running on the current server. (Inherited from SPJobDefinition.)
	UpdateWithNoObjectCallbackCheck	(Inherited from SPPersistedObject.)
	Validate	Validates the state of the job definition before persisting the object. (Inherited from SPJobDefinition.)
	WorkItemType	Returns a globally unique identifier (GUID) that identifies the type of a specified work item (SPWorkItem) or work-item batch.

Top

See also

Reference

SPWorkItemJobDefinition class

Microsoft.SharePoint.Administration namespace