|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface TemplatedDocument
An interface defining a Document
that can be templated using
an AuthoringTemplate
Method Summary | |
---|---|
DocumentId |
getAuthoringTemplateID()
Returns the ID of the AuthoringTemplate that was used to
create this TemplatedDocument . |
void |
setAuthoringTemplateID(DocumentId authoringTemplateID)
Sets the authoring template associated with this TemplatedDocument . |
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 |
Method Detail |
---|
DocumentId getAuthoringTemplateID() throws com.ibm.workplace.wcm.api.exceptions.AuthorizationException, com.ibm.workplace.wcm.api.exceptions.PropertyRetrievalException
AuthoringTemplate
that was used to
create this TemplatedDocument
.
AuthoringTemplate
com.ibm.workplace.wcm.api.exceptions.AuthorizationException
- if the user does not have access to the template
com.ibm.workplace.wcm.api.exceptions.PropertyRetrievalException
- if an error occurred while retrieving the templatevoid setAuthoringTemplateID(DocumentId authoringTemplateID) throws com.ibm.workplace.wcm.api.exceptions.IllegalDocumentTypeException
TemplatedDocument
.
Note: This method updates the authoring template reference only and does not
change the ContentComponent
s on the
TemplatedDocument
to match the authoring template. This must be done
manually via the add/update/remove component methods.
note: since
v6.0.0
, a ContentComponent
is
referred to as an "Element"
in the Authoring UI.
authoringTemplateID
- The ID of the AuthoringTemplate
to associate with this TemplatedDocument
. Can not be null.
com.ibm.workplace.wcm.api.exceptions.IllegalDocumentTypeException
- If the supplied ID is not an AuthoringTemplate
of the correct type that corresponds to the
TemplatedDocument
type
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |