Package com.priint.pubserver.plannerapi.interfaces

Interface PublicationsServiceLocal

  • public interface PublicationsServiceLocal
    Local interface for the Publications service from the Planner API

    • Method Detail

      • setPublication

        java.lang.String setPublication​(Publication publication)
                         throws ServiceException,
                                ResourceNotFoundException
        Modifies existing publication based on passed parameter

        Publication ID from passed parameter is used to find existing publication.
        If field 'deleted' is changed from false to true it will be applied for publication and all sub publications and documents.

        Parameters:
        publication - the publication object
        Returns:
        publication ID
        Throws:
        ServiceException
        ResourceNotFoundException
        See Also:
        Publication

      • setPublications

        java.util.List<Publication> setPublications​(java.util.List<Publication> publications)
                                     throws ServiceException,
                                            ResourceNotFoundException
        Modifies existing publications

        For each publication object from the list the existing publication found by publication ID is updated.
        If field 'deleted' is changed from false to true it will be applied for the publication and all sub publications and documents.

        Parameters:
        publications - the list of publications to update
        Returns:
        List of processed publications. Each Publication object from the list contains status code of the operation
        Throws:
        ServiceException
        ResourceNotFoundException
        See Also:
        Publication

      • addPublications

        java.util.List<Publication> addPublications​(java.util.List<Publication> publications)
                                     throws ServiceException
        Creates new publications

        For each publication object from the list the new publication is created.
        Parameters are created by PublicationType (Parameters are assigned to publication types).
        If it is not a root publication it inherits Master Documents, Templates, PageTemplates, SearchNReplace and ImpProfileCB from parent publication. Publication rights are set for user who creates publications.

        Parameters:
        publications - the list of publications to create
        Returns:
        the list of processed publications. Each Publication object from the list contains status code of the operation and new publication ID
        Throws:
        ServiceException
        See Also:
        Publication

      • deletePublication

        java.lang.String deletePublication​(java.lang.String id)
                            throws ServiceException
        Deletes publication at the specified ID

        Deletes publication and all sub publications of it and all documents from them.

        Parameters:
        id - publication id
        Returns:
        id of deleted publication
        Throws:
        ServiceException

      • getPublicationsByMasterDocument

        java.util.List<Publication> getPublicationsByMasterDocument​(java.lang.String masterDocumentID,
                                                            PublicationsFilter searchParameters)
                                                     throws ServiceException
        Returns the list of publications for specified master document and the search criteria
        Parameters:
        masterDocumentID - master document ID
        searchParameters - search criteria in the PublicationsFilter object
        Returns:
        the list of publications
        Throws:
        ServiceException
        See Also:
        Publication, PublicationsFilter

      • getPublicationsByTemplate

        java.util.List<Publication> getPublicationsByTemplate​(java.lang.String templateID,
                                                      PublicationsFilter searchParameters)
                                               throws ServiceException
        Returns the list of publications for specified template and the search criteria
        Parameters:
        templateID - template ID
        searchParameters - search criteria in the PublicationsFilter object
        Returns:
        the list of publications
        Throws:
        ServiceException
        See Also:
        Publication, PublicationsFilter

      • setPublicationsXTemplate

        java.util.List<Publication> setPublicationsXTemplate​(java.lang.String templateID,
                                                     java.util.List<Publication> publicationsList)
                                              throws ServiceException
        Sets specific template for publications.

        For each publication object from the list the template of given ID is set.

        Parameters:
        templateID - template ID
        publicationsList - the list of publication
        Returns:
        the list of processed publications. Each Publication object from the list contains status code of the operation
        Throws:
        ServiceException
        See Also:
        Publication

      • getPublicationsByWorkflowID

        java.util.List<Publication> getPublicationsByWorkflowID​(java.lang.String workflowID,
                                                        PublicationsFilter searchParameters)
                                                 throws ServiceException
        Returns the list of publications for specified workflow and the search criteria
        Parameters:
        workflowID - workflow ID
        searchParameters - search criteria in the PublicationsFilter object
        Returns:
        the list of publications
        Throws:
        ServiceException
        See Also:
        Publication, PublicationsFilter

      • getPublicationsForPublication

        java.util.List<Publication> getPublicationsForPublication​(java.lang.String publicationIDPath,
                                                          PublicationsFilter searchParameters)
                                                   throws ServiceException
        Returns the list of sub publications for the specified publication and fullfilling the search criteria
        Parameters:
        publicationIDPath - publication ID path
        searchParameters - the search criteria in the PublicationsFilter object
        Returns:
        the list of publications
        Throws:
        ServiceException
        See Also:
        Publication, PublicationsFilter

      • getPublicationsByPageTemplate

        java.util.List<Publication> getPublicationsByPageTemplate​(java.lang.String pageTemplateID,
                                                          PublicationsFilter searchParameters)
                                                   throws ServiceException
        Returns the list of publications for specified page template and the search criteria
        Parameters:
        pageTemplateID - page template ID
        searchParameters - search criteria in the PublicationsFilter object
        Returns:
        the list of publications
        Throws:
        ServiceException
        See Also:
        Publication, PublicationsFilter

      • setPublicationsXPageTemplate

        java.util.List<Publication> setPublicationsXPageTemplate​(java.lang.String pageTemplateID,
                                                         java.util.List<Publication> publicationsList)
                                                  throws ServiceException
        Sets specific page template for publications.

        For each Publication object from the list the page template of given ID is set.

        Parameters:
        pageTemplateID - page template ID
        publicationsList - the list of publication
        Returns:
        the list of processed publications. Each Publication object from the list contains status code of the operation
        Throws:
        ServiceException
        See Also:
        Publication