AlfrescoWorkflowService Class Reference
Inherits from | NSObject |
Declared in | AlfrescoWorkflowService.h |
Tasks
Initialisation methods
-
– initWithSession:
Initialises with a public or old API implementation
Retrieval methods for the Alfresco Workflow Service
-
– retrieveProcessDefinitionsWithCompletionBlock:
Retrieves a list of all process definitions.
-
– retrieveProcessDefinitionsWithListingContext:completionBlock:
Retrieves a paged result of all process definitions in accordance to a listing context.
-
– retrieveProcessDefinitionWithIdentifier:completionBlock:
Retrieves a process definition for a specific process identifier.
-
– retrieveProcessDefinitionWithKey:completionBlock:
Retrieves a process definition for a specific process identifier.
-
– retrieveProcessesWithCompletionBlock:
Retrieves a list of all processes.
-
– retrieveProcessesWithListingContext:completionBlock:
Retrieves a paged result of processes in accordance to a listing context. The listing filter mechanism on listing context can be used to filter the processes.
-
– retrieveProcessWithIdentifier:completionBlock:
Retrieves a process for a given process identifier.
-
– retrieveImageForProcess:completionBlock:
Retrieves an image of the given process. An image is only returned if the user has started the process or is involved in any of the tasks.
-
– retrieveImageForProcess:outputStream:completionBlock:
Retrieves an image of the provided process written to a given outputstream. An image is only returned if the user has started the process or is involved in any of the tasks.
-
– retrieveTasksForProcess:completionBlock:
Retrieves an array of all tasks for the given process that the user is able to see. Tasks are returned if created by the user, or if the user is involved in the task.
-
– retrieveTasksForProcess:listingContext:completionBlock:
Retrieves paged results of all tasks for the given process that the user is able to see. The listing filter mechanism on listing context can be used to filter the tasks. Tasks are returned if created by the user, or if the user is involved in the task.
-
– retrieveAttachmentsForProcess:completionBlock:
Retrieves an array of AlfrescoNode’s for a specific process. If there are no attachments, nil is returned in the completion block.
-
– retrieveTasksWithCompletionBlock:
Retrieves a list of all tasks the authenticated user is allowed to see.
-
– retrieveTasksWithListingContext:completionBlock:
Retrieves a paged result of the tasks the authenticated user is allowed to see. The listing filter mechanism on listing context can be used to filter the tasks.
-
– retrieveTaskWithIdentifier:completionBlock:
Retrieves the task for a specific task identifier.
-
– retrieveAttachmentsForTask:completionBlock:
Retrieves an array of AlfrescoNode’s for a specific task. If there are no attachments, nil is returned in the completion block.
Process management methods for the Alfresco Workflow Service
-
– startProcessForProcessDefinition:assignees:variables:attachments:completionBlock:
Creates and returns a process for a given process definition.
-
– startProcessForProcessDefinition:name:priority:dueDate:sendEmailNotification:assignees:variables:attachments:completionBlock:
A convenience method that creates and returns a process for a given process definition. This method takes an number of predefined variables.
-
– deleteProcess:completionBlock:
Deletes a process.
Task management methods for the Alfresco Workflow Service
-
– completeTask:variables:completionBlock:
Completes a given task.
-
– claimTask:completionBlock:
Claims the task for the authenticated user.
-
– unclaimTask:completionBlock:
Unclaims a task and sets the assignee to “Unassigned”.
-
– reassignTask:toAssignee:completionBlock:
Reassigns the given task to an assignee.
-
– resolveTask:completionBlock:
Resolves the given task and assigns it back to the owner.
-
– addAttachmentToTask:attachment:completionBlock:
Adds a single attachment to a given task.
-
– addAttachmentsToTask:attachments:completionBlock:
Adds an array of attachments to a given task.
-
– removeAttachmentFromTask:attachment:completionBlock:
Removes an attachment from a specific task.
Instance Methods
addAttachmentToTask:attachment:completionBlock:
Adds a single attachment to a given task.
- (AlfrescoRequest *)addAttachmentToTask:(AlfrescoWorkflowTask *)task attachment:(AlfrescoDocument *)document completionBlock:(AlfrescoBOOLCompletionBlock)completionBlock
Parameters
- task
The task which the node should be attached
- document
The document that should be added to the task
- completionBlock
The block that’s called with the operation completes
Discussion
Adds a single attachment to a given task.
Declared In
AlfrescoWorkflowService.h
addAttachmentsToTask:attachments:completionBlock:
Adds an array of attachments to a given task.
- (AlfrescoRequest *)addAttachmentsToTask:(AlfrescoWorkflowTask *)task attachments:(NSArray *)documentArray completionBlock:(AlfrescoBOOLCompletionBlock)completionBlock
Parameters
- task
The task to which the nodes should be attached
- documentArray
An array of AlfrescoDocuments’s that should be added to the task
- completionBlock
The block that’s called with the operation completes
Discussion
Adds an array of attachments to a given task.
Declared In
AlfrescoWorkflowService.h
claimTask:completionBlock:
Claims the task for the authenticated user.
- (AlfrescoRequest *)claimTask:(AlfrescoWorkflowTask *)task completionBlock:(AlfrescoTaskCompletionBlock)completionBlock
Parameters
- task
The task to be claimed by the authenticated user
- completionBlock
The block that’s called with the operation completes
Discussion
Claims the task for the authenticated user.
Declared In
AlfrescoWorkflowService.h
completeTask:variables:completionBlock:
Completes a given task.
- (AlfrescoRequest *)completeTask:(AlfrescoWorkflowTask *)task variables:(NSDictionary *)variables completionBlock:(AlfrescoTaskCompletionBlock)completionBlock
Parameters
- task
The task that should be marked as complete
- variables
Any variables to add to the task
- completionBlock
The block that’s called with the operation completes
Discussion
Completes a given task.
Declared In
AlfrescoWorkflowService.h
deleteProcess:completionBlock:
Deletes a process.
- (AlfrescoRequest *)deleteProcess:(AlfrescoWorkflowProcess *)process completionBlock:(AlfrescoBOOLCompletionBlock)completionBlock
Parameters
- process
The process to delete
- completionBlock
The block that’s called with the operation completes
Discussion
Deletes a process.
Declared In
AlfrescoWorkflowService.h
initWithSession:
Initialises with a public or old API implementation
- (id)initWithSession:(id<AlfrescoSession>)session
Parameters
- session
the AlfrescoSession to initialise the site service with
Discussion
Initialises with a public or old API implementation
Declared In
AlfrescoWorkflowService.h
reassignTask:toAssignee:completionBlock:
Reassigns the given task to an assignee.
- (AlfrescoRequest *)reassignTask:(AlfrescoWorkflowTask *)task toAssignee:(AlfrescoPerson *)assignee completionBlock:(AlfrescoTaskCompletionBlock)completionBlock
Parameters
- task
The task to be reassigned
- assignee
To whom the task should be assigned
- completionBlock
The block that’s called with the operation completes
Discussion
Reassigns the given task to an assignee.
Declared In
AlfrescoWorkflowService.h
removeAttachmentFromTask:attachment:completionBlock:
Removes an attachment from a specific task.
- (AlfrescoRequest *)removeAttachmentFromTask:(AlfrescoWorkflowTask *)task attachment:(AlfrescoDocument *)document completionBlock:(AlfrescoBOOLCompletionBlock)completionBlock
Parameters
- task
The task from which the node should be removed
- document
The document that should be removed from the task
- completionBlock
The block that’s called with the operation completes
Discussion
Removes an attachment from a specific task.
Declared In
AlfrescoWorkflowService.h
resolveTask:completionBlock:
Resolves the given task and assigns it back to the owner.
- (AlfrescoRequest *)resolveTask:(AlfrescoWorkflowTask *)task completionBlock:(AlfrescoTaskCompletionBlock)completionBlock
Parameters
- task
The task which should be resolved
- completionBlock
The block that’s called with the operation completes
Discussion
Resolves the given task and assigns it back to the owner.
Declared In
AlfrescoWorkflowService.h
retrieveAttachmentsForProcess:completionBlock:
Retrieves an array of AlfrescoNode’s for a specific process. If there are no attachments, nil is returned in the completion block.
- (AlfrescoRequest *)retrieveAttachmentsForProcess:(AlfrescoWorkflowProcess *)process completionBlock:(AlfrescoArrayCompletionBlock)completionBlock
Parameters
- process
The process for which attachment(s) should be retrieved
- completionBlock
The block that’s called with the operation completes
Discussion
Retrieves an array of AlfrescoNode’s for a specific process. If there are no attachments, nil is returned in the completion block.
Declared In
AlfrescoWorkflowService.h
retrieveAttachmentsForTask:completionBlock:
Retrieves an array of AlfrescoNode’s for a specific task. If there are no attachments, nil is returned in the completion block.
- (AlfrescoRequest *)retrieveAttachmentsForTask:(AlfrescoWorkflowTask *)task completionBlock:(AlfrescoArrayCompletionBlock)completionBlock
Parameters
- task
The task for which attachments should be retrieved
- completionBlock
The block that’s called with the operation completes
Discussion
Retrieves an array of AlfrescoNode’s for a specific task. If there are no attachments, nil is returned in the completion block.
Declared In
AlfrescoWorkflowService.h
retrieveImageForProcess:completionBlock:
Retrieves an image of the given process. An image is only returned if the user has started the process or is involved in any of the tasks.
- (AlfrescoRequest *)retrieveImageForProcess:(AlfrescoWorkflowProcess *)process completionBlock:(AlfrescoContentFileCompletionBlock)completionBlock
Parameters
- process
The process for which an image should be retrieved
- completionBlock
The block that’s called with the operation completes
Discussion
Retrieves an image of the given process. An image is only returned if the user has started the process or is involved in any of the tasks.
Declared In
AlfrescoWorkflowService.h
retrieveImageForProcess:outputStream:completionBlock:
Retrieves an image of the provided process written to a given outputstream. An image is only returned if the user has started the process or is involved in any of the tasks.
- (AlfrescoRequest *)retrieveImageForProcess:(AlfrescoWorkflowProcess *)process outputStream:(NSOutputStream *)outputStream completionBlock:(AlfrescoBOOLCompletionBlock)completionBlock
Parameters
- process
The process for which an image should be retrieved
- outputStream
The stream to which the image will be written
- completionBlock
The block that’s called with the operation completes
Discussion
Retrieves an image of the provided process written to a given outputstream. An image is only returned if the user has started the process or is involved in any of the tasks.
Declared In
AlfrescoWorkflowService.h
retrieveProcessDefinitionWithIdentifier:completionBlock:
Retrieves a process definition for a specific process identifier.
- (AlfrescoRequest *)retrieveProcessDefinitionWithIdentifier:(NSString *)processDefinitionId completionBlock:(AlfrescoProcessDefinitionCompletionBlock)completionBlock
Parameters
- processDefinitionId
The process definition identifier for the process definition to be retrieved
- completionBlock
The block that’s called with the operation completes
Discussion
Retrieves a process definition for a specific process identifier.
Declared In
AlfrescoWorkflowService.h
retrieveProcessDefinitionWithKey:completionBlock:
Retrieves a process definition for a specific process identifier.
- (AlfrescoRequest *)retrieveProcessDefinitionWithKey:(NSString *)key completionBlock:(AlfrescoProcessDefinitionCompletionBlock)completionBlock
Parameters
- key
The process definition key for the process definition to be retrieved
- completionBlock
The block that’s called with the operation completes
Discussion
Retrieves a process definition for a specific process identifier.
Declared In
AlfrescoWorkflowService.h
retrieveProcessDefinitionsWithCompletionBlock:
Retrieves a list of all process definitions.
- (AlfrescoRequest *)retrieveProcessDefinitionsWithCompletionBlock:(AlfrescoArrayCompletionBlock)completionBlock
Parameters
- completionBlock
The block that’s called with the operation completes
Discussion
Retrieves a list of all process definitions.
Declared In
AlfrescoWorkflowService.h
retrieveProcessDefinitionsWithListingContext:completionBlock:
Retrieves a paged result of all process definitions in accordance to a listing context.
- (AlfrescoRequest *)retrieveProcessDefinitionsWithListingContext:(AlfrescoListingContext *)listingContext completionBlock:(AlfrescoPagingResultCompletionBlock)completionBlock
Parameters
- listingContext
The listing context with a paging definition that’s used to retrieve process definitions
- completionBlock
The block that’s called with the operation completes
Discussion
Retrieves a paged result of all process definitions in accordance to a listing context.
Declared In
AlfrescoWorkflowService.h
retrieveProcessWithIdentifier:completionBlock:
Retrieves a process for a given process identifier.
- (AlfrescoRequest *)retrieveProcessWithIdentifier:(NSString *)processIdentifier completionBlock:(AlfrescoProcessCompletionBlock)completionBlock
Parameters
- completionBlock
The block that’s called with the operation completes
- processID
The process identifier of the process to retrieve
Discussion
Retrieves a process for a given process identifier.
Declared In
AlfrescoWorkflowService.h
retrieveProcessesWithCompletionBlock:
Retrieves a list of all processes.
- (AlfrescoRequest *)retrieveProcessesWithCompletionBlock:(AlfrescoArrayCompletionBlock)completionBlock
Parameters
- completionBlock
The block that’s called with the operation completes
Discussion
Retrieves a list of all processes.
Declared In
AlfrescoWorkflowService.h
retrieveProcessesWithListingContext:completionBlock:
Retrieves a paged result of processes in accordance to a listing context. The listing filter mechanism on listing context can be used to filter the processes.
- (AlfrescoRequest *)retrieveProcessesWithListingContext:(AlfrescoListingContext *)listingContext completionBlock:(AlfrescoPagingResultCompletionBlock)completionBlock
Parameters
- listingContext
The listing context with a paging definition that’s used to retrieve the processes
- completionBlock
The block that’s called with the operation completes
Discussion
Retrieves a paged result of processes in accordance to a listing context. The listing filter mechanism on listing context can be used to filter the processes.
Declared In
AlfrescoWorkflowService.h
retrieveTaskWithIdentifier:completionBlock:
Retrieves the task for a specific task identifier.
- (AlfrescoRequest *)retrieveTaskWithIdentifier:(NSString *)taskIdentifier completionBlock:(AlfrescoTaskCompletionBlock)completionBlock
Parameters
- taskIdentifier
The task identifier for the task to retrieve
- completionBlock
The block that’s called with the operation completes
Discussion
Retrieves the task for a specific task identifier.
Declared In
AlfrescoWorkflowService.h
retrieveTasksForProcess:completionBlock:
Retrieves an array of all tasks for the given process that the user is able to see. Tasks are returned if created by the user, or if the user is involved in the task.
- (AlfrescoRequest *)retrieveTasksForProcess:(AlfrescoWorkflowProcess *)process completionBlock:(AlfrescoArrayCompletionBlock)completionBlock
Parameters
- process
The process for which task(s) should be retrieved
- completionBlock
The block that’s called with the operation completes
Discussion
Retrieves an array of all tasks for the given process that the user is able to see. Tasks are returned if created by the user, or if the user is involved in the task.
Declared In
AlfrescoWorkflowService.h
retrieveTasksForProcess:listingContext:completionBlock:
Retrieves paged results of all tasks for the given process that the user is able to see. The listing filter mechanism on listing context can be used to filter the tasks. Tasks are returned if created by the user, or if the user is involved in the task.
- (AlfrescoRequest *)retrieveTasksForProcess:(AlfrescoWorkflowProcess *)process listingContext:(AlfrescoListingContext *)listingContext completionBlock:(AlfrescoPagingResultCompletionBlock)completionBlock
Parameters
- process
The process for which task(s) should be retrieved
- completionBlock
The block that’s called with the operation completes
Discussion
Retrieves paged results of all tasks for the given process that the user is able to see. The listing filter mechanism on listing context can be used to filter the tasks. Tasks are returned if created by the user, or if the user is involved in the task.
Declared In
AlfrescoWorkflowService.h
retrieveTasksWithCompletionBlock:
Retrieves a list of all tasks the authenticated user is allowed to see.
- (AlfrescoRequest *)retrieveTasksWithCompletionBlock:(AlfrescoArrayCompletionBlock)completionBlock
Parameters
- completionBlock
The block that’s called with the operation completes
Discussion
Retrieves a list of all tasks the authenticated user is allowed to see.
Declared In
AlfrescoWorkflowService.h
retrieveTasksWithListingContext:completionBlock:
Retrieves a paged result of the tasks the authenticated user is allowed to see. The listing filter mechanism on listing context can be used to filter the tasks.
- (AlfrescoRequest *)retrieveTasksWithListingContext:(AlfrescoListingContext *)listingContext completionBlock:(AlfrescoPagingResultCompletionBlock)completionBlock
Parameters
- listingContext
The listing context with a paging definition that’s used to retrieve the tasks
- completionBlock
The block that’s called with the operation completes
Discussion
Retrieves a paged result of the tasks the authenticated user is allowed to see. The listing filter mechanism on listing context can be used to filter the tasks.
Declared In
AlfrescoWorkflowService.h
startProcessForProcessDefinition:assignees:variables:attachments:completionBlock:
Creates and returns a process for a given process definition.
- (AlfrescoRequest *)startProcessForProcessDefinition:(AlfrescoWorkflowProcessDefinition *)processDefinition assignees:(NSArray *)assignees variables:(NSDictionary *)variables attachments:(NSArray *)attachmentNodes completionBlock:(AlfrescoProcessCompletionBlock)completionBlock
Parameters
- processDefinition
The process definition the process should be modeled on
- assignees
(optional) An array of AlfrescoPerson’s to assign to the task. If this is left blank, the process will be assigned to the creator
- variables
(optional) A dictionary of process variables to add at the start of the process. Variable keys must be the same as those defined in the workflow model definition in the repository
- completionBlock
The block that’s called with the operation completes
- attachments
(optional) An array of AlfrescoNode’s to add to the process
Discussion
Creates and returns a process for a given process definition.
Declared In
AlfrescoWorkflowService.h
startProcessForProcessDefinition:name:priority:dueDate:sendEmailNotification:assignees:variables:attachments:completionBlock:
A convenience method that creates and returns a process for a given process definition. This method takes an number of predefined variables.
- (AlfrescoRequest *)startProcessForProcessDefinition:(AlfrescoWorkflowProcessDefinition *)processDefinition name:(NSString *)name priority:(NSNumber *)priority dueDate:(NSDate *)dueDate sendEmailNotification:(NSNumber *)sendEmail assignees:(NSArray *)assignees variables:(NSDictionary *)variables attachments:(NSArray *)attachmentNodes completionBlock:(AlfrescoProcessCompletionBlock)completionBlock
Parameters
- processDefinition
The process definition the process should be modeled on
- name
(optional) A descripton of the process to be created
- priority
(optional) The priority level of the process to be created
- dueDate
(optional) The due date of the process to be created
- sendEmail
(optional) Whather email notifications should be sent
- assignees
(optional) An array of AlfrescoPerson’s to assign to the task. If this is left blank, the process will be assigned to the creator
- variables
(optional) A dictionary of process variables to add at the start of the process. Variable keys must be the same as those defined in the workflow model definition in the repository
- completionBlock
The block that’s called with the operation completes
- attachments
(optional) An array of AlfrescoNode’s to add to the process
Discussion
A convenience method that creates and returns a process for a given process definition. This method takes an number of predefined variables.
Declared In
AlfrescoWorkflowService.h
unclaimTask:completionBlock:
Unclaims a task and sets the assignee to “Unassigned”.
- (AlfrescoRequest *)unclaimTask:(AlfrescoWorkflowTask *)task completionBlock:(AlfrescoTaskCompletionBlock)completionBlock
Parameters
- task
The task the be unclaimed by the authenticated user
- completionBlock
The block that’s called with the operation completes
- properties
Any properties to add to the task before completion
Discussion
Unclaims a task and sets the assignee to “Unassigned”.
Declared In
AlfrescoWorkflowService.h