Package com.redwood.scheduler.api.model

Interface SubjectRoleGrant

All Superinterfaces:

BusinessKeyObject, Readable, Root, SchedulerEntity, SchedulerEntityComp, SubjectGrant

public interface SubjectRoleGrant
extends SubjectGrant, BusinessKeyObject, Readable

A mapping of which User Subject has granted which Role Subject to which Subject.

Field Summary

Fields

Modifier and Type	Field	Description
static String	OBJECT_TYPE	String that will be returned from SchedulerEntity.getObjectType() for "SubjectRoleGrant" objects.
static String	SEC_RANK_ALL	This rank is made of the following privileges:
static String	SEC_RANK_NONE	This rank has no privileges assigned to it.
static QueryObjectType<SubjectRoleGrant>	TYPE	Type that can be used in SchedulerSession.executeObjectQuery(QueryObjectType, String, Object...).

Fields inherited from interface com.redwood.scheduler.api.model.SchedulerEntity

ACTION_AUDIT, ACTION_EXPORT, ACTION_READ, BEHAVIOR_DEPRECATED, BEHAVIOR_NONE, BEHAVIOR_SYSTEM

Method Summary

Modifier and Type	Method	Description
Subject	getGrantedSubject()	Get the GrantedSubject.
boolean	isGrantable()	Deprecated. This attribute has been deprecated since it was never used.
void	setGrantable(boolean newGrantable)	Deprecated. This attribute has been deprecated since it was never used.
void	setGrantedSubject(Subject newGrantedSubject)	Set the value for GrantedSubject.

Methods inherited from interface com.redwood.scheduler.api.model.BusinessKeyObject

getBusinessKey

Methods inherited from interface com.redwood.scheduler.api.model.Root

getCreationTime, getLastModificationTime, getLastModifierSubject

Methods inherited from interface com.redwood.scheduler.api.model.SchedulerEntity

canPerform, createSubjectObjectPrivilegeGrant, deleteObject, getAuditTrail, getAuditTrailSize, getBehavior, getEffectiveBehavior, getErrorNameEN, getErrorNameKey, getLLPVersion, getLOV, getLOVSupport, getObjectType, getParentSchedulerEntities, getRuntime, getSubjectObjectPrivilegeGrantBySubject, getSubjectObjectPrivilegeGrants, getUniqueId, getUrl, getUrl, isCreated, isDeletable, isDeleted, isModifiable, isModified, isSelectVersioned, processRelatedObjects, processRelatedObjects, processRelatedObjects, refreshObject, resetObject, resetObject, resetValuesToDefault, selectForRead

Methods inherited from interface com.redwood.scheduler.api.model.SubjectGrant

getGranteeSubject, getGrantorSubject, isExportable, setExportable, setGranteeSubject

Field Detail

OBJECT_TYPE

static final String OBJECT_TYPE

String that will be returned from SchedulerEntity.getObjectType() for "SubjectRoleGrant" objects.

See Also:

Constant Field Values

TYPE

static final QueryObjectType<SubjectRoleGrant> TYPE

Type that can be used in SchedulerSession.executeObjectQuery(QueryObjectType, String, Object...).

SEC_RANK_NONE

static final String SEC_RANK_NONE

This rank has no privileges assigned to it.

See Also:

Constant Field Values

SEC_RANK_ALL

static final String SEC_RANK_ALL

This rank is made of the following privileges:

See Also:

Constant Field Values

Method Detail

isGrantable

@Deprecated
boolean isGrantable()

Deprecated.

This attribute has been deprecated since it was never used.

Get the value for Grantable. (Can the assignee subject grant the assigned subject to other assignee subjects?)

Returns:

the field

Throws:

com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.

setGrantable

@Deprecated
void setGrantable(boolean newGrantable)

Deprecated.

This attribute has been deprecated since it was never used.

Set the value for Grantable. (Can the assignee subject grant the assigned subject to other assignee subjects?)

Parameters:

newGrantable - the new value for Grantable.

Throws:

com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.

getGrantedSubject

Subject getGrantedSubject()

Get the GrantedSubject.

Returns:

GrantedSubject

Throws:

com.redwood.scheduler.api.exception.ObjectDeletedException - If this method is called when the object has been marked for deletion.

com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException - If this method is called when the object has been removed from it's session.

setGrantedSubject

void setGrantedSubject(Subject newGrantedSubject)

Set the value for GrantedSubject. This value is mandatory.

Parameters:

newGrantedSubject - is the object to set GrantedSubject to. Which Subject was granted to the Grantee Subject. This Subject must have Grantable==true. If this is null, then the object cannot be persisted.