Package com.priint.pubserver.plannerapi.interfaces

Interface PublicationsServiceLocal

public interface PublicationsServiceLocal

Local interface for the Publications service from the Planner API

Method Summary

Modifier and Type	Method	Description
List<Publication>	addPublications(List<Publication> publications)	Creates new publications
String	deletePublication(String id)	Deletes publication at the specified ID
Publication	getPublication(String id)	Returns the publication at the specified ID
List<Publication>	getPublications(PublicationsFilter searchParameters)	Returns the list of publications fulfilling the search criteria passed as parameter
List<Publication>	getPublicationsByMasterDocument(String masterDocumentID, PublicationsFilter searchParameters)	Returns the list of publications for specified master document and the search criteria
List<Publication>	getPublicationsByPageTemplate(String pageTemplateID, PublicationsFilter searchParameters)	Returns the list of publications for specified page template and the search criteria
List<Publication>	getPublicationsByStausID(String statusID, PublicationsFilter searchParameters)	Returns the list of publications for specified status ID and the search criteria
List<Publication>	getPublicationsByTemplate(String templateID, PublicationsFilter searchParameters)	Returns the list of publications for specified template and the search criteria
List<Publication>	getPublicationsByTodoID(String todoID, PublicationsFilter searchParameters)	Returns the list of publications for specified todo and the search criteria
List<Publication>	getPublicationsByWorkflowID(String workflowID, PublicationsFilter searchParameters)	Returns the list of publications for specified workflow and the search criteria
List<Publication>	getPublicationsForPublication(String publicationIDPath, PublicationsFilter searchParameters)	Returns the list of sub publications for the specified publication and fullfilling the search criteria
String	setPublication(Publication publication)	Modifies existing publication based on passed parameter
List<Publication>	setPublications(List<Publication> publications)	Modifies existing publications
List<Publication>	setPublicationsXPageTemplate(String pageTemplateID, List<Publication> publicationsList)	Sets specific page template for publications.
List<Publication>	setPublicationsXTemplate(String templateID, List<Publication> publicationsList)	Sets specific template for publications.

Method Details

getPublication

Publication getPublication(String id)
                    throws ServiceException,
ResourceNotFoundException

Returns the publication at the specified ID

Parameters:

id - publication id

Returns:

the publication

Throws:

ServiceException

ResourceNotFoundException

See Also:

• Publication

getPublications

List<Publication> getPublications(PublicationsFilter searchParameters)
                           throws ServiceException

Returns the list of publications fulfilling the search criteria passed as parameter

Parameters:

searchParameters - search criteria in PublicationsFilter object

Returns:

the list of publications

Throws:

ServiceException

See Also:

• Publication
• PublicationsFilter

setPublication

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

List<Publication> setPublications(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

List<Publication> addPublications(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

String deletePublication(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

List<Publication> getPublicationsByMasterDocument(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

List<Publication> getPublicationsByTemplate(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

List<Publication> setPublicationsXTemplate(String templateID,
 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

getPublicationsByTodoID

List<Publication> getPublicationsByTodoID(String todoID,
 PublicationsFilter searchParameters)
                                   throws ServiceException

Returns the list of publications for specified todo and the search criteria

Parameters:

todoID - todo ID

searchParameters - search criteria in the PublicationsFilter object

Returns:

the list of publications

Throws:

ServiceException

See Also:

• Publication
• PublicationsFilter

getPublicationsByWorkflowID

List<Publication> getPublicationsByWorkflowID(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

getPublicationsByStausID

List<Publication> getPublicationsByStausID(String statusID,
 PublicationsFilter searchParameters)
                                    throws ServiceException

Returns the list of publications for specified status ID and the search criteria

Parameters:

searchParameters - publicationsFilter object

Returns:

the list of publications

Throws:

ServiceException

See Also:

• Publication
• PublicationsFilter

getPublicationsForPublication

List<Publication> getPublicationsForPublication(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

List<Publication> getPublicationsByPageTemplate(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

List<Publication> setPublicationsXPageTemplate(String pageTemplateID,
 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