|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.arsdigita.domain.DomainObject
com.arsdigita.domain.ObservableDomainObject
com.arsdigita.kernel.ACSObject
com.arsdigita.categorization.CategoryPurpose
Category
class.
Implements persistent storage of category purposes, which may be used to filter the list of categories associated with an object.
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 |
public static final String BASE_DATA_OBJECT_TYPE
public static final String KEY
public static final String NAME
public static final String DESCRIPTION
public static final String CATEGORIES
public static final String NAVIGATION
public static final String ADVANCED_SEARCH
Constructor Detail |
public CategoryPurpose(DataObject categoryPurposeObjectData)
categoryPurposeObjectData
- the data objectpublic CategoryPurpose()
ObjectType
of CategoryPurpose.
DomainObject.DomainObject(String)
,
ObjectType
public CategoryPurpose(String typeName)
typeName
- the object type for the
contained data objectDomainObject.DomainObject(String)
,
DataObject
,
ObjectType
public CategoryPurpose(ObjectType type)
type
- the object type for the contained
data objectDomainObject.DomainObject(ObjectType)
,
DataObject
public CategoryPurpose(OID oid) throws DataObjectNotFoundException
oid
- the OID for the data object to retrieve
DataObjectNotFoundException
- if this OID is
invalid or has been deleted.DomainObject.DomainObject(OID)
,
DataObject
public CategoryPurpose(String key, String name, String description)
key
- the key for the new categoryPurposename
- the name for the new categoryPurposedescription
- the description for the new categoryPurposepublic CategoryPurpose(String key, String name)
key
- the key for the new categoryPurposename
- the name for the new categoryPurposeMethod Detail |
protected String getBaseDataObjectType()
DomainObject
getBaseDataObjectType
in class ACSObject
public static String getBaseDataObjectPackage()
public static void setupCategoryPurposes()
public static boolean purposeExists(String key)
key
- The integer key
public static CategoryPurpose getPurpose(String key)
key
- The integer key
public String getKey()
public void setKey(String value)
value
- the new key of the CategoryPurposepublic String getName()
public void setName(String value)
value
- the new name of the CategoryPurposepublic String getDescription()
public void setDescription(String value)
value
- the new description of the CategoryPurposepublic Collection getCategories()
public static Collection getAllPurposes()
public static Category getRootCategory(String key)
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |