|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.ibm.task.api.AuthorizationOptions
com.ibm.task.api.AdminAuthorizationOptions
public final class AdminAuthorizationOptions
Describes administrative authorizations options for a query that uses a predefined or composite query table. They are ignored for supplemental query tables.
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 | |
---|---|
static java.lang.String |
COPYRIGHT
|
Constructor Summary | |
---|---|
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 | |
---|---|
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. |
Methods inherited from class com.ibm.task.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 |
---|
public static final java.lang.String COPYRIGHT
Constructor Detail |
---|
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.
Method Detail |
---|
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
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |