cz.ues.core.sysc.dto

Class CommandCreate

java.lang.Object

cz.ues.core.sysc.dto.CommandCreate

@DTO
public class CommandCreate
extends java.lang.Object

DTO for command Command.create(UESURI, CommandCreate).

Since:

UES8-09

Field Summary

Fields

Modifier and Type	Field and Description
private java.lang.Boolean	asynchronous Flag if command is asynchronous.
private java.lang.String	code Code of the new command.
private UESURI	competentRoleUri UESURI of the competent role.
private java.lang.String	controllerUrlPath Part of controller URL path.
private java.lang.String	description Description of the new command.
private UESURI	iconUri UESURI of the command's icon.
private UESURI	metaArtifactUri UESURI of the meta artifact.
private java.lang.String	name Name of the new command.
private UESSecurityLevel	securityLevel Security level.

Constructor Summary

Constructors

Constructor and Description
CommandCreate(UESURI metaArtifactUri, java.lang.String controllerUrlPath) Minimal constructor for the command creation.
CommandCreate(UESURI metaArtifactUri, java.lang.String name, java.lang.String code, java.lang.String controllerUrlPath) Enough constructor for the command creation.
CommandCreate(UESURI metaArtifactUri, java.lang.String name, java.lang.String code, java.lang.String description, UESURI competentRoleUri, UESSecurityLevel securityLevel, UESURI iconUri, java.lang.String controllerUrlPath, java.lang.Boolean asynchronous) Maximal constructor for the command creation.

Method Summary

Methods inherited from class java.lang.Object

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

Field Detail

metaArtifactUri

private metaArtifactUri

UESURI of the meta artifact. Only a meta artifact with the template class of command (not its descendants) can be used. If the rights does not permit to create a new command from the meta artifact in the specified location, the create command fails.

Since:

UES8-09

name

private name

Name of the new command. When null is set, default name from meta artifact is used if set, otherwise the create command fails.

Since:

UES8-09

code

private code

Code of the new command. When null is set, the code is generated automatically using the system sequence. The code must be unique in the given territory, otherwise the create command fails.

Since:

UES8-09

description

private description

Description of the new command. When null is set, default description from meta artifact is used if set, otherwise no description is set on the new command.

Since:

UES8-09

competentRoleUri

private competentRoleUri

UESURI of the competent role. When null is set, the executive role from authorization is used. If no role is authorized to create the command into specified container, the create command fails. If the selected role doesn't have connected the role interface with the selected meta artifact, the create command fails. If the selected role doesn't belong to the same organizational unit as a new command or if it doesn't belong to one of superior organizational units, the create command fails.

Since:

UES8-09

securityLevel

private securityLevel

Security level. When null is set, security level is taken from the meta artifact tSecurityLevel. If the meta artifact tSecurityLevel is higher than the user's security clearance, the create command fails.

Since:

UES8-09

iconUri

private iconUri

UESURI of the command's icon. When null is set, the command uses icon from meta artifact.

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}:#{ART_077}

Since:

UES8-09

controllerUrlPath

private controllerUrlPath

Part of controller URL path. Value must start with '/' and contains only valid URL characters.

Since:

UES8-09

asynchronous

private asynchronous

Flag if command is asynchronous. Defaults to false (command is by default created as synchronous).

Since:

UES8-09

Constructor Detail

CommandCreate

public CommandCreate(UESURI metaArtifactUri,
java.lang.String controllerUrlPath)

Minimal constructor for the command creation. Warning: Use this constructor carefully because it is need perfect defined attributes of the specified command template. The command fails when some mandatory attribute (name) is not defined on the specified command template.

Since:

UES8-09

CommandCreate

public CommandCreate(UESURI metaArtifactUri,
java.lang.String name,
java.lang.String code,
java.lang.String controllerUrlPath)

Enough constructor for the command creation. This constructor extends minimal constructor and covers eventually missing mandatory attributes of the specified template.

Since:

UES8-09

CommandCreate

public CommandCreate(UESURI metaArtifactUri,
java.lang.String name,
java.lang.String code,
java.lang.String description,
UESURI competentRoleUri,
UESSecurityLevel securityLevel,
UESURI iconUri,
java.lang.String controllerUrlPath,
java.lang.Boolean asynchronous)

Maximal constructor for the command creation. This constructor allows to set all possible command attributes.

Recommendation: Read description of all attributes for command creation very carefully before using this constructor.

Parameters:

metaArtifactUri -

name -

code -

description -

competentRoleUri -

securityLevel -

iconUri -

controllerUrlPath -

Since:

UES8-09