org.nuxeo.ecm.webapp.documenttemplates
Interface DocumentTemplatesActions

All Known Implementing Classes:

DocumentTemplatesActionsBean

public interface DocumentTemplatesActions

Stateful Seam component.

• lookup of document templates
• creation of document from a template

Method Summary

java.lang.String	createDocumentFromTemplate() Creates a Document from a template using the selectedTemplateId and the changeableDocument.
java.lang.String	createDocumentFromTemplate(DocumentModel doc) Creates a Document from a template using the selectedTemplateId.
java.lang.String	createDocumentFromTemplate(DocumentModel doc, java.lang.String templateId) Creates a Document from a template.
void	destroy() Removes the components.
void	documentChildrenChanged(DocumentModel targetDoc) Listener to children changed event.
void	domainChanged(DocumentModel targetDoc) Listener for domain changed event.
java.lang.String	getSelectedTemplateId() Getter of the selected template id.
java.lang.String	getTargetType() Getter for type of the document to be created.
DocumentModelList	getTemplates()
DocumentModelList	getTemplates(java.lang.String targetTypeName)
void	setSelectedTemplateId(java.lang.String requestedId) Setter for the template to use.
void	setTargetType(java.lang.String targetType) Setter for the type of document to be created.
DocumentModelList	templatesListFactory() Factory accessor on the getter.

Method Detail

destroy

void destroy()

Removes the components.

getTemplates

DocumentModelList getTemplates()
                               throws ClientException

Returns:

list of DocumentModels of available templates of currently selected type.

Throws:

ClientException

getTemplates

DocumentModelList getTemplates(java.lang.String targetTypeName)
                               throws ClientException

Throws:

ClientException

templatesListFactory

DocumentModelList templatesListFactory()

Factory accessor on the getter.

createDocumentFromTemplate

java.lang.String createDocumentFromTemplate(DocumentModel doc,
                                            java.lang.String templateId)
                                            throws ClientException

Creates a Document from a template.

Parameters:

doc - the DocumentModel with edited data

templateId - the template id

Throws:

ClientException

createDocumentFromTemplate

java.lang.String createDocumentFromTemplate(DocumentModel doc)
                                            throws ClientException

Creates a Document from a template using the selectedTemplateId.

Throws:

ClientException

createDocumentFromTemplate

java.lang.String createDocumentFromTemplate()
                                            throws ClientException

Creates a Document from a template using the selectedTemplateId and the changeableDocument.

Throws:

ClientException

getSelectedTemplateId

java.lang.String getSelectedTemplateId()

Getter of the selected template id.

setSelectedTemplateId

void setSelectedTemplateId(java.lang.String requestedId)

Setter for the template to use.

getTargetType

java.lang.String getTargetType()

Getter for type of the document to be created.

setTargetType

void setTargetType(java.lang.String targetType)

Setter for the type of document to be created.

documentChildrenChanged

void documentChildrenChanged(DocumentModel targetDoc)

Listener to children changed event.

domainChanged

void domainChanged(DocumentModel targetDoc)

Listener for domain changed event.