com.bea.wlpi.common
Class OrganizationInfo

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

All Implemented Interfaces:

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

public final class OrganizationInfo

extends java.lang.Object

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

Holds information about an organization.

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

OrganizationInfo(java.lang.String orgId)
Create a new OrganizationInfo object.

OrganizationInfo(java.lang.String orgId, java.lang.String calendarId)
Create a new OrganizationInfo object.

Method Summary

int	compareTo(java.lang.Object o) Compare two OrganizationInfo objects.
boolean	equals(java.lang.Object obj) Test two OrganizationInfo objects for equality.
java.lang.String	getCalendarId() Return the ID of 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	getOrgId() Return the organization ID.
java.lang.String	getOwnerName() Return the name of the object's owner.
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.

Methods inherited from class java.lang.Object

clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

OrganizationInfo

public OrganizationInfo(java.lang.String orgId)

Create a new OrganizationInfo object.

Parameters:

orgId - The organization ID.

OrganizationInfo

public OrganizationInfo(java.lang.String orgId,
                        java.lang.String calendarId)

Create a new OrganizationInfo object.

Parameters:

orgId - The organization ID.

calendarId - The ID of the business calendar to use when performing business time interval calculations.

Method Detail

getOrgId

public final java.lang.String getOrgId()

Return the organization ID.

Returns:

The organization ID.

getCalendarId

public final java.lang.String getCalendarId()

Return the ID of the business calendar to use.

Returns:

The ID of the business calendar to use when performing business time interval calculations.

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 to use when calculating business time intervals.

See Also:

getCalendarId()

equals

public boolean equals(java.lang.Object obj)

Test two OrganizationInfo objects for equality.

Overrides:

equals in class java.lang.Object

Parameters:

obj - The object with which to compare this one.

Returns:

true if obj is an instance of OrganizationInfo with the same ID as this one.

See Also:

compareTo(java.lang.Object)

compareTo

public int compareTo(java.lang.Object o)

Compare two OrganizationInfo objects.

Specified by:

compareTo in interface java.lang.Comparable

Parameters:

obj - The object with which to compare this one. Must be null or an instance of OrganizationInfo.

Returns:

The result of comparing the from and to members using the String.compareTo(Object) method.

Throws:

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

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.

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.