getDefinitions

The Process Manager Web Service - PMService2 › The com.ejbtech.processmanager.services Package › Class PMService2 › Class PMService2 Methods › getDefinitions

getDefinitions

Description

Returns an array of process definition descriptors. This returns an array of process definitions known by the Process Manager. Each array element is a ProcessDefinitionDescriptor, rather than an entire process definition.

Syntax

public ProcessDefinitionDescriptor[] getDefinitions()
throws PMServiceException

Parameters

None

Return

An array of Process Definition Descriptors

Exception Thrown

PMServiceException

getExternalVariables

Description

Returns the external variables for a process.

Syntax

public Pair[]getExternalVariables(java.lang.String processId)
throws PMServiceException

Parameters

Parameter	Type	Description
processid	string	Identifies the ID of the process instance

Return: An array of external variables as pairs (see Complex Types-PMServices2)
Exception Thrown: PMServiceException

getInputParameters

Description

Returns input parameters (process attributes) for a selected process definition.

Syntax

public AttributeBean[] getInputParameters(java.lang.String id)
throws PMServiceException

Parameters

Parameter	Type	Description
ID	string	Identifies the process definition ID

Return: A list of input parameters (see Complex Types-PMService2)
Exception Thrown: PMServiceException

getInstance

Description: Returns a string containing the complete process instance object for the specified process instance expressed as an XML document.

Syntax

public java.lang.String getInstance(java.lang.String id)
throws PMServiceException

Parameters

Parameter	Type	Description
ID	string	Identifies the process instance ID

Return: The process instance at the specified URL or null if no process instance was found
Exception Thrown: PMServiceException

getInstanceDetails()

Description

Returns a string containing the "Process Instance details" for the specified process instance expressed as an XML document. The returned value contains bare-minimum details of a given process-instance equal to the getInstance(String) method of PMService.

Syntax

getInstanceDetails(java.lang.String id) 
throws PMServiceException

Parameters

Parameter	Type	Description
ID	string	Specifies the process instance ID

Return: The process instance at the specified URL or null if no process instance was found
Exception Thrown: PMServiceException

getInstanceHistory

Description

Returns the instance history as an array of HistoryRecords.

Syntax

public com.ejbtech.process.HistoryRecord[] getInstanceHistory(java.lang.String id)
throws PMServiceException

Parameters

Parameter	Type	Description
ID	string	Identifies the process instance ID

Return: An array of history records (see Complex Types-PMService2)
Exception Thrown: PMServiceException

getInstanceImage

Description

Returns a process instance status image.

Syntax

public byte[] getInstanceImage(final String instanceid, TransmissionType tp, ImageType it)
throws PMServiceException

Parameters

Parameter	Type	Description
instanceId	string	Identifies the instance id to get a status image
tp	Transmission Type	Identifies the transmission type of image which can be either byte array or attachment.
it	ImageType	Identifies the image type which can be either PNG or JPEG

Return: An instance status image either as a byte array or attachment
Exception Thrown: PMServiceException

getInstances

Description

Returns an array of instances for the process definition and returns an array of process instances known by the Process Manager. Each array element is a ProcessInstanceDescriptor rather than an entire process instance.

Syntax

public ProcessInstanceDescriptor[] getInstances(java.lang.String definitionId,long from, long to)
throws PMServiceException

Parameters

Parameter	Type	Description
definitionId	string	Identifies the process definition ID This parameter will be replaced by "ANY" if it is a null or empty string.
from	long	Identifies the date from which to start listing instances
to	long	Identifies the date to which instances should be listed

Return: An array of process instance objects expressed as XML documents or null if no process instances exist
Exception Thrown: PMServiceException

getInstanceWorkItems

Description

Returns all the workitems for a particular instance.

Syntax

public com.ejbtech.processengine.WorkItem[] getInstanceWorkItems(java.lang.String id,
boolean showCompleted)
throws PMServiceException

Parameters

Parameter	Type	Description
ID	string	Identifies the process instance ID
showCompleted	Boolean	Determines whether to include completed workitems

Return: An array of workitems (see Complex Types-PMService2)
Exception Thrown: PMServiceException

getLog

Description

Returns the user's log. This does not return the entire Process Manager log, only events that occurred since enableLogging was called.

Syntax

public WSLogEntry[] getLog()
throws PMServiceException

Parameters

None

Return

The contents of the log as an array of log entries (see Complex Types-PMService2)

Exception Thrown

PMServiceException

getLoginName

Description

Returns the user name associated with the session, which can be used to find the user name associated with a token.

Syntax

public java.lang.String getLoginName()
throws PMServiceException

Parameters

None

Return

The name of the user logged in with the session

Exception Thrown

PMServiceException

getResults

Description

Returns process execution results as an array of attributes.

Syntax

public AttributeBean[] getResults(java.lang.String sessionId)
throws PMServiceException

Parameters

Parameter	Type	Description
ID	string	Identifies the process instance ID

Return: An array of attributes (see Complex Types-PMServices2)
Exception Thrown: PMServiceException

Tell Technical Publications how we can improve this information