|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface AbstractAuthoringTemplate
Represents an abstract authoring template. Authoring Templates are used to define
the types of templated documents that can be created within the content management system.
New TemplatedDocument
objects will derive their default attributes from
the AuthoringTemplate
defined during its creation.
The Prototype
of the AuthoringTemplate
is used to define the set of ContentComponent
s that make
up the target TemplateDocument
type.
Since version 8.0, there are two types of AbstractAuthoringTemplate
,
AuthoringTemplate
and SiteAreaTemplate
. Queries that specify the
AbstractTemplate DocumentType
will return both AuthoringTemplate
s and SiteAreaTemplate
s.
If only AuthoringTemplate
or SiteAreaTemplate
s are required, use the DocumentType
for AuthoringTemplate
or SiteAreaTemplate.
Note that the AbstractAuthoringTemplate
is referred to as a "Authoring Template" since 8.0 in the Authoring UI and that
an AuthoringTemplate
is referred to as a "Content Template" since 8.0 in the Authoring UI.
Method Summary | |
---|---|
Prototype |
getGenericPrototype()
Returns the Prototype for this authoring template. |
AbstractTemplateItemProperties |
getItemProperties()
Return the item properties for this authoring template. |
ContentPrototype |
getPrototype()
Deprecated. Use getGenericPrototype() instead. Since 8.0, the prototype can be of any Prototype type. |
TargetableContentComponent |
getTargetComponent()
Deprecated. Use getTargetComponent() in getItemProperties() instead. |
void |
setTargetComponent(TargetableContentComponent target)
Deprecated. Use setTargetComponent() in getItemProperties() instead. |
Methods inherited from interface com.ibm.workplace.wcm.api.Item |
---|
getCreationDate, getDescription, getIdentity, getModifiedDate, getName, getTitle |
Methods inherited from interface com.ibm.portal.Localized |
---|
getLocales |
Methods inherited from interface com.ibm.workplace.wcm.api.EditableItem |
---|
setDescription, setName, setTitle |
Methods inherited from interface com.ibm.workplace.wcm.api.Hierarchical |
---|
getParentId |
Method Detail |
---|
Prototype getGenericPrototype()
Prototype
for this authoring template. The type of the Prototype
will
correspond to the type of the AuthoringTemplate
. To update
the prototype, save this authoring template.
This is referred to as the Default Item for an AuthoringTemplate
in the Authoring UI.
ContentPrototype getPrototype()
Prototype
type.
ContentPrototype
for this authoring template if this is
an AuthoringTemplate
. For other AbstractAuthoringTemplate
type,
an IllegalStateException
will be thrown. This method is retained
for pre 8.0 backwards compatibility only.
To update the content prototype, save this authoring template.
java.lang.IllegalStateException
TargetableContentComponent getTargetComponent()
TargetableContentComponent
that has been set on this authoring template.
If the the TargetableContentComponent
hasn't been set then null
will be returned.
This method is implemented by Content Templates, but not by Site Area Templates.
void setTargetComponent(TargetableContentComponent target) throws com.ibm.workplace.wcm.api.exceptions.ComponentNotFoundException, com.ibm.workplace.wcm.api.exceptions.IllegalTypeChangeException
TargetableContentComponent
as the target component for this AuthoringTemplate.
Passing a null argument to clear target component.
The target component controls the behavior of Content subsequently created by this template when rendered within a Menu, Navigator or by a Link Component.
If the target component is LinkComponent
or FileComponent
then all links rendered
to the that Content item will be directed towards the TargetableContentComponent
.
E.g. If the target component is FileComponent
then all links to
that content item will by default render as links to the embedded
file resource TargetableContentComponent
.
This method is implemented by Content Templates, but not by Site Area Templates.
target
- A TargetableContentComponent
should already created in ContentPrototype
.
com.ibm.workplace.wcm.api.exceptions.ComponentNotFoundException
- if the given TargetableContentComponent
doesn't exist in ContentPrototype
com.ibm.workplace.wcm.api.exceptions.IllegalTypeChangeException
- if the ContentComponent
passed
in as an argument is a different type than the existing componentAbstractTemplateItemProperties getItemProperties()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |