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

Class AbstractWorkflowService

java.lang.Object

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

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

All Implemented Interfaces:

android.os.Parcelable, Service, WorkflowService

Direct Known Subclasses:

OnPremiseWorkflowServiceImpl, PublicAPIWorkflowServiceImpl

public abstract class AbstractWorkflowService
extends AlfrescoService
implements WorkflowService

Abstract class implementation of WorkflowService. Responsible of sharing common methods between child class (OnPremise and PublicAPI)

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 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
AbstractWorkflowService(AlfrescoSession repositorySession) Default constructor for service.

Method Summary

Methods

Modifier and Type	Method and Description
protected static String	decodeKey(String key)
void	deleteProcess(Process process) Deletes a process.
protected static String	encodeKey(String key)
List<Document>	getDocuments(Process process) Returns a list items associated to the process.
List<Document>	getDocuments(Task task) Returns a list items associated to the the task.
ProcessDefinition	getProcessDefinitionByKey(String processDefinitionKey) Returns a single process definition that matches the (versionless) specific key.
List<ProcessDefinition>	getProcessDefinitions()
abstract org.apache.chemistry.opencmis.commons.impl.UrlBuilder	getProcessDiagramUrl(String processId)
List<Process>	getProcesses() Returns a list of processes in progress for the current user. Each process is an execution of a process definition.
protected abstract org.apache.chemistry.opencmis.commons.impl.UrlBuilder	getProcessUrl(Process process) Internal method to retrieve a specific process url.
List<Task>	getTasks() Returns a list of task in progress for the current user.
List<Task>	getTasks(Process process) Get all the tasks in progress for the specified process.

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.WorkflowService

addDocuments, claimTask, completeTask, getDocuments, getDocuments, getProcess, getProcessDefinition, getProcessDefinitions, getProcessDiagram, getProcessDiagram, getProcesses, getTask, getTasks, getTasks, getVariables, getVariables, reassignTask, refresh, refresh, removeDocuments, startProcess, unclaimTask, updateVariables, updateVariables

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

clear

Methods inherited from interface android.os.Parcelable

describeContents, writeToParcel

Constructor Detail

AbstractWorkflowService

public AbstractWorkflowService(AlfrescoSession repositorySession)

Default constructor for service.
Used by the AbstractServiceRegistry.

Parameters:

repositorySession -

Method Detail

getProcessDefinitions

public List<ProcessDefinition> getProcessDefinitions()

Specified by:

getProcessDefinitions in interface WorkflowService

Returns:

a list of process definitions.

getProcessDefinitionByKey

public ProcessDefinition getProcessDefinitionByKey(String processDefinitionKey)

Description copied from interface: WorkflowService

Returns a single process definition that matches the (versionless) specific key.

Specified by:

getProcessDefinitionByKey in interface WorkflowService

Parameters:

processDefinitionKey - : unique key

getProcessUrl

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

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

Parameters:

process - : a process object

Returns:

UrlBuilder to retrieve for a specific process url.

deleteProcess

public void deleteProcess(Process process)

Deletes a process. An authenticated user can only delete a process if the authenticated user has started the process.

Specified by:

deleteProcess in interface WorkflowService

Parameters:

process - : process object to delete

getProcesses

public List<Process> getProcesses()

Returns a list of processes in progress for the current user.
Each process is an execution of a process definition.

Specified by:

getProcesses in interface WorkflowService

Returns:

list of processes

getTasks

public List<Task> getTasks(Process process)

Get all the tasks in progress for the specified process.

Specified by:

getTasks in interface WorkflowService

Returns:

getProcessDiagramUrl

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

getDocuments

public List<Document> getDocuments(Task task)

Returns a list items associated to the the task.

Specified by:

getDocuments in interface WorkflowService

Returns:

a list of documents attached to the specified task.

getDocuments

public List<Document> getDocuments(Process process)

Returns a list items associated to the process.

Specified by:

getDocuments in interface WorkflowService

Returns:

a list of documents attached to the specified process.

getTasks

public List<Task> getTasks()

Returns a list of task in progress for the current user.

Specified by:

getTasks in interface WorkflowService

Returns:

list of task

encodeKey

protected static String encodeKey(String key)

decodeKey

protected static String decodeKey(String key)