cz.ues.core.workflow

Interface UESActivityAction

@UESService
public interface UESActivityAction

UESActivityAction is a service that provides operations related to actions of activity templates.

Since:

UES8-07

Field Summary

Fields

Modifier and Type	Field and Description
static UESURI	BETYPE_ACTIVITY_ACTION URI of UESActivityAction business entity.

Method Summary

Methods

Modifier and Type	Method and Description
UESURI	create(UESURI entityUri, UESActivityActionCreate activityAction) Creates a new activity action for the specified entity (activity template or activity instance).
void	delete(UESURI activityActionUri) Deletes the specified activity action.
UESResultList<UESActivityActionAttributes,UESActivityActionGetActivityActionList>	getActivityActionList(UESURI entityUri, UESActivityActionGetActivityActionList criteria) Returns a list of activity actions of the specified entity (activity template or activity instance) according to the entered criteria.
UESActivityActionAttributes	getAttributes(UESURI activityActionUri) Returns attributes of the specified activity action.

Field Detail

BETYPE_ACTIVITY_ACTION

static final BETYPE_ACTIVITY_ACTION

URI of UESActivityAction business entity.

Method Detail

create

@UESAudit(propagation=SKIP, useCaseType=COMMAND) @UESCommand(stereotype=CREATE)

UESURI create(UESURI entityUri,
UESActivityActionCreate activityAction)
throws UESActivityActionRTException

Creates a new activity action for the specified entity (activity template or activity instance). The parameters activityStateTemplateUri and the type of the activity action must be always specified. Then, according to this type, following parameters must be specified as well: - for set artifact state actions, the parameter targetArtifactStateTemplateUri must be specified - for set activity state actions, the parameter targetActivityStateTemplateUri must be specified - for exec macro actions, the parameter macroUri must be specified

Parameters:

entityUri - UESURI of the activity template or activity instance for which the new activity action is to be created.

activityAction - Object containing attributes of the new activity action.

Returns:

UESURI of the new activity action.

Throws:

UESActivityActionRTException

Since:

UES8-07

getAttributes

@UESAudit(propagation=SKIP, useCaseType=COMMAND) @UESCommand(stereotype=READ)

UESActivityActionAttributes getAttributes(UESURI activityActionUri)
throws UESActivityActionRTException

Returns attributes of the specified activity action.

Parameters:

activityActionUri - UESURI of the activity action whose attributes are to be returned.

Returns:

Object with attributes of the activity action.

Throws:

UESActivityActionRTException

Since:

UES8-07

delete

@UESAudit(propagation=SKIP, useCaseType=COMMAND) @UESCommand(stereotype=DELETE)

void delete(UESURI activityActionUri)
throws UESActivityActionRTException

Deletes the specified activity action.

Parameters:

activityActionUri - UESURI of the activity action which is to be deleted.

Throws:

UESActivityActionRTException

Since:

UES8-07

getActivityActionList

@UESAudit(propagation=SKIP, useCaseType=COMMAND) @UESCommand(stereotype=READ)

UESResultList<UESActivityActionAttributes,UESActivityActionGetActivityActionList> getActivityActionList(UESURI entityUri,
UESActivityActionGetActivityActionList criteria)
throws UESActivityActionRTException

Returns a list of activity actions of the specified entity (activity template or activity instance) according to the entered criteria. Criteria are defined using query. The list of returned activity actions can be filtered and sorted by the type and code (or by combinations of those attributes). The list is sorted by the attribute type (and by code in case types are equal) of activity actions by default. See the UES query documentation for more information.

Parameters:

entityUri - UESURI of the entity (activity template or activity instance) whose activity action list is to be returned.

criteria - Object containing paging and filtering criteria.

Returns:

List of objects representing activity actions filtered according to the entered criteria.

Throws:

UESActivityActionRTException

Since:

UES8-07

See Also:

UESQuery Documentation.