com.ibm.task.api

Class AdminAuthorizationOptions

  1. java.lang.Object
  2. extended bycom.ibm.task.api.AuthorizationOptions
  3. extended bycom.ibm.task.api.AdminAuthorizationOptions
All implemented interfaces:
java.io.Serializable

  1. public final class AdminAuthorizationOptions
  2. extends AuthorizationOptions
  3. implements java.io.Serializable
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.

Since:
7.0
See Also:
Serialized Form

Field Summary

Modifier and Type Field and Description
  1. static
  2. java.lang.String
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
  1. java.lang.String
getOnBehalfUser()
Returns the user on whose behalf the query is to be executed.
  1. void
setOnBehalfUser(java.lang.String onBehalfUser)
Sets the user on whose behalf the query is to be executed.
  1. 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

  1. public static final java.lang.String COPYRIGHT
See Also:

Constructor Detail

AdminAuthorizationOptions

  1. public AdminAuthorizationOptions( )
Default constructor to initialize the admin authorization options.

AdminAuthorizationOptions

  1. public AdminAuthorizationOptions( java.lang.String onBehalfUser)
Constructor that builds an admin authorization option from the passed values.
Parameters:
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

  1. public java.lang.String getOnBehalfUser( )
Returns the user on whose behalf the query is to be executed.
Returns:
The user on whose behalf the query is to be executed. If no user is specified, null is returned.

setOnBehalfUser

  1. public void setOnBehalfUser(java.lang.String onBehalfUser)
Sets the user on whose behalf the query is to be executed.
Parameters:
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

  1. public java.lang.String toString( )
Returns a string representation of the AdminAuthorizationOptions object.
Overrides:
Returns:
String - A string representation of the object.