|
|||||||||||
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.cms.TemplateMapping
com.arsdigita.cms.CategoryTemplateMapping
Represents a mapping from (category + content type) to a template.
Field Summary | |
static String |
BASE_DATA_OBJECT_TYPE
|
static String |
CATEGORY
|
static String |
CONTENT_TYPE
|
static String |
SECTION
|
static String |
versionId
|
Fields inherited from class com.arsdigita.cms.TemplateMapping |
IS_DEFAULT, TEMPLATE, USE_CONTEXT |
Fields inherited from class com.arsdigita.kernel.ACSObject |
CONTAINER, DEFAULT_DOMAIN_CLASS, DISPLAY_NAME, ID, OBJECT_TYPE |
Constructor Summary | |
CategoryTemplateMapping()
Default constructor. |
|
CategoryTemplateMapping(BigDecimal id)
Constructor in which the contained DataObject is retrieved
from the persistent storage mechanism using the
specified BigDecimal ID and ObjectType of "CategoryTemplateMapping". |
|
CategoryTemplateMapping(com.arsdigita.persistence.DataObject obj)
Constructor in which a CategoryTemplateMapping is created using passed-in DataObject . |
|
CategoryTemplateMapping(com.arsdigita.persistence.OID oid)
Constructor in which the contained DataObject is retrieved
from the persistent storage mechanism using the
specified OID. |
|
CategoryTemplateMapping(String type)
Constructor in which the contained DataObject is
initialized with a new DataObject with an
ObjectType specified by the string
type. |
Method Summary | |
com.arsdigita.categorization.Category |
getCategory()
Returns the Category for this
CategoryTemplateMapping |
ContentSection |
getContentSection()
Returns the ContentSection for this
CategoryTemplateMapping |
ContentType |
getContentType()
Returns the ContentType for this
CategoryTemplateMapping |
static Template |
getDefaultTemplate(com.arsdigita.categorization.Category category,
ContentType type,
String useContext)
Get the default template for the given use context |
static CategoryTemplateMapping |
getMapping(com.arsdigita.categorization.Category category,
ContentType type,
Template template,
String useContext)
Load the specified mapping; return null if no such mapping exists |
com.arsdigita.kernel.ACSObject |
getParent()
Return the parent of the template within the category. |
static CategoryTemplateCollection |
getTemplates(com.arsdigita.categorization.Category category)
Retrieve all templates for the given category, and all types within it, along with their use context |
static CategoryTemplateCollection |
getTemplates(com.arsdigita.categorization.Category category,
ContentType type)
Retrieve all templates for the given category and type, along with their use context |
static CategoryTemplateCollection |
getTemplates(com.arsdigita.categorization.Category category,
ContentType type,
String useContext)
Retrieve all templates for the given category, type, and use context |
Boolean |
isDefault()
Determine if the template will be the default within its context |
void |
setCategory(com.arsdigita.categorization.Category cat)
Sets the Category for this
CategoryTemplateMapping |
void |
setContentSection(ContentSection sec)
Sets the ContentSection for this
CategoryTemplateMapping |
void |
setContentType(ContentType t)
Sets the ContentType for this
CategoryTemplateMapping |
void |
setDefault(Boolean b)
Set whether the template will be the default within its context |
Methods inherited from class com.arsdigita.cms.TemplateMapping |
getTemplate, getUseContext, setTemplate, setUseContext |
Methods inherited from class com.arsdigita.kernel.ACSObject |
assertPrivilege, beforeSave, checkPrivilege, doCreateCheck, doWriteCheck, getBaseDataObjectType, 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 versionId
public static final String BASE_DATA_OBJECT_TYPE
public static final String CATEGORY
public static final String SECTION
public static final String CONTENT_TYPE
Constructor Detail |
public CategoryTemplateMapping()
DataObject
is
initialized with a new DataObject
with an
ObjectType
of "CategoryTemplateMapping".
CategoryTemplateMapping(String)
,
ObjectType
public CategoryTemplateMapping(com.arsdigita.persistence.OID oid) throws com.arsdigita.domain.DataObjectNotFoundException
DataObject
is retrieved
from the persistent storage mechanism using the
specified OID.
oid
- the OID for the retrieved
DataObject
ObservableDomainObject.ObservableDomainObject(OID)
,
DataObject
,
OID
public CategoryTemplateMapping(BigDecimal id) throws com.arsdigita.domain.DataObjectNotFoundException
DataObject
is retrieved
from the persistent storage mechanism using the
specified BigDecimal ID and ObjectType
of "CategoryTemplateMapping".
id
- the ID for the retrieved
DataObject
DataObject
,
OID
public CategoryTemplateMapping(com.arsdigita.persistence.DataObject obj)
DataObject
.
obj
- the DataObject
to initialize this CategoryTemplateMappingObservableDomainObject.ObservableDomainObject(DataObject)
,
DataObject
,
OID
public CategoryTemplateMapping(String type)
DataObject
is
initialized with a new DataObject
with an
ObjectType
specified by the string
type.
type
- the name of the ObjectType
of the
contained DataObject
ObservableDomainObject.ObservableDomainObject(String)
,
DataObject
,
ObjectType
Method Detail |
public final ContentSection getContentSection()
ContentSection
for this
CategoryTemplateMapping
getContentSection
in class TemplateMapping
public final void setContentSection(ContentSection sec)
ContentSection
for this
CategoryTemplateMapping
sec
- The ContentSection for which this mapping should be valid.public com.arsdigita.categorization.Category getCategory()
Category
for this
CategoryTemplateMapping
public void setCategory(com.arsdigita.categorization.Category cat)
Category
for this
CategoryTemplateMapping
cat
- The Category for which this mapping should be valid.public com.arsdigita.kernel.ACSObject getParent()
getParent
in class TemplateMapping
public ContentType getContentType()
ContentType
for this
CategoryTemplateMapping
public void setContentType(ContentType t)
ContentType
for this
CategoryTemplateMapping
t
- The ContentType for which this mapping should be valid.public Boolean isDefault()
isDefault
in class TemplateMapping
public void setDefault(Boolean b)
setDefault
in class TemplateMapping
b
- whether the template is the default within its context.public static CategoryTemplateMapping getMapping(com.arsdigita.categorization.Category category, ContentType type, Template template, String useContext)
category
- The Category for the return mappingtype
- The ContentType for the return mappingtemplate
- The Template for the return mappinguseContext
- The use context for the return mapping
public static Template getDefaultTemplate(com.arsdigita.categorization.Category category, ContentType type, String useContext)
category
- The Category for the return mappingtype
- The ContentType for the return mappinguseContext
- The use context for the return mapping
public static CategoryTemplateCollection getTemplates(com.arsdigita.categorization.Category category, ContentType type, String useContext)
category
- The Category for the return mappingtype
- The ContentType for the return mappinguseContext
- The use context for the return mapping
public static CategoryTemplateCollection getTemplates(com.arsdigita.categorization.Category category, ContentType type)
category
- The Category for the return mappingtype
- The ContentType for the return mapping
public static CategoryTemplateCollection getTemplates(com.arsdigita.categorization.Category category)
category
- The Category for the return mapping
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |