PFGarbageCleaner Class |
This job cleans deleted objects out of database.
Inheritance HierarchyNamespace: Packflow.Core.Jobs.Impl
Assembly: MicaSystems.Packflow.Core (in MicaSystems.Packflow.Core.dll) Version: 1.0.0.0 (3.2.0.306)
SyntaxC#
public class PFGarbageCleaner : PFJob
The PFGarbageCleaner type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | PFGarbageCleaner |
Initializes a new instance of the PFGarbageCleaner class.
|
Properties| Name | Description | |
|---|---|---|
 | BackupFolder |
Gets or sets the backup folder for archived logs.
|
| Description |
Override this property to return a friendly description of the PFJob.
(Overrides PFJobDescription.) |
| ExecutionGuid |
Gets the execution unique identifier.
(Inherited from PFJob.) |
| ExecutionId |
Gets the execution Id.
(Inherited from PFJob.) |
| FullName |
Gets the type full name.
(Inherited from PFJob.) |
| IsBusy |
Gets a value indicating whether this instance is currently executing.
(Inherited from PFJob.) |
| IsCanceled |
Gets a value indicating whether this execution should be canceled.
Code in the Execute method should take this property into account for async cancelation.
(Inherited from PFJob.) |
| IsSimulation |
Gets or sets a value indicating whether this instance is simulation. Means no row will be deleted from database.
|
| Key |
Gets an unique key for this instance
(Inherited from PFJob.) |
| Logger |
Gets the loggerfor this instance. Anything logged here can be retrieved as part of a job execution info.
(Inherited from PFJob.) |
| LogIdentification |
Gets the log identification.
(Inherited from PFJob.) |
| PFFieldsTimeOut |
Gets or sets the deleted fields time out.
|
| PFGroupsTimeOut |
Gets or sets the deleted groups time out.
|
| PFItemEventsTimeOut |
Gets or sets the deleted item events time out.
|
| PFItemRelationsTimeOut |
Gets or sets the deleted item relations time out.
|
| PFLogEntriesTimeOut |
Gets or sets the log entries time out.
|
| PFNavigationEntriesTimeout |
Gets or sets the deleted navigation entries timeout.
|
| PFObjectLocksTimeout |
Gets or sets the deleted object locks timeout.
|
| PFPerformanceReportsTimeout |
Gets or sets the performance reports timeout.
|
| PFTimerJobsTimeout |
Gets or sets the deleted timer jobs timeout.
|
| PFUserNotificationsMaxEntries |
Gets or sets the user notifications maximum entries.
|
| PFUsersTimeout |
Gets or sets the deleted users timeout.
|
| PFViewsTimeout |
Gets or sets the deleted views timeout.
|
 | Progression |
Gets the progression info object.
(Inherited from PFJob.) |
| Settings |
Gets the collection of settings for this PFJob.
Typical usage doen't require manipulating this collection.
Use the decorated properties on the PFJob instance instead.
(Inherited from PFJob.) |
| Site |
Gets the PFSite this PFJob belongs to.
(Inherited from PFJob.) |
Methods| Name | Description | |
|---|---|---|
| CancelAsync |
Call this method to cancel PFJob execution.
(Inherited from PFJob.) |
 | Execute |
Here lies your execution code.
(Overrides PFJobExecute.) |
| GetChoicesForSetting |
Gets the possible choices for given setting (or parameter).
(Inherited from PFJob.) |
| GetRunUsers |
Override this property to return a list of users authorized to run this PFJob.
Don't forget to include users from base method.
(Overrides PFJobGetRunUsers.) |
| InitJob |
Initializes the job.
Override this method to set default values to parameters, and to subscribe on job events.
(Overrides PFJobInitJob.) |
| OnProgressionChanged |
Call this method in 'Execute' to report a progression changed.
Makes the 'Progression' property available.
(Inherited from PFJob.) |
| OnProgressionChanged(Int32, String) |
Call this method in 'Execute' to report a progression changed.
Makes the 'Progression' property available.
(Inherited from PFJob.) |
| Run |
Call this method to run PFJob synchronously.
(Inherited from PFJob.) |
| RunAsync |
Call this method to run PFJob asynchronously
(Inherited from PFJob.) |
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
| Validate |
Override this method to throw an exception if your validation conditions fail.
Validation should be related to job parameters only.
(Overrides PFJobValidate.) |
Events| Name | Description | |
|---|---|---|
 | ExecuteCompleted |
Occurs when the execution has completed.
(Inherited from PFJob.) |
| ExecuteProgressChanged |
Occurs when OnProgressionChanged is called from execution code.
(Inherited from PFJob.) |
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