cz.ues.core.role.dto

Class UESCastSetAttributes

java.lang.Object

cz.ues.core.role.dto.UESCastSetAttributes

@DTO
public class UESCastSetAttributes
extends java.lang.Object

DTO for command UESCast.setAttributes(UESURI, UESCastSetAttributes).

Since:

UES6-10

Field Summary

Fields

Modifier and Type	Field and Description
private UESURI	castedSubjectUri UESURI of the subject (role or group) which is casted to the subject identified by the command main entity.
private java.lang.Object	dateTo The date when the cast will be automatically set to the UESCastState.PASSIVE state.
private UESCastLevel	level The level of the cast.
private java.lang.Boolean	primary Specifies whether the cast will be the primary cast to the role.
private UESCastState	state Deprecated. Since UES8-20.
private java.lang.Boolean	visible Specifies whether the cast is visible in Show Casts use case.

Constructor Summary

Constructors

Constructor and Description
UESCastSetAttributes(UESURI castedSubjectUri, UESCastLevel level, java.lang.Boolean primary, UESCastState state, java.lang.Object dateTo) Creates a new instance of UESCastSetAttributes.
UESCastSetAttributes(UESURI castedSubjectUri, UESCastLevel level, java.lang.Boolean primary, UESCastState state, java.lang.Object dateTo, java.lang.Boolean visible) Creates a new instance of UESCastSetAttributes.

Method Summary

Methods inherited from class java.lang.Object

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

Field Detail

castedSubjectUri

private castedSubjectUri

UESURI of the subject (role or group) which is casted to the subject identified by the command main entity. Cannot be null.

Since:

UES6-10

level

private level

The level of the cast. The attribute cannot be set at the same time as the #executive attribute. If the level is changed, the value of the #executive attribute will be changed as well (true for the EXECUTIVE level, false for the ASSISTENCE or GUEST level).

Since:

UES6-10

primary

private primary

Specifies whether the cast will be the primary cast to the role. Applicable only when the subjectUri (main entity) is a role. If set to true, the cast must be UESCastSetAttributes.visible in ACTIVE UESCastSetAttributes.state and EXECUTIVE UESCastSetAttributes.level. If the cast is primary and it is set to false, another cast (the oldest UESCastSetAttributes.visible cast in ACTIVE UESCastSetAttributes.state and EXECUTIVE UESCastSetAttributes.level) to the subjectUri (main entity) will become the primary cast. If set to null, the primary cast will not be changed.

Since:

UES6-10

dateTo

private dateTo

The date when the cast will be automatically set to the UESCastState.PASSIVE state. If the subject is a Role and the cast is the primary cast to the Role, then there must be either another UESCastState.ACTIVE visible cast with ASSISTENCE level to the Role which will become the UESCastSetAttributes.primary cast, or no cast at all; otherwise the cast state will not be changed. If set to an empty string, the date will be erased. If set to null, the value will not be modified.

Since:

UES6-10

state

@Deprecated

private state

Deprecated. Since UES8-20.

Deprecated. In territories with cast strategies of 2 or higher, all casts are either ACTIVE or they do not exist at all, so if you set a cast into a PASSIVE state, the cast will be permanently deleted. In territories with a cast strategy of 1 or lower, PASSIVE casts are just ignored while only ACTIVE casts are used in cast calculations.

Since:

UES6-10

visible

private visible

Specifies whether the cast is visible in Show Casts use case. If set to null, the value will not be modified. If set to false, the cast must not be set as UESCastSetAttributes.primary.

Since:

UES8-12

Constructor Detail

UESCastSetAttributes

public UESCastSetAttributes(UESURI castedSubjectUri,
UESCastLevel level,
java.lang.Boolean primary,
UESCastState state,
java.lang.Object dateTo)

Creates a new instance of UESCastSetAttributes.

Since:

UES6-10

UESCastSetAttributes

public UESCastSetAttributes(UESURI castedSubjectUri,
UESCastLevel level,
java.lang.Boolean primary,
UESCastState state,
java.lang.Object dateTo,
java.lang.Boolean visible)

Creates a new instance of UESCastSetAttributes.

Since:

UES8-12