com.arsdigita.categorization
Class CategoryPurpose

java.lang.Object
  extended bycom.arsdigita.domain.DomainObject
      extended bycom.arsdigita.domain.ObservableDomainObject
          extended bycom.arsdigita.kernel.ACSObject
              extended bycom.arsdigita.categorization.CategoryPurpose

Deprecated. See the note about "use context" methods in the documentation for Category class.

public class CategoryPurpose
extends ACSObject

Implements persistent storage of category purposes, which may be used to filter the list of categories associated with an object.

Version:
$Revision: #12 $ $DateTime: 2004/04/07 16:07:11 $
Author:
Scott Seago

Field Summary
static String ADVANCED_SEARCH
          Deprecated. Constant for identifying the Advanced Search purpose
static String BASE_DATA_OBJECT_TYPE
          Deprecated.  
static String CATEGORIES
          Deprecated.  
static String DESCRIPTION
          Deprecated.  
static String KEY
          Deprecated.  
static String NAME
          Deprecated.  
static String NAVIGATION
          Deprecated. Constant for identifying the Navigation purpose (used for navbars, etc.)
 
Fields inherited from class com.arsdigita.kernel.ACSObject
CONTAINER, DEFAULT_DOMAIN_CLASS, DISPLAY_NAME, ID, OBJECT_TYPE, versionId
 
Constructor Summary
CategoryPurpose()
          Deprecated. Initalizes the contained data object with a new data object that has the ObjectType of CategoryPurpose.
CategoryPurpose(DataObject categoryPurposeObjectData)
          Deprecated. Initializes with the specified data object.
CategoryPurpose(ObjectType type)
          Deprecated. Initializes the contained data object with a new data object whose object type is the specified type.
CategoryPurpose(OID oid)
          Deprecated. Retrieves the data object with the specified OID from the persistent storage mechanism.
CategoryPurpose(String typeName)
          Deprecated. Initializes the contained data object with a new data object whose object type is specified by the passed in type name.
CategoryPurpose(String key, String name)
          Deprecated. Creates a new category with the given key and name.
CategoryPurpose(String key, String name, String description)
          Deprecated. Creates a new category with the given key, name, and description.
 
Method Summary
static Collection getAllPurposes()
          Deprecated. Returns all existing category purposes.
static String getBaseDataObjectPackage()
          Deprecated. Gets the base data object package.
protected  String getBaseDataObjectType()
          Deprecated. Returns the base data object type for this domain object class.
 Collection getCategories()
          Deprecated. Returns a collection of categories for this category purpose.
 String getDescription()
          Deprecated. Returns the description of the CategoryPurpose.
 String getKey()
          Deprecated. Returns the key of the CategoryPurpose.
 String getName()
          Deprecated. Returns the name of the CategoryPurpose.
static CategoryPurpose getPurpose(String key)
          Deprecated. Returns a CategoryPurpose with the given key.
static Category getRootCategory(String key)
          Deprecated.  
static boolean purposeExists(String key)
          Deprecated. Determines whether there exists a CatgegoryPurpose with the given key.
 void setDescription(String value)
          Deprecated. Sets the description of the CategoryPurpose.
 void setKey(String value)
          Deprecated. Sets the key of the CategoryPurpose.
 void setName(String value)
          Deprecated. Sets the name of the CategoryPurpose.
static void setupCategoryPurposes()
          Deprecated. Sets up the set of valid CategoryPurposes.
 
Methods inherited from class com.arsdigita.kernel.ACSObject
assertPrivilege, beforeSave, checkPrivilege, doCreateCheck, doWriteCheck, getContainer, getDefaultDomainClass, getDisplayName, getID, getSpecificObjectType, getSpecificOID, gimmeContainer, initialize, isContainerModified, setID, setID
 
Methods inherited from class com.arsdigita.domain.ObservableDomainObject
addObserver, getObservers
 
Methods inherited from class com.arsdigita.domain.DomainObject
add, add, addToAssociation, afterDelete, afterSave, beforeDelete, clear, delete, disconnect, equals, get, getObjectType, getOID, getSession, hashCode, isDeleted, isDisconnected, isModified, isNew, isPropertyModified, isValid, remove, remove, remove, removeFromAssociation, save, set, setAssociation, setAssociation, specializeDataObject, specializeDataObject, toString
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

BASE_DATA_OBJECT_TYPE

public static final String BASE_DATA_OBJECT_TYPE
Deprecated. 
See Also:
Constant Field Values

KEY

public static final String KEY
Deprecated. 
See Also:
Constant Field Values

NAME

public static final String NAME
Deprecated. 
See Also:
Constant Field Values

DESCRIPTION

public static final String DESCRIPTION
Deprecated. 
See Also:
Constant Field Values

CATEGORIES

public static final String CATEGORIES
Deprecated. 
See Also:
Constant Field Values

NAVIGATION

public static final String NAVIGATION
Deprecated. 
Constant for identifying the Navigation purpose (used for navbars, etc.)

See Also:
Constant Field Values

ADVANCED_SEARCH

public static final String ADVANCED_SEARCH
Deprecated. 
Constant for identifying the Advanced Search purpose

See Also:
Constant Field Values
Constructor Detail

CategoryPurpose

public CategoryPurpose(DataObject categoryPurposeObjectData)
Deprecated. 
Initializes with the specified data object.

Parameters:
categoryPurposeObjectData - the data object

CategoryPurpose

public CategoryPurpose()
Deprecated. 
Initalizes the contained data object with a new data object that has the ObjectType of CategoryPurpose.

See Also:
DomainObject.DomainObject(String), ObjectType

CategoryPurpose

public CategoryPurpose(String typeName)
Deprecated. 
Initializes the contained data object with a new data object whose object type is specified by the passed in type name.

Parameters:
typeName - the object type for the contained data object
See Also:
DomainObject.DomainObject(String), DataObject, ObjectType

CategoryPurpose

public CategoryPurpose(ObjectType type)
Deprecated. 
Initializes the contained data object with a new data object whose object type is the specified type.

Parameters:
type - the object type for the contained data object
See Also:
DomainObject.DomainObject(ObjectType), DataObject

CategoryPurpose

public CategoryPurpose(OID oid)
                throws DataObjectNotFoundException
Deprecated. 
Retrieves the data object with the specified OID from the persistent storage mechanism. If the OID is not present, it throws a DataObjectNotFoundException.

Parameters:
oid - the OID for the data object to retrieve
Throws:
DataObjectNotFoundException - if this OID is invalid or has been deleted.
See Also:
DomainObject.DomainObject(OID), DataObject

CategoryPurpose

public CategoryPurpose(String key,
                       String name,
                       String description)
Deprecated. 
Creates a new category with the given key, name, and description.

Parameters:
key - the key for the new categoryPurpose
name - the name for the new categoryPurpose
description - the description for the new categoryPurpose

CategoryPurpose

public CategoryPurpose(String key,
                       String name)
Deprecated. 
Creates a new category with the given key and name.

Parameters:
key - the key for the new categoryPurpose
name - the name for the new categoryPurpose
Method Detail

getBaseDataObjectType

protected String getBaseDataObjectType()
Deprecated. 
Description copied from class: DomainObject
Returns the base data object type for this domain object class. Intended to be overrided by subclasses whenever the subclass will only work if their primary data object is of a certain base type.

Overrides:
getBaseDataObjectType in class ACSObject

getBaseDataObjectPackage

public static String getBaseDataObjectPackage()
Deprecated. 
Gets the base data object package.

Returns:
the baseDataObjectPackage for CategoryPurposes.

setupCategoryPurposes

public static void setupCategoryPurposes()
Deprecated. 
Sets up the set of valid CategoryPurposes.


purposeExists

public static boolean purposeExists(String key)
Deprecated. 
Determines whether there exists a CatgegoryPurpose with the given key.

Parameters:
key - The integer key
Returns:
whether the purpose exists.

getPurpose

public static CategoryPurpose getPurpose(String key)
Deprecated. 
Returns a CategoryPurpose with the given key.

Parameters:
key - The integer key
Returns:
the CategoryPurpose

getKey

public String getKey()
Deprecated. 
Returns the key of the CategoryPurpose.

Returns:
the CategoryPurpose key.

setKey

public void setKey(String value)
Deprecated. 
Sets the key of the CategoryPurpose.

Parameters:
value - the new key of the CategoryPurpose

getName

public String getName()
Deprecated. 
Returns the name of the CategoryPurpose.

Returns:
the CategoryPurpose name.

setName

public void setName(String value)
Deprecated. 
Sets the name of the CategoryPurpose.

Parameters:
value - the new name of the CategoryPurpose

getDescription

public String getDescription()
Deprecated. 
Returns the description of the CategoryPurpose.

Returns:
the CategoryPurpose description.

setDescription

public void setDescription(String value)
Deprecated. 
Sets the description of the CategoryPurpose.

Parameters:
value - the new description of the CategoryPurpose

getCategories

public Collection getCategories()
Deprecated. 
Returns a collection of categories for this category purpose.


getAllPurposes

public static Collection getAllPurposes()
Deprecated. 
Returns all existing category purposes.


getRootCategory

public static Category getRootCategory(String key)
Deprecated. 


Copyright (c) 2004 Red Hat, Inc. Corporation. All Rights Reserved. Generated at July 20 2004:2337 UTC