org.alfresco.mobile.android.api.model.impl

Class ProcessImpl

java.lang.Object

org.alfresco.mobile.android.api.model.impl.ProcessImpl

All Implemented Interfaces:

Serializable, Process

public class ProcessImpl
extends Object
implements Process

Since:

1.3

Author:

jpascal

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ProcessImpl()

Method Summary

Methods

Modifier and Type	Method and Description
Map<String,Serializable>	getData()
String	getDefinitionIdentifier() Returns the unique identifier of the process definition associated to the process.
String	getDescription() Returns the description of the process.
GregorianCalendar	getDueAt()
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.
static Process	parseJson(Map<String,Object> json) Parse Json Response from Alfresco REST API to create a process Definition Object.
static Process	parsePublicAPIJson(Map<String,Object> json)
static Process	refreshProcess(Process process, Map<String,Property> properties)

Methods inherited from class java.lang.Object

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

Constructor Detail

ProcessImpl

public ProcessImpl()

Method Detail

parseJson

public static Process parseJson(Map<String,Object> json)

Parse Json Response from Alfresco REST API to create a process Definition Object.

Parameters:

json - : json response that contains data from the repository

Returns:

ProcessDefinition Object

refreshProcess

public static Process refreshProcess(Process process,
                     Map<String,Property> properties)

parsePublicAPIJson

public static Process parsePublicAPIJson(Map<String,Object> json)

getIdentifier

public String getIdentifier()

Returns the unique identifier of the Process.

Specified by:

getIdentifier in interface Process

Returns:

the identifier

getDefinitionIdentifier

public String getDefinitionIdentifier()

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

Specified by:

getDefinitionIdentifier in interface Process

Returns:

the processDefinitionIdentifier

getStartedAt

public GregorianCalendar getStartedAt()

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

Specified by:

getStartedAt in interface Process

Returns:

the started at

getData

public Map<String,Serializable> getData()

getEndedAt

public GregorianCalendar getEndedAt()

Description copied from interface: Process

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

Specified by:

getEndedAt in interface Process

Returns:

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

getKey

public String getKey()

Description copied from interface: Process

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

Specified by:

getKey in interface Process

Returns:

the Process definition key

getDueAt

public GregorianCalendar getDueAt()

getPriority

public Integer getPriority()

Description copied from interface: Process

Returns the priority of the process.

Specified by:

getPriority in interface Process

Returns:

the priority. By default it's PRIORITY_MEDIUM

getInitiatorIdentifier

public String getInitiatorIdentifier()

Description copied from interface: Process

Returns the username of the person who start the process.

Specified by:

getInitiatorIdentifier in interface Process

Returns:

the initiator username/identifier

getName

public String getName()

Description copied from interface: Process

Returns the name of the process.

Specified by:

getName in interface Process

Returns:

the name

getDescription

public String getDescription()

Description copied from interface: Process

Returns the description of the process.

Specified by:

getDescription in interface Process

Returns:

the description.

hasAllVariables

public boolean hasAllVariables()

Description copied from interface: Process

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

Specified by:

hasAllVariables in interface Process

Returns:

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

getVariable

public Property getVariable(String name)

Description copied from interface: Process

Returns the requested variable.

Specified by:

getVariable in interface Process

Parameters:

name - : unique identifier of your variable.

Returns:

Property object.

getVariables

public Map<String,Property> getVariables()

Description copied from interface: Process

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

Specified by:

getVariables in interface Process

Returns:

map of properties object

getVariableValue

public <T> T getVariableValue(String name)

Description copied from interface: Process

Returns the value of the variable with the given name.

Specified by:

getVariableValue in interface Process

Parameters:

name - : unique identifier label of the variable

Returns:

the property value

hasCompleted

public boolean hasCompleted()

Description copied from interface: Process

Returns true if the task has completed.

Specified by:

hasCompleted in interface Process