PFTask Methods |
The PFTask type exposes the following members.
Methods| Name | Description | |
|---|---|---|
 | AddItemRelation(Guid, PFItem) |
Adds an item relation from this item to another.
(Inherited from PFItem.) |
| AddItemRelation(Guid, PFItemReference) |
Adds an item relation from this item to another.
(Inherited from PFItem.) |
| AddItemRelation(String, PFItem) |
Adds an item relation from this item to another.
(Inherited from PFItem.) |
| AddItemRelation(String, PFItemReference) |
Adds an item relation from this item to another.
(Inherited from PFItem.) |
| AddItemRelation(ContentRelation, PFItem) |
Adds an item relation from this item to another.
(Inherited from PFItem.) |
| AddItemRelation(ContentRelation, PFItemReference) |
Adds an item relation from this item to another.
(Inherited from PFItem.) |
| AddItemRelation(String, Guid, PFItem) |
Adds an item relation from this item to another.
(Inherited from PFItem.) |
| AddItemRelation(String, Guid, PFItemReference) |
Adds an item relation from this item to another.
(Inherited from PFItem.) |
| AddItemRelation(String, String, PFItem) |
Adds an item relation from this item to another.
(Inherited from PFItem.) |
| AddItemRelation(String, String, PFItemReference) |
Adds an item relation from this item to another.
(Inherited from PFItem.) |
| AttachFile(String, Byte, PFFieldFileHolder) |
This will create and persist a file in database and then link it into the fileHolder field value.
You will need to save this item to persist the value in database.
Note : this is different from .Files.Add() that will only create a non-yet-persisted instance of a file.
(Inherited from PFItem.) |
| AttachFile(String, Byte, String) |
This will create and persist a file in database and then link it into the fileHolder field value.
You will need to save this item to persist the value in database.
Note : this is different from .Files.Add() that will only create a non-yet-persisted instance of a file.
(Inherited from PFItem.) |
| AttachPdfFile(PFFile, PFFieldFileHolder) |
This will create and persist a file in database and then link it into the fileHolder field value.
You will need to save this item to persist the value in database.
Note : this is different from .Files.Add() that will only create a non-yet-persisted instance of a file.
(Inherited from PFItem.) |
| AttachPdfFile(PFFile, String) |
This will create and persist a file in database and then link it into the fileHolder field value.
You will need to save this item to persist the value in database.
Note : this is different from .Files.Add() that will only create a non-yet-persisted instance of a file.
(Inherited from PFItem.) |
| BaseSave |
IMPORTANT : will not call overridden Save method!
Saves item to database. Note: use transaction.
If transaction already exists, will not commit it, but may rollback it
if needed (then an exception is thrown).
(Inherited from PFItem.) |
| CanFieldBeModifiedByUser(String) |
Checks if a field control mode is editable in the current context.
(Inherited from PFItem.) |
| CanFieldBeModifiedByUser(PFField) |
Checks if a field control mode is editable in the current context.
(Inherited from PFItem.) |
| ChangeApplicationContext |
Will change the context of this item, of its parts items and of its tasks.
You must have the permission to modify everything.
(Inherited from PFItem.) |
| ChangeTaskDecision |
Changes the chosen decision of a task.
|
| CustomizeDefaultFileNameByTemplate |
Allows to customize default file names proposed to users for each template.
(Inherited from PFItem.) |
| Delete |
Flags this object as deleted.
(Inherited from PFBaseObject.)If it fails, throws an error. If the object could not be deleted because it does not yet exist in database, returns false. If successful, returns true. |
| ExternalConnection_Get |
Gets the external connection having synchronized this item.
(Inherited from PFItem.) |
| ExternalConnection_GetExternalData |
Externals the connection_ get external data.
(Inherited from PFItem.) |
| ExternalConnection_Synchronize |
Synchronizes this item's data properties with its external content.
(Inherited from PFItem.)Note: this does NOT save the item. |
| ExternalConnection_SynchronizeAndSave |
Synchronizes this item's data properties with its external content,
then saves the item if the synchronization changed any value.
(Inherited from PFItem.) |
| ExternalConnection_SynchronizeValidation |
Checks if the item can be synchronized with its external source by the current user.
Called for the method ExternalConnection_Synchronize in the batch action feature.
(Inherited from PFItem.) |
| GenerateHtmlMessage(Int32, String) |
Generates a html message (subject and body) from a modeling message.
(Inherited from PFItem.) |
| GenerateHtmlMessage(String, String) |
Generates a html message (subject and body) from a modeling message.
(Inherited from PFItem.) |
| GenerateHtmlMessage(ContentMessage, String) |
Generates a html message (subject and body) from a modeling message.
(Inherited from PFItem.) |
 | GenerateReference | Returns a reference for the current item. Is called by the Save method when the item is not yet created and the reference is empty. |
| GenerateTaskTitle | Used to initialize a task title in the current workflow state. Default : "{Reference} : {State}" |
| GenerateTextMessage(Int32, String) |
Generates a html message (subject and body) from a modeling message.
(Inherited from PFItem.) |
| GenerateTextMessage(String, String) |
Generates a html message (subject and body) from a modeling message.
(Inherited from PFItem.) |
| GenerateTextMessage(ContentMessage, String) |
Generates a html message (subject and body) from a modeling message.
(Inherited from PFItem.) |
| GetConversationTitle |
Defines the title of this item conversation for the specified user.
Returns this item caption by default.
(Inherited from PFItem.) |
| GetFieldControlMode(String) |
Gets the control mode of a field in the current context.
(Inherited from PFItem.) |
| GetFieldControlMode(PFField) |
Gets the control mode of a field in the current context.
(Inherited from PFItem.) |
| GetFieldDisplayValue(String) |
Gets display text (not html) of a field in this item.
(Inherited from PFItem.) |
| GetFieldDisplayValue(PFField) |
Gets display text (not html) of a field in this item.
(Inherited from PFItem.) |
| GetGuid |
Returns a Global Unique Identifier for the target.
(Inherited from PFItem.) |
| GetId |
Returns an id representing the target.
(Inherited from PFItem.) |
| GetItemLocks |
Gets current locks.
(Inherited from PFItem.)Note : will return an empty list if the object is not yet created. |
| GetLocks |
Gets current locks.
(Inherited from PFItem.) |
| GetMessagePlaceHolderHtml |
Gets the html of a message placeholder (in a ContentMessage) in the specified language.
(Inherited from PFItem.) |
| GetMessagePlaceHolderText |
Gets the text of a message placeholder (in a ContentMessage) in the specified language.
(Inherited from PFItem.) |
| GetNewPermissionContext |
Creates a new permission context based on current object type.
(Inherited from PFItem.) |
| GetObjectRelationByName |
Gets a children entities relation by its name.
(Inherited from PFRelationalObject.) |
| GetParts |
Gets items whose current item is the owner item.
(Inherited from PFItem.) |
| GetPartsAndTasksRecursively |
Gets items whose current item is the owner item and recursively.
Will also return tasks of each returned item.
(Inherited from PFItem.) |
| GetPartsRecursively |
Gets items whose current item is the owner item and recursively.
(Inherited from PFItem.) |
| GetRelatedItems(Guid, PFQuery, PFItemRelationDirection, Boolean) |
Gets items linked inside a relation.
(Inherited from PFItem.) |
| GetRelatedItems(String, PFQuery, PFItemRelationDirection, Boolean) |
Gets items linked inside a relation.
(Inherited from PFItem.) |
| GetRelatedItems(String, Guid, PFQuery, PFItemRelationDirection, Boolean) |
Gets items linked inside a relation.
(Inherited from PFItem.) |
| GetRelatedItems(String, String, PFQuery, PFItemRelationDirection, Boolean) |
Gets items linked inside a relation.
(Inherited from PFItem.) |
| GetRelatedItems(ContentRelation, PFQuery, PFContentType, PFItemRelationDirection, Boolean) |
Gets items linked inside a relation.
(Inherited from PFItem.) |
| GetRelatedItemsByGroup(Guid, PFQuery, PFItemRelationDirection) |
Gets aggregated items linked inside a relation.
(Inherited from PFItem.) |
| GetRelatedItemsByGroup(String, PFQuery, PFItemRelationDirection) |
Gets aggregated items linked inside a relation.
(Inherited from PFItem.) |
| GetRelatedItemsByGroup(String, Guid, PFQuery, PFItemRelationDirection) |
Gets aggregated items linked inside a relation.
(Inherited from PFItem.) |
| GetRelatedItemsByGroup(String, String, PFQuery, PFItemRelationDirection) |
Gets aggregated items linked inside a relation.
(Inherited from PFItem.) |
| GetRelatedItemsByGroup(ContentRelation, PFQuery, PFContentType, PFItemRelationDirection) |
Gets aggregated items linked inside a relation.
(Inherited from PFItem.) |
| GetShownEventTagsInMessaging |
Returns the values of Tag that should be included when displaying the messaging
UI for this PFItem instance.
(Inherited from PFItem.) |
| GetTasksDueDate |
Computes the due date using modeling settings on current state and taken transition.
(Inherited from PFItem.) |
| HasPendingModificationsOnSynchronizedColumns |
Determines whether at least one synchronized (with the model) data has been modified.
This will always return false for an item not being synchronized with the model.
(Inherited from PFItem.) |
| InheritFromOwnerItemApplicationContext |
Gets the corresponding application context from the owner item and set in this item.
(Inherited from PFItem.) |
| InitializeLogger |
Use this method to override the way the logger is initialized.
(Inherited from PFBaseObject.) |
| IsFieldRequired | Checks if a field is required before any Save of this item. By default, returns True if the field is marked as required or if the transition requires this field, if the transition is specified. Note : will return false for all FileHolder fields before creation. |
| IsUserOwner |
Checks if a user has the owner privilege on this item.
(Inherited from PFItem.) |
| IsVisibleToEveryone |
Override this method if you want to force-open this item's visibility to everyone.
(Inherited from PFItem.) |
| OnAfterCreateNotification |
Raises the [E:BeforeSendingNotification] event.
(Inherited from PFItem.) |
| OnBeforeCreateNotification |
Raises the [E:BeforeSendingNotification] event.
(Inherited from PFItem.) |
| OnFileBinding |
Raises the [E:FileOpened] event.
(Inherited from PFItem.) |
| OnFileDownloaded |
Raises the [E:FileDownloaded] event.
(Inherited from PFItem.) |
| OnFileDownloading |
Raises the [E:FileDownloading] event.
(Inherited from PFItem.) |
| OnInitialized |
Raises the [E:Initialized] event.
(Inherited from PFItem.) |
| PreInitOwnerItem |
Initializes owner item before creation.
(Inherited from PFItem.)This allows the item to have access to the OwnerItem property before its creation and obviously before the relation exists. Important: an exception is thrown if the owner item is invalid or already initialized or if the item is already created in the database. |
| ProcessPermissions |
Compute permissions from permission context and set in data properties.
(Inherited from PFBaseObject.) |
| ReleaseLock |
Releases the lock of a given user, if found.
(Inherited from PFItem.) |
| RemoveItemRelation(Guid, PFItem) |
Removes an item relation between this item and another.
(Inherited from PFItem.) |
| RemoveItemRelation(Guid, PFItemReference) |
Removes an item relation between this item and another.
(Inherited from PFItem.) |
| RemoveItemRelation(String, PFItem) |
Removes an item relation between this item and another.
(Inherited from PFItem.) |
| RemoveItemRelation(String, PFItemReference) |
Removes an item relation between this item and another.
(Inherited from PFItem.) |
| RemoveItemRelation(ContentRelation, PFItem) |
Removes an item relation between this item and another.
(Inherited from PFItem.) |
| RemoveItemRelation(ContentRelation, PFItemReference) |
Removes an item relation between this item and another.
(Inherited from PFItem.) |
| RemoveItemRelation(String, Guid, PFItem) |
Removes an item relation between this item and another.
(Inherited from PFItem.) |
| RemoveItemRelation(String, Guid, PFItemReference) |
Removes an item relation between this item and another.
(Inherited from PFItem.) |
| RemoveItemRelation(String, String, PFItem) |
Removes an item relation between this item and another.
(Inherited from PFItem.) |
| RemoveItemRelation(String, String, PFItemReference) |
Removes an item relation between this item and another.
(Inherited from PFItem.) |
| ResetOwnerItemCache |
Resets owner item cache, for example if the owner item could have changed.
(Inherited from PFItem.) |
| 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 |
Applies the data of this object in the database.
(Overrides PFItemSave.) |
| SaveAsPartOf(String, PFItem, Boolean, Boolean) |
Saves this item and directly link it to an owner item through a relation.
(Inherited from PFItem.) |
| SaveAsPartOf(ContentRelation, PFItem, Boolean, Boolean) |
Saves this item and directly link it to an owner item through a relation.
(Inherited from PFItem.) |
| SaveObjectsInDataCollection |
Saves data loaded from temp specialized object
in data properties collection before save or check hasPendingChanges.
(Inherited from PFItem.) |
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
| TriggerNotification(String, ListPFUser) |
Triggers a notification based on a name.
(Inherited from PFItem.) |
| TriggerNotification(PFNotificationTriggerType, ListPFUser) |
Triggers a notification type for this item.
(Inherited from PFItem.)IMPORTANT : This method does not support TaskAssigned as a trigger type, use TaskAssignedOnly or TaskReassignedOnly instead. |
| TryGetLock |
Tries to get a lock for a given user.
(Inherited from PFItem.) |
| TryToGetVersionEditedByUser |
The edited version is a backup of the item's data when the user started to edit this item.
This allows to set his changes to the same item version
(Inherited from PFItem.)This method tries to get this item's version, if it exists. |
| UpdateVersionEditedByUser |
The edited version is a backup of the item's data when the user started to edit this item.
This allows to set his changes to the same item version
(Inherited from PFItem.)This method updates that version to the current metadata, it upgrades it. |
| UserHasPrivilege |
Checks if a user has a given privilege on this item.
(Inherited from PFItem.) |
| ValidateRequiredFields |
Checks if all required fields are currently filled.
(Inherited from PFItem.)Will throw a PFMissingItemValuesException if not. Will throw a ValidationException is one or more required fields entry are missing in the data collection. Note : this method is called at the beginning of the Save method. |
| Workflow_Enact | Moves the workflow (if possible). Ensures tasks (if enacted). Saves item to database (in any case). Note: uses transaction. If transaction already exists, will not commit it, but may rollback it if needed (then an exception is thrown). |
| Workflow_Enact(Int32) | Moves the workflow (if possible). Ensures tasks (if enacted). Saves item to database (in any case). Note: uses transaction. If transaction already exists, will not commit it, but may rollback it if needed (then an exception is thrown). |
| Workflow_Enact(State) | Moves the workflow (if possible). Ensures tasks (if enacted). Saves item to database (in any case). Note: uses transaction. If transaction already exists, will not commit it, but may rollback it if needed (then an exception is thrown). |
| Workflow_Enact(Transition) | Moves the workflow (if possible). Ensures tasks (if enacted). Saves item to database (in any case). Note: uses transaction. If transaction already exists, will not commit it, but may rollback it if needed (then an exception is thrown). |
| Workflow_EnsureTasks |
Cancels tasks of previous state instances and ensure tasks for current state instance.
(Inherited from PFItem.) |
| Workflow_GetCurrentTaskForUser |
Gets the task of a given user in the current state instance, if found.
(Inherited from PFItem.)If multiple instance tasks are available for the user, active task (if any) is returned first. |
| Workflow_GetRequiredFieldsForTransition |
Gets the required fields for a given transition.
(Inherited from PFItem.) |
| Workflow_ReassignTask |
Reassigns a specific task of this workflow to another user.
(Inherited from PFItem.) |
| Workflow_ResolveTransitionConflict |
If multiple transitions are possible; the conflict must be resolved.
By default, takes top most transition based on Transition Priority and then on participation count.
(Inherited from PFItem.) |
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.) |
| GetReference | Overloaded.
Gets a object referencing the item.
(Defined by PFItemExtensions.) |
| GetReference(String) | Overloaded.
Gets a object referencing the item.
The Text of the reference will be the value of the specified field.
(Defined by PFItemExtensions.) |
| 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