cz.ues.core.workflow

Interface UESActivityStateTemplate

@UESService
public interface UESActivityStateTemplate

UESActivityStateTemplate is a service that provides operations related to activity state templates.

Since:

UES8-07

Field Summary

Fields

Modifier and Type	Field and Description
static UESURI	BETYPE_ACTIVITY_STATE_TEMPLATE URI of UESActivityStateTemplate business entity.

Method Summary

Methods

Modifier and Type	Method and Description
UESURI	create(UESURI activityTemplateUri, UESActivityStateTemplateCreate activityStateTemplate) Creates a new activity state template on the specified activity template.
void	delete(UESURI activityStateTemplateUri) Deletes the specified activity state template.
UESResultList<UESActivityStateTemplateAttributes,UESActivityStateTemplateGetActivityStateTemplateList>	getActivityStateTemplateList(UESURI activityTemplateUri, UESActivityStateTemplateGetActivityStateTemplateList criteria) Returns a list of activity state templates for the specified activity template according to entered criteria.
UESActivityStateTemplateAttributes	getAttributes(UESURI activityStateTemplateUri) Returns attributes of the specified activity state template.
UESURI	setAttributes(UESURI activityStateTemplateUri, UESActivityStateTemplateSetAttributes activityStateTemplate) Sets attributes of an activity state template.

Field Detail

BETYPE_ACTIVITY_STATE_TEMPLATE

static final BETYPE_ACTIVITY_STATE_TEMPLATE

URI of UESActivityStateTemplate business entity.

Method Detail

create

@UESCommand(stereotype=CREATE)

UESURI create(UESURI activityTemplateUri,
UESActivityStateTemplateCreate activityStateTemplate)
throws UESActivityStateTemplateRTException

Creates a new activity state template on the specified activity template. At least, its future name and type have to be specified in this command.

Parameters:

activityTemplateUri - UESURI of the activity template the new activity state template is to be created on.

activityStateTemplate - Object containing attributes of the new activity state template.

Returns:

UESURI of the new activity state template.

Throws:

UESActivityStateTemplateRTException

Since:

UES8-07

getAttributes

@UESCommand(stereotype=READ)

UESActivityStateTemplateAttributes getAttributes(UESURI activityStateTemplateUri)
throws UESActivityStateTemplateRTException

Returns attributes of the specified activity state template.

Parameters:

activityStateTemplateUri - UESURI of the activity state template whose attributes are to be returned.

Returns:

Object with attributes of the activity state template.

Throws:

UESActivityStateTemplateRTException

Since:

UES8-07

setAttributes

@UESCommand(stereotype=UPDATE)

UESURI setAttributes(UESURI activityStateTemplateUri,
UESActivityStateTemplateSetAttributes activityStateTemplate)
throws UESActivityStateTemplateRTException

Sets attributes of an activity state template. This command cannot modify the type.

Parameters:

activityStateTemplateUri - UESURI of the activity state template whose attributes are to be modified.

activityStateTemplate - Object containing new attributes of the activity state template.

Returns:

UESURI of the modified activity state template.

Throws:

UESActivityStateTemplateRTException

Since:

UES8-07

delete

@UESCommand(stereotype=DELETE)

void delete(UESURI activityStateTemplateUri)
throws UESActivityStateTemplateRTException

Deletes the specified activity state template. It it not possible to delete the entry or the exit state template, or a state template used in a condition or an action, or if it is important for the system according to its type.

Parameters:

activityStateTemplateUri - UESURI of the activity state template which is to be deleted.

Throws:

UESActivityStateTemplateRTException

Since:

UES8-07

getActivityStateTemplateList

@UESCommand(stereotype=READ)

UESResultList<UESActivityStateTemplateAttributes,UESActivityStateTemplateGetActivityStateTemplateList> getActivityStateTemplateList(UESURI activityTemplateUri,
UESActivityStateTemplateGetActivityStateTemplateList criteria)
throws UESActivityStateTemplateRTException

Returns a list of activity state templates for the specified activity template according to entered criteria. Criteria are defined using query. The command does not return all activity state templates, only a sublist. The list of returned activity state templates can be filtered by the name, code, type, entryState, exitState and order. The list is sorted by the attribute order (and by name in case orders are equal) of an activity state template by default, or it can be sorted arbitrarily by any of activity state template attributes usable for filtering or by combinations of such attributes. See the UES query documentation for more information.

Parameters:

activityTemplateUri - UESURI of the activity template whose activity state templates are to be listed.

criteria - Object containing paging and filtering criteria.

Returns:

List of Objects representing activity state templates (the same objects as in the command getAttributes).

Throws:

UESActivityStateTemplateRTException

Since:

UES8-07

See Also:

UESQuery Documentation.