org.nuxeo.ecm.platform.publisher.api

Interface PublisherService

All Known Implementing Classes:

PublisherServiceImpl

public interface PublisherService

Main publication Service.

Author:

tiry

Field Summary

Fields

Modifier and Type	Field and Description
static String	DOMAIN_NAME_KEY

Method Summary

Methods

Modifier and Type	Method and Description
List<String>	getAvailablePublicationTree()
Map<String,String>	getAvailablePublicationTrees() Returns a Map with tree name as key and tree title as value.
Map<String,String>	getParametersFor(String treeConfigName)
PublicationTree	getPublicationTree(String treeName, CoreSession coreSession, Map<String,String> params)
PublicationTree	getPublicationTree(String treeName, CoreSession coreSession, Map<String,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, Map<String,String> params)
void	unpublish(DocumentModel doc, PublicationNode targetNode)
PublicationNode	wrapToPublicationNode(DocumentModel documentModel, CoreSession coreSession)

Field Detail

DOMAIN_NAME_KEY

static final String DOMAIN_NAME_KEY

See Also:

Constant Field Values

Method Detail

getAvailablePublicationTree

List<String> getAvailablePublicationTree()

getAvailablePublicationTrees

Map<String,String> getAvailablePublicationTrees()

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

getPublicationTree

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

Throws:

ClientException

PublicationTreeNotAvailable

getPublicationTree

PublicationTree getPublicationTree(String treeName,
                                 CoreSession coreSession,
                                 Map<String,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,
                        Map<String,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

Map<String,String> getParametersFor(String treeConfigName)