com.bea.wlpi.common
Class UserInfo

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

All Implemented Interfaces:

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

public final class UserInfo

extends java.lang.Object

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

Holds information about a workflow user.

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

UserInfo(java.lang.String userId)
Create a new UserInfo object.

UserInfo(java.lang.String userId, java.lang.String eMailAddress, java.lang.String defaultOrgId, java.lang.String calendarId)
Create a new UserInfo object.

Method Summary

int	compareTo(java.lang.Object o) Compare two UserInfo objects.
boolean	equals(java.lang.Object obj) Test two UserInfo objects for equality.
java.lang.String	getCalendarId() Return the user's business calendar.
java.lang.Object	getContents() Return the publishable content.
java.lang.String	getDefaultOrgId() Return the user's default organization.
java.lang.String	getEMailAddress() Return the user's email address.
java.lang.String	getEntryName() Return the display name for the publishable object.
java.lang.String	getOwnerName() Return the name of the object's owner.
int	getType() Return the type of publishable object.
java.lang.String	getUserId() Return the user ID.
boolean	isPublished() Returns whether the object is published.
void	setCalendarId(java.lang.String calendarId) Set the user's business calendar.
void	setDefaultOrg(java.lang.String defaultOrgId) Set the user's default organization.
void	setEMailAddress(java.lang.String eMailAddress) Set the user's email address.
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

UserInfo

public UserInfo(java.lang.String userId)

Create a new UserInfo object.

Parameters:

userId - WebLogic Process Integrator user ID.

UserInfo

public UserInfo(java.lang.String userId,
                java.lang.String eMailAddress,
                java.lang.String defaultOrgId,
                java.lang.String calendarId)

Create a new UserInfo object.

Parameters:

userId - WebLogic Process Integrator user ID.

eMailAddress - The user's email address.

defaultOrgId - ID of user's default organization.

calendarId - ID of user's business calendar (can be null).

Method Detail

getUserId

public final java.lang.String getUserId()

Return the user ID.

Returns:

The WebLogic Process Integrator user ID.

getEMailAddress

public final java.lang.String getEMailAddress()

Return the user's email address.

Returns:

The user's email address.

See Also:

setEMailAddress(java.lang.String)

getDefaultOrgId

public final java.lang.String getDefaultOrgId()

Return the user's default organization.

Returns:

The ID of the user's default organization.

See Also:

setDefaultOrg(java.lang.String)

getCalendarId

public final java.lang.String getCalendarId()

Return the user's business calendar.

Returns:

The ID of the user's business calendar.

See Also:

setCalendarId(java.lang.String)

setCalendarId

public final void setCalendarId(java.lang.String calendarId)

Set the user's business calendar.

Parameters:

calendarId - The ID of the business calendar to use.

See Also:

getCalendarId()

setEMailAddress

public void setEMailAddress(java.lang.String eMailAddress)

Set the user's email address.

Parameters:

eMailAddress - The email address.

See Also:

getEMailAddress()

setDefaultOrg

public void setDefaultOrg(java.lang.String defaultOrgId)

Set the user's default organization.

Parameters:

defaultOrgId - The ID of the user's default organization.

See Also:

getDefaultOrgId()

equals

public boolean equals(java.lang.Object obj)

Test two UserInfo 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 UserInfo with the same user ID as this one.

See Also:

compareTo(java.lang.Object)

compareTo

public int compareTo(java.lang.Object o)

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

Returns:

The result of comparing the userId members using the String.compareTo(Object) method.

Throws:

java.lang.ClassCastException - if o is not an instance of UserInfo.

See Also:

equals(java.lang.Object)

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

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.

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.