SPJobDefinition members

Represents a job definition.

The SPJobDefinition type exposes the following members.

Constructors

	Name	Description
	SPJobDefinition()	Initializes a new instance of the SPJobDefinition class.
	SPJobDefinition(String, SPService, SPServer, SPJobLockType)	Initializes a new instance of the SPJobDefinition class and provides parameters for specifying key objects.
	SPJobDefinition(String, SPWebApplication, SPServer, SPJobLockType)	Initializes a new instance of the SPJobDefinition class and provides parameters for specifying key objects.

Top

Properties

	Name	Description
	CanRenameOnRestore	Gets a Boolean value that indicates whether this object can be renamed at restore time.
	CanSelectForBackup	Gets and sets a Boolean value that indicates whether this object can be selected for backup.
	CanSelectForRestore	Gets and sets a Boolean value that indicates whether this object can be selected for backup.
	DeploymentLocked	(Inherited from SPPersistedObject.)
	Description	Gets a localized description of the job definition.
	DiskSizeRequired	Gets the disk sized required for backup.
	DisplayName	Gets the localized name of the job definition. (Overrides SPPersistedObject.DisplayName.)
	EnableBackup	Gets a Boolean value that indicates whether the job can be involved in the backup/restore process.
	Farm	Gets the server farm where the object resides. (Inherited from SPPersistedObject.)
	HistoryEntries	Enumerate the job history entries for this job definition.
	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.
	IsServiceJob
	LastRunTime	Gets the last run time of the job definition.
	LockType	Gets the lock type for the job definition.
	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.
	Schedule	Gets or sets the schedule of the job definition.
	Server	Gets the server of the job definition.
	Service	Gets the service for this job definition.
	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.
	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.
	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.

Top

Methods

	Name	Description
	AddBackupObjects	Adds this SPJobDefinition object to the backup/restore operation.
	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. (Overrides SPPersistedObject.Delete().)
	Equals	Determines whether the current persisted object equals the specified object. (Inherited from SPPersistedObject.)
	Execute	Executes the job definition on the local machine and is intended to be used only by the timer service.
	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.)
	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.
	OnBackup	Called when the system is being backed up.
	OnBackupComplete	Called when a backup operation is complete.
	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.
	OnPreCreate	(Overrides SPPersistedObject.OnPreCreate().)
	OnPrepareBackup	Called when the system is preparing for a backup operation.
	OnPreRestore	Called when the system is preparing to restore a backup.
	OnRestore	Called when the system is being restored.
	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.
	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. (Overrides SPPersistedObject.Update().)
	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.
	UpdateWithNoObjectCallbackCheck	(Inherited from SPPersistedObject.)
	Validate	Validates the state of the job definition before persisting the object. (Overrides SPPersistedObject.Validate().)

Top

See also

Reference

SPJobDefinition class

Microsoft.SharePoint.Administration namespace