Package org.nuxeo.ecm.platform.publisher.api

Interface PublishedDocumentFactory

All Known Implementing Classes:
AbstractBasePublishedDocumentFactory, CoreProxyFactory, CoreProxyWithWorkflowFactory, FolderishProxyFactory, RenditionPublicationFactory
public interface PublishedDocumentFactory
Interface of the pluggable factory used to create a PublishedDocument in a give PublicationTree.
Author:
tiry

  • Method Details

    • getName

      String getName()

    • publishDocument

      PublishedDocument publishDocument(DocumentModel doc, PublicationNode targetNode)

    • publishDocument

      PublishedDocument publishDocument(DocumentModel doc, PublicationNode targetNode, Map<String,String> params)

    • init

      void init(CoreSession coreSession, ValidatorsRule validatorsRule, Map<String,String> parameters)

    • init

      void init(CoreSession coreSession, Map<String,String> parameters)

    • snapshotDocumentBeforePublish

      DocumentModel snapshotDocumentBeforePublish(DocumentModel doc)

    • wrapDocumentModel

      PublishedDocument wrapDocumentModel(DocumentModel doc)

    • getValidatorsFor

      String[] getValidatorsFor(DocumentModel dm)
      Computes the list of publishing validators given the document model of the document just published. The string can be prefixed with 'group:' or 'user:'. If there is no prefix (no : in the string) it is assumed to be a user.
      Parameters:
      dm - a Nuxeo Core document model. (the document that just has been published)
      Returns:
      a list of principal names.

    • getValidatorsRule

      ValidatorsRule getValidatorsRule()
      Returns the registered section validators rule.
      Returns:
      a validators rule

    • validatorPublishDocument

      void validatorPublishDocument(PublishedDocument publishedDocument, String comment)
      A validator (the current user) approves the publication.
      Parameters:
      publishedDocument - the current published document that will be approved

    • validatorRejectPublication

      void validatorRejectPublication(PublishedDocument publishedDocument, String comment)
      A validator (the current user) rejects the publication.
      Parameters:
      publishedDocument - the currently published document that will be rejected

    • hasValidationTask

      boolean hasValidationTask(PublishedDocument publishedDocument)

    • canManagePublishing

      boolean canManagePublishing(PublishedDocument publishedDocument)