cz.ues.core.personalrole.dto

Class UESPersonalRoleCreate

java.lang.Object

cz.ues.core.personalrole.dto.UESPersonalRoleCreate

@DTO
public class UESPersonalRoleCreate
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field and Description
private java.lang.String	accessCode1 Access code 1 of the Personal Role.
private java.lang.String	accessCode2 Access code 2 of the Personal Role.
private java.lang.String	avatarUri UESURI or URL of image which represents Personal Role's avatar.
private java.lang.String	code Code of the Personal Role.
private UESURI	competentRoleUri UESURI of the competent role.
private java.lang.Boolean	componentContent Defines whether the primarily displayed content of the Personal Role is component content.
private java.lang.String	description The description of the Personal Role.
private java.lang.String	firstName First name of the user represented by the Personal Role.
private java.lang.Boolean	grantAllFromOrganizationalUnit Deprecated. All From OU will not be used in the new authorization (v4)
private UESURI	iconUri UESURI of the Personal Role icon.
private UESURI	metaArtifactUri UESURI of the Personal Role meta artifact.
private java.lang.Boolean	searchableInTerritory Specifies if it is possible to search the Personal Role within the territory.
private UESSecurityLevel	securityClearance Security clearance of the new Personal Role.
private UESSecurityLevel	securityLevel Security level of the new Personal Role.
private java.lang.String	surname Surname of the user represented by the Personal Role.
private java.lang.String	universeId Universe identifier of the Personal Role.

Constructor Summary

Constructors

Constructor and Description
UESPersonalRoleCreate()
UESPersonalRoleCreate(UESURI metaArtifactUri, java.lang.String code, java.lang.String description, UESURI competentRoleUri, java.lang.String firstName, java.lang.String surname, java.lang.Boolean componentContent, java.lang.Boolean grantAllFromOrganizationalUnit, UESURI iconUri, java.lang.Boolean searchableInTerritory, UESSecurityLevel securityClearance, UESSecurityLevel securityLevel, java.lang.String accessCode1, java.lang.String accessCode2, java.lang.String avatarUri)
UESPersonalRoleCreate(UESURI metaArtifactUri, java.lang.String code, java.lang.String description, UESURI competentRoleUri, java.lang.String firstName, java.lang.String surname, java.lang.Boolean componentContent, java.lang.Boolean grantAllFromOrganizationalUnit, UESURI iconUri, java.lang.Boolean searchableInTerritory, UESSecurityLevel securityClearance, UESSecurityLevel securityLevel, java.lang.String accessCode1, java.lang.String accessCode2, java.lang.String avatarUri, java.lang.String universeId) Full constructor

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getAccessCode1()
java.lang.String	getAccessCode2()
java.lang.String	getAvatarUri()
java.lang.String	getCode()
UESURI	getCompetentRoleUri()
java.lang.Boolean	getComponentContent()
java.lang.String	getDescription()
java.lang.String	getFirstName()
java.lang.Boolean	getGrantAllFromOrganizationalUnit()
UESURI	getIconUri()
UESURI	getMetaArtifactUri()
java.lang.Boolean	getSearchableInTerritory()
UESSecurityLevel	getSecurityClearance()
UESSecurityLevel	getSecurityLevel()
java.lang.String	getSurname()
java.lang.String	getUniverseId()
void	setAccessCode1(java.lang.String accessCode1)
void	setAccessCode2(java.lang.String accessCode2)
void	setAvatarUri(java.lang.String avatarUri)
void	setCode(java.lang.String code)
void	setCompetentRoleUri(UESURI competentRoleUri)
void	setComponentContent(java.lang.Boolean componentContent)
void	setDescription(java.lang.String description)
void	setFirstName(java.lang.String firstName)
void	setGrantAllFromOrganizationalUnit(java.lang.Boolean grantAllFromOrganizationalUnit)
void	setIconUri(UESURI iconUri)
void	setMetaArtifactUri(UESURI metaArtifactUri)
void	setSearchableInTerritory(java.lang.Boolean searchableInTerritory)
void	setSecurityClearance(UESSecurityLevel securityClearance)
void	setSecurityLevel(UESSecurityLevel securityLevel)
void	setSurname(java.lang.String surname)
void	setUniverseId(java.lang.String universeId)

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 Personal Role meta artifact. If the meta artifact is not specified or the user is not authorized to create a Personal Role according to the selected meta artifact, the command fails. Must not be nil.

Since:

UES8-23

code

private code

Code of the Personal Role. The code must be unique in the given territory, otherwise the command fails. When nil is set, the code will be set according to the generated Universe ID.

Since:

UES8-23

description

private description

The description of the Personal Role.

Since:

UES8-23

universeId

private universeId

Universe identifier of the Personal Role. When null is set, universe identifier will be generated.

Since:

UES8-23

competentRoleUri

private competentRoleUri

UESURI of the competent role. When nil is set, the executive role from authorization is used. If no role is authorized to create a Personal Role into the selected location, the command fails. If the selected role does not have connected an interface with the selected meta artifact, the command fails. If the selected role does not belong to the same organizational unit as the relocated Personal Role or to a superior organizational unit, the command fails.

Since:

UES8-23

firstName

private firstName

First name of the user represented by the Personal Role. When nil is set, the first name will be set according to the generated Universe ID.

Since:

UES8-23

surname

private surname

Surname of the user represented by the Personal Role. When nil is set, the surname will be set to "uuPerson".

Since:

UES8-23

componentContent

private componentContent

Defines whether the primarily displayed content of the Personal Role is component content. The default value is obtained from the meta artifact.

Since:

UES8-23

grantAllFromOrganizationalUnit

@Deprecated

private grantAllFromOrganizationalUnit

Deprecated. All From OU will not be used in the new authorization (v4)

Deprecated. Specifies if the Personal Role will be included among All roles from organizational unit. When nil is set, the value will be automatically set to true.

Since:

UES8-23

iconUri

private iconUri

UESURI of the Personal Role icon. When nil is set, the Personal Role uses the default icon from the meta artifact. Allowed format of icon URI: 'ues:#{system}:#{ues_v5.core_v1.codetable_v1.base_v1.CodeTable_Icons}:#{CODE_OF_ICON}'. An example of icon URI: 'ues:#{system}:#{ues_v5.core_v1.codetable_v1.base_v1.CodeTable_Icons}:#{ART_077}'.

Since:

UES8-23

searchableInTerritory

private searchableInTerritory

Specifies if it is possible to search the Personal Role within the territory. When nil is set, the default value from meta artifact is used.

Since:

UES8-23

securityClearance

private securityClearance

Security clearance of the new Personal Role. When nil is set, the value NO_CONFIDENTIALITY is used.

Since:

UES8-23

securityLevel

private securityLevel

Security level of the new Personal Role. When nil is set, security level is taken from the meta artifact. If the default security level is higher than the user security clearance, the command fails.

Since:

UES8-23

accessCode1

private accessCode1

Access code 1 of the Personal Role. The access code 1 must be unique in the Universe, otherwise the command fails. When nil is set, a random code will be generated.

Since:

UES8-23

accessCode2

private accessCode2

Access code 2 of the Personal Role. When nil is set, a random code will be generated.

Since:

UES8-23

avatarUri

private avatarUri

UESURI or URL of image which represents Personal Role's avatar. If set to an empty string or nil, the Personal Role will be created without avatar.

Since:

UES8-23

Constructor Detail

UESPersonalRoleCreate

public UESPersonalRoleCreate()

UESPersonalRoleCreate

public UESPersonalRoleCreate(UESURI metaArtifactUri,
java.lang.String code,
java.lang.String description,
UESURI competentRoleUri,
java.lang.String firstName,
java.lang.String surname,
java.lang.Boolean componentContent,
java.lang.Boolean grantAllFromOrganizationalUnit,
UESURI iconUri,
java.lang.Boolean searchableInTerritory,
UESSecurityLevel securityClearance,
UESSecurityLevel securityLevel,
java.lang.String accessCode1,
java.lang.String accessCode2,
java.lang.String avatarUri,
java.lang.String universeId)

Full constructor

Since:

UES8-25

UESPersonalRoleCreate

public UESPersonalRoleCreate(UESURI metaArtifactUri,
java.lang.String code,
java.lang.String description,
UESURI competentRoleUri,
java.lang.String firstName,
java.lang.String surname,
java.lang.Boolean componentContent,
java.lang.Boolean grantAllFromOrganizationalUnit,
UESURI iconUri,
java.lang.Boolean searchableInTerritory,
UESSecurityLevel securityClearance,
UESSecurityLevel securityLevel,
java.lang.String accessCode1,
java.lang.String accessCode2,
java.lang.String avatarUri)

Method Detail

getMetaArtifactUri

public UESURI getMetaArtifactUri()

setMetaArtifactUri

public void setMetaArtifactUri(UESURI metaArtifactUri)

getCode

public java.lang.String getCode()

setCode

public void setCode(java.lang.String code)

getDescription

public java.lang.String getDescription()

setDescription

public void setDescription(java.lang.String description)

getCompetentRoleUri

public UESURI getCompetentRoleUri()

setCompetentRoleUri

public void setCompetentRoleUri(UESURI competentRoleUri)

getFirstName

public java.lang.String getFirstName()

setFirstName

public void setFirstName(java.lang.String firstName)

getSurname

public java.lang.String getSurname()

setSurname

public void setSurname(java.lang.String surname)

getGrantAllFromOrganizationalUnit

public java.lang.Boolean getGrantAllFromOrganizationalUnit()

setGrantAllFromOrganizationalUnit

public void setGrantAllFromOrganizationalUnit(java.lang.Boolean grantAllFromOrganizationalUnit)

getIconUri

public UESURI getIconUri()

setIconUri

public void setIconUri(UESURI iconUri)

getSearchableInTerritory

public java.lang.Boolean getSearchableInTerritory()

setSearchableInTerritory

public void setSearchableInTerritory(java.lang.Boolean searchableInTerritory)

getSecurityClearance

public UESSecurityLevel getSecurityClearance()

setSecurityClearance

public void setSecurityClearance(UESSecurityLevel securityClearance)

getSecurityLevel

public UESSecurityLevel getSecurityLevel()

setSecurityLevel

public void setSecurityLevel(UESSecurityLevel securityLevel)

getAccessCode1

public java.lang.String getAccessCode1()

setAccessCode1

public void setAccessCode1(java.lang.String accessCode1)

getAccessCode2

public java.lang.String getAccessCode2()

setAccessCode2

public void setAccessCode2(java.lang.String accessCode2)

getAvatarUri

public java.lang.String getAvatarUri()

setAvatarUri

public void setAvatarUri(java.lang.String avatarUri)

getComponentContent

public java.lang.Boolean getComponentContent()

setComponentContent

public void setComponentContent(java.lang.Boolean componentContent)

getUniverseId

public java.lang.String getUniverseId()

setUniverseId

public void setUniverseId(java.lang.String universeId)