|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface AbstractTemplateItemProperties
The item properties for a content template or site area template.
Field Summary | |
---|---|
static java.lang.String |
DEFAULT_PRESENTATION_IDENTIFIER
String to indicate that the render modes should fallback to the default presentation template. |
static java.lang.String |
SUMMARY_PRESENTATION_IDENTIFIER
String to indicate the render mode for the Summary Presentation |
Method Summary | |
---|---|
java.util.Set<java.lang.String> |
getAllSupportedRenderModes()
Returns the all render modes supported by this Authoring Template. |
DocumentId<PresentationTemplate> |
getDefaultPresentationTemplate()
Retrieve the default presentation template for this authoring template. |
DocumentId<PresentationTemplate> |
getPresentationTemplateForMode(java.lang.String p_renderModeName)
Get the presentation template the defined for the given render mode. |
DocumentId<PresentationTemplate> |
getPresentationTemplateForModes(java.util.List<java.lang.String> p_renderModeNames)
Get the presentation template the defined for the given render modes. |
FileComponent |
getPreviewImage()
Retrieve the "Preview-image" resource. |
java.util.Set<java.lang.String> |
getRenderModesForPresentationTemplate(DocumentId p_presentationTemplateId)
Returns the set of render modes that use the same presentation template |
boolean |
hasPresentationTemplateForMode(java.lang.String p_renderModeName)
Returns true if a presentation template is defined for the given render mode. |
boolean |
hasPreviewImage()
Returns true if this template has a defined "Preview-image". |
boolean |
isWorkflowEnabled()
Returns whether user defined workflow has been enabled. |
void |
removeRenderMode(java.lang.String p_renderModeName)
Remove the render mode from this template. |
void |
setDefaultPresentationTemplate(DocumentId p_presentationTemplateId)
Set the default presentation template for this authoring template. |
void |
setPresentationTemplateForMode(java.lang.String p_renderModeName,
DocumentId p_presentationTemplateId)
Set the default presentation template for the target mode for this authoring template. |
void |
setWorkflowEnabled(boolean p_enabled)
Control whether user defined Workflow will be enabled on the items created from this template on creation. |
Field Detail |
---|
static final java.lang.String DEFAULT_PRESENTATION_IDENTIFIER
static final java.lang.String SUMMARY_PRESENTATION_IDENTIFIER
Method Detail |
---|
void setDefaultPresentationTemplate(DocumentId p_presentationTemplateId)
p_presentationTemplateId
- the DocumentId of the presentation template to set as the default. Use null to
specify that no default should be defined.DocumentId<PresentationTemplate> getDefaultPresentationTemplate() throws com.ibm.workplace.wcm.api.exceptions.AuthorizationException, com.ibm.workplace.wcm.api.exceptions.PropertyRetrievalException
com.ibm.workplace.wcm.api.exceptions.AuthorizationException
- if the user does not have the appropriate access to the PresentationTemplate
com.ibm.workplace.wcm.api.exceptions.PropertyRetrievalException
- if the PresentationTemplate
DocumentId cannot be retrievedvoid setPresentationTemplateForMode(java.lang.String p_renderModeName, DocumentId p_presentationTemplateId)
DEFAULT_PRESENTATION_IDENTIFIER
.
The render mode name "summary" indicates the "Summary Presentation". See SUMMARY_PRESENTATION_IDENTIFIER
.
p_renderModeName
- The name of the target render mode to associate with this presentation templatep_presentationTemplateId
- the DocumentId of the presentation template to set as the default. Use null to
specify that no default should be defined.
java.lang.IllegalArgumentException
- if the ID is not that of a presentation templateDocumentId<PresentationTemplate> getPresentationTemplateForMode(java.lang.String p_renderModeName) throws com.ibm.workplace.wcm.api.exceptions.AuthorizationException, com.ibm.workplace.wcm.api.exceptions.PropertyRetrievalException
p_renderModeName
- the name of the target render modes. Should not be null.
com.ibm.workplace.wcm.api.exceptions.AuthorizationException
- if the user does not have the appropriate access to the PresentationTemplate
com.ibm.workplace.wcm.api.exceptions.PropertyRetrievalException
- if the PresentationTemplate
DocumentId cannot be retrievedDocumentId<PresentationTemplate> getPresentationTemplateForModes(java.util.List<java.lang.String> p_renderModeNames) throws com.ibm.workplace.wcm.api.exceptions.AuthorizationException, com.ibm.workplace.wcm.api.exceptions.PropertyRetrievalException
DEFAULT_PRESENTATION_IDENTIFIER
.
The render mode name "summary" indicates the "Summary Presentation". See SUMMARY_PRESENTATION_IDENTIFIER
.
p_renderModeNames
- the names of the target render modes. Should not be null.
com.ibm.workplace.wcm.api.exceptions.AuthorizationException
- if the user does not have the appropriate access to the PresentationTemplate
com.ibm.workplace.wcm.api.exceptions.PropertyRetrievalException
- if the PresentationTemplate
DocumentId cannot be retrievedboolean hasPresentationTemplateForMode(java.lang.String p_renderModeName)
p_renderModeName
- the name of the target render mode
java.util.Set<java.lang.String> getAllSupportedRenderModes()
void removeRenderMode(java.lang.String p_renderModeName)
p_renderModeName
- the name of the render mode to removejava.util.Set<java.lang.String> getRenderModesForPresentationTemplate(DocumentId p_presentationTemplateId)
p_presentationTemplateId
- the DocumentId of the presentation mapped to a render mode
java.lang.IllegalArgumentException
- if the ID is not that of a presentation templatevoid setWorkflowEnabled(boolean p_enabled)
p_enabled
- true to enable workflow, otherwise false to disable workflowboolean isWorkflowEnabled()
false
will be returned.boolean hasPreviewImage()
true
if this template has a defined "Preview-image". This resource will be
used to replace the out of the box icon for all content created using this template.
true
if this template has a defined "Preview-image"FileComponent getPreviewImage()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |