Click or drag to resize

PFTask Class

Represents an item in a content-type, used to represent a workflow task in a specific state instance.
Inheritance Hierarchy

Namespace:  Packflow.Core
Assembly:  MicaSystems.Packflow.Core (in MicaSystems.Packflow.Core.dll) Version: 1.0.0.0 (3.2.0.306)
Syntax
C#
public class PFTask : PFItem

The PFTask type exposes the following members.

Constructors
  NameDescription
Public methodPFTask
Top
Properties
  NameDescription
Public propertyAbsolutePrintUrl
Gets the absolute url of the print form of this item.
(Inherited from PFItem.)
Public propertyAbsoluteUrl
Gets the absolute url of the form of this item.
(Inherited from PFItem.)
Public propertyActorType
Gets the type of actor owning this task. Currently only concerns normal actors, but will be used later to identify non-human actors and actors not impacting the decision of a workflow.
Public propertyApplicationContext
Gets the current application context of this item, if not yet assigned, will assign and return first found context on the parent application.
(Inherited from PFItem.)
Public propertyApplicationContextId

Gets or sets the id of the current application context of this item.

Note : can only be assigned if this item has not been created yet or if the current application context does not exist anymore.
(Inherited from PFItem.)
Public propertyApplicationContextName
Gets the name of the current application context of this item.
(Inherited from PFItem.)
Public propertyAssignedTo
Gets the owner of this task.
Public propertyBeforeSaveValues
Gets the previous values of modified fields before the latest Save.

Note: this feature is NOT persisted in the database and therefore only concerns this instance.

(Inherited from PFBaseObject.)
Public propertyCanDelete
Checks if the current permission context allows current user to delete this object.
(Inherited from PFBaseObject.)
Public propertyCanRead
Checks if the current permission context allows current user to access this object.
(Inherited from PFBaseObject.)
Public propertyCanUpdate
Checks if the current permission context allows current user to update this object.
(Inherited from PFBaseObject.)
Public propertyCaption
Gets the display text representing this item.
(Inherited from PFItem.)
Public propertyComments
Gets a relation allowing to access all comments.
(Inherited from PFItem.)
Public propertyCommentsEnabled
Gets a value indicating whether comments are enabled.
(Inherited from PFItem.)
Public propertyCreated
Indicates if this object has been created and is still in database (positive Id).
(Inherited from PFBaseObject.)
Public propertyCreatedAt
Gets the date of creation of this object in the database.
(Inherited from PFBaseObject.)
Public propertyCreatedBy
Gets the user who created this object in the database.
(Inherited from PFBaseObject.)
Public propertyData
Gets the metadata of this item.
(Inherited from PFItem.)
Public propertyDateLastReminder
Gets the date of the last time this task was reminded to the owner by the PFTaskReminderJob.
Public propertyDateObjectCreation
Gets the date of the creation of this object in memory.
(Inherited from PFManagedObject.)
Public propertyDeleted
True if this object is flagged as deleted.
(Inherited from PFBaseObject.)
Public propertyDeletedAt
Date of the suppression of this object.
(Inherited from PFBaseObject.)
Public propertyDeletedBy
The user who deleted this object.
(Inherited from PFBaseObject.)
Public propertyDisableNotificationsTemporarily
Gets or sets a value indicating whether all operations on this item should avoid to send notifications to users.

Important : this flag will only concern the current INSTANCE of this object.

(Inherited from PFItem.)
Public propertyDueDate
Gets the due date.
Public propertyDueStartDate
Gets the due start date.
Public propertyEnableVersionMergeToResolveSaveConflicts
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 PFItem.)
Public propertyEndDate
Gets the end date.
Public propertyEvents
Gets a relation allowing to access all significant events that occurred during the life of this item.
(Inherited from PFItem.)
Public propertyExists
Indicates if this object has been created, still exists in database and is not flagged for suppression.
(Inherited from PFBaseObject.)
Public propertyExternalConnectionId
Gets or sets the id of the PFExternalConnection having created and synchronized this item. If not synchronized, this value is 0 or less.
(Inherited from PFItem.)
Public propertyFiles
Gets a relation allowing to access all files attached to this item using a PFFileHolderField.
(Inherited from PFItem.)
Public propertyGuid
Gets the GUID identifying this object. Must be used if Id is no more viable, example if content were merged.
(Inherited from PFBaseObject.)
Public propertyHasPendingModifications
Checks if there is pending changes. Will check if the values are different from the currently persisted values.
(Inherited from PFBaseObject.)
Public propertyHasPendingPermissionsModifications
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.)
Public propertyHasWorkflowItem
Checks in database if the parent workflow item is available.
Public propertyId
Gets the id identifying this object. Must be used to find or identify an object because faster than Guid.
(Inherited from PFBaseObject.)
Public propertyInboundTransition
Gets the last persisted display name of the last taken transition.
(Inherited from PFItem.)
Public propertyInboundTransitionId
Gets the id of the last transition taken in the workflow, corresponding to the modeling Transition id.
(Inherited from PFItem.)
Public propertyIsSynchronizedWithAnExternalSource
Gets a value indicating whether this instance is synchronized with an external source.
(Inherited from PFItem.)
Public propertyIsWorkflowTask
Gets a value indicating whether this task is related to a workflow or not.
Public propertyKeepBeforeSaveValues
Gets or sets a value indicating whether the Save should keep a collection of the modified fields previous values.

Note: this feature is NOT persisted in the database and therefore only concerns this instance.

(Inherited from PFItem.)
Public propertyLogger
Gets the logger, used to log any useful warning, error or information in the database.
(Inherited from PFManagedObject.)
Public propertyLogIdentification
Gets a technical text representing this object.
(Inherited from PFBaseObject.)
Public propertyModelItem
If this item is linked to or synchronized with a modeled item, this will contain the ContentItem (from the model).
(Inherited from PFItem.)
Public propertyModelItemGuid
If this item is linked to or synchronized with a modeled item, this will contain the Guid of that ContentItem.
(Inherited from PFItem.)
Public propertyOwnerItem
Gets the owner item of this item. Based on the item relation with the correct ownership.
(Inherited from PFItem.)
Public propertyParentApplication
Gets the parent application of this item.
(Inherited from PFItem.)
Public propertyParentContentType
Gets the parent content-type of this item.
(Inherited from PFItem.)
Public propertyPermissionContext
Gets an object calculating permissions on demand.
(Inherited from PFItem.)
Public propertyPermissions
Gets the permission set (RUD permissions) of this item.
(Inherited from PFBaseObject.)
Protected propertyPermissionSetDeleteId
Id of the permission set for Delete access.
(Inherited from PFBaseObject.)
Protected propertyPermissionSetDeleteXml
XML of serialized permission set for Delete access.
(Inherited from PFBaseObject.)
Protected propertyPermissionSetReadId
Id of the permission set for Read access.
(Inherited from PFBaseObject.)
Protected propertyPermissionSetReadXml
XML of serialized permission set for Read access.
(Inherited from PFBaseObject.)
Protected propertyPermissionSetUpdateId
Id of the permission set for Update access.
(Inherited from PFBaseObject.)
Protected propertyPermissionSetUpdateXml
XML of serialized permission set for Update access.
(Inherited from PFBaseObject.)
Public propertyPrintUrl
Gets the relative url of the print form of this item.
(Inherited from PFItem.)
Public propertyReference
Gets or sets the formatted text used to represent this item.
(Inherited from PFItem.)
Public propertyRemindersCount
Gets the number of time this task has been reminded to the owner by the PFTaskReminderJob.
Public propertyShortCaption
Gets the short display text representing this item.
(Inherited from PFItem.)
Public propertySite
Gets the root of the persisted objects tree.
(Inherited from PFBaseObject.)
Public propertyStartDate
Gets the start date.
Public propertyState
Gets the last persisted display name of the current state. Uses Workflow_ModelState to access the modeling object.
(Inherited from PFItem.)
Public propertyState_Translated
Gets the display name of the current state, translation based on current user effective language.
(Inherited from PFItem.)
Public propertyStateId
Gets the current state in the workflow, corresponding to the modeling State id.
(Inherited from PFItem.)
Public propertyStateInstanceId
Gets the instance of state in the workflow. This will change every time this item's state changes, even if the state is the same.
(Inherited from PFItem.)
Public propertyStatus
Gets or sets the status of the last taken transition in the workflow.
(Inherited from PFItem.)
Public propertySubscriptions
Gets a relation allowing to access all subscriptions.
(Inherited from PFItem.)
Public propertyTaskActive
Gets a value indicating whether the task has not been completed or cancelled yet.
Public propertyTaskStatus
Change status of this task.

Task is enacted (and saved) if the change of status is authorized by standard Task workflow.

If changed to "Finished", workflow outbound transition is set and parent workflow item is enacted too.

This does not mean that workflow item will move, BUT workflow item will be saved anyway.

Public propertyTitle
Gets or sets the title.
Public propertyUpdatedAt
Gets the date of the last update of this object.
(Inherited from PFBaseObject.)
Public propertyUpdatedBy
Gets the user who last updated this object in the database.
(Inherited from PFBaseObject.)
Public propertyUrl
Gets the relative url of the form of this item.
(Inherited from PFItem.)
Public propertyUserUpdatedAt
Gets the date of the last update (ignoring system updates) of this object.
(Inherited from PFItem.)
Public propertyUserUpdatedBy
Gets the user who last updated this object in the database (ignoring system updates).
(Inherited from PFItem.)
Public propertyVersionNumber
Gets the version number of this object in database. Incremented after each save.
(Inherited from PFBaseObject.)
Public propertyWorkflow_CurrentUserTask
Gets the current user task in the current state instance, if found.
(Inherited from PFItem.)
Public propertyWorkflow_InstanceTasks
Gets the task of the current state instance.
(Inherited from PFItem.)
Public propertyWorkflow_ModelState
Gets the current workflow state.
(Inherited from PFItem.)
Public propertyWorkflow_ModelStep
Gets the current workflow step.
(Inherited from PFItem.)
Public propertyWorkflow_Tasks
Gets all tasks attached to the workflow of this item.
(Inherited from PFItem.)
Public propertyWorkflowContentTypeGuid
Gets the content-type guid of the workflow item (using this task).
Public propertyWorkflowContentTypeId
Gets the content-type id of the workflow item (using this task).
Public propertyWorkflowItem
Gets the parent workflow item.
Public propertyWorkflowItemGuid
Gets the guid of the workflow item (using this task).
Public propertyWorkflowItemId
Gets the id of the workflow item (using this task).
Public propertyWorkflowOutboundTransition
Gets the last persisted display name of the chosen transition.
Public propertyWorkflowOutboundTransitionId
Gets the transition id of the chosen transition.
Public propertyWorkflowReference
Gets the reference of the workflow item (using this task).
Public propertyWorkflowState
Gets the last persisted display name of the parent workflow state.
Public propertyWorkflowStateId
Gets the current state of the parent workflow.
Public propertyWorkflowStateInstanceId
Gets the instance of state of the parent workflow.
Top
Methods
  NameDescription
Public methodAddItemRelation(Guid, PFItem)
Adds an item relation from this item to another.
(Inherited from PFItem.)
Public methodAddItemRelation(Guid, PFItemReference)
Adds an item relation from this item to another.
(Inherited from PFItem.)
Public methodAddItemRelation(String, PFItem)
Adds an item relation from this item to another.
(Inherited from PFItem.)
Public methodAddItemRelation(String, PFItemReference)
Adds an item relation from this item to another.
(Inherited from PFItem.)
Public methodAddItemRelation(ContentRelation, PFItem)
Adds an item relation from this item to another.
(Inherited from PFItem.)
Public methodAddItemRelation(ContentRelation, PFItemReference)
Adds an item relation from this item to another.
(Inherited from PFItem.)
Public methodAddItemRelation(String, Guid, PFItem)
Adds an item relation from this item to another.
(Inherited from PFItem.)
Public methodAddItemRelation(String, Guid, PFItemReference)
Adds an item relation from this item to another.
(Inherited from PFItem.)
Public methodAddItemRelation(String, String, PFItem)
Adds an item relation from this item to another.
(Inherited from PFItem.)
Public methodAddItemRelation(String, String, PFItemReference)
Adds an item relation from this item to another.
(Inherited from PFItem.)
Public methodAttachFile(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.)
Public methodAttachFile(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.)
Public methodAttachPdfFile(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.)
Public methodAttachPdfFile(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.)
Public methodBaseSave
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.)
Public methodCanFieldBeModifiedByUser(String)
Checks if a field control mode is editable in the current context.
(Inherited from PFItem.)
Public methodCanFieldBeModifiedByUser(PFField)
Checks if a field control mode is editable in the current context.
(Inherited from PFItem.)
Public methodChangeApplicationContext
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.)
Public methodChangeTaskDecision
Changes the chosen decision of a task.
Public methodCustomizeDefaultFileNameByTemplate
Allows to customize default file names proposed to users for each template.
(Inherited from PFItem.)
Public methodDelete
Flags this object as deleted.

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.

(Inherited from PFBaseObject.)
Public methodExternalConnection_Get
Gets the external connection having synchronized this item.
(Inherited from PFItem.)
Public methodExternalConnection_GetExternalData
Externals the connection_ get external data.
(Inherited from PFItem.)
Public methodExternalConnection_Synchronize
Synchronizes this item's data properties with its external content.

Note: this does NOT save the item.

(Inherited from PFItem.)
Public methodExternalConnection_SynchronizeAndSave
Synchronizes this item's data properties with its external content, then saves the item if the synchronization changed any value.
(Inherited from PFItem.)
Public methodExternalConnection_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.)
Public methodGenerateHtmlMessage(Int32, String)
Generates a html message (subject and body) from a modeling message.
(Inherited from PFItem.)
Public methodGenerateHtmlMessage(String, String)
Generates a html message (subject and body) from a modeling message.
(Inherited from PFItem.)
Public methodGenerateHtmlMessage(ContentMessage, String)
Generates a html message (subject and body) from a modeling message.
(Inherited from PFItem.)
Protected methodGenerateReference

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.

(Inherited from PFItem.)
Protected methodGenerateTaskTitle

Used to initialize a task title in the current workflow state.

Default : "{Reference} : {State}"

(Inherited from PFItem.)
Public methodGenerateTextMessage(Int32, String)
Generates a html message (subject and body) from a modeling message.
(Inherited from PFItem.)
Public methodGenerateTextMessage(String, String)
Generates a html message (subject and body) from a modeling message.
(Inherited from PFItem.)
Public methodGenerateTextMessage(ContentMessage, String)
Generates a html message (subject and body) from a modeling message.
(Inherited from PFItem.)
Public methodGetConversationTitle
Defines the title of this item conversation for the specified user. Returns this item caption by default.
(Inherited from PFItem.)
Public methodGetFieldControlMode(String)
Gets the control mode of a field in the current context.
(Inherited from PFItem.)
Public methodGetFieldControlMode(PFField)
Gets the control mode of a field in the current context.
(Inherited from PFItem.)
Public methodGetFieldDisplayValue(String)
Gets display text (not html) of a field in this item.
(Inherited from PFItem.)
Public methodGetFieldDisplayValue(PFField)
Gets display text (not html) of a field in this item.
(Inherited from PFItem.)
Public methodGetGuid
Returns a Global Unique Identifier for the target.
(Inherited from PFItem.)
Public methodGetId
Returns an id representing the target.
(Inherited from PFItem.)
Public methodGetItemLocks
Gets current locks.

Note : will return an empty list if the object is not yet created.

(Inherited from PFItem.)
Public methodGetLocks
Gets current locks.
(Inherited from PFItem.)
Public methodGetMessagePlaceHolderHtml
Gets the html of a message placeholder (in a ContentMessage) in the specified language.
(Inherited from PFItem.)
Public methodGetMessagePlaceHolderText
Gets the text of a message placeholder (in a ContentMessage) in the specified language.
(Inherited from PFItem.)
Protected methodGetNewPermissionContext
Creates a new permission context based on current object type.
(Inherited from PFItem.)
Public methodGetObjectRelationByName
Gets a children entities relation by its name.
(Inherited from PFRelationalObject.)
Public methodGetParts
Gets items whose current item is the owner item.
(Inherited from PFItem.)
Public methodGetPartsAndTasksRecursively
Gets items whose current item is the owner item and recursively. Will also return tasks of each returned item.
(Inherited from PFItem.)
Public methodGetPartsRecursively
Gets items whose current item is the owner item and recursively.
(Inherited from PFItem.)
Public methodGetRelatedItems(Guid, PFQuery, PFItemRelationDirection, Boolean)
Gets items linked inside a relation.
(Inherited from PFItem.)
Public methodGetRelatedItems(String, PFQuery, PFItemRelationDirection, Boolean)
Gets items linked inside a relation.
(Inherited from PFItem.)
Public methodGetRelatedItems(String, Guid, PFQuery, PFItemRelationDirection, Boolean)
Gets items linked inside a relation.
(Inherited from PFItem.)
Public methodGetRelatedItems(String, String, PFQuery, PFItemRelationDirection, Boolean)
Gets items linked inside a relation.
(Inherited from PFItem.)
Public methodGetRelatedItems(ContentRelation, PFQuery, PFContentType, PFItemRelationDirection, Boolean)
Gets items linked inside a relation.
(Inherited from PFItem.)
Public methodGetRelatedItemsByGroup(Guid, PFQuery, PFItemRelationDirection)
Gets aggregated items linked inside a relation.
(Inherited from PFItem.)
Public methodGetRelatedItemsByGroup(String, PFQuery, PFItemRelationDirection)
Gets aggregated items linked inside a relation.
(Inherited from PFItem.)
Public methodGetRelatedItemsByGroup(String, Guid, PFQuery, PFItemRelationDirection)
Gets aggregated items linked inside a relation.
(Inherited from PFItem.)
Public methodGetRelatedItemsByGroup(String, String, PFQuery, PFItemRelationDirection)
Gets aggregated items linked inside a relation.
(Inherited from PFItem.)
Public methodGetRelatedItemsByGroup(ContentRelation, PFQuery, PFContentType, PFItemRelationDirection)
Gets aggregated items linked inside a relation.
(Inherited from PFItem.)
Public methodGetShownEventTagsInMessaging
Returns the values of Tag that should be included when displaying the messaging UI for this PFItem instance.
(Inherited from PFItem.)
Protected methodGetTasksDueDate
Computes the due date using modeling settings on current state and taken transition.
(Inherited from PFItem.)
Protected methodHasPendingModificationsOnSynchronizedColumns
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.)
Public methodInheritFromOwnerItemApplicationContext
Gets the corresponding application context from the owner item and set in this item.
(Inherited from PFItem.)
Protected methodInitializeLogger
Use this method to override the way the logger is initialized.
(Inherited from PFBaseObject.)
Public methodIsFieldRequired

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.

(Inherited from PFItem.)
Public methodIsUserOwner
Checks if a user has the owner privilege on this item.
(Inherited from PFItem.)
Protected methodIsVisibleToEveryone
Override this method if you want to force-open this item's visibility to everyone.
(Inherited from PFItem.)
Public methodOnAfterCreateNotification
Raises the [E:BeforeSendingNotification] event.
(Inherited from PFItem.)
Public methodOnBeforeCreateNotification
Raises the [E:BeforeSendingNotification] event.
(Inherited from PFItem.)
Public methodOnFileBinding
Raises the [E:FileOpened] event.
(Inherited from PFItem.)
Public methodOnFileDownloaded
Raises the [E:FileDownloaded] event.
(Inherited from PFItem.)
Public methodOnFileDownloading
Raises the [E:FileDownloading] event.
(Inherited from PFItem.)
Protected methodOnInitialized
Raises the [E:Initialized] event.
(Inherited from PFItem.)
Public methodPreInitOwnerItem
Initializes owner item before creation.

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.

(Inherited from PFItem.)
Protected methodProcessPermissions
Compute permissions from permission context and set in data properties.
(Inherited from PFBaseObject.)
Public methodReleaseLock
Releases the lock of a given user, if found.
(Inherited from PFItem.)
Public methodRemoveItemRelation(Guid, PFItem)
Removes an item relation between this item and another.
(Inherited from PFItem.)
Public methodRemoveItemRelation(Guid, PFItemReference)
Removes an item relation between this item and another.
(Inherited from PFItem.)
Public methodRemoveItemRelation(String, PFItem)
Removes an item relation between this item and another.
(Inherited from PFItem.)
Public methodRemoveItemRelation(String, PFItemReference)
Removes an item relation between this item and another.
(Inherited from PFItem.)
Public methodRemoveItemRelation(ContentRelation, PFItem)
Removes an item relation between this item and another.
(Inherited from PFItem.)
Public methodRemoveItemRelation(ContentRelation, PFItemReference)
Removes an item relation between this item and another.
(Inherited from PFItem.)
Public methodRemoveItemRelation(String, Guid, PFItem)
Removes an item relation between this item and another.
(Inherited from PFItem.)
Public methodRemoveItemRelation(String, Guid, PFItemReference)
Removes an item relation between this item and another.
(Inherited from PFItem.)
Public methodRemoveItemRelation(String, String, PFItem)
Removes an item relation between this item and another.
(Inherited from PFItem.)
Public methodRemoveItemRelation(String, String, PFItemReference)
Removes an item relation between this item and another.
(Inherited from PFItem.)
Public methodResetOwnerItemCache
Resets owner item cache, for example if the owner item could have changed.
(Inherited from PFItem.)
Public methodRunInTransactionArea
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.)
Public methodSave
Applies the data of this object in the database.
(Overrides PFItemSave.)
Public methodSaveAsPartOf(String, PFItem, Boolean, Boolean)
Saves this item and directly link it to an owner item through a relation.
(Inherited from PFItem.)
Public methodSaveAsPartOf(ContentRelation, PFItem, Boolean, Boolean)
Saves this item and directly link it to an owner item through a relation.
(Inherited from PFItem.)
Protected methodSaveObjectsInDataCollection
Saves data loaded from temp specialized object in data properties collection before save or check hasPendingChanges.
(Inherited from PFItem.)
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Public methodTriggerNotification(String, ListPFUser)
Triggers a notification based on a name.
(Inherited from PFItem.)
Public methodTriggerNotification(PFNotificationTriggerType, ListPFUser)
Triggers a notification type for this item.

IMPORTANT : This method does not support TaskAssigned as a trigger type, use TaskAssignedOnly or TaskReassignedOnly instead.

(Inherited from PFItem.)
Public methodTryGetLock
Tries to get a lock for a given user.
(Inherited from PFItem.)
Public methodTryToGetVersionEditedByUser
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

This method tries to get this item's version, if it exists.

(Inherited from PFItem.)
Public methodUpdateVersionEditedByUser
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

This method updates that version to the current metadata, it upgrades it.

(Inherited from PFItem.)
Public methodUserHasPrivilege
Checks if a user has a given privilege on this item.
(Inherited from PFItem.)
Public methodValidateRequiredFields
Checks if all required fields are currently filled.

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.

(Inherited from PFItem.)
Public methodWorkflow_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).
(Inherited from PFItem.)
Public methodWorkflow_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).
(Inherited from PFItem.)
Public methodWorkflow_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).
(Inherited from PFItem.)
Public methodWorkflow_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).
(Inherited from PFItem.)
Public methodWorkflow_EnsureTasks
Cancels tasks of previous state instances and ensure tasks for current state instance.
(Inherited from PFItem.)
Public methodWorkflow_GetCurrentTaskForUser
Gets the task of a given user in the current state instance, if found.

If multiple instance tasks are available for the user, active task (if any) is returned first.

(Inherited from PFItem.)
Public methodWorkflow_GetRequiredFieldsForTransition
Gets the required fields for a given transition.
(Inherited from PFItem.)
Public methodWorkflow_ReassignTask
Reassigns a specific task of this workflow to another user.
(Inherited from PFItem.)
Protected methodWorkflow_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.)
Top
Events
  NameDescription
Public eventAfterCreate
Occurs after an item has been created in database.
(Inherited from PFItem.)
Public eventAfterCreateFile
Occurs after a file has been created on this item.
(Inherited from PFItem.)
Public eventAfterCreateNotification
Occurs after a user notification whose related object is this item was created.
(Inherited from PFItem.)
Public eventAfterDelete
Occurs after an item has been deleted.
(Inherited from PFItem.)
Public eventAfterDeleteFile
Occurs after a file of this item has been deleted.
(Inherited from PFItem.)
Public eventAfterSave
Occurs when an item has been updated or created in database.
(Inherited from PFItem.)
Public eventAfterUpdate
Occurs after an item has been updated in database.
(Inherited from PFItem.)
Public eventAfterUpdateFile
Occurs after a file of this item has been updated.
(Inherited from PFItem.)
Public eventBeforeCreate
Occurs when an item is being persisted for the first time in database.
(Inherited from PFItem.)
Public eventBeforeCreateFile
Occurs when a file is being created on this item.
(Inherited from PFItem.)
Public eventBeforeCreateNotification
Occurs before a user notification whose related object is this item is created.
(Inherited from PFItem.)
Public eventBeforeDelete
Occurs when an item is being deleted.
(Inherited from PFItem.)
Public eventBeforeDeleteFile
Occurs when a file of this item is being deleted.
(Inherited from PFItem.)
Public eventBeforeSave
Occurs when an item is being updated or created in database.
(Inherited from PFItem.)
Public eventBeforeSendingNotification
Occurs before a modeled notification is sent.
(Inherited from PFItem.)
Public eventBeforeUpdate
Occurs when an item is being updated in database.
(Inherited from PFItem.)
Public eventBeforeUpdateFile
Occurs when a file of this item is being updated.
(Inherited from PFItem.)
Public eventCommentAdded
Occurs after a PFItemComment has been added on the item.
(Inherited from PFItem.)
Public eventEventAdded
Occurs after a PFItemEvent has been added on the item.
(Inherited from PFItem.)
Public eventFileBinding
Occurs when a file of this item is about to be bound via WordForm or Quickparts.
(Inherited from PFItem.)
Public eventFileConfirmed
Occurs when a file has been confirmed on this item. A file is confirmed when, after its upload, the parent item is saved with a reference to the file in the FileHolder value.
(Inherited from PFItem.)
Public eventFileDownloaded
Occurs when a file of this item has been downloaded. Engine triggers this event on an async task. Do not use non-thread safe objects. (Packflow types inheriting PFBaseObject are thread-safe in this case) Codes triggering this event does not depend on HttpContext or other web context object. When triggered, there is no warranty the download is finished or succeeded.
(Inherited from PFItem.)
Public eventFileDownloading
Occurs when a file of this item has been downloaded.
(Inherited from PFItem.)
Public eventFileOpened
Occurs when a file of this item has been opened for modification (Office or KeePass application).
(Inherited from PFItem.)
Public eventStateChanged
Occurs after the call to Save() during enactment when the SQL transaction made to move the workflow is committed.
(Inherited from PFItem.)
Public eventStateChanging
Occurs when the state has been changed in this item instance, but the save has not been called yet.
(Inherited from PFItem.)
Public eventStatusUpdated
Occurs when the task status has been updated.
Public eventStatusUpdating
Occurs when the task status is being updated.
Top
Fields
  NameDescription
Public fieldStatic memberFieldName_ActorType
Column name in database.
Public fieldStatic memberFieldName_AssignedTo
Column name in database.
Public fieldStatic memberFieldName_DateLastReminder
Column name in database.
Public fieldStatic memberFieldName_DueDate
Column name in database.
Public fieldStatic memberFieldName_DueStartDate
Column name in database.
Public fieldStatic memberFieldName_EndDate
Column name in database.
Public fieldStatic memberFieldName_RemindersCount
Column name in database.
Public fieldStatic memberFieldName_StartDate
Column name in database.
Public fieldStatic memberFieldName_Title
Column name in database.
Public fieldStatic memberFieldName_WorkflowContentTypeGuid
Column name in database.
Public fieldStatic memberFieldName_WorkflowContentTypeId
Column name in database.
Public fieldStatic memberFieldName_WorkflowItemId
Column name in database.
Public fieldStatic memberFieldName_WorkflowOutboundTransition
Column name in database.
Public fieldStatic memberFieldName_WorkflowOutboundTransitionId
Column name in database.
Public fieldStatic memberFieldName_WorkflowReference
Column name in database.
Public fieldStatic memberFieldName_WorkflowState
Column name in database.
Public fieldStatic memberFieldName_WorkflowStateId
Column name in database.
Public fieldStatic memberFieldName_WorkflowStateInstanceId
Column name in database.
Top
Extension Methods
  NameDescription
Public Extension MethodAsT
Casts an object to another type. Returns default(T) if the object is null.
(Defined by Utils_Other.)
Public Extension MethodEqualsAll
Checks that this object is equal to every object in parameters.
(Defined by Utils_Other.)
Public Extension MethodEqualsAny
Checks that this object is equal to at least one of the parameters.
(Defined by Utils_Other.)
Public Extension MethodGetReferenceOverloaded.
Gets a object referencing the item.
(Defined by PFItemExtensions.)
Public Extension MethodGetReference(String)Overloaded.
Gets a object referencing the item. The Text of the reference will be the value of the specified field.
(Defined by PFItemExtensions.)
Public Extension MethodGetString
Converts an object to String using ToString() method, else returns String.Empty.
(Defined by Utils_Other.)
Public Extension MethodIsGenericListOverloaded.
Checks if this object is a System.Collections.Generic.List.
(Defined by Utils_Linq.)
Public Extension MethodIsGenericList(Type)Overloaded.
Checks if this object is a System.Collections.Generic.List using type as T.
(Defined by Utils_Linq.)
Public Extension MethodSerializeOverloaded.
Serializes an object into an XML document.
(Defined by Utils_Xml.)
Public Extension MethodSerialize(String)Overloaded.
Serializes an object into an XML document.
(Defined by Utils_Xml.)
Public Extension MethodSerializeJsonOverloaded.
Serializes an object using a DataContractJsonSerializer.
(Defined by Utils_String.)
Public Extension MethodSerializeJson(ListType)Overloaded.
Serializes an object using a DataContractJsonSerializer.
(Defined by Utils_String.)
Public Extension MethodSerializeJson(DataContractJsonSerializerSettings)Overloaded.
Serializes an object using a DataContractJsonSerializer.
(Defined by Utils_String.)
Top
See Also