cz.ues.core.workflow.dto

Class UESActivityTemplateSetAttributes

java.lang.Object

cz.ues.core.workflow.dto.UESActivityTemplateSetAttributes

@DTO
public class UESActivityTemplateSetAttributes
extends java.lang.Object

DTO for command UESActivityTemplate.setAttributes(UESURI, UESActivityTemplateSetAttributes).

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 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 The new code of the 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 The new description of the 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 The new name of the activity template.
private java.lang.String	notification Parameter specifies the default time from creation of the activity to its expected completion.
private UESURI	relatedObjectUri The new related object of the activity template.

Constructor Summary

Constructors

Constructor and Description
UESActivityTemplateSetAttributes() Empty constructor.
UESActivityTemplateSetAttributes(java.lang.String name, java.lang.String code, java.lang.String description, 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.

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

The new name of the activity template. If it is not specified, the name is not modified.

code

private code

The new code of the activity template. If it is not specified, the code is not modified. If blank string is set, the code is generated automatically using the system sequence. The code must be unique in the scope of the given meta artifact, otherwise the setAttributes command fails.

description

private description

The new description of the activity template. If it is not specified, the description is not modified.

relatedObjectUri

private relatedObjectUri

The new related object of the activity template. If it is not specified, the related object reference is not modified. If null UESURI ("ues:[-1]:[-1]:") is set, the related artifact is set empty.

iconUri

private iconUri

UESURI of the new activity template's icon. The same icon will be used for created activity instances. If it is not specified, the icon is not modified. If null UESURI ("ues:[-1]:[-1]:") is set, the activity template's icon is replaced by a default icon derived from the 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. This option cannot be turned off for generic templates. If it is not specified, the value is not modified.

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. If it is not specified, the value is not modified.

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. This parameter can be used only for activity templates with type COVER_MEETING or TIME_RESERVATION. The entered value must be in ISO 8601 format. If it is not specified, the value is not modified.

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. If it is not specified, the value is not modified.

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. If it is not specified, the value is not modified.

defaultSubactivityTemplateUri

private defaultSubactivityTemplateUri

UESURI of the activity template which should be used as the default template for subactivities. The UESURI must refer to an activity template on the same meta artifact which is usable as delegation template. If it is not specified, the value is not modified. If null UESURI ("ues:[-1]:[-1]:") is set, this parameter is set empty.

This parameter must not be set on templates for subactivities!

executiveRoleUri

private executiveRoleUri

UESURI of the executive role for the activities created according to this template. If it is not specified, the value is not modified.

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. If it is not specified, the value is not modified.

allowExecutiveRoleChange

private allowExecutiveRoleChange

Parameter specifies whether the executive role of the activities created according to this template can be changed. If it is not specified, the value is not modified.

allowSubactivities

private allowSubactivities

Parameter specifies whether it is allowed to create subactivities of the activities created according to this template. If it is not specified, the value is not modified.

Constructor Detail

UESActivityTemplateSetAttributes

public UESActivityTemplateSetAttributes()

Empty constructor.

Since:

UES8-07

UESActivityTemplateSetAttributes

public UESActivityTemplateSetAttributes(java.lang.String name,
java.lang.String code,
java.lang.String description,
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