cz.ues.core.sysc.dto

Class VisualUseCaseCreate

java.lang.Object

cz.ues.core.sysc.dto.VisualUseCaseCreate

@DTO
public class VisualUseCaseCreate
extends java.lang.Object

DTO for command VisualUseCase#create(UESURI, VisualUseCaseCreate).

Since:

UES7-10

Field Summary

Fields

Modifier and Type	Field and Description
private java.lang.String	code Code of the new visual use case.
private UESURI	competentRoleUri UESURI of the competent role.
private java.lang.String	controllerClass Name of class in controller.
private ControllerEngine	controllerEngine Engine used for controller creation.
private java.lang.String	controllerUrlPath Part of controller URL path.
private java.lang.String	description Description of the new visual use case.
private UESURI	iconUri UESURI of the visual use case's icon.
private UESURI	metaArtifactUri UESURI of the meta artifact.
private java.lang.String	name Name of the new visual use case.
private UESStreamHandler	options Options data for use case calling.
private UESSecurityLevel	securityLevel Security level.

Constructor Summary

Constructors

Constructor and Description
VisualUseCaseCreate(UESURI metaArtifactUri, java.lang.String controllerUrlPath, ControllerEngine controllerEngine, java.lang.String controllerClass) Minimal constructor for the visual use case creation.
VisualUseCaseCreate(UESURI metaArtifactUri, java.lang.String name, java.lang.String code, java.lang.String controllerUrlPath, ControllerEngine controllerEngine, java.lang.String controllerClass, UESStreamHandler options) Enough constructor for the visual use case creation.
VisualUseCaseCreate(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.String controllerClass, ControllerEngine controllerEngine, UESStreamHandler options) Maximal constructor for the visual use case 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 visual use case (not its descendants) can be used. If the rights does not permit to create a new visual use case from the meta artifact in the specified location, the create command fails.

Since:

UES7-10

name

private name

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

Since:

UES7-10

code

private code

Code of the new visual use case. 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:

UES7-10

description

private description

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

Since:

UES7-10

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 visual use case 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 visual use case or if it doesn't belong to one of superior organizational units, the create command fails.

Since:

UES7-10

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:

UES7-10

iconUri

private iconUri

UESURI of the visual use case's icon. When null is set, the visual use case 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:

UES7-10

controllerUrlPath

private controllerUrlPath

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

Since:

UES7-10

controllerClass

private controllerClass

Name of class in controller.

Since:

UES7-10

controllerEngine

private controllerEngine

Engine used for controller creation.

Since:

UES7-10

options

private options

Options data for use case calling. Accepted format is JSON.

Since:

UES7-10

Constructor Detail

VisualUseCaseCreate

public VisualUseCaseCreate(UESURI metaArtifactUri,
java.lang.String controllerUrlPath,
ControllerEngine controllerEngine,
java.lang.String controllerClass)

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

Since:

UES7-10

VisualUseCaseCreate

public VisualUseCaseCreate(UESURI metaArtifactUri,
java.lang.String name,
java.lang.String code,
java.lang.String controllerUrlPath,
ControllerEngine controllerEngine,
java.lang.String controllerClass,
UESStreamHandler options)

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

Since:

UES7-10

VisualUseCaseCreate

public VisualUseCaseCreate(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.String controllerClass,
ControllerEngine controllerEngine,
UESStreamHandler options)

Maximal constructor for the visual use case creation. This constructor allows to set all possible visual use case attributes.

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

Parameters:

metaArtifactUri -

name -

code -

description -

competentRoleUri -

securityLevel -

iconUri -

controllerUrlPath -

engine -

controllerClass -

options -

Since:

UES7-10