Package com.priint.pubserverapi.document

Interface DocumentServiceLocal

public interface DocumentServiceLocal

Interface for a document service class.

Since:

4.5.0-object-storage

Method Summary

Modifier and Type	Method	Description
DocumentId	createDocumentFromTemplate(String sessionId, PublicationId parentPublicationId, DocumentId documentTemplateId, String newDocumentName, String masterPage)	Creates a new document from document template
List<DocumentId>	createMultipleDocumentsFromTemplate(String sessionId, PublicationId parentPublicationId, DocumentId documentTemplateId, List<String> newDocumentNames, String masterPage)	Creates multiple documents from document template
DocumentId	duplicateDocument(String sessionId, DocumentId documentId, PublicationId destinationPublicationId, String name, boolean tryToUseDocumentTemplate)	Duplicates a document

Method Details

duplicateDocument

DocumentId duplicateDocument(String sessionId,
 DocumentId documentId,
 PublicationId destinationPublicationId,
 String name,
 boolean tryToUseDocumentTemplate)

Duplicates a document

Parameters:

sessionId - id of the user session

documentId - id of the (source) document to duplicate

destinationPublicationId - id of the destination publication

name - new name of the document or empty for the same name

tryToUseDocumentTemplate - create a new document based on the document template from the source document

Returns:

id of the new created (duplicated) document

createDocumentFromTemplate

DocumentId createDocumentFromTemplate(String sessionId,
 PublicationId parentPublicationId,
 DocumentId documentTemplateId,
 String newDocumentName,
 String masterPage)

Creates a new document from document template

Parameters:

sessionId - id of the user session

parentPublicationId - id of the destination publication

documentTemplateId - id of the document template

newDocumentName - name of the new document

masterPage - master page of document template

Returns:

id of the new created document

createMultipleDocumentsFromTemplate

List<DocumentId> createMultipleDocumentsFromTemplate(String sessionId,
 PublicationId parentPublicationId,
 DocumentId documentTemplateId,
 List<String> newDocumentNames,
 String masterPage)

Creates multiple documents from document template

Parameters:

sessionId - id of the user session

parentPublicationId - id of the destination publication

documentTemplateId - id of the document template

newDocumentNames - list of names of the new documents

masterPage - master page of document template

Returns:

id of the new created document