cz.ues.core.workflow

Interface UESActivity

@UESService
public interface UESActivity

Since:

UES6-00

Field Summary

Fields

Modifier and Type	Field and Description
static UESURI	BETYPE_ACTIVITY URI of activity business entity.

Method Summary

Methods

Modifier and Type	Method and Description
UESURI	create(UESURI parentNodeUri, UESActivityCreate activity) This command creates a new activity on the specified artifact.
void	delete(UESURI activityUri) This command deletes an unfinished activity.
UESResultList<UESActivityAttributes,UESActivityGetActivityList>	getActivityList(UESURI parentNodeUri, UESActivityGetActivityList criteria) Returns list of the activities and sub activities for the specified artifact or activity.
UESActivityAttributes	getAttributes(UESURI activityUri) This command returns attributes representing the activity specified by the activityUri parameter.
UESResultList<UESActivityAttributes,UESActivityGetInstanceList>	getInstanceList(UESURI activityUri, UESActivityGetInstanceList criteria) Returns list of all instances of the recurrent activity.
UESResultList<UESActivityStateAttributes,UESActivityGetStateHistoryList>	getStateHistoryList(UESURI activityUri, UESActivityGetStateHistoryList criteria) Retrieves the list of set states on a given activity based on provided criteria.
UESURI	setAttributes(UESURI activityUri, UESActivitySetAttributes activity) This command updates some basic attributes of an activity.
void	setState(UESURI activityUri, UESActivitySetState state) This command sets a new state for the specified activity.

Field Detail

BETYPE_ACTIVITY

static final BETYPE_ACTIVITY

URI of activity business entity.

Since:

UES6-06

Method Detail

setState

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

void setState(UESURI activityUri,
UESActivitySetState state)
throws UESActivityRTException

This command sets a new state for the specified activity. You can enter the state template using ues uri or by specifying its type and, additionally, subtype.

Parameters:

activityUri - UESURI of the activity

state - DTO containing attributes of new activity state

Throws:

UESActivityRTException

Since:

UES6-00

getAttributes

@UESCommand(stereotype=READ)

UESActivityAttributes getAttributes(UESURI activityUri)
throws UESActivityRTException

This command returns attributes representing the activity specified by the activityUri parameter. The command does not change the state of the activity in the system.

Parameters:

activityUri - UESURI of an activity whose attributes are returned

Returns:

DTO containing the activity attributes

Throws:

UESActivityRTException

Since:

UES6-00

create

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

UESURI create(UESURI parentNodeUri,
UESActivityCreate activity)
throws UESActivityRTException

This command creates a new activity on the specified artifact. At the very least activity template or the activity type have to be specified in this command. Attention: No activity actions or conditions are copied from the template when the new activity is created by templateUri.

Parameters:

parentNodeUri - UESURI of an artifact (or a parent activity) where the new activity is created

activity - DTO containing attributes of a new activity

Returns:

UESURI of the new activity

Throws:

UESActivityRTException

Since:

UES6-00

setAttributes

@UESCommand(stereotype=UPDATE)

UESURI setAttributes(UESURI activityUri,
UESActivitySetAttributes activity)
throws UESActivityRTException

This command updates some basic attributes of an activity.

Parameters:

activityUri - UESURI of the activity whose attributes are to be changed

activity - DTO containing new attributes the activity

Returns:

UESURI of the activity. It could be changed because command could change name and code.

Throws:

UESActivityRTException

Since:

UES6-00

delete

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

void delete(UESURI activityUri)
throws UESActivityRTException

This command deletes an unfinished activity. Planned activity will be removed from the system, activity in progress will be set to the canceled state.

Parameters:

activityUri - UESURI of the activity which is about to be deleted.

Throws:

UESActivityRTException

Since:

UES6-10

getInstanceList

@UESCommand(stereotype=READ)

UESResultList<UESActivityAttributes,UESActivityGetInstanceList> getInstanceList(UESURI activityUri,
UESActivityGetInstanceList criteria)
throws UESActivityRTException

Returns list of all instances of the recurrent activity. Returned list does not contain any objects filtered out by executed UESQuery.

Parameters:

activityUri - UES URI of the activity for which instances are to be listed.

criteria - DTO containing the criteria for filtering of the result list. Criteria are defined using UESQuery. Allowed filtering parameters are name, code, activityType, allowExecutiveRoleChange, allowSubactivities, blockTimeInCalendar, activityStateType, activityStateSubtype, recurrent, termModifiable, dateFrom, dateStart, dateTo and dateFinished.

Returns:

List of DTO representing activities.

Throws:

UESActivityRTException

Since:

UES7-08

See Also:

How to work with activities in UES Command

getActivityList

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

UESResultList<UESActivityAttributes,UESActivityGetActivityList> getActivityList(UESURI parentNodeUri,
UESActivityGetActivityList criteria)
throws UESActivityRTException

Returns list of the activities and sub activities for the specified artifact or activity. Returned list does not contain any objects filtered out by executed UESQuery.

Parameters:

parentNodeUri - UES URI of the artifact or activity for which activities are about to be listed.

criteria - DTO containing the criteria for filtering of the result list. Criteria are defined using UESQuery. Allowed filtering parameters are name, code, activityType, allowExecutiveRoleChange, allowSubactivities, blockTimeInCalendar, activityStateType, activityStateSubtype, recurrent, termModifiable, dateFrom, dateStart, dateTo and dateFinished.

Returns:

List of DTO representing activities.

Throws:

UESActivityRTException

Since:

UES7-08

See Also:

How to work with activities in UES Command

getStateHistoryList

@UESCommand(stereotype=READ)

UESResultList<UESActivityStateAttributes,UESActivityGetStateHistoryList> getStateHistoryList(UESURI activityUri,
UESActivityGetStateHistoryList criteria)
throws UESActivityRTException

Retrieves the list of set states on a given activity based on provided criteria.

Parameters:

activityUri - UESURI of the activity (model or instance), whose communication will be retrieved.

criteria - Object containing paging criteria.

Returns:

Returns list of activity states attributes. Contains instances of UESActivityStateAttributes.

Throws:

UESActivityRTException

Since:

UES8-08