public final class AdminAuthorizationOptions extends AuthorizationOptions implements java.io.Serializable
Only a system administrator or system monitor can specify these options. They must be specified when the query is run on predefined query tables. When the query is run on composite query tables and the primary view contains template data, administrative options must be specified if role-based authorization is required.
When specified for a predefined query table that contains instance data or for a composite query table with a primary view that contains instance data, then all data contained in the query table is returned.
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
COPYRIGHT |
Constructor and Description |
---|
AdminAuthorizationOptions()
Default constructor to initialize the admin authorization options.
|
AdminAuthorizationOptions(java.lang.String onBehalfUser)
Constructor that builds an admin authorization option from the passed values.
|
Modifier and Type | Method and Description |
---|---|
java.lang.String |
getOnBehalfUser()
Returns the user on whose behalf the query is to be executed.
|
void |
setOnBehalfUser(java.lang.String onBehalfUser)
Sets the user on whose behalf the query is to be executed.
|
java.lang.String |
toString()
Returns a string representation of the AdminAuthorizationOptions object.
|
areGroupsUsed, areIndividualsUsed, areInheritedWorkItemsUsed, isEverybodyUsed, setEverybodyUsed, setGroupsUsed, setIndividualsUsed, setInheritedUsed
public static final java.lang.String COPYRIGHT
public AdminAuthorizationOptions()
public AdminAuthorizationOptions(java.lang.String onBehalfUser)
onBehalfUser
- The user the query is to be executed for.
If no user is specified, a query is executed as administrator.
Note that this value overwrites the $USER system variable which may be specified in filters and selection criteria.
public java.lang.String getOnBehalfUser()
public void setOnBehalfUser(java.lang.String onBehalfUser)
onBehalfUser
- The user the query is to be executed for.
If no user is specified, a query is executed as administrator.
Note that this value overwrites the $USER system variable which may be specified in filters and selection criteria.
public java.lang.String toString()
toString
in class AuthorizationOptions