All Superinterfaces:

BusinessKeyObject, GlobalPrivilegeComp, NamedRootObject, NamedRootObjectComp, Root, SchedulerEntity, SchedulerEntityComp
```
public interface GlobalPrivilege
extends GlobalPrivilegeComp, NamedRootObject, BusinessKeyObject
```
Global security privileges.

Field Summary

Fields
Modifier and Type	Field	Description
`static String`	`OBJECT_TYPE`	String that will be returned from `SchedulerEntity.getObjectType()` for "GlobalPrivilege" objects.
`static String`	`PRIVILEGE_ALLOW_RUN_NOW`	Name of the privilege that allows user to run the process immediately.
`static String`	`PRIVILEGE_APP_ADMINISTRATOR`	Name of the privilege that allows a user to install signed apps.
`static String`	`PRIVILEGE_ARCHIVER_MANAGER`	Name of the privilege for managing archiver processes.
`static String`	`PRIVILEGE_CHANGE_OWNER`	Name of the privilege to change the owner using the setOwner operation.
`static String`	`PRIVILEGE_CONFIGURE_HOUSEKEEPING_DASHBOARD`	Name of the privilege to configure the housekeeping dashboard.
`static String`	`PRIVILEGE_CONFIGURE_MONITORING_DASHBOARD`	Name of the privilege to configure the monitoring dashboard.
`static String`	`PRIVILEGE_CONFIGURE_NETWORK`	Name of the privilege for configuring network settings.
`static String`	`PRIVILEGE_CONFIGURE_PLATFORM`	Name of the privilege for configuring platform settings.
`static String`	`PRIVILEGE_CONFIGURE_PUBLISHED_WEBSERVICES`	Name of the privilege for configuring published webservices.
`static String`	`PRIVILEGE_CONFIGURE_SCHEDULER`	Name of the privilege for configuring system-level scheduler settings.
`static String`	`PRIVILEGE_DEFAULT_NAVIGATION_BAR`	Name of the privilege for access to the default navigation bar.
`static String`	`PRIVILEGE_EXTERNALLY_AVAILABLE_CREDENTIAL`	Name of the privilege to change the Externally Modified attribute on Credentials.
`static String`	`PRIVILEGE_HOUSEKEEPING_DASHBOARD`	Name of the privilege to access the housekeeping dashboard.
`static String`	`PRIVILEGE_JOB_DEFINITION_PARAMETERS`	Name of the privilege for access to job definition parameters.
`static String`	`PRIVILEGE_LICENSE_MANAGEMENT`	Name of the privilege for access to license management.
`static String`	`PRIVILEGE_MONITORING_DASHBOARD`	Name of the privilege to access the monitoring dashboard.
`static String`	`PRIVILEGE_OBJECTSEARCH`	Name of the privilege to access Object Search.
`static String`	`PRIVILEGE_PLSQL_SET_ANY_USER`	Name of the privilege for calling jcs.setuser/jcs.use_known_password for another user (and impersonate this user) via the PL/SQL API.
`static String`	`PRIVILEGE_PORTAL_ADMINISTRATION`	Name of the privilege to enable the performance of administrative tasks on the support portal.
`static String`	`PRIVILEGE_REDWOOD_SCRIPT`	Name of the privilege for access to RedwoodScript.
`static String`	`PRIVILEGE_REPLY_ALL_EQUIVALENT_TYPE`	Name of the privilege for replying all equivalent type for operator messages.
`static String`	`PRIVILEGE_SHELL`	Name of the privilege for access to the browser-based shell.
`static String`	`PRIVILEGE_SUPPORT_FILES_GET`	Name of the privilege to enable the retrieval of support files.
`static String`	`PRIVILEGE_SYSTEM_DYNAMIC_TRACE`	Name of the privilege for 'submit' privilege rank on the System_DynamicTrace job.
`static String`	`PRIVILEGE_SYSTEM_SUPPORT`	Name of the privilege to access the system support utilities.
`static String`	`PRIVILEGE_USER_ADMINISTRATION`	Name of the privilege to enable the administration of users and roles.
`static String`	`PRIVILEGE_USER_VOICE`	Name of the privilege to enable Redwood Customer Voice (User Voice).
`static String`	`SEC_PRIV_CHANGEACTIVATION`	This privilege can be granted at a group level.
`static String`	`SEC_RANK_ALL`	This rank is made of the following privileges: changeActivation
`static String`	`SEC_RANK_NONE`	This rank has no privileges assigned to it.
`static QueryObjectType<GlobalPrivilege>`	`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

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`RequiredPermission`	`checkChangeActivationPrivilege()`	Check whether or not the changeActivation action can be performed on this object.
`SubjectGlobalPrivilegeGrant`	`getSubjectGlobalPrivilegeGrantByGranteeSubject(Subject granteeSubject)`	Get the SubjectGlobalPrivilegeGrant by SubjectGlobalPrivilegeLevelGrant.
`RWIterable<SubjectGlobalPrivilegeGrant>`	`getSubjectGlobalPrivilegeGrants()`	Get an `RWIterable` over an ordered collection of `SubjectGlobalPrivilegeGrants`.
`boolean`	`isActivated()`	Get the value for Activated.
`void`	`setActivated(boolean newActivated)`	Set the value for Activated.

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

- Field Detail
  - OBJECT_TYPE
```
static final String OBJECT_TYPE
```
    String that will be returned from SchedulerEntity.getObjectType() for "GlobalPrivilege" objects.
    
    See Also:
    
    Constant Field Values
  - TYPE
```
static final QueryObjectType<GlobalPrivilege> TYPE
```
    Type that can be used in SchedulerSession.executeObjectQuery(QueryObjectType, String, Object...).
  - PRIVILEGE_SHELL
```
static final String PRIVILEGE_SHELL
```
    Name of the privilege for access to the browser-based shell.
    
    See Also:
    
    Constant Field Values
  - PRIVILEGE_PLSQL_SET_ANY_USER
```
static final String PRIVILEGE_PLSQL_SET_ANY_USER
```
    Name of the privilege for calling jcs.setuser/jcs.use_known_password for another user (and impersonate this user) via the PL/SQL API.
    
    See Also:
    
    Constant Field Values
  - PRIVILEGE_CONFIGURE_NETWORK
```
static final String PRIVILEGE_CONFIGURE_NETWORK
```
    Name of the privilege for configuring network settings.
    
    See Also:
    
    Constant Field Values
  - PRIVILEGE_CONFIGURE_PLATFORM
```
static final String PRIVILEGE_CONFIGURE_PLATFORM
```
    Name of the privilege for configuring platform settings. These settings usually require access to the underlying application server or operating system.
    
    See Also:
    
    Constant Field Values
  - PRIVILEGE_CONFIGURE_SCHEDULER
```
static final String PRIVILEGE_CONFIGURE_SCHEDULER
```
    Name of the privilege for configuring system-level scheduler settings.
    
    See Also:
    
    Constant Field Values
  - PRIVILEGE_DEFAULT_NAVIGATION_BAR
```
static final String PRIVILEGE_DEFAULT_NAVIGATION_BAR
```
    Name of the privilege for access to the default navigation bar.
    
    See Also:
    
    Constant Field Values
  - PRIVILEGE_JOB_DEFINITION_PARAMETERS
```
static final String PRIVILEGE_JOB_DEFINITION_PARAMETERS
```
    Name of the privilege for access to job definition parameters.
    
    See Also:
    
    Constant Field Values
  - PRIVILEGE_LICENSE_MANAGEMENT
```
static final String PRIVILEGE_LICENSE_MANAGEMENT
```
    Name of the privilege for access to license management.
    
    See Also:
    
    Constant Field Values
  - PRIVILEGE_HOUSEKEEPING_DASHBOARD
```
static final String PRIVILEGE_HOUSEKEEPING_DASHBOARD
```
    Name of the privilege to access the housekeeping dashboard.
    
    See Also:
    
    Constant Field Values
  - PRIVILEGE_CONFIGURE_HOUSEKEEPING_DASHBOARD
```
static final String PRIVILEGE_CONFIGURE_HOUSEKEEPING_DASHBOARD
```
    Name of the privilege to configure the housekeeping dashboard.
    
    See Also:
    
    Constant Field Values
  - PRIVILEGE_MONITORING_DASHBOARD
```
static final String PRIVILEGE_MONITORING_DASHBOARD
```
    Name of the privilege to access the monitoring dashboard.
    
    See Also:
    
    Constant Field Values
  - PRIVILEGE_CONFIGURE_MONITORING_DASHBOARD
```
static final String PRIVILEGE_CONFIGURE_MONITORING_DASHBOARD
```
    Name of the privilege to configure the monitoring dashboard.
    
    See Also:
    
    Constant Field Values
  - PRIVILEGE_CONFIGURE_PUBLISHED_WEBSERVICES
```
static final String PRIVILEGE_CONFIGURE_PUBLISHED_WEBSERVICES
```
    Name of the privilege for configuring published webservices.
    
    See Also:
    
    Constant Field Values
  - PRIVILEGE_REDWOOD_SCRIPT
```
static final String PRIVILEGE_REDWOOD_SCRIPT
```
    Name of the privilege for access to RedwoodScript.
    
    See Also:
    
    Constant Field Values
  - PRIVILEGE_SYSTEM_DYNAMIC_TRACE
```
static final String PRIVILEGE_SYSTEM_DYNAMIC_TRACE
```
    Name of the privilege for 'submit' privilege rank on the System_DynamicTrace job.
    
    See Also:
    
    Constant Field Values
  - PRIVILEGE_SYSTEM_SUPPORT
```
static final String PRIVILEGE_SYSTEM_SUPPORT
```
    Name of the privilege to access the system support utilities.
    
    See Also:
    
    Constant Field Values
  - PRIVILEGE_SUPPORT_FILES_GET
```
static final String PRIVILEGE_SUPPORT_FILES_GET
```
    Name of the privilege to enable the retrieval of support files.
    
    See Also:
    
    Constant Field Values
  - PRIVILEGE_PORTAL_ADMINISTRATION
```
static final String PRIVILEGE_PORTAL_ADMINISTRATION
```
    Name of the privilege to enable the performance of administrative tasks on the support portal.
    
    See Also:
    
    Constant Field Values
  - PRIVILEGE_USER_ADMINISTRATION
```
static final String PRIVILEGE_USER_ADMINISTRATION
```
    Name of the privilege to enable the administration of users and roles.
    
    See Also:
    
    Constant Field Values
  - PRIVILEGE_USER_VOICE
```
static final String PRIVILEGE_USER_VOICE
```
    Name of the privilege to enable Redwood Customer Voice (User Voice).
    
    See Also:
    
    Constant Field Values
  - PRIVILEGE_APP_ADMINISTRATOR
```
static final String PRIVILEGE_APP_ADMINISTRATOR
```
    Name of the privilege that allows a user to install signed apps.
    
    See Also:
    
    Constant Field Values
  - PRIVILEGE_EXTERNALLY_AVAILABLE_CREDENTIAL
```
static final String PRIVILEGE_EXTERNALLY_AVAILABLE_CREDENTIAL
```
    Name of the privilege to change the Externally Modified attribute on Credentials.
    
    See Also:
    
    Constant Field Values
  - PRIVILEGE_OBJECTSEARCH
```
static final String PRIVILEGE_OBJECTSEARCH
```
    Name of the privilege to access Object Search.
    
    See Also:
    
    Constant Field Values
  - PRIVILEGE_CHANGE_OWNER
```
static final String PRIVILEGE_CHANGE_OWNER
```
    Name of the privilege to change the owner using the setOwner operation.
    
    See Also:
    
    Constant Field Values
  - PRIVILEGE_REPLY_ALL_EQUIVALENT_TYPE
```
static final String PRIVILEGE_REPLY_ALL_EQUIVALENT_TYPE
```
    Name of the privilege for replying all equivalent type for operator messages.
    
    See Also:
    
    Constant Field Values
  - PRIVILEGE_ARCHIVER_MANAGER
```
static final String PRIVILEGE_ARCHIVER_MANAGER
```
    Name of the privilege for managing archiver processes.
    
    See Also:
    
    Constant Field Values
  - PRIVILEGE_ALLOW_RUN_NOW
```
static final String PRIVILEGE_ALLOW_RUN_NOW
```
    Name of the privilege that allows user to run the process immediately.
    
    See Also:
    
    Constant Field Values
  - SEC_PRIV_CHANGEACTIVATION
```
static final String SEC_PRIV_CHANGEACTIVATION
```
    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_ALL
```
static final String SEC_RANK_ALL
```
    This rank is made of the following privileges: changeActivation
    
    See Also:
    
    Constant Field Values
- Method Detail
  - isActivated
```
boolean isActivated()
```
    Get the value for Activated. (Everyone has global privileges that are not activated (activated = false). Once activated, users that want to use a feature governed by the privilege must have it granted to one of their roles.)
    
    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.
  - setActivated
```
void setActivated(boolean newActivated)
```
    Set the value for Activated. (Everyone has global privileges that are not activated (activated = false). Once activated, users that want to use a feature governed by the privilege must have it granted to one of their roles.)
    
    Parameters:
    
    newActivated - the new value for Activated.
    
    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.
  - getSubjectGlobalPrivilegeGrants
```
RWIterable<SubjectGlobalPrivilegeGrant> getSubjectGlobalPrivilegeGrants()
```
    Get an RWIterable over an ordered collection of SubjectGlobalPrivilegeGrants. If the collection is empty, an empty iterator will be returned, that is, this method will never return null. Grant a global privilege to a subject.
    
    Specified by:
    
    getSubjectGlobalPrivilegeGrants in interface GlobalPrivilegeComp
    
    Returns:
    
    An RWIterable over an ordered collection of SubjectGlobalPrivilegeGrant objects .
  - getSubjectGlobalPrivilegeGrantByGranteeSubject
```
SubjectGlobalPrivilegeGrant getSubjectGlobalPrivilegeGrantByGranteeSubject(Subject granteeSubject)
```
    Get the SubjectGlobalPrivilegeGrant by SubjectGlobalPrivilegeLevelGrant.
    
    Parameters:
    
    granteeSubject -
    
    Returns:
    
    the SubjectGlobalPrivilegeGrant, or null if it could not be found
  - checkChangeActivationPrivilege
```
RequiredPermission checkChangeActivationPrivilege()
```
    Check whether or not the changeActivation 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.

Interface GlobalPrivilege

Field Summary

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

Method Summary

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

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

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

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

Field Detail

OBJECT_TYPE

TYPE

PRIVILEGE_SHELL

PRIVILEGE_PLSQL_SET_ANY_USER

PRIVILEGE_CONFIGURE_NETWORK

PRIVILEGE_CONFIGURE_PLATFORM

PRIVILEGE_CONFIGURE_SCHEDULER

PRIVILEGE_DEFAULT_NAVIGATION_BAR

PRIVILEGE_JOB_DEFINITION_PARAMETERS

PRIVILEGE_LICENSE_MANAGEMENT

PRIVILEGE_HOUSEKEEPING_DASHBOARD

PRIVILEGE_CONFIGURE_HOUSEKEEPING_DASHBOARD

PRIVILEGE_MONITORING_DASHBOARD

PRIVILEGE_CONFIGURE_MONITORING_DASHBOARD

PRIVILEGE_CONFIGURE_PUBLISHED_WEBSERVICES

PRIVILEGE_REDWOOD_SCRIPT

PRIVILEGE_SYSTEM_DYNAMIC_TRACE

PRIVILEGE_SYSTEM_SUPPORT

PRIVILEGE_SUPPORT_FILES_GET

PRIVILEGE_PORTAL_ADMINISTRATION

PRIVILEGE_USER_ADMINISTRATION

PRIVILEGE_USER_VOICE

PRIVILEGE_APP_ADMINISTRATOR

PRIVILEGE_EXTERNALLY_AVAILABLE_CREDENTIAL

PRIVILEGE_OBJECTSEARCH

PRIVILEGE_CHANGE_OWNER

PRIVILEGE_REPLY_ALL_EQUIVALENT_TYPE

PRIVILEGE_ARCHIVER_MANAGER

PRIVILEGE_ALLOW_RUN_NOW

SEC_PRIV_CHANGEACTIVATION

SEC_RANK_NONE

SEC_RANK_ALL

Method Detail

isActivated

setActivated

getSubjectGlobalPrivilegeGrants

getSubjectGlobalPrivilegeGrantByGranteeSubject

checkChangeActivationPrivilege