SPJobDefinition members

  • Article

Represents a job definition.

The SPJobDefinition type exposes the following members.

Constructors

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

Top

Properties

  Name Description
Public property CanRenameOnRestore Gets a Boolean value that indicates whether this object can be renamed at restore time.
Public property CanSelectForBackup Gets and sets a Boolean value that indicates whether this object can be selected for backup.
Public property CanSelectForRestore Gets and sets a Boolean value that indicates whether this object can be selected for backup.
Public property DeploymentLocked (Inherited from SPPersistedObject.)
Public property Description Gets a localized description of the job definition.
Public property DiskSizeRequired Gets the disk sized required for backup.
Public property DisplayName Gets the localized name of the job definition. (Overrides SPPersistedObject.DisplayName.)
Public property EnableBackup Gets a Boolean value that indicates whether the job can be involved in the backup/restore process.
Public property Farm Gets the server farm where the object resides. (Inherited from SPPersistedObject.)
Public property HistoryEntries Enumerate the job history entries for this job definition.
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.
Public property IsServiceJob
Public property LastRunTime Gets the last run time of the job definition.
Public property LockType Gets the lock type for the job definition.
Public property Name Gets or sets a name that is used to uniquely identify two objects that have the same parent and class. (Inherited from SPPersistedObject.)
Public property Parent Gets the parent in the logical hierarchy of the configuration object tree. (Inherited from SPPersistedObject.)
Public property Properties Gets metadata for the persisted object. (Inherited from SPPersistedObject.)
Public property Retry Gets or sets whether the job definition should be retried if it ends abnormally.
Public property Schedule Gets or sets the schedule of the job definition.
Public property Server Gets the server of the job definition.
Public property Service Gets the service for this job definition.
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.
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 VerboseTracingEnabled Gets and sets a Boolean value that indicates whether verbose tracing is enabled.
Public property Version Gets a value that is incremented each time the object is updated. (Inherited from SPPersistedObject.)
Protected property WasCreated Gets a Boolean value that indicates whether the object is initialized and can be found in the database. (Inherited from SPPersistedObject.)
Public property WebApplication Gets the web application for this job definition.

Top

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.)
Public method LegacyUpdate (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.)
Protected method OnPostCreate (Inherited from SPPersistedObject.)
Public method OnPostRestore Called when the system is done restoring a backup.
Protected method OnPreCreate (Overrides SPPersistedObject.OnPreCreate().)
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 RunWithConcurrencyRetries (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 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.
Public method UpdateWithNoObjectCallbackCheck (Inherited from SPPersistedObject.)
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