com.bea.wlpi.common
Class RoleUserMap

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

public final class RoleUserMap

extends java.lang.Object

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

Holds mapping information of a workflow role and its associated users.

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.

Author:

Copyright © 2000, 2001 BEA Systems, Inc. All Rights Reserved.

See Also:

Serialized Form

Constructor Summary

RoleUserMap(java.lang.String roleId, java.lang.String orgId)
Create a new RoleUserMap object.

RoleUserMap(java.lang.String roleId, java.lang.String orgId, java.util.List users)
Create a new RoleUserMap object.

Method Summary

int	compareTo(java.lang.Object o) Compare two RoleUserMap objects.
boolean	equals(java.lang.Object obj) Test two RoleUserMap objects for equality.
java.lang.Object	getContents()
java.lang.String	getEntryName()
java.lang.String	getOrgId() Return the organization within which the role is defined.
java.lang.String	getOwnerName()
java.util.List	getReferencedPublishables(java.util.Map publishables)
java.lang.String	getRoleId() Return the role ID.
int	getType()
java.util.List	getUsers() Return the list of users that are a member of the role.
boolean	isPublished()
void	publish()
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

RoleUserMap

public RoleUserMap(java.lang.String roleId,
                   java.lang.String orgId)

Create a new RoleUserMap object.

Parameters:

roleId - The role ID.

orgId - The ID of the organization within which the role is defined by the external security realm.

RoleUserMap

public RoleUserMap(java.lang.String roleId,
                   java.lang.String orgId,
                   java.util.List users)

Create a new RoleUserMap object.

Parameters:

roleId - The role ID.

orgId - The ID of the organization within which the role is defined by the external security realm.

users - A list of UserInfo objects of the users that are members of this 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.

getUsers

public final java.util.List getUsers()

Return the list of users that are a member of the role.

Returns:

A list of UserInfo objects.

equals

public boolean equals(java.lang.Object obj)

Test two RoleUserMap objects for equality.

Parameters:

obj - Object with which to compare this one.

Returns:

true if obj is an instance of RoleUserMap with the same role ID and organization ID as this one.

Overrides:

equals in class java.lang.Object

See Also:

compareTo(java.lang.Object)

compareTo

public int compareTo(java.lang.Object o)

Compare two RoleUserMap 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 RoleUserMap.

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

See Also:

equals(java.lang.Object)

getContents

public java.lang.Object getContents()

Specified by:

getContents in interface Publishable

getEntryName

public java.lang.String getEntryName()

Specified by:

getEntryName in interface Publishable

getType

public int getType()

Specified by:

getType in interface Publishable

getOwnerName

public java.lang.String getOwnerName()

Specified by:

getOwnerName in interface Publishable

toString

public java.lang.String toString()

Return a string representation of the object.

Returns:

String representation, showing the values of members.

Overrides:

toString in class java.lang.Object

isPublished

public boolean isPublished()

Specified by:

isPublished in interface Publishable

getReferencedPublishables

public java.util.List getReferencedPublishables(java.util.Map publishables)

Specified by:

getReferencedPublishables in interface Publishable

publish

public void publish()

Specified by:

publish in interface Publishable