cz.ues.core.workflow.dto

Class UESActivityTemplateCreate

java.lang.Object

cz.ues.core.workflow.dto.UESActivityTemplateCreate

@DTO
public class UESActivityTemplateCreate
extends java.lang.Object

DTO for command UESActivityTemplate.create(UESURI, UESActivityTemplateCreate).

Since:

UES8-07

Field Summary

Fields

Modifier and Type	Field and Description
private java.lang.Boolean	allowAsSubactivityTemplate Parameter specifies whether this activity template will be usable as a template for subactivities.
private java.lang.Boolean	allowCreationThroughUi Parameter specifies whether activities can be created according to this activity template through the user interface or not.
private java.lang.Boolean	allowExecutiveRoleChange Parameter specifies whether Specifies whether the executive role of the activities created according to this template can be changed.
private java.lang.Boolean	allowSubactivities Parameter specifies whether it is allowed to create subactivities of the activities created according to this template.
private java.lang.Boolean	blockTimeInCalendar Specifies whether the activities created according to this template will reserve time in the related users' calendars.
private java.lang.String	code Code of the new activity template.
private UESURI	defaultSubactivityTemplateUri UESURI of the activity template which should be used as the default template for subactivities.
private java.lang.String	description Description of the new activity template.
private java.lang.String	duration Parameter specifies the duration of the activity template.
private UESURI	executiveRoleUri UESURI of the executive role for the activities created according to this template.
private java.lang.Object	expiration Parameter specifies how long after the expected completion date the activities created according to this template should be automatically terminated.
private UESURI	iconUri UESURI of the new activity template's icon.
private java.lang.String	name Name of the new activity template.
private java.lang.String	notification Parameter specifies the default time from creation of the activity to its expected completion.
private UESURI	relatedObjectUri UESURI of the artifact or object which is somehow related to the activity template.
private UESActivityType	type Type of the new activity template.

Constructor Summary

Constructors

Constructor and Description
UESActivityTemplateCreate() Empty constructor.
UESActivityTemplateCreate(java.lang.String name, java.lang.String code, java.lang.String description, UESActivityType type, UESURI relatedObjectUri, UESURI iconUri, java.lang.Boolean allowCreationThroughUi, java.lang.String notification, java.lang.String duration, java.lang.Object expiration, java.lang.Boolean allowAsSubactivityTemplate, UESURI defaultSubactivityTemplateUri, UESURI executiveRoleUri, java.lang.Boolean blockTimeInCalendar, java.lang.Boolean allowExecutiveRoleChange, java.lang.Boolean allowSubactivities) Full constructor.
UESActivityTemplateCreate(java.lang.String name, UESActivityType type) Minimal constructor.
UESActivityTemplateCreate(java.lang.String name, UESActivityType type, UESURI executiveRoleUri) Minimal constructor for templates of subactivities.

Method Summary

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

name

private name

Name of the new activity template. If not specified, the create command fails.

code

private code

Code of the new activity template. If not specified, the code is generated automatically using the system sequence. The code must be unique in the scope of the given meta artifact, otherwise the create command fails.

description

private description

Description of the new activity template. If not specified, it is left empty.

type

private type

Type of the new activity template. Specific generic activity template will be used as the source for the new activity template according to the specified type. If not specified, the create command fails.

Subactivity templates whose parent has the type TIME_RESERVATION must also have the type TIME_RESERVATION.

relatedObjectUri

private relatedObjectUri

UESURI of the artifact or object which is somehow related to the activity template.

iconUri

private iconUri

UESURI of the new activity template's icon. The same icon will be used for created activity instances. If not specified, there will be used a default icon derived from the specified state type.

Allowed format URI of icon: ues:#{system}:#{ues_v5.core_v1.codetable_v1.base_v1.CodeTable_Icons}:#{CODE_OF_ICON}

For example: ues:#{system}:#{ues_v5.core_v1.codetable_v1.base_v1.CodeTable_Icons}:#{S00_C01}

allowCreationThroughUi

private allowCreationThroughUi

Parameter specifies whether activities can be created according to this activity template through the user interface or not. The default value is true.

notification

private notification

Parameter specifies the default time from creation of the activity to its expected completion. The entered value must be in ISO 8601 format. The default value is one day.

If the user creates a subactivity template, the default value is derived from the parent activity template.

The value must not be longer than the value of the same parameter at the superior activity (if it exists).

duration

private duration

Parameter specifies the duration of the activity template. It can be set only for activity templates with type COVER_MEETING or TIME_RESERVATION. For those types of templates, the default value is one hour. The entered value must be in ISO 8601 format.

If the user creates a subactivity template, the default value is derived from the parent activity template.

The value must not be longer than the value of the same parameter at the superior activity (if it exists).

expiration

private expiration

Parameter specifies how long after the expected completion date the activities created according to this template should be automatically terminated. This parameter can contain two possible types of values:
If it's a time duration, it sets the activity to expire after that duration. This value must be in ISO 8601 format.
If it's set to false, the activity created according to this activity template will never expire. The default value is false.

If the user creates a subactivity template, the default value is derived from the parent activity template.

The value must not be longer than the value of the same parameter at the superior activity (if it exists).

allowAsSubactivityTemplate

private allowAsSubactivityTemplate

Parameter specifies whether this activity template will be usable as a template for subactivities. The default value is false.

defaultSubactivityTemplateUri

private defaultSubactivityTemplateUri

UESURI of the activity template which should be used as the default template for subactivities. The UESURI must refer to a generic activity template on the same meta artifact. If it is not set, no default subactivity is specified.

This parameter must not be set when the user creates a template for subactivities!

executiveRoleUri

private executiveRoleUri

UESURI of the executive role for the activities created according to this template.

The parameter is required when the user creates a template for subactivities!

blockTimeInCalendar

private blockTimeInCalendar

Specifies whether the activities created according to this template will reserve time in the related users' calendars. This parameter can be used only for activity templates with type COVER_MEETING or TIME_RESERVATION. For those types of templates, the default value is true.

allowExecutiveRoleChange

private allowExecutiveRoleChange

Parameter specifies whether Specifies whether the executive role of the activities created according to this template can be changed. The default value is true.

allowSubactivities

private allowSubactivities

Parameter specifies whether it is allowed to create subactivities of the activities created according to this template. The default value is true.

Constructor Detail

UESActivityTemplateCreate

public UESActivityTemplateCreate()

Empty constructor.

Since:

UES8-07

UESActivityTemplateCreate

public UESActivityTemplateCreate(java.lang.String name,
UESActivityType type)

Minimal constructor.

Since:

UES8-07

UESActivityTemplateCreate

public UESActivityTemplateCreate(java.lang.String name,
UESActivityType type,
UESURI executiveRoleUri)

Minimal constructor for templates of subactivities.

Since:

UES8-07

UESActivityTemplateCreate

public UESActivityTemplateCreate(java.lang.String name,
java.lang.String code,
java.lang.String description,
UESActivityType type,
UESURI relatedObjectUri,
UESURI iconUri,
java.lang.Boolean allowCreationThroughUi,
java.lang.String notification,
java.lang.String duration,
java.lang.Object expiration,
java.lang.Boolean allowAsSubactivityTemplate,
UESURI defaultSubactivityTemplateUri,
UESURI executiveRoleUri,
java.lang.Boolean blockTimeInCalendar,
java.lang.Boolean allowExecutiveRoleChange,
java.lang.Boolean allowSubactivities)

Full constructor.

Since:

UES8-07