SPJobDefinition Methods

Include Protected Members
Include Inherited Members

The SPJobDefinition type exposes the following members.

Methods

  Name Description
Public method AddBackupObjects Adds this SPJobDefinition object to the backup/restore operation.
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. (Overrides SPPersistedObject.Delete().)
Public method Equals Determines whether the current persisted object equals the specified object. (Inherited from SPPersistedObject.)
Public method Execute Executes the job definition on the local machine and is intended to be used only by the timer service.
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 Gets the serialized state of the object. (Inherited from SPAutoSerializingObject.)
Public method GetType (Inherited from Object.)
Protected method HasAdditionalUpdateAccess Override this method to allow more users to update the object. (Inherited from SPPersistedObject.)
Protected method MemberwiseClone (Inherited from Object.)
Public method OnAbort Called when a user cancels the operation.
Public method OnBackup Called when the system is being backed up.
Public method OnBackupComplete Called when a backup operation is complete.
Protected method OnDeserialization Called immediately after the base class deserializes itself to do additional work. (Inherited from SPPersistedObject.)
Public method OnPostRestore Called when the system is done restoring a backup.
Public method OnPrepareBackup Called when the system is preparing for a backup operation.
Public method OnPreRestore Called when the system is preparing to restore a backup.
Public method OnRestore Called when the system is being restored.
Public method Provision Makes the changes to the local server that are needed before the object can be used. (Inherited from SPPersistedObject.)
Public method RunNow Schedules the job for immediate execution.
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 changes to the local server that are needed to clean up after deleting the object. (Inherited from SPPersistedObject.)
Public method Update() Causes the job definition to save its state and propagate changes to all machines in the farm. (Overrides SPPersistedObject.Update().)
Public method 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.)
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.
Protected method 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