com.bea.wlpi.common
Class RoleInfo

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

All Implemented Interfaces:

java.lang.Comparable, Publishable, java.io.Serializable

public final class RoleInfo

extends java.lang.Object

implements java.io.Serializable, java.lang.Comparable, Publishable

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

Fields inherited from interface com.bea.wlpi.common.Publishable

BUSINESS_CALENDAR, BUSINESS_OPERATION, EVENT_KEY, ORG, ROLE, TEMPLATE, TEMPLATE_DEFINITION, USER, XML_REPOSITORY_ENTITY, XML_REPOSITORY_FOLDER

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.

RoleInfo(java.lang.String roleId, java.lang.String orgId, java.lang.String calendarId, java.lang.String groupId)
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.Object	getContents() Return the publishable content.
java.lang.String	getEntryName() Return the display name for the publishable object.
java.lang.String	getGroupId() Return the WLS security group this role maps to.
java.lang.String	getOrgId() Return the organization within which the role is defined.
java.lang.String	getOwnerName() Return the name of the object's owner.
java.lang.String	getRoleId() Return the role ID.
int	getType() Return the type of publishable object.
boolean	isPublished() Returns whether the object is published.
void	setCalendarId(java.lang.String calendarId) Set the business calendar to use.
void	setGroupId(java.lang.String groupId) Set the WLS group this role maps to.
java.lang.String	toString() Return a string representation of the object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, hashCode, notify, notifyAll, 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.

RoleInfo

public RoleInfo(java.lang.String roleId,
                java.lang.String orgId,
                java.lang.String calendarId,
                java.lang.String groupId)

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.

groupId - The WLS security group that this role maps to.

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)

getGroupId

public final java.lang.String getGroupId()

Return the WLS security group this role maps to.

Returns:

The WLS security group name

See Also:

setGroupId(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()

setGroupId

public final void setGroupId(java.lang.String groupId)

Set the WLS group this role maps to. This will not update the mapping that must be done through the proper API. This is an internal only method

Returns:

The WLS security group name

See Also:

setGroupId(java.lang.String)

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)

getContents

public java.lang.Object getContents()

Description copied from interface: Publishable

Return the publishable content.

Specified by:

getContents in interface Publishable

Following copied from interface: com.bea.wlpi.common.Publishable

Returns:

A serializable object.

getEntryName

public java.lang.String getEntryName()

Description copied from interface: Publishable

Return the display name for the publishable object.

Specified by:

getEntryName in interface Publishable

Following copied from interface: com.bea.wlpi.common.Publishable

Returns:

Display name.

getType

public int getType()

Description copied from interface: Publishable

Return the type of publishable object.

Specified by:

getType in interface Publishable

Following copied from interface: com.bea.wlpi.common.Publishable

Returns:

Publishable object type: Publishable.TEMPLATE, Publishable.TEMPLATE_DEFINITION, Publishable.BUSINESS_OPERATION, Publishable.BUSINESS_CALENDAR, Publishable.USER, Publishable.ROLE, Publishable.ORG, Publishable.XML_REPOSITORY_FOLDER, Publishable.XML_REPOSITORY_ENTITY, Publishable.EVENT_KEY,

getOwnerName

public java.lang.String getOwnerName()

Description copied from interface: Publishable

Return the name of the object's owner.

Specified by:

getOwnerName in interface Publishable

Following copied from interface: com.bea.wlpi.common.Publishable

Returns:

The object's owner, if any.

toString

public java.lang.String toString()

Return a string representation of the object.

Overrides:

toString in class java.lang.Object

Returns:

String representation, showing the values of members.

Since:

WebLogic Process Integrator 2.0

isPublished

public boolean isPublished()

Description copied from interface: Publishable

Returns whether the object is published. Published objects cannot be modified.

Specified by:

isPublished in interface Publishable

Following copied from interface: com.bea.wlpi.common.Publishable

Returns:

true if the object is published.