org.alfresco.mobile.android.api.services.impl.publicapi

Class PublicAPIWorkflowServiceImpl

java.lang.Object

org.alfresco.mobile.android.api.services.impl.AlfrescoService

org.alfresco.mobile.android.api.services.impl.AbstractWorkflowService

org.alfresco.mobile.android.api.services.impl.publicapi.PublicAPIWorkflowServiceImpl

All Implemented Interfaces:

android.os.Parcelable, Service, WorkflowService

Direct Known Subclasses:

CloudWorkflowServiceImpl

public class PublicAPIWorkflowServiceImpl
extends AbstractWorkflowService

Specific implementation of WorkflowService for Public API.

Since:

1.3

Author:

Jean Marie Pascal

Nested Class Summary

Nested classes/interfaces inherited from interface android.os.Parcelable

android.os.Parcelable.ClassLoaderCreator<T>, android.os.Parcelable.Creator<T>

Field Summary

Fields

Modifier and Type	Field and Description
static android.os.Parcelable.Creator<PublicAPIWorkflowServiceImpl>	CREATOR
static String	INCLUDE_VARIABLES Use for Public API to include extra variables in response.

Fields inherited from class org.alfresco.mobile.android.api.services.impl.AlfrescoService

CONTENT_CACHE, RENDITION_CACHE, session

Fields inherited from interface org.alfresco.mobile.android.api.services.WorkflowService

FILTER_ASSIGNEE_ALL, FILTER_ASSIGNEE_ME, FILTER_ASSIGNEE_UNASSIGNED, FILTER_DUE_7DAYS, FILTER_DUE_NODATE, FILTER_DUE_OVERDUE, FILTER_DUE_TODAY, FILTER_DUE_TOMORROW, FILTER_INITIATOR_ANY, FILTER_INITIATOR_ME, FILTER_KEY_ASSIGNEE, FILTER_KEY_DUE, FILTER_KEY_INITIATOR, FILTER_KEY_PRIORITY, FILTER_KEY_STATUS, FILTER_NO_ASSIGNEE, FILTER_PRIORITY_HIGH, FILTER_PRIORITY_LOW, FILTER_PRIORITY_MEDIUM, FILTER_STATUS_ACTIVE, FILTER_STATUS_ANY, FILTER_STATUS_COMPLETE

Fields inherited from interface android.os.Parcelable

CONTENTS_FILE_DESCRIPTOR, PARCELABLE_WRITE_RETURN_VALUE

Constructor Summary

Constructors

Constructor and Description
PublicAPIWorkflowServiceImpl(AlfrescoSession repositorySession)
PublicAPIWorkflowServiceImpl(android.os.Parcel o)

Method Summary

Methods

Modifier and Type	Method and Description
void	addDocuments(Task task, List<Document> items) Add a list of items to the the specified task.
Task	claimTask(Task task) Claiming a task is done by one of the candidates of a task, task owner or process-initiator
Task	completeTask(Task task, Map<String,Serializable> variables) Completing a task.
PagingResult<Document>	getDocuments(Process process, ListingContext listingContext)
PagingResult<Document>	getDocuments(Task task, ListingContext listingContext)
Process	getProcess(String processId) Retrieves a single process.
ProcessDefinition	getProcessDefinition(String processDefinitionIdentifier) Returns a single process definition.
PagingResult<ProcessDefinition>	getProcessDefinitions(ListingContext listingContext)
ContentStream	getProcessDiagram(Process process) This process diagram shows a user the context of the task that is being performed.
ContentStream	getProcessDiagram(String processId) This process diagram shows a user the context of the task that is being performed.
org.apache.chemistry.opencmis.commons.impl.UrlBuilder	getProcessDiagramUrl(String processId)
PagingResult<Process>	getProcesses(ListingContext listingContext) Returns a list of process.
protected org.apache.chemistry.opencmis.commons.impl.UrlBuilder	getProcessUrl(Process process) Internal method to retrieve a specific process url.
Task	getTask(String taskIdentifier) Retrieves a single task by its id.
PagingResult<Task>	getTasks(ListingContext listingContext) Returns a list of tasks that the authenticated user is allowed to see. This method support the use of ListingFilter inside the ListingContext parameter to get task that meet certain criteria like WorkflowService.FILTER_KEY_ASSIGNEE, WorkflowService.FILTER_KEY_STATUS , WorkflowService.FILTER_KEY_PRIORITY , WorkflowService.FILTER_KEY_DUE.
PagingResult<Task>	getTasks(Process process, ListingContext listingContext) Get the tasks for the specified process.
Map<String,Property>	getVariables(Process process) Retrieves the variables for a given process.
Map<String,Property>	getVariables(Task task) Retrieves the variables for a given task.
Task	reassignTask(Task task, Person assignee) Reassign the task from the owner to an assignee
Process	refresh(Process process) Returns the latest (and complete) variables for the provided process.
Task	refresh(Task task) Returns the latest (and complete) variables for the provided task.
void	removeDocuments(Task task, List<Document> items) Delete a list of items to the the task.
Process	startProcess(ProcessDefinition processDefinition, List<Person> assignees, Map<String,Serializable> variables, List<Document> items) Start a new process based on the specified process definition with an optional set of variables and document attachments(items). Variables keys must respect the same format as defined by the workflowModel inside the repository.
Task	unclaimTask(Task task) This removes the assignee of the task i.e the current user.
Task	updateVariable(Task task, String key, Serializable value)
Process	updateVariables(Process process, Map<String,Serializable> variables) Update the variables for a given process.
Task	updateVariables(Task task, Map<String,Serializable> variables) Update the variables for a given process.

Methods inherited from class org.alfresco.mobile.android.api.services.impl.AbstractWorkflowService

decodeKey, deleteProcess, encodeKey, getDocuments, getDocuments, getProcessDefinitionByKey, getProcessDefinitions, getProcesses, getTasks, getTasks

Methods inherited from class org.alfresco.mobile.android.api.services.impl.AlfrescoService

clear, convertException, convertNode, convertNode, convertStatusCode, delete, describeContents, getHttpInvoker, getSessionHttp, isCloudSession, isListNull, isMapNull, isObjectNull, isOnPremiseSession, isStringNull, post, put, read, saveContentStream, writeToParcel

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.alfresco.mobile.android.api.services.Service

clear

Methods inherited from interface android.os.Parcelable

describeContents, writeToParcel

Field Detail

INCLUDE_VARIABLES

public static final String INCLUDE_VARIABLES

Use for Public API to include extra variables in response.

See Also:

Constant Field Values

CREATOR

public static final android.os.Parcelable.Creator<PublicAPIWorkflowServiceImpl> CREATOR

Constructor Detail

PublicAPIWorkflowServiceImpl

public PublicAPIWorkflowServiceImpl(AlfrescoSession repositorySession)

PublicAPIWorkflowServiceImpl

public PublicAPIWorkflowServiceImpl(android.os.Parcel o)

Method Detail

getProcessDefinitions

public PagingResult<ProcessDefinition> getProcessDefinitions(ListingContext listingContext)

Parameters:

listingContext - : Listing context that define the behavior of paging results ListingContext

Returns:

Return a paged list of all the ProcessDefinition available inside the repository.

getProcessDefinition

public ProcessDefinition getProcessDefinition(String processDefinitionIdentifier)

Description copied from interface: WorkflowService

Returns a single process definition.

Parameters:

processDefinitionIdentifier - : unique identifier

Returns:

Returns a processDefinition object with the given identifier. If the processDefinitionIdentifier doesn’t match an existing one null is returned.

startProcess

public Process startProcess(ProcessDefinition processDefinition,
                   List<Person> assignees,
                   Map<String,Serializable> variables,
                   List<Document> items)

Start a new process based on the specified process definition with an optional set of variables and document attachments(items).
Variables keys must respect the same format as defined by the workflowModel inside the repository. For example Alfresco supplied BPM task model defines the property bpm:workflowPriority. To reference this property in your process definition you would specify the string bpm_workflowPriority. Note that the colon character is replaced by an underscore.

A collection of default Alfresco variables are available inside the WorkflowModel

 Starting an Adhoc Process
   // Process Definition Listing
    List<ProcessDefinition> definitions = workflowService.getProcessDefinitions();
    // Retrieve adhoc processDefinition
    ProcessDefinition def = null;
    for (ProcessDefinition processDefinition : definitions)
    {
        if (WorkflowModel.KEY_ADHOC_ACTIVITI.equals(processDefinition.getKey()))
        {
            def = processDefinition;
            break;
        }
    }
  
    // Start Process : Prepare Variables
    Map<String, Serializable> variables = new HashMap<String, Serializable>();
  
    // ASSIGNEE
    Person user = alfsession.getServiceRegistry().getPersonService().getPerson(alfsession.getPersonIdentifier());
    List<Person> users = new ArrayList<Person>();
    users.add(user);
  
    // DUE DATE
    GregorianCalendar calendar = new GregorianCalendar();
    calendar.set(Calendar.YEAR, 2000);
    variables.put(WorkflowModel.PROP_WORKFLOW_DUE_DATE, DateUtils.format(calendar));
  
    // PRIORITY
    variables.put(WorkflowModel.PROP_WORKFLOW_PRIORITY, priority);
  
    // DESCRIPTION
    variables.put(WorkflowModel.PROP_WORKFLOW_DESCRIPTION, description);
  
    // START THE PROCESS
    return workflowService.startProcess(def, users, variables, null);
 
   
 

Parameters:

processDefinition - (mandatory) : Represents the process definition to execute.

assignees - (optional) : List of person to assign. In case of "group based process", leave this parameter as null and add inside the variables map the correct key/value like bpm__groupAssignee. Warning : Majority of default alfresco workflow/process require an assignee.

variables - (optional) : Map of process variables to add at the start.

items - (optional) : List of document object.

Returns:

the started process object.

getProcessUrl

protected org.apache.chemistry.opencmis.commons.impl.UrlBuilder getProcessUrl(Process process)

Internal method to retrieve a specific process url. (depending on repository type)

Specified by:

getProcessUrl in class AbstractWorkflowService

Parameters:

process - : a process object

Returns:

UrlBuilder to retrieve for a specific process url.

getProcesses

public PagingResult<Process> getProcesses(ListingContext listingContext)

Returns a list of process.
Each process is an execution of a process definition.

Parameters:

listingContext - : Listing context that define the behavior of paging results ListingContext

Returns:

Return a paged list of processes available that meet certain criteria.

getProcess

public Process getProcess(String processId)

Retrieves a single process.

Parameters:

processId - : unique identifier of the process

Returns:

Returns a process object with the given identifier. If the processId doesn’t match an existing one null is returned.

getTasks

public PagingResult<Task> getTasks(Process process,
                          ListingContext listingContext)

Get the tasks for the specified process. This method support the use of ListingFilter inside the ListingContext parameter to get task that meet certain criteria like WorkflowService.FILTER_KEY_STATUS.

Parameters:

process - : process specified

listingContext - : defines the behavior of paging results ListingContext

Returns:

Return a paged list of tasks available associated to the process.

refresh

public Process refresh(Process process)

Description copied from interface: WorkflowService

Returns the latest (and complete) variables for the provided process.

Parameters:

process - : process to refresh

Returns:

the refreshed task with all available variables.

getDocuments

public PagingResult<Document> getDocuments(Task task,
                                  ListingContext listingContext)

listingContext - : defines the behavior of paging results ListingContext

Returns:

Return a paged list of documents attached to the specified task.

getDocuments

public PagingResult<Document> getDocuments(Process process,
                                  ListingContext listingContext)

listingContext - : defines the behavior of paging results ListingContext

Returns:

Return a paged list of documents attached to the specified process.

addDocuments

public void addDocuments(Task task,
                List<Document> items)

Add a list of items to the the specified task.

removeDocuments

public void removeDocuments(Task task,
                   List<Document> items)

Delete a list of items to the the task.

getTasks

public PagingResult<Task> getTasks(ListingContext listingContext)

Returns a list of tasks that the authenticated user is allowed to see.
This method support the use of ListingFilter inside the ListingContext parameter to get task that meet certain criteria like WorkflowService.FILTER_KEY_ASSIGNEE, WorkflowService.FILTER_KEY_STATUS , WorkflowService.FILTER_KEY_PRIORITY , WorkflowService.FILTER_KEY_DUE. It's possible to add more than one filter. In this case filters value are joined with an AND operator.

  // We wants tasks which are unassigned AND active
   ListingFilter lf = new ListingFilter();
   lf.addFilter(WorkflowService.FILTER_STATUS, WorkflowService.FILTER_STATUS_ACTIVE);
   lf.addFilter(WorkflowService.FILTER_ASSIGNEE, WorkflowService.FILTER_ASSIGNEE_UNASSIGNED);
   ListingContext lc = new ListingContext();
   lc.setFilter(lf);
   PagingResult<Task> pagingTasks = workflowService.getTasks(lc);
   
  
 

Parameters:

listingContext - : defines the behavior of paging results ListingContext

Returns:

getTask

public Task getTask(String taskIdentifier)

Retrieves a single task by its id.

Parameters:

taskIdentifier - : unique identifier of the task

Returns:

Returns a task object with the given identifier. If the taskIdentifier doesn’t match an existing one null is returned.

completeTask

public Task completeTask(Task task,
                Map<String,Serializable> variables)

Completing a task. In order to complete a task, the authenticated user has to be the assignee of the task, the task owner or the process initiator.

Parameters:

task - : Task object to complete

Returns:

completed task object.

claimTask

public Task claimTask(Task task)

Claiming a task is done by one of the candidates of a task, task owner or process-initiator

Parameters:

task - : Task object to claim

Returns:

claimed task object.

unclaimTask

public Task unclaimTask(Task task)

This removes the assignee of the task i.e the current user. In order to unclaim a task, the authenticated user should be a either the assignee/owner of the task or process initiator.

Parameters:

task - : Task object to unclaim

Returns:

unclaimed task object.

reassignTask

public Task reassignTask(Task task,
                Person assignee)

Reassign the task from the owner to an assignee

Parameters:

task - : Task object to reassign

assignee - : New assignee username/identifier of the task

Returns:

updated task object.

refresh

public Task refresh(Task task)

Returns the latest (and complete) variables for the provided task.

Parameters:

task - : task to refresh

Returns:

the refreshed task with all available variables.

getVariables

public Map<String,Property> getVariables(Task task)

Retrieves the variables for a given task.

Parameters:

task - : task to refresh

Returns:

the map of all available variables

getVariables

public Map<String,Property> getVariables(Process process)

Description copied from interface: WorkflowService

Retrieves the variables for a given process.

Parameters:

process -

Returns:

updateVariables

public Task updateVariables(Task task,
                   Map<String,Serializable> variables)

Update the variables for a given process. If the variable doesn't exist yet, it will be created. Only small subset of variables can be upgraded.

Parameters:

task - : tak to update

variables - : map of variables to update

updateVariable

public Task updateVariable(Task task,
                  String key,
                  Serializable value)

updateVariables

public Process updateVariables(Process process,
                      Map<String,Serializable> variables)

Description copied from interface: WorkflowService

Update the variables for a given process. If the variable doesn't exist yet, it will be created. Only small subset of variables can be upgraded.

Parameters:

process - : process to update

variables - : map of variables to update

getProcessDiagramUrl

public org.apache.chemistry.opencmis.commons.impl.UrlBuilder getProcessDiagramUrl(String processId)

Specified by:

getProcessDiagramUrl in class AbstractWorkflowService

getProcessDiagram

public ContentStream getProcessDiagram(Process process)

This process diagram shows a user the context of the task that is being performed. The user can check the status of processes he or she is involved in. This can be used to see the context when a user is performing a task as part of a process. Or when a user wants to check the status of a process that he/she was involved in at another time.

Parameters:

process - : process object

Returns:

the contentFile representation that contains file informations + inputStream of the content. Null in other case.

getProcessDiagram

public ContentStream getProcessDiagram(String processId)

This process diagram shows a user the context of the task that is being performed. The user can check the status of processes he or she is involved in. This can be used to see the context when a user is performing a task as part of a process. Or when a user wants to check the status of a process that he/she was involved in at another time.

Parameters:

processId - : process unique identifier

Returns:

the contentFile representation that contains file informations + inputStream of the content.