org.nuxeo.ecm.platform.publisher.api
Interface PublisherService

All Known Implementing Classes:

PublisherServiceImpl

public interface PublisherService

Main publication Service.

Author:

tiry

Field Summary

static java.lang.String

DOMAIN_NAME_KEY

Method Summary

java.util.List<java.lang.String>	getAvailablePublicationTree()
java.util.Map<java.lang.String,java.lang.String>	getAvailablePublicationTrees() Returns a Map with tree name as key and tree title as value.
java.util.Map<java.lang.String,java.lang.String>	getParametersFor(java.lang.String treeConfigName)
PublicationTree	getPublicationTree(java.lang.String treeName, CoreSession coreSession, java.util.Map<java.lang.String,java.lang.String> params)
PublicationTree	getPublicationTree(java.lang.String treeName, CoreSession coreSession, java.util.Map<java.lang.String,java.lang.String> params, DocumentModel currentDocument)
PublicationTree	getPublicationTreeFor(DocumentModel doc, CoreSession coreSession)
boolean	isPublishedDocument(DocumentModel documentModel)
PublishedDocument	publish(DocumentModel doc, PublicationNode targetNode)
PublishedDocument	publish(DocumentModel doc, PublicationNode targetNode, java.util.Map<java.lang.String,java.lang.String> params)
void	unpublish(DocumentModel doc, PublicationNode targetNode)
PublicationNode	wrapToPublicationNode(DocumentModel documentModel, CoreSession coreSession)

Field Detail

DOMAIN_NAME_KEY

static final java.lang.String DOMAIN_NAME_KEY

See Also:

Constant Field Values

Method Detail

getAvailablePublicationTree

java.util.List<java.lang.String> getAvailablePublicationTree()

getAvailablePublicationTrees

java.util.Map<java.lang.String,java.lang.String> getAvailablePublicationTrees()

Returns a Map with tree name as key and tree title as value.

getPublicationTree

PublicationTree getPublicationTree(java.lang.String treeName,
                                   CoreSession coreSession,
                                   java.util.Map<java.lang.String,java.lang.String> params)
                                   throws ClientException,
                                          PublicationTreeNotAvailable

Throws:

ClientException

PublicationTreeNotAvailable

getPublicationTree

PublicationTree getPublicationTree(java.lang.String treeName,
                                   CoreSession coreSession,
                                   java.util.Map<java.lang.String,java.lang.String> params,
                                   DocumentModel currentDocument)
                                   throws ClientException,
                                          PublicationTreeNotAvailable

Throws:

ClientException

PublicationTreeNotAvailable

publish

PublishedDocument publish(DocumentModel doc,
                          PublicationNode targetNode)
                          throws ClientException

Throws:

ClientException

publish

PublishedDocument publish(DocumentModel doc,
                          PublicationNode targetNode,
                          java.util.Map<java.lang.String,java.lang.String> params)
                          throws ClientException

Throws:

ClientException

unpublish

void unpublish(DocumentModel doc,
               PublicationNode targetNode)
               throws ClientException

Throws:

ClientException

isPublishedDocument

boolean isPublishedDocument(DocumentModel documentModel)

getPublicationTreeFor

PublicationTree getPublicationTreeFor(DocumentModel doc,
                                      CoreSession coreSession)
                                      throws ClientException

Throws:

ClientException

wrapToPublicationNode

PublicationNode wrapToPublicationNode(DocumentModel documentModel,
                                      CoreSession coreSession)
                                      throws ClientException,
                                             PublicationTreeNotAvailable

Throws:

ClientException

PublicationTreeNotAvailable

getParametersFor

java.util.Map<java.lang.String,java.lang.String> getParametersFor(java.lang.String treeConfigName)