com.ibm.bpe.api
Class AuthorizationOptions

java.lang.Object
  extended by com.ibm.bpe.api.AuthorizationOptions
All Implemented Interfaces:
java.io.Serializable
Direct Known Subclasses:
AdminAuthorizationOptions

public class AuthorizationOptions
extends java.lang.Object
implements java.io.Serializable

States authorizations options for a query that uses a predefined or composite query table. Authorization options are ignored for supplemental query tables.

Authorization options are added to any authorization specification defined for the query table. This means that they can be used to further restrict authorization checks but not to weaken those checks.

For example, if the authorization specification of a query table states that everybody work items should be considered, the authorization options passed to the actual query may specify that they are not to be used. The other way round, if the authorization specification of a query table states that everybody work items should not be considered, the authorization options passed to the actual query cannot specify that they are to be used.

If authorization options are not specified or specified by a system administrator or monitor, a query is executed without special privileges for the logged-on user. In other words, if specified by a system administrator or monitor, the system administrator or monitor is treated like a normal user.

Since:
6.2
See Also:
Serialized Form

Field Summary
static java.lang.String COPYRIGHT
           
 
Constructor Summary
AuthorizationOptions()
          Default constructor to initialize the authorization options.
AuthorizationOptions(java.lang.Boolean everybodyUsed, java.lang.Boolean individualsUsed, java.lang.Boolean groupsUsed, java.lang.Boolean inheritedUsed)
          Constructor that builds an authorization option from the passed values.
 
Method Summary
 java.lang.Boolean areGroupsUsed()
          Returns whether group work items should be considered for a query.
 java.lang.Boolean areIndividualsUsed()
          Returns whether individual work items should be considered for a query.
 java.lang.Boolean areInheritedWorkItemsUsed()
          Returns whether inherited work items should be considered for a query.
 java.lang.Boolean isEverybodyUsed()
          Returns whether everybody work items should be considered for a query.
 void setEverybodyUsed(java.lang.Boolean everybodyUsed)
          Sets whether everybody work items should be considered.
 void setGroupsUsed(java.lang.Boolean groupsUsed)
          Sets whether group work items should be considered.
 void setIndividualsUsed(java.lang.Boolean individualsUsed)
          Sets whether individual work items should be considered.
 void setInheritedUsed(java.lang.Boolean inheritedUsed)
          Sets whether inherited work items should be considered.
 java.lang.String toString()
          Returns a string representation of the AuthorizationOptions object.
 
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
See Also:
Constant Field Values
Constructor Detail

AuthorizationOptions

public AuthorizationOptions()
Default constructor to initialize the authorization options.


AuthorizationOptions

public AuthorizationOptions(java.lang.Boolean everybodyUsed,
                            java.lang.Boolean individualsUsed,
                            java.lang.Boolean groupsUsed,
                            java.lang.Boolean inheritedUsed)
Constructor that builds an authorization option from the passed values.

Parameters:
everybodyUsed - Specifies whether everybody work items should be considered.
individualsUsed - Specifies whether owner work items should be considered.
groupsUsed - Specifies whether group work items should be considered.
inheritedUsed - Specifies whether inherited work items should be considered.
Method Detail

isEverybodyUsed

public java.lang.Boolean isEverybodyUsed()
Returns whether everybody work items should be considered for a query.

Returns:
States whether everybody work items should be considered for a query. Null is returned when this indicator is not set. If not set and if there is no authorization filter defined for the query table, the ProcessChoreographer default of true is used.

areIndividualsUsed

public java.lang.Boolean areIndividualsUsed()
Returns whether individual work items should be considered for a query.

Returns:
States whether individual work items should be considered for a query. Null is returned when this indicator is not set. If not set and if there is no authorization filter defined for the query table, the ProcessChoreographer default of true is used.

areGroupsUsed

public java.lang.Boolean areGroupsUsed()
Returns whether group work items should be considered for a query.

Returns:
States whether group work items should be considered for a query. Null is returned when this indicator is not set. If not set and if there is no authorization filter defined for the query table, the ProcessChoreographer default of true is used.

areInheritedWorkItemsUsed

public java.lang.Boolean areInheritedWorkItemsUsed()
Returns whether inherited work items should be considered for a query.

Returns:
States whether inherited work items should be considered for a query. Null is returned when this indicator is not set. If not set and if there is no authorization filter defined for the query table, the ProcessChoreographer default of true is used for a query table of kind composite, a default of false for a query table of kind predefined.

setEverybodyUsed

public void setEverybodyUsed(java.lang.Boolean everybodyUsed)
Sets whether everybody work items should be considered.

Parameters:
everybodyUsed - Specifies whether everybody work items should be considered. Null indicates that the ProcessChoreographer default value of true is to be used for a query.

setIndividualsUsed

public void setIndividualsUsed(java.lang.Boolean individualsUsed)
Sets whether individual work items should be considered.

Parameters:
individualsUsed - Specifies whether individual work items should be considered. Null indicates that the ProcessChoreographer default value of true is to be used for a query.

setGroupsUsed

public void setGroupsUsed(java.lang.Boolean groupsUsed)
Sets whether group work items should be considered.

Parameters:
groupsUsed - Specifies whether group work items should be considered. Null indicates that the ProcessChoreographer default value of true is to be used for a query.

setInheritedUsed

public void setInheritedUsed(java.lang.Boolean inheritedUsed)
Sets whether inherited work items should be considered.

Parameters:
inheritedUsed - Specifies whether inherited work items should be considered. Null indicates that the ProcessChoreographer default value is to be used for a query. The default value is true for a query table of kind composite, false for a query table of kind predefined.

toString

public java.lang.String toString()
Returns a string representation of the AuthorizationOptions object.

Overrides:
toString in class java.lang.Object
Returns:
String - A string representation of the object.