com.ibm.bpe.api
Class AdminAuthorizationOptions
- java.lang.Object
com.ibm.bpe.api.AuthorizationOptions
com.ibm.bpe.api.AdminAuthorizationOptions
- 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.
Field Summary
Modifier and Type | Field and Description |
---|---|
|
COPYRIGHT
|
Constructor Summary
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.
|
Method Summary
Modifier and Type | Method and Description |
---|---|
|
getOnBehalfUser()
Returns the user on whose behalf the query is to be executed.
|
|
setOnBehalfUser(java.lang.String onBehalfUser)
Sets the user on whose behalf the query is to be executed.
|
|
toString()
Returns a string representation of the AdminAuthorizationOptions object.
|
Methods inherited from class com.ibm.bpe.api.AuthorizationOptions |
---|
areGroupsUsed, areIndividualsUsed, areInheritedWorkItemsUsed, isEverybodyUsed, setEverybodyUsed, setGroupsUsed, setIndividualsUsed, setInheritedUsed |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail
COPYRIGHT
- public static final java.lang.String COPYRIGHT
Constructor Detail
AdminAuthorizationOptions
- public AdminAuthorizationOptions( )
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.
Method Detail
getOnBehalfUser
- public java.lang.String getOnBehalfUser( )
setOnBehalfUser
- 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.
toString
- public java.lang.String toString( )
toString
in class AuthorizationOptions