PFTimerJob Class |
This class represents a PFJob implementation persisted in Packflow.
It allows to save and schedule PFJobs in packflow.
Inheritance HierarchyNamespace: Packflow.Core.Jobs
Assembly: MicaSystems.Packflow.Core (in MicaSystems.Packflow.Core.dll) Version: 1.0.0.0 (3.2.0.306)
SyntaxC#
public sealed class PFTimerJob : PFBaseObject
The PFTimerJob type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | PFTimerJob |
Properties| Name | Description | |
|---|---|---|
 | BeforeSaveValues |
Gets the previous values of modified fields before the latest Save.
(Inherited from PFBaseObject.)Note: this feature is NOT persisted in the database and therefore only concerns this instance. |
| CanDelete |
Checks if the current permission context allows current user to delete this object.
(Inherited from PFBaseObject.) |
| CanRead |
Checks if the current permission context allows current user to access this object.
(Inherited from PFBaseObject.) |
| CanUpdate |
Checks if the current permission context allows current user to update this object.
(Inherited from PFBaseObject.) |
| Created |
Indicates if this object has been created and is still in database (positive Id).
(Inherited from PFBaseObject.) |
| CreatedAt |
Gets the date of creation of this object in the database.
(Inherited from PFBaseObject.) |
| CreatedBy |
Gets the user who created this object in the database.
(Inherited from PFBaseObject.) |
| Data |
Gets the data collection of this object.
(Inherited from PFBaseObject.) |
| DateObjectCreation |
Gets the date of the creation of this object in memory.
(Inherited from PFManagedObject.) |
| Deleted |
True if this object is flagged as deleted.
(Inherited from PFBaseObject.) |
| DeletedAt |
Date of the suppression of this object.
(Inherited from PFBaseObject.) |
| DeletedBy |
The user who deleted this object.
(Inherited from PFBaseObject.) |
| EnableVersionMergeToResolveSaveConflicts |
Gets a value indicating whether versions can be merged to resolve save conflicts.
If an object is saved with an older version than the last persisted (in database),
the system will try to merge the versions values (if no conflicts between values)
and will then save the merged item to database.
Note : this setting is NOT persisted and will affect this object instance only.
(Inherited from PFBaseObject.) |
| Exists |
Indicates if this object has been created, still exists in database and is not flagged for suppression.
(Inherited from PFBaseObject.) |
| Guid |
Gets the GUID identifying this object.
Must be used if Id is no more viable, example if content were merged.
(Inherited from PFBaseObject.) |
| HasPendingModifications |
Checks if there is pending changes.
Will check if the values are different from the currently persisted values.
(Inherited from PFBaseObject.) |
| HasPendingPermissionsModifications |
Checks if there is pending modifications in permissions.
Will compute permissions (RUD) and check if there is differences with current persisted permissions.
(Inherited from PFBaseObject.) |
| Id |
Gets the id identifying this object.
Must be used to find or identify an object because faster than Guid.
(Inherited from PFBaseObject.) |
| Job |
Gets the PFJob this PFTimerJob persists.
PFJob instance state is automatically restored when getting from a PFTimerJob.
|
| JobDescription |
Gets or sets the job description.
|
| JobFullName |
Gets or sets the full name of the PFJob type.
|
| JobKey |
Gets or sets the job unique key. |
| KeepBeforeSaveValues |
Gets or sets a value indicating whether
the Save should keep a collection of the modified fields previous values.
(Inherited from PFBaseObject.)Note: this feature is NOT persisted in the database and therefore only concerns this instance. |
| Logger |
Gets the logger, used to log any useful warning, error or information in the database.
(Inherited from PFManagedObject.) |
| LogIdentification |
Gets a technical text representing this object.
(Inherited from PFBaseObject.) |
| Paused |
Not Implemented! Pause is implemented at the PFJobTrigger level.
Gets or sets a value indicating whether this PFTimerJob is paused.
|
| PermissionContext |
Gets an object calculating permissions on demand.
(Inherited from PFBaseObject.) |
| Permissions |
Gets the permission set (RUD permissions) of this item.
(Inherited from PFBaseObject.) |
| Settings |
Gets the collection of generic settings for this PFJob |
| Site |
Gets the root of the persisted objects tree.
(Inherited from PFBaseObject.) |
| Triggers |
Gets a collection of triggers for this PFTimerJob.
Add triggers to schedule your PFTimerJob.
|
| UpdatedAt |
Gets the date of the last update of this object.
(Inherited from PFBaseObject.) |
| UpdatedBy |
Gets the user who last updated this object in the database.
(Inherited from PFBaseObject.) |
| VersionNumber |
Gets the version number of this object in database. Incremented after each save.
(Inherited from PFBaseObject.) |
Methods| Name | Description | |
|---|---|---|
| Delete |
Flags this object as deleted and updates the external scheduler, if present.
Tries unscheduling it.
(Overrides PFBaseObjectDelete.)If it fails, throws an error/ |
| RunInTransactionArea |
Runs a code with a transaction on object connection.
If there is no current transaction and if the code succeed, transaction is committed.
If an exception is thrown, transaction is rollback.
(Inherited from PFBaseObject.) |
| Save |
Saves the current Timer Job in the database and updates the external scheduler if present.
(Overrides PFBaseObjectSave.) |
| Save(Boolean, Boolean) |
Saves the current Timer Job in the database, updates the scheduler according to parameters.
|
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
Fields| Name | Description | |
|---|---|---|
  | FieldName_InstanceDescription |
Database column
|
| FieldName_JobDescription |
Column name in database.
|
| FieldName_JobFullName |
Column name in database.
|
| FieldName_Name |
Column name in database.
|
Extension Methods| Name | Description | |
|---|---|---|
 | AsT |
Casts an object to another type. Returns default(T) if the object is null.
(Defined by Utils_Other.) |
| EqualsAll |
Checks that this object is equal to every object in parameters.
(Defined by Utils_Other.) |
| EqualsAny |
Checks that this object is equal to at least one of the parameters.
(Defined by Utils_Other.) |
| GetString |
Converts an object to String using ToString() method, else returns String.Empty.
(Defined by Utils_Other.) |
| IsGenericList | Overloaded.
Checks if this object is a System.Collections.Generic.List.
(Defined by Utils_Linq.) |
| IsGenericList(Type) | Overloaded.
Checks if this object is a System.Collections.Generic.List using type as T.
(Defined by Utils_Linq.) |
| Serialize | Overloaded.
Serializes an object into an XML document.
(Defined by Utils_Xml.) |
| Serialize(String) | Overloaded.
Serializes an object into an XML document.
(Defined by Utils_Xml.) |
| SerializeJson | Overloaded.
Serializes an object using a DataContractJsonSerializer.
(Defined by Utils_String.) |
| SerializeJson(ListType) | Overloaded.
Serializes an object using a DataContractJsonSerializer.
(Defined by Utils_String.) |
| SerializeJson(DataContractJsonSerializerSettings) | Overloaded.
Serializes an object using a DataContractJsonSerializer.
(Defined by Utils_String.) |
See Also