|
Nuxeo Enterprise Platform 5.4 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface PublicationTree
Interface for the publication tree. A Publication Tree is a generic view on a set of PublicationNode.
Method Summary | |
---|---|
boolean |
canManagePublishing(PublishedDocument publishedDocument)
Returns true if the current user can manage the publishing of the given publishedDocument,
ie approve or reject the document. |
boolean |
canPublishTo(PublicationNode publicationNode)
Returns true if the current user can publish to the specified publicationNode,
false otherwise. |
boolean |
canUnpublish(PublishedDocument publishedDocument)
Returns true if the current user can unpublish the given publishedDocument,
false otherwise. |
java.lang.String |
getConfigName()
|
java.util.List<PublishedDocument> |
getExistingPublishedDocument(DocumentLocation docLoc)
|
java.lang.String |
getIconCollapsed()
|
java.lang.String |
getIconExpanded()
|
PublicationNode |
getNodeByPath(java.lang.String path)
|
java.util.List<PublishedDocument> |
getPublishedDocumentInNode(PublicationNode node)
|
java.lang.String |
getTreeTitle()
|
java.lang.String |
getTreeType()
|
boolean |
hasValidationTask(PublishedDocument publishedDocument)
|
void |
initTree(java.lang.String sid,
CoreSession coreSession,
java.util.Map<java.lang.String,java.lang.String> parameters,
PublishedDocumentFactory factory,
java.lang.String configName,
java.lang.String title)
|
boolean |
isPublicationNode(DocumentModel documentModel)
Returns true if the given documentModel is a PublicationNode of the current tree,
false otherwise. |
PublishedDocument |
publish(DocumentModel doc,
PublicationNode targetNode)
|
PublishedDocument |
publish(DocumentModel doc,
PublicationNode targetNode,
java.util.Map<java.lang.String,java.lang.String> params)
|
void |
release()
|
void |
setCurrentDocument(DocumentModel currentDocument)
Sets the current document on which the tree will be based, if needed. |
void |
unpublish(DocumentModel doc,
PublicationNode targetNode)
|
void |
unpublish(PublishedDocument publishedDocument)
|
void |
validatorPublishDocument(PublishedDocument publishedDocument,
java.lang.String comment)
A validator (the current user) approves the publication. |
void |
validatorRejectPublication(PublishedDocument publishedDocument,
java.lang.String comment)
A validator (the current user) rejects the publication. |
PublicationNode |
wrapToPublicationNode(DocumentModel documentModel)
Returns a PublicationNode for the current tree built on the given documentModel . |
PublishedDocument |
wrapToPublishedDocument(DocumentModel documentModel)
|
Methods inherited from interface org.nuxeo.ecm.platform.publisher.api.PublicationNode |
---|
getChildrenDocuments, getChildrenNodes, getName, getNodeType, getParent, getPath, getSessionId, getTitle, getTreeConfigName, getType |
Method Detail |
---|
PublicationNode getNodeByPath(java.lang.String path) throws ClientException
ClientException
PublishedDocument publish(DocumentModel doc, PublicationNode targetNode) throws ClientException
ClientException
PublishedDocument publish(DocumentModel doc, PublicationNode targetNode, java.util.Map<java.lang.String,java.lang.String> params) throws ClientException
ClientException
void unpublish(DocumentModel doc, PublicationNode targetNode) throws ClientException
ClientException
void unpublish(PublishedDocument publishedDocument) throws ClientException
ClientException
java.util.List<PublishedDocument> getExistingPublishedDocument(DocumentLocation docLoc) throws ClientException
ClientException
java.util.List<PublishedDocument> getPublishedDocumentInNode(PublicationNode node) throws ClientException
ClientException
java.lang.String getConfigName()
java.lang.String getTreeType()
java.lang.String getTreeTitle()
void initTree(java.lang.String sid, CoreSession coreSession, java.util.Map<java.lang.String,java.lang.String> parameters, PublishedDocumentFactory factory, java.lang.String configName, java.lang.String title) throws ClientException
ClientException
void setCurrentDocument(DocumentModel currentDocument) throws ClientException
Can be useful for some implementations that need to know on which document the user is.
currentDocument
- the current document
ClientException
void release()
java.lang.String getIconExpanded()
java.lang.String getIconCollapsed()
void validatorPublishDocument(PublishedDocument publishedDocument, java.lang.String comment) throws ClientException
publishedDocument
- the current published document that will be
approvedcomment
-
ClientException
void validatorRejectPublication(PublishedDocument publishedDocument, java.lang.String comment) throws ClientException
publishedDocument
- the currently published document that will be
rejectedcomment
-
ClientException
boolean canPublishTo(PublicationNode publicationNode) throws ClientException
true
if the current user can publish to the specified publicationNode,
false
otherwise.
true
if the current user can publish to the specified publicationNode, false
otherwise.
ClientException
boolean canUnpublish(PublishedDocument publishedDocument) throws ClientException
true
if the current user can unpublish the given publishedDocument,
false
otherwise.
true
if the current user can unpublish the given publishedDocument, false
otherwise.
ClientException
boolean hasValidationTask(PublishedDocument publishedDocument) throws ClientException
ClientException
boolean canManagePublishing(PublishedDocument publishedDocument) throws ClientException
true
if the current user can manage the publishing of the given publishedDocument,
ie approve or reject the document.
ClientException
PublishedDocument wrapToPublishedDocument(DocumentModel documentModel) throws ClientException
ClientException
boolean isPublicationNode(DocumentModel documentModel) throws ClientException
true
if the given documentModel
is a PublicationNode of the current tree,
false
otherwise.
ClientException
PublicationNode wrapToPublicationNode(DocumentModel documentModel) throws ClientException
documentModel
.
ClientException
- if the given documentModel cannot be a PublicationNode
|
Nuxeo Enterprise Platform 5.4 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |