org.bonitasoft.engine.api

Interface BusinessDataAPI

public interface BusinessDataAPI

This API allows to list the BusinessDataReference related to specific ProcessInstance

Since:

7.0.0

Author:

Elias Ricken de Medeiros, Laurent Leseigneur

See Also:

BusinessDataReference, ProcessInstance

Method Summary

Methods

Modifier and Type	Method and Description
BusinessDataReference	getProcessBusinessDataReference(String businessDataName, long processInstanceId) Returns the BusinessDataReference of the named business data of the process instance.
List<BusinessDataReference>	getProcessBusinessDataReferences(long processInstanceId, int startIndex, int maxResults) Lists the paginated @link BusinessDataReference}s of the process instance order by identifier.

Method Detail

getProcessBusinessDataReference

BusinessDataReference getProcessBusinessDataReference(String businessDataName,
                                                    long processInstanceId)
                                                      throws DataNotFoundException

Returns the BusinessDataReference of the named business data of the process instance. The value is returned in a DataInstance object.

Parameters:

businessDataName - The name of the business data

processInstanceId - The identifier of the process instance

Returns:

the reference of the business data

Throws:

InvalidSessionException - If the session is invalid, e.g. the session has expired.

DataNotFoundException - If the specified business data value cannot be found.

getProcessBusinessDataReferences

List<BusinessDataReference> getProcessBusinessDataReferences(long processInstanceId,
                                                           int startIndex,
                                                           int maxResults)

Lists the paginated @link BusinessDataReference}s of the process instance order by identifier.

Parameters:

processInstanceId - The identifier of the process instance

startIndex - the index of the first result (starting from 0).

maxResults - the maximum number of result per page

Returns:

the paginated references of the business data