WebLogic Process Integrator Version 1.1

com.bea.wlpi.common
Class RoleInfo

java.lang.Object
  |
  +--com.bea.wlpi.common.RoleInfo

public final class RoleInfo
extends java.lang.Object
implements java.io.Serializable, java.lang.Comparable

Holds information about a workflow role.

Objects of this class override the boolean equals(Object) and implement the comparable interface. Homogeneous collections containing objects of this class may, therefore, be searched and sorted using the Collection.contains(Object), List.indexOf(Object), Collections.sort(List) methods.

See Also:
Serialized Form

Constructor Summary
RoleInfo(java.lang.String roleId, java.lang.String orgId)
          Create a new RoleInfo object.
RoleInfo(java.lang.String roleId, java.lang.String orgId, java.lang.String calendarId)
          Create a new RoleInfo object.
 
Method Summary
 int compareTo(java.lang.Object o)
          Compare two RoleInfo objects.
 boolean equals(java.lang.Object obj)
          Test two RoleInfo objects for equality.
 java.lang.String getCalendarId()
          Return the business calendar to use.
 java.lang.String getOrgId()
          Return the organization within which the role is defined.
 java.lang.String getRoleId()
          Return the role ID.
 void setCalendarId(java.lang.String calendarId)
          Set the business calendar to use.
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

RoleInfo

public RoleInfo(java.lang.String roleId,
                java.lang.String orgId)
Create a new RoleInfo object.
Parameters:
roleId - The role ID.
orgId - The ID of the organization within which the role is defined by the external security realm.

RoleInfo

public RoleInfo(java.lang.String roleId,
                java.lang.String orgId,
                java.lang.String calendarId)
Create a new RoleInfo object.
Parameters:
roleId - The role ID.
orgId - The ID of the organization within which the role is defined by the external security realm.
calendarId - The ID of the business calendar to use when performing business time interval calculations for the role.
Method Detail

getRoleId

public final java.lang.String getRoleId()
Return the role ID.
Returns:
The role ID.

getOrgId

public final java.lang.String getOrgId()
Return the organization within which the role is defined.
Returns:
The ID of the organization within which the role is defined.

getCalendarId

public final java.lang.String getCalendarId()
Return the business calendar to use.
Returns:
The ID of the business calendar.
See Also:
setCalendarId(java.lang.String)

setCalendarId

public final void setCalendarId(java.lang.String calendarId)
Set the business calendar to use.
Parameters:
calendarId - The ID of the business calendar.
See Also:
getCalendarId()

equals

public boolean equals(java.lang.Object obj)
Test two RoleInfo objects for equality.
Overrides:
equals in class java.lang.Object
Parameters:
obj - Object with which to compare this one.
Returns:
true if obj is an instance of RoleInfo with the same role ID and organization ID as this one.
See Also:
compareTo(java.lang.Object)

compareTo

public int compareTo(java.lang.Object o)
Compare two RoleInfo objects.
Specified by:
compareTo in interface java.lang.Comparable
Parameters:
obj - Object with which to compare this one. Must be null or an instance of RoleInfo.
Returns:
The result of comparing the roleId and orgId members using the String.compareTo(Object) method.
Throws:
java.lang.ClassCastException - if o is not an instance of RoleInfo.
See Also:
equals(java.lang.Object)

WebLogic Process Integrator Version 1.1

WebLogic and Process Integrator are trademarks of BEA Systems, Inc.
Copyright (c) 2000 BEA Systems, Inc., 8920 Woodbine Avenue, Suite 400,
Markham, Ontario L3R 9W9 Canada. All rights reserved.