com.epicentric.portalbeans.categories
Class DisplayCategory

java.lang.Object
  |
  +--com.epicentric.portalbeans.categories.DisplayCategory

All Implemented Interfaces:

Serializable, UniquelyIdentifiable

Deprecated. as of Version 7.2, to be removed in 9.0 or later; instead use the new Portlet Category API, see the new PortletCategoryManager class.

public class DisplayCategory

extends Object

implements Serializable, UniquelyIdentifiable

A DisplayCategory is a labeled group of modules. The purpose of DisplayCategories is to allow both the administrator and end-users to search through organized subsets of modules in the user interface. This categorization, while it should be logical, has no explicit meaning.

Users will be able to view modules that belong to a particular category by selecting that category in the interface. Administrators will be able to place modules in different categories on a system-wide and a per-site basis. Administrators will also be able to create and delete categories on a per-site basis.

See Also:

Serialized Form

Field Summary

protected com.epicentric.category.Category	_category Deprecated.
protected com.vignette.portal.portlet.management.external.PortletCategoryManager	_manager Deprecated.
protected com.vignette.portal.portlet.management.external.PortletCategory	_newCategory Deprecated.
protected static LogWrapper	LOG Deprecated.

Constructor Summary

protected

DisplayCategory(com.vignette.portal.portlet.management.external.PortletCategory cat) Deprecated.

Method Summary

boolean	addModule(String modID) Deprecated. Adds the module to this category.
boolean	contains(String modID) Deprecated. Indicates whether the module belongs to this category.
void	delete() Deprecated. Deletes this category.
boolean	equals(Object object) Deprecated.
Date	getCreatedDate() Deprecated. Returns the date this category was created.
String	getCreatedDateString() Deprecated. Returns a string representation of the date this category was created.
String	getDescription() Deprecated. Returns the description of the types of modules that are stored in this display category.
String	getID() Deprecated. as of version 4.0, No Replacement
int	getOwnerID() Deprecated. as of version 4.0, No Replacement
String	getOwnerName() Deprecated. as of version 4.0, No Replacement
String	getSiteID() Deprecated. Returns the UID of the site which this category belongs to.
String	getTitle() Deprecated. Returns the title of this category.
String	getUID() Deprecated. Returns the UID of this category.
String	getUIDType() Deprecated. Returns the UID Type of this class.
int	hashCode() Deprecated.
Iterator	listModules() Deprecated. Returns a list of all modules that belong to this category.
boolean	removeModule(String modID) Deprecated. Removes the module from this category.
void	save() Deprecated. Saves the list of modules that belong to this category.
String	serialVersionUID() Deprecated. as of version 4.0, No Replacement
boolean	setDescription(String desc) Deprecated. Sets the description of the types of modules that are stored in this display category.
void	setID(String id) Deprecated. as of version 4.0, No Replacement.
void	setOwnerID(int ownerID) Deprecated. as of version 4.0, No Replacement
void	setOwnerName(String ownerName) Deprecated. as of version 4.0, No Replacement
boolean	setTitle(String title) Deprecated. Sets the title of this category.

Methods inherited from class java.lang.Object

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

Field Detail

LOG

protected static final LogWrapper LOG

Deprecated.

_category

protected com.epicentric.category.Category _category

Deprecated.

_newCategory

protected com.vignette.portal.portlet.management.external.PortletCategory _newCategory

Deprecated.

_manager

protected com.vignette.portal.portlet.management.external.PortletCategoryManager _manager

Deprecated.

Constructor Detail

DisplayCategory

protected DisplayCategory(com.vignette.portal.portlet.management.external.PortletCategory cat)

Deprecated.

Method Detail

addModule

public boolean addModule(String modID)

Deprecated.

Adds the module to this category.

Parameters:

modID - the UID of the module to be added to this category

Returns:

true if the module was added to the display category

Since:

version 4.0

contains

public boolean contains(String modID)

Deprecated.

Indicates whether the module belongs to this category.

Parameters:

modID - the UID of the module being tested

Returns:

true if the module belongs to this category

Since:

version 4.0

delete

public void delete()
            throws CategoryStoreException

Deprecated.

Deletes this category.

getCreatedDate

public Date getCreatedDate()

Deprecated.

Returns the date this category was created.

Returns:

the date that this display category was created

getCreatedDateString

public String getCreatedDateString()

Deprecated.

Returns a string representation of the date this category was created.

Returns:

the date that this display category was created as a formatted string

getDescription

public String getDescription()

Deprecated.

Returns the description of the types of modules that are stored in this display category. This description provides a means of deciding which modules should be added to this category when they are created.

Returns:

the description of this display category

getID

public String getID()

Deprecated. as of version 4.0, No Replacement

Returns the friendly ID of this category. The DisplayCategory API no longer guaranteeds that there will be a friendly ID.

Returns:

the friendly of this category or null if it does not have one

getOwnerID

public int getOwnerID()

Deprecated. as of version 4.0, No Replacement

Returns the ID of the owner/creator of this category. The DisplayCategory API no longer maintains the owner's ID.

getOwnerName

public String getOwnerName()

Deprecated. as of version 4.0, No Replacement

Returns the name of the owner/creator of this category. The DisplayCategory API no longer maintains the owner's name.

getSiteID

public String getSiteID()

Deprecated.

Returns the UID of the site which this category belongs to.

Returns:

the UID of the site which this category belongs to

Since:

version 4.0

getTitle

public String getTitle()

Deprecated.

Returns the title of this category.

Returns:

the title of this category

getUID

public String getUID()

Deprecated.

Returns the UID of this category.

Specified by:

getUID in interface UniquelyIdentifiable

Returns:

the UID of this category

getUIDType

public String getUIDType()

Deprecated.

Returns the UID Type of this class.

Specified by:

getUIDType in interface UniquelyIdentifiable

Returns:

the UID Type of this class

listModules

public Iterator listModules()

Deprecated.

Returns a list of all modules that belong to this category.

Returns:

a list of all modules that belong to this category

Since:

version 4.0

removeModule

public boolean removeModule(String modID)

Deprecated.

Removes the module from this category. Does nothing if the module does not belong to this category.

Returns:

true if display category was modified (if it contained the specified module)

Since:

version 4.0

save

public void save()
          throws CategoryStoreException

Deprecated.

Saves the list of modules that belong to this category.

serialVersionUID

public String serialVersionUID()

Deprecated. as of version 4.0, No Replacement

Returns the serial version UID.

setDescription

public boolean setDescription(String desc)

Deprecated.

Sets the description of the types of modules that are stored in this display category. This description should provide a means of deciding which modules should be added to this category when they are created.

Parameters:

description - a string that describes this display category

Returns:

true if the description was set successfully

setID

public void setID(String id)

Deprecated. as of version 4.0, No Replacement.

Sets the UID of this category. The UID will be set when the display category is constructed and should not be modified afterward.

setOwnerID

public void setOwnerID(int ownerID)

Deprecated. as of version 4.0, No Replacement

Sets the ID of the owner/creator of this category. The DisplayCategory API no longer maintains the owner's ID.

setOwnerName

public void setOwnerName(String ownerName)

Deprecated. as of version 4.0, No Replacement

Sets the name of the owner/creator of this category. The DisplayCategory API no longer maintains the owner's name.

setTitle

public boolean setTitle(String title)

Deprecated.

Sets the title of this category. Setting the title of a display category changes its uid! No two categories may have the same name in the same site. The title will not be modified if another category already has the new title.

Parameters:

title - the new title of this display category

Returns:

true if the category title is now equal to the parameter

equals

public boolean equals(Object object)

Deprecated.

Overrides:

equals in class Object

hashCode

public int hashCode()

Deprecated.

Overrides:

hashCode in class Object