cz.ues.core.role.dto

Class UESRoleCreate

java.lang.Object

cz.ues.core.role.dto.UESRoleCreate

@DTO
public class UESRoleCreate
extends java.lang.Object

Since:

UES6-06

Field Summary

Fields

Modifier and Type	Field and Description
private java.lang.String	code Code of the new role.
private UESURI	competentRoleUri UESURI of the competent role.
private java.lang.String	description Description of the new role.
private java.lang.Boolean	dryRun Specifies whether this is only a test run to verify that the object can be created.
private java.lang.Boolean	grantAllFromOrganizationalUnit Specifies if the role will be included among All roles from organizational unit.
private UESURI	iconUri URI of the role's icon.
private UESURI	metaArtifactUri UESURI of the meta artifact.
private java.lang.String	name Name of the new role.
private java.lang.Boolean	searchableAcrossTerritories Deprecated. This attribute has been deprecated and will not be supported in the future.
private java.lang.Boolean	searchableInTerritory Specifies if it is possible to search the new role in its territory.
private UESSecurityLevel	securityLevel Security level.
private java.lang.Boolean	territorySwitchVisible Deprecated. This attribute has been deprecated. The visual use case for displaying territories and organizational units, which this attribute was used for, is no longer supported.

Constructor Summary

Constructors

Constructor and Description
UESRoleCreate(UESURI metaArtifactUri, java.lang.String name, java.lang.String code)
UESRoleCreate(UESURI metaArtifactUri, java.lang.String name, java.lang.String code, java.lang.String description, UESURI competentRoleUri, UESSecurityLevel securityLevel, java.lang.Boolean searchableInTerritory, java.lang.Boolean searchableAcrossTerritories) Deprecated.
UESRoleCreate(UESURI metaArtifactUri, java.lang.String name, java.lang.String code, java.lang.String description, UESURI competentRoleUri, UESSecurityLevel securityLevel, java.lang.Boolean searchableInTerritory, java.lang.Boolean searchableAcrossTerritories, java.lang.Boolean territorySwitchVisible) Deprecated.
UESRoleCreate(UESURI metaArtifactUri, java.lang.String name, java.lang.String code, java.lang.String description, UESURI competentRoleUri, UESSecurityLevel securityLevel, java.lang.Boolean searchableInTerritory, java.lang.Boolean searchableAcrossTerritories, java.lang.Boolean territorySwitchVisible, UESURI iconUri) Deprecated.
UESRoleCreate(UESURI metaArtifactUri, java.lang.String name, java.lang.String code, java.lang.String description, UESURI competentRoleUri, UESSecurityLevel securityLevel, java.lang.Boolean searchableInTerritory, java.lang.Boolean searchableAcrossTerritories, java.lang.Boolean territorySwitchVisible, UESURI iconUri, java.lang.Boolean grantAllFromOrganizationalUnit) Deprecated.
UESRoleCreate(UESURI metaArtifactUri, java.lang.String name, java.lang.String code, java.lang.String description, UESURI competentRoleUri, UESSecurityLevel securityLevel, java.lang.Boolean searchableInTerritory, java.lang.Boolean searchableAcrossTerritories, java.lang.Boolean territorySwitchVisible, UESURI iconUri, java.lang.Boolean grantAllFromOrganizationalUnit, java.lang.Boolean dryRun) Deprecated.
UESRoleCreate(UESURI metaArtifactUri, java.lang.String name, java.lang.String code, java.lang.String description, UESURI competentRoleUri, UESSecurityLevel securityLevel, java.lang.Boolean searchableInTerritory, UESURI iconUri, java.lang.Boolean grantAllFromOrganizationalUnit, java.lang.Boolean dryRun)

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 Role (not its descendants) can be used. If the rights does not permit to create a new role from the meta artifact in the specified location, the create command fails.

Since:

UES6-06

code

private code

Code of the new role. 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:

UES6-06

name

private name

Name of the new role. When null is set, tName from meta artifact is used if set, otherwise the create command fails. Note that the role name is automatically extended by the name of casted access roles names. Therefore the name attribute returned by getAttributes command returns a different string.

Since:

UES6-06

description

private description

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

Since:

UES6-06

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

Since:

UES6-06

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:

UES6-06

searchableInTerritory

private searchableInTerritory

Specifies if it is possible to search the new role in its territory. When null is set, tSearchableInTerritory from meta artifact is used if set, otherwise the create command fails.

Since:

UES6-06

searchableAcrossTerritories

@Deprecated

private searchableAcrossTerritories

Deprecated. This attribute has been deprecated and will not be supported in the future.

Specifies if it is possible to search and cast the new role in other territories. When null is set, tSearchableAcrossTerritories from meta artifact is used if set, otherwise the create command fails.

Since:

UES6-06

territorySwitchVisible

@Deprecated

private territorySwitchVisible

Deprecated. This attribute has been deprecated. The visual use case for displaying territories and organizational units, which this attribute was used for, is no longer supported.

Specifies if the organizational unit of this role should be visible in visual usecase for displaying list of territories and organizational units. When true is set then related organizational unit is displayed. When false is set then related organizational unit is not visible unless there is another role with this flag set to true. When null is set, tTerritorySwitchVisible from meta artifact is used if set, otherwise the create command fails.

Since:

UES7-00

iconUri

private iconUri

URI of the role's icon. When null is set, the role 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-04

grantAllFromOrganizationalUnit

private grantAllFromOrganizationalUnit

Specifies if the role will be included among All roles from organizational unit. When true or null is set, the role will be included, otherwise it will not be included among All roles from organizational unit.

Since:

UES7-07

dryRun

private dryRun

Specifies whether this is only a test run to verify that the object can be created. The default value is false.

Since:

UES8-02

Constructor Detail

UESRoleCreate

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

Since:

UES6-06

UESRoleCreate

@Deprecated

public UESRoleCreate(UESURI metaArtifactUri,
java.lang.String name,
java.lang.String code,
java.lang.String description,
UESURI competentRoleUri,
UESSecurityLevel securityLevel,
java.lang.Boolean searchableInTerritory,
java.lang.Boolean searchableAcrossTerritories)

Deprecated.

Since:

UES6-06

UESRoleCreate

@Deprecated

public UESRoleCreate(UESURI metaArtifactUri,
java.lang.String name,
java.lang.String code,
java.lang.String description,
UESURI competentRoleUri,
UESSecurityLevel securityLevel,
java.lang.Boolean searchableInTerritory,
java.lang.Boolean searchableAcrossTerritories,
java.lang.Boolean territorySwitchVisible)

Deprecated.

Since:

UES7-00

UESRoleCreate

@Deprecated

public UESRoleCreate(UESURI metaArtifactUri,
java.lang.String name,
java.lang.String code,
java.lang.String description,
UESURI competentRoleUri,
UESSecurityLevel securityLevel,
java.lang.Boolean searchableInTerritory,
java.lang.Boolean searchableAcrossTerritories,
java.lang.Boolean territorySwitchVisible,
UESURI iconUri)

Deprecated.

Since:

UES7-04

UESRoleCreate

@Deprecated

public UESRoleCreate(UESURI metaArtifactUri,
java.lang.String name,
java.lang.String code,
java.lang.String description,
UESURI competentRoleUri,
UESSecurityLevel securityLevel,
java.lang.Boolean searchableInTerritory,
java.lang.Boolean searchableAcrossTerritories,
java.lang.Boolean territorySwitchVisible,
UESURI iconUri,
java.lang.Boolean grantAllFromOrganizationalUnit)

Deprecated.

Since:

UES7-07

UESRoleCreate

@Deprecated

public UESRoleCreate(UESURI metaArtifactUri,
java.lang.String name,
java.lang.String code,
java.lang.String description,
UESURI competentRoleUri,
UESSecurityLevel securityLevel,
java.lang.Boolean searchableInTerritory,
java.lang.Boolean searchableAcrossTerritories,
java.lang.Boolean territorySwitchVisible,
UESURI iconUri,
java.lang.Boolean grantAllFromOrganizationalUnit,
java.lang.Boolean dryRun)

Deprecated.

Since:

UES8-02

UESRoleCreate

public UESRoleCreate(UESURI metaArtifactUri,
java.lang.String name,
java.lang.String code,
java.lang.String description,
UESURI competentRoleUri,
UESSecurityLevel securityLevel,
java.lang.Boolean searchableInTerritory,
UESURI iconUri,
java.lang.Boolean grantAllFromOrganizationalUnit,
java.lang.Boolean dryRun)

Since:

UES8-04