public abstract class AbstractRemotableTree extends Object implements PublicationTree
PublicationTree
that delegates method calls to a
remote service.Constructor and Description |
---|
AbstractRemotableTree() |
Modifier and Type | Method and Description |
---|---|
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. |
String |
getConfigName() |
List<PublishedDocument> |
getExistingPublishedDocument(DocumentLocation docLoc) |
PublicationNode |
getNodeByPath(String path) |
PublicationNode |
getParent() |
List<PublishedDocument> |
getPublishedDocumentInNode(PublicationNode node) |
boolean |
hasValidationTask(PublishedDocument publishedDocument) |
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,
Map<String,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,
String comment)
A validator (the current user) approves the publication.
|
void |
validatorRejectPublication(PublishedDocument publishedDocument,
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) |
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
getIconCollapsed, getIconExpanded, getTreeTitle, getTreeType, initTree
getChildrenDocuments, getChildrenNodes, getName, getNodeType, getPath, getSessionId, getTitle, getTreeConfigName, getType
public List<PublishedDocument> getExistingPublishedDocument(DocumentLocation docLoc) throws ClientException
getExistingPublishedDocument
in interface PublicationTree
ClientException
public List<PublishedDocument> getPublishedDocumentInNode(PublicationNode node) throws ClientException
getPublishedDocumentInNode
in interface PublicationTree
ClientException
public PublishedDocument publish(DocumentModel doc, PublicationNode targetNode) throws ClientException
publish
in interface PublicationTree
ClientException
public PublishedDocument publish(DocumentModel doc, PublicationNode targetNode, Map<String,String> params) throws ClientException
publish
in interface PublicationTree
ClientException
public void unpublish(DocumentModel doc, PublicationNode targetNode) throws ClientException
unpublish
in interface PublicationTree
ClientException
public void unpublish(PublishedDocument publishedDocument) throws ClientException
unpublish
in interface PublicationTree
ClientException
public PublicationNode getNodeByPath(String path) throws ClientException
getNodeByPath
in interface PublicationTree
ClientException
public String getConfigName()
getConfigName
in interface PublicationTree
public PublicationNode getParent()
getParent
in interface PublicationNode
public void setCurrentDocument(DocumentModel currentDocument) throws ClientException
PublicationTree
Can be useful for some implementations that need to know on which document the user is.
setCurrentDocument
in interface PublicationTree
currentDocument
- the current documentClientException
public void release()
release
in interface PublicationTree
public void validatorPublishDocument(PublishedDocument publishedDocument, String comment) throws ClientException
PublicationTree
validatorPublishDocument
in interface PublicationTree
publishedDocument
- the current published document that will be
approvedClientException
public void validatorRejectPublication(PublishedDocument publishedDocument, String comment) throws ClientException
PublicationTree
validatorRejectPublication
in interface PublicationTree
publishedDocument
- the currently published document that will be
rejectedClientException
public boolean canPublishTo(PublicationNode publicationNode) throws ClientException
PublicationTree
true
if the current user can publish to the specified publicationNode,
false
otherwise.canPublishTo
in interface PublicationTree
true
if the current user can publish to the specified publicationNode, false
otherwise.ClientException
public boolean canUnpublish(PublishedDocument publishedDocument) throws ClientException
PublicationTree
true
if the current user can unpublish the given publishedDocument,
false
otherwise.canUnpublish
in interface PublicationTree
true
if the current user can unpublish the given publishedDocument, false
otherwise.ClientException
public boolean hasValidationTask(PublishedDocument publishedDocument) throws ClientException
hasValidationTask
in interface PublicationTree
ClientException
public boolean canManagePublishing(PublishedDocument publishedDocument) throws ClientException
PublicationTree
true
if the current user can manage the publishing of the given publishedDocument,
ie approve or reject the document.canManagePublishing
in interface PublicationTree
ClientException
public PublishedDocument wrapToPublishedDocument(DocumentModel documentModel) throws ClientException
wrapToPublishedDocument
in interface PublicationTree
ClientException
public boolean isPublicationNode(DocumentModel documentModel) throws ClientException
PublicationTree
true
if the given documentModel
is a PublicationNode of the current tree,
false
otherwise.isPublicationNode
in interface PublicationTree
ClientException
public PublicationNode wrapToPublicationNode(DocumentModel documentModel) throws ClientException
PublicationTree
documentModel
.wrapToPublicationNode
in interface PublicationTree
ClientException
- if the given documentModel cannot be a PublicationNodeCopyright © 2013 Nuxeo SA. All Rights Reserved.