cz.ues.core.role

Interface UESCast

@UESService
public interface UESCast

Since:

UES6-10

Method Summary

Methods

Modifier and Type	Method and Description
void	create(UESURI subjectUri, UESCastCreate cast) Casts a subject (role or group) to another subject (role or group).
void	delete(UESURI subjectUri, UESCastDelete subject) This command deletes the cast from the system.
java.lang.Boolean	exists(UESURI subjectUri, UESCastExists cast) This command checks the direct cast existence of an castedSubjectUri in subjectUri.
UESResultList<UESCastAccessRoleAttributes,UESCastGetAccessRoleCastList>	getAccessRoleCastList(UESURI subjectUri, UESCastGetAccessRoleCastList criteria) Returns list of access roles (personal access roles and uuEEs) casted directly or indirectly to the specified subject (role or group).
UESCastAttributes	getAttributes(UESURI subjectUri, UESCastGetAttributes subject) This command returns attributes of one cast.
UESResultList<UESCastAttributes,UESCastGetCastList>	getCastList(UESURI subjectUri, UESCastGetCastList criteria) The command returns casts to the specified subject (role or group).
void	setAttributes(UESURI subjectUri, UESCastSetAttributes cast) Sets basic attributes of the cast.

Method Detail

create

@UESAudit(propagation=SKIP, useCaseType=COMMAND) @UESCommand(stereotype=CREATE)

void create(UESURI subjectUri,
UESCastCreate cast)
throws UESCastRTException

Casts a subject (role or group) to another subject (role or group). Only roles and groups from the same territory are supported at the moment (therefore it is not possible to cast across territories and form pseudo business access role relation at the moment). Cast is not an entity, it is a relation between 2 subjects (and these 2 subjects identify the relation).

Note that only some combinations of subjects in a cast relation are permitted:

	casted subject (castedSubjectUri DTO parameter type) ROLE GROUP ACCESS ROLE
the subject to which the subject from DTO is casted (main entity type) ROLE GROUP ACCESS ROLE	YES NO YES YES YES YES NO NO NO

Parameters:

subjectUri - UESURI of the subject into which another subject is casted

cast - DTO containing attributes of the cast

Throws:

UESCastRTException

Since:

UES6-10

getAttributes

@UESCommand(stereotype=READ)

UESCastAttributes getAttributes(UESURI subjectUri,
UESCastGetAttributes subject)
throws UESCastRTException

This command returns attributes of one cast. Cast is identified by 2 subjects. The main entity (a subject to which the other is casted) and parameter castedSubjectUri in the DTO (the casted subject).

Parameters:

subject - Uri UESURI of the subject to which the other is casted

subject - DTO containing ues uri of the casted subject

Returns:

DTO containing the cast attributes

Throws:

UESCastRTException

Since:

UES6-10

getCastList

@UESCommand(stereotype=READ)

UESResultList<UESCastAttributes,UESCastGetCastList> getCastList(UESURI subjectUri,
UESCastGetCastList criteria)
throws UESCastRTException

The command returns casts to the specified subject (role or group). The list of returned casts can be filtered by the name and code of casted subjects, by the cast level, by the primary cast flag, by the cast state, by the date of creation of the cast and by the cast direction. The list is sorted by the date of creation of a cast by default and due to backwards compatibility are returned only casts with UESCastDirection.IN by default, or it can be sorted arbitrarily by any of cast attributes usable for the filtering or these attributes combinations.

Parameters:

subjectUri - UESURI of the subject to which the casts are listed.

criteria - DTO containing criteria for listing casts. Available parameters are: castedSubjectName, castedSubjectCode, dateFrom , state : UESCastState, level : UESCastLevel, primary, castDirection.

Returns:

List of DTO representing casts to the subjectUri

Throws:

UESCastRTException

Since:

UES6-10

See Also:

UESQuery Documentation.

getAccessRoleCastList

@UESCommand(stereotype=READ)

UESResultList<UESCastAccessRoleAttributes,UESCastGetAccessRoleCastList> getAccessRoleCastList(UESURI subjectUri,
UESCastGetAccessRoleCastList criteria)
throws UESCastRTException

Returns list of access roles (personal access roles and uuEEs) casted directly or indirectly to the specified subject (role or group). The list is sorted by the casted subject name and subsequently by casted subject code by default.

Parameters:

subjectUri - UESURI of the subject into which the personal access roles are casted.

criteria - Object containing paging and filtering criteria. Available parameters are: castedSubjectName and castedSubjectCode.

Returns:

List of access roles casted to the specified subject. Contains instances of UESAccessRoleCastAttributes.

Throws:

UESCastRTException

Since:

UES8-07

See Also:

UESQuery Documentation.

setAttributes

@UESAudit(propagation=SKIP, useCaseType=COMMAND) @UESCommand(stereotype=UPDATE)

void setAttributes(UESURI subjectUri,
UESCastSetAttributes cast)
throws UESCastRTException

Sets basic attributes of the cast. Cast is not an entity, it is a relation between 2 subjects (and these 2 subjects identify the relation).

Parameters:

subjectUri - UESURI of the subject into which another subject is casted

cast - DTO containing attributes of the cast

Throws:

UESCastRTException

Since:

UES6-10

delete

@UESAudit(propagation=SKIP, useCaseType=COMMAND) @UESCommand(stereotype=DELETE)

void delete(UESURI subjectUri,
UESCastDelete subject)
throws UESCastRTException

This command deletes the cast from the system. Any change of user authorization resulting from the cast modification will take effect approximately after 15 minutes. The last active executive cast cannot be deleted when this role has an active assistence or guest cast (active casts of these types cannot exist without at least one active executive cast). The last active executive cast for this role cannot be deleted when the role is competent for at least one artifact (a role without an active cast cannot be competent for any artifacts).

Parameters:

subjectUri - UESURI of the subject to which the other is casted.

subject - DTO containing UESURI of the casted subject.

Throws:

UESCastRTException

Since:

UES6-10

exists

@UESAudit(propagation=SKIP, useCaseType=COMMAND) @UESCommand(stereotype=READ)

java.lang.Boolean exists(UESURI subjectUri,
UESCastExists cast)
throws UESCastRTException

This command checks the direct cast existence of an castedSubjectUri in subjectUri. If subjectUri contains UESURI of an access role it is possible to use parameter recursive to check the indirect cast existence.

Parameters:

subjectUri - UESURI of the subject to which the other is casted.

cast - DTO containing cast exists parameters.

Returns:

true if castedSubjectUri is casted in subjectUri.

Throws:

UESCastRTException