Package com.redwood.scheduler.api.model

Interface IsolationGroup

All Superinterfaces:

BusinessKeyObject, IsolationGroupComp, NamedRootObject, NamedRootObjectComp, Root, SchedulerEntity, SchedulerEntityComp

public interface IsolationGroup
extends IsolationGroupComp, NamedRootObject, BusinessKeyObject

Isolation groups are used to isolate the view a subject has of the system. Subjects can be assigned to associated with multiple isolation groups, but only operate within a single isolation group at any given time. Partitions can belong to a single isolation group or all of them (as the GLOBAL partition does). An isolation group can contain multiple partitions.

Field Summary

Fields

Modifier and Type	Field	Description
static String	GLOBAL	The name of the GLOBAL IsolationGroup.
static String	OBJECT_TYPE	String that will be returned from SchedulerEntity.getObjectType() for "IsolationGroup" objects.
static String	ROLENAME_ISOLATION_ADMIN	Deprecated. Isolation Group Administrator is no longer used
static String	SEC_PRIV_CREATE	This privilege can be granted at a group level.
static String	SEC_PRIV_DELETE	This privilege can be granted at a group level.
static String	SEC_PRIV_EDIT	This privilege can be granted at a group level.
static String	SEC_PRIV_VIEW	This privilege can be granted at a group level.
static String	SEC_RANK_ALL	This rank is made of the following privileges: create , view , edit , delete
static String	SEC_RANK_CREATE	This rank is made of the following privileges: create
static String	SEC_RANK_DELETE	This rank is made of the following privileges: create , view , delete
static String	SEC_RANK_EDIT	This rank is made of the following privileges: create , view , edit
static String	SEC_RANK_NONE	This rank has no privileges assigned to it.
static String	SEC_RANK_VIEW	This rank is made of the following privileges: view
static QueryObjectType<IsolationGroup>	TYPE	Type that can be used in SchedulerSession.executeObjectQuery(QueryObjectType, String, Object...).
static com.redwood.scheduler.infrastructure.logging.Versions	VERSION_ISOLATIONGROUP

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

COPYRIGHT_MESSAGE_BKO, ID_BKO

Fields inherited from interface com.redwood.scheduler.api.model.compatibility_14.IsolationGroupComp

VERSION_ISOLATIONGROUPCOMP

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

VERSION_NAMEDROOTOBJECT

Fields inherited from interface com.redwood.scheduler.api.model.compatibility_14.NamedRootObjectComp

VERSION_NAMEDROOTOBJECTCOMP

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

VERSION_ROOT

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

ACTION_AUDIT, ACTION_EXPORT, ACTION_READ, BEHAVIOR_DEPRECATED, BEHAVIOR_NONE, BEHAVIOR_SYSTEM, VERSION_SCHEDULERENTITY

Fields inherited from interface com.redwood.scheduler.api.model.compatibility_14.SchedulerEntityComp

VERSION_SCHEDULERENTITYCOMP

Method Summary

Modifier and Type	Method	Description
RequiredPermission	checkCreatePrivilege()	Check whether or not the create action can be performed on this object.
RequiredPermission	checkDeletePrivilege()	Check whether or not the delete action can be performed on this object.
RequiredPermission	checkEditPrivilege()	Check whether or not the edit action can be performed on this object.
RequiredPermission	checkViewPrivilege()	Check whether or not the view action can be performed on this object.
SubjectIsolationGroup	createSubjectIsolationGroup(Subject newSubject)	Create a new SubjectIsolationGroup linked to this object.
RWIterable<Partition>	getPartitions()	Get an RWIterable over an ordered collection of Partitions.
SubjectIsolationGroup	getSubjectIsolationGroupBySubject(Subject subject)	Get the SubjectIsolationGroup by SubjectIsolationGroup.
RWIterable<SubjectIsolationGroup>	getSubjectIsolationGroups()	Get an RWIterable over an ordered collection of SubjectIsolationGroups.

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

getBusinessKey

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

createObjectReference, getComment, getDescription, getLinkedObjectReferenceByLinkedObject, getLinkedObjectReferenceByName, getLinkedObjectReferences, getName, getSearchName, getSourceObjectReferences, isHidden, setComment, setDescription, setName

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

Field Detail

VERSION_ISOLATIONGROUP

static final com.redwood.scheduler.infrastructure.logging.Versions VERSION_ISOLATIONGROUP

OBJECT_TYPE

static final String OBJECT_TYPE

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

See Also:

Constant Field Values

TYPE

static final QueryObjectType<IsolationGroup> TYPE

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

GLOBAL

static final String GLOBAL

The name of the GLOBAL IsolationGroup. Users in this IsolationGroup will not be able to see objects from any other IsolationGroup. This IsolationGroup is automatically assigned if the user has no other IsolationGroup assigned to them by the security subsystem.

See Also:

Constant Field Values

ROLENAME_ISOLATION_ADMIN

@Deprecated
static final String ROLENAME_ISOLATION_ADMIN

Deprecated.

Isolation Group Administrator is no longer used

Role name for the isolation group administrator.

See Also:

Constant Field Values

SEC_PRIV_CREATE

static final String SEC_PRIV_CREATE

This privilege can be granted at a group level.

See Also:

Constant Field Values

SEC_PRIV_VIEW

static final String SEC_PRIV_VIEW

This privilege can be granted at a group level. This privilege can be granted at an instance level.

See Also:

Constant Field Values

SEC_PRIV_EDIT

static final String SEC_PRIV_EDIT

This privilege can be granted at a group level. This privilege can be granted at an instance level.

See Also:

Constant Field Values

SEC_PRIV_DELETE

static final String SEC_PRIV_DELETE

This privilege can be granted at a group level. This privilege can be granted at an instance level.

See Also:

Constant Field Values

SEC_RANK_NONE

static final String SEC_RANK_NONE

This rank has no privileges assigned to it.

See Also:

Constant Field Values

SEC_RANK_CREATE

static final String SEC_RANK_CREATE

This rank is made of the following privileges: create

See Also:

Constant Field Values

SEC_RANK_VIEW

static final String SEC_RANK_VIEW

This rank is made of the following privileges: view

See Also:

Constant Field Values

SEC_RANK_EDIT

static final String SEC_RANK_EDIT

This rank is made of the following privileges: create , view , edit

See Also:

Constant Field Values

SEC_RANK_DELETE

static final String SEC_RANK_DELETE

This rank is made of the following privileges: create , view , delete

See Also:

Constant Field Values

SEC_RANK_ALL

static final String SEC_RANK_ALL

This rank is made of the following privileges: create , view , edit , delete

See Also:

Constant Field Values

Method Detail

getPartitions

RWIterable<Partition> getPartitions()

Get an RWIterable over an ordered collection of Partitions. If the collection is empty, an empty iterator will be returned, that is, this method will never return null. The isolation group that this partition belongs to.

Specified by:

getPartitions in interface IsolationGroupComp

Returns:

An RWIterable over an ordered collection of Partition objects .

getSubjectIsolationGroups

RWIterable<SubjectIsolationGroup> getSubjectIsolationGroups()

Get an RWIterable over an ordered collection of SubjectIsolationGroups. If the collection is empty, an empty iterator will be returned, that is, this method will never return null. The subjects that belong to an isolation-group.

Specified by:

getSubjectIsolationGroups in interface IsolationGroupComp

Returns:

An RWIterable over an ordered collection of SubjectIsolationGroup objects .

createSubjectIsolationGroup

SubjectIsolationGroup createSubjectIsolationGroup(Subject newSubject)

Create a new SubjectIsolationGroup linked to this object.

Parameters:

newSubject - The other parent of the SubjectIsolationGroupSubject association.

Returns:

a new SubjectIsolationGroup.

getSubjectIsolationGroupBySubject

SubjectIsolationGroup getSubjectIsolationGroupBySubject(Subject subject)

Get the SubjectIsolationGroup by SubjectIsolationGroup.

Parameters:

subject -

Returns:

the SubjectIsolationGroup, or null if it could not be found

checkCreatePrivilege

RequiredPermission checkCreatePrivilege()

Check whether or not the create action can be performed on this object.

Returns:

a RequiredPermission instance indicating whether the current user has the privilege. To check this, use isAllowed() on the returned permission.

checkViewPrivilege

RequiredPermission checkViewPrivilege()

Check whether or not the view action can be performed on this object.

Returns:

a RequiredPermission instance indicating whether the current user has the privilege. To check this, use isAllowed() on the returned permission.

checkEditPrivilege

RequiredPermission checkEditPrivilege()

Check whether or not the edit action can be performed on this object.

Returns:

a RequiredPermission instance indicating whether the current user has the privilege. To check this, use isAllowed() on the returned permission.

checkDeletePrivilege

RequiredPermission checkDeletePrivilege()

Check whether or not the delete action can be performed on this object.

Returns:

a RequiredPermission instance indicating whether the current user has the privilege. To check this, use isAllowed() on the returned permission.