com.ibm.bpe.api

Class AuthorizationOptions

  1. java.lang.Object
  2. extended bycom.ibm.bpe.api.AuthorizationOptions
All implemented interfaces:
java.io.Serializable
Direct known subclasses:
AdminAuthorizationOptions

  1. public class AuthorizationOptions
  2. extends java.lang.Object
  3. 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

Modifier and Type Field and Description
  1. static
  2. java.lang.String
COPYRIGHT

Constructor Summary

Constructor and Description
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

Modifier and Type Method and Description
  1. java.lang.Boolean
areGroupsUsed()
Returns whether group work items should be considered for a query.
  1. java.lang.Boolean
areIndividualsUsed()
Returns whether individual work items should be considered for a query.
  1. java.lang.Boolean
areInheritedWorkItemsUsed()
Returns whether inherited work items should be considered for a query.
  1. java.lang.Boolean
isEverybodyUsed()
Returns whether everybody work items should be considered for a query.
  1. void
setEverybodyUsed(java.lang.Boolean everybodyUsed)
Sets whether everybody work items should be considered.
  1. void
setGroupsUsed(java.lang.Boolean groupsUsed)
Sets whether group work items should be considered.
  1. void
setIndividualsUsed(java.lang.Boolean individualsUsed)
Sets whether individual work items should be considered.
  1. void
setInheritedUsed(java.lang.Boolean inheritedUsed)
Sets whether inherited work items should be considered.
  1. 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

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

Constructor Detail

AuthorizationOptions

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

AuthorizationOptions

  1. public AuthorizationOptions(java.lang.Boolean everybodyUsed,
  2. java.lang.Boolean individualsUsed,
  3. java.lang.Boolean groupsUsed,
  4. 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

  1. 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

  1. 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

  1. 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

  1. 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

  1. 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

  1. 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

  1. 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

  1. 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

  1. 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.