org.alfresco.mobile.android.api.model

Interface Process

All Superinterfaces:

Serializable

All Known Implementing Classes:

ProcessImpl

public interface Process
extends Serializable

In Alfresco a Process or Workflow is a sequence of connected tasks applied to a document or other item of content. Each task can be performed by a person, a group, or automatically.

For example, you might have a document that you needed reviewing and approving by a number of people. The sequence of connected tasks would be:

• Send an email to each reviewer asking the to review the document within a certain time
• Each reviewer reviews the document
• Each reviewer approves or rejects the document
• If enough reviewers approve, the task is completed successfully

Alfresco workflow automate the process for you. Users can choose from five workflow definitions provided in Alfresco. You can also create your own workflow definitions for more complex workflows.

Since:

1.3

Author:

jpascal

Method Summary

Methods

Modifier and Type	Method and Description
String	getDefinitionIdentifier() Returns the unique identifier of the process definition associated to the process.
String	getDescription() Returns the description of the process.
GregorianCalendar	getEndedAt() Returns the timestamp in the session’s locale when the process was completed.
String	getIdentifier() Returns the unique identifier of the Process.
String	getInitiatorIdentifier() Returns the username of the person who start the process.
String	getKey() Refers to a logical process definition.
String	getName() Returns the name of the process.
Integer	getPriority() Returns the priority of the process.
GregorianCalendar	getStartedAt() Returns the timestamp in the session’s locale when the process was started.
Property	getVariable(String name) Returns the requested variable.
Map<String,Property>	getVariables() Returns a Map of all available variables for the specific process object.
<T> T	getVariableValue(String name) Returns the value of the variable with the given name.
boolean	hasAllVariables() Indicates whether the process has all it’s variables populated.
boolean	hasCompleted() Returns true if the task has completed.

Method Detail

getIdentifier

String getIdentifier()

Returns the unique identifier of the Process.

Returns:

the identifier

getDefinitionIdentifier

String getDefinitionIdentifier()

Returns the unique identifier of the process definition associated to the process.

Returns:

the processDefinitionIdentifier

getKey

String getKey()

Refers to a logical process definition. eg "financialReport".
Potentially multiple versions of this process definition are deployed.

Returns:

the Process definition key

getStartedAt

GregorianCalendar getStartedAt()

Returns the timestamp in the session’s locale when the process was started.

Returns:

the started at

getEndedAt

GregorianCalendar getEndedAt()

Returns the timestamp in the session’s locale when the process was completed.

Returns:

the ended at timestamp. Null if it's not defined.

getPriority

Integer getPriority()

Returns the priority of the process.

Returns:

the priority. By default it's PRIORITY_MEDIUM

getInitiatorIdentifier

String getInitiatorIdentifier()

Returns the username of the person who start the process.

Returns:

the initiator username/identifier

getName

String getName()

Returns the name of the process.

Returns:

the name

getDescription

String getDescription()

Returns the description of the process.

Returns:

the description.

hasAllVariables

boolean hasAllVariables()

Indicates whether the process has all it’s variables populated.

Returns:

true if all variables are present. False if only general variables are provided.

getVariable

Property getVariable(String name)

Returns the requested variable.

Parameters:

name - : unique identifier of your variable.

Returns:

Property object.

getVariables

Map<String,Property> getVariables()

Returns a Map of all available variables for the specific process object.

Returns:

map of properties object

getVariableValue

<T> T getVariableValue(String name)

Returns the value of the variable with the given name.

Parameters:

name - : unique identifier label of the variable

Returns:

the property value

hasCompleted

boolean hasCompleted()

Returns true if the task has completed.

Since:

1.4