Package com.priint.pubserver.plugin.interfaces

Interface PublishingManagementConnector

All Superinterfaces:

PluginControl

All Known Subinterfaces:

ConnectorLocal

All Known Implementing Classes:

AbstractConnector

public interface PublishingManagementConnector
extends PluginControl

This interface contains methods used by planning.

Method Summary

Modifier and Type	Method	Description
void	addRootPlannings(List<Planning> plannings)	This method add new plannings on root level
void	changeParentRealGridElementForPlannedBuckets(List<Planning> planningList, Planning realGridElemet)	This method moves list of Planning to another Real Grid element
default Map<String,Planning>	clonePlanningsOfDocument(String login, String sourceDocumentId, String targetDocumentId)	This method clones plannings from one document to the other
void	deletePlannings(List<String> planningIds)
Long	getCountOfCordRefsOfPlanning(String planningId, Context context)	This method returns a number of planned cords in given planning
Long	getCountOfKeyValueRefsOfPlanning(String planningId, Context context)	This method returns a number of planned key values in given planning
Long	getCountOfMediaAssetRefsOfPlanning(String planningId, Context context)	This method returns a number of planned media assets in given planning
Long	getCountOfPriceRefsOfPlanning(String planningId, Context context)	This method returns a number of planned prices in given planning
Long	getCountOfSubBucketRefsOfPlanning(String planningId, Context context)	This method returns a number of planned sub-buckets in given planning
Long	getCountOfTextRefsOfPlanning(String planningId, Context context)	This method returns a number of planned texts in given planning
List<Planning>	getPlanningByDocument(String documentId, ConnectorEntity connectorEntity, String searchStr)	This method returns a List of Planning objects searched by the referenced documentId
List<Planning>	getPlanningByDocumentAndPage(String documentId, String pageIndex, Context context, ConnectorEntity connectorEntity, String resultEntityId, String searchString)	This method returns a list of planning objects searched by the referenced pageIndex in given document
List<Planning>	getPlanningByIdentifier(String identifier, ConnectorEntity connectorEntity, String searchStr)	This method returns a List of Planning objects searched by their Identifier
List<Planning>	getPlanningByPage(String pageId, ConnectorEntity connectorEntity, String searchStr)	Deprecated. Replaced by getPlanningByPage(String, Context, ConnectorEntity, String, String)
List<Planning>	getPlanningByPage(String pageIndex, Context context, ConnectorEntity connectorEntity, String resultEntityId, String searchString)	This method returns a list of planning objects searched by the referenced pageIndex in given document
List<Planning>	getPlanningsBySnippetId(String snippetId)	This method returns plannings with assigned snippet by snippet id
List<Planning>	getPlanningsBySnippetOrigin(String snippetOriginId, Context context, String resultEntityId, String searchString)
List<Planning>	getPlanningsBySourcePlanningId(String sourcePlanningId, Context context, String resultEntityId, String searchString)
List<Planning>	getPlanningsOfPageBySnippetOrigin(String snippetOriginId, int pageIndex, Context context, String resultEntityId, String searchString)
List<Planning>	getPlanningsOfPageBySourcePlanningId(String sourcePlanningId, int pageIndex, Context context, String resultEntityId, String searchString)
List<Planning>	getSubPlanning(String parentPlanningId)	This method returns sub Planning
void	setPlanning(Planning planning, String searchStr)	This method persist a Planning object
void	updatePlanning(Planning planning)
void	updatePlannings(List<Planning> plannings)
void	updateSequenceOfRootPlanning(List<Planning> plannings)	This method sorts plannings on root level

Methods inherited from interface com.priint.pubserver.plugin.interfaces.PluginControl

afterCreateConfigurations, afterDeleteConfigurations, afterUpdateConfigurations, createConfiguration, deleteConfigurations, initInstance, loadServerConfig, ping, updateConfigurations, validateConfigurations

Method Details

getPlanningByIdentifier

List<Planning> getPlanningByIdentifier(String identifier,
 ConnectorEntity connectorEntity,
 String searchStr)
                                throws DataSourceException,
ConnectorException

This method returns a List of Planning objects searched by their Identifier

Parameters:

identifier - planning identifier

connectorEntity - connector entity

searchStr - search string

Returns:

list of Planning

Throws:

ConnectorException

DataSourceException

getPlanningByDocument

List<Planning> getPlanningByDocument(String documentId,
 ConnectorEntity connectorEntity,
 String searchStr)
                              throws DataSourceException,
ConnectorException

This method returns a List of Planning objects searched by the referenced documentId

Parameters:

documentId - document Id

connectorEntity - connector entity

searchStr - search string

Returns:

list of Planning

Throws:

ConnectorException

DataSourceException

getPlanningByPage

@Deprecated
List<Planning> getPlanningByPage(String pageId,
 ConnectorEntity connectorEntity,
 String searchStr)
                          throws DataSourceException,
ConnectorException

Deprecated.

Replaced by getPlanningByPage(String, Context, ConnectorEntity, String, String)

This method returns a List of Planning objects searched by the referenced pageId

Parameters:

pageId - page Id

connectorEntity - connector entity

searchStr - search string

Returns:

list of Planning

Throws:

ConnectorException

DataSourceException

getPlanningByPage

List<Planning> getPlanningByPage(String pageIndex,
 Context context,
 ConnectorEntity connectorEntity,
 String resultEntityId,
 String searchString)
                          throws DataSourceException,
ConnectorException

This method returns a list of planning objects searched by the referenced pageIndex in given document

Parameters:

pageIndex - zero based index of the page in the document

context - context criteria, including documentId

connectorEntity - connector entity

resultEntityId - entity Id of the result records

searchString - search string

Returns:

list of Planning

Throws:

ConnectorException

DataSourceException

getPlanningByDocumentAndPage

List<Planning> getPlanningByDocumentAndPage(String documentId,
 String pageIndex,
 Context context,
 ConnectorEntity connectorEntity,
 String resultEntityId,
 String searchString)
                                     throws DataSourceException,
ConnectorException

This method returns a list of planning objects searched by the referenced pageIndex in given document

Parameters:

documentId - document ID

pageIndex - zero based index of the page in the document

context - context criteria, including documentId

connectorEntity - connector entity

resultEntityId - entity Id of the result records

searchString - search string

Returns:

list of Planning

Throws:

ConnectorException

DataSourceException

setPlanning

void setPlanning(Planning planning,
 String searchStr)
          throws DataSourceException,
ConnectorException

This method persist a Planning object

Parameters:

planning - planning object to persist

searchStr - search string

Throws:

ConnectorException

DataSourceException

clonePlanningsOfDocument

default Map<String,Planning> clonePlanningsOfDocument(String login,
 String sourceDocumentId,
 String targetDocumentId)
                                               throws DataSourceException,
ConnectorException

This method clones plannings from one document to the other

Parameters:

login - user login name

sourceDocumentId - source document Id

targetDocumentId - target document Id

Returns:

map with original planning id as a key and a new planning as value

Throws:

ConnectorException

DataSourceException

getSubPlanning

List<Planning> getSubPlanning(String parentPlanningId)
                       throws ConnectorException,
DataSourceException

This method returns sub Planning

Parameters:

parentPlanningId - identifier of parent Planning

Returns:

list of sub plannings

Throws:

ConnectorException

DataSourceException

changeParentRealGridElementForPlannedBuckets

void changeParentRealGridElementForPlannedBuckets(List<Planning> planningList,
 Planning realGridElemet)
                                           throws ConnectorException,
DataSourceException

This method moves list of Planning to another Real Grid element

Parameters:

planningList - list of Planning

realGridElemet - realGridElelemt

Throws:

ConnectorException

DataSourceException

getPlanningsBySnippetId

List<Planning> getPlanningsBySnippetId(String snippetId)
                                throws ConnectorException,
DataSourceException

This method returns plannings with assigned snippet by snippet id

Parameters:

snippetId - identifier of the snippet

Returns:

List of plannings

Throws:

ConnectorException

DataSourceException

getPlanningsBySourcePlanningId

List<Planning> getPlanningsBySourcePlanningId(String sourcePlanningId,
 Context context,
 String resultEntityId,
 String searchString)
                                       throws DataSourceException,
ConnectorException

Parameters:

sourcePlanningId -

context -

resultEntityId -

searchString -

Returns:

Throws:

DataSourceException

ConnectorException

getPlanningsOfPageBySourcePlanningId

List<Planning> getPlanningsOfPageBySourcePlanningId(String sourcePlanningId,
 int pageIndex,
 Context context,
 String resultEntityId,
 String searchString)
                                             throws DataSourceException,
ConnectorException

Parameters:

sourcePlanningId -

pageIndex -

context -

resultEntityId -

searchString -

Returns:

Throws:

DataSourceException

ConnectorException

getPlanningsBySnippetOrigin

List<Planning> getPlanningsBySnippetOrigin(String snippetOriginId,
 Context context,
 String resultEntityId,
 String searchString)
                                    throws DataSourceException,
ConnectorException

Parameters:

snippetOriginId -

context -

resultEntityId -

searchString -

Returns:

Throws:

DataSourceException

ConnectorException

getPlanningsOfPageBySnippetOrigin

List<Planning> getPlanningsOfPageBySnippetOrigin(String snippetOriginId,
 int pageIndex,
 Context context,
 String resultEntityId,
 String searchString)
                                          throws DataSourceException,
ConnectorException

Parameters:

snippetOriginId -

pageIndex -

context -

resultEntityId -

searchString -

Returns:

Throws:

DataSourceException

ConnectorException

getCountOfMediaAssetRefsOfPlanning

Long getCountOfMediaAssetRefsOfPlanning(String planningId,
 Context context)
                                 throws NotImplementedException,
DataSourceException,
ConnectorException

This method returns a number of planned media assets in given planning

Parameters:

planningId - planning identifier

context - context criteria

Returns:

number of planned media assets (Long)

Throws:

ConnectorException

DataSourceException

NotImplementedException

getCountOfTextRefsOfPlanning

Long getCountOfTextRefsOfPlanning(String planningId,
 Context context)
                           throws NotImplementedException,
DataSourceException,
ConnectorException

This method returns a number of planned texts in given planning

Parameters:

planningId - planning identifier

context - context criteria

Returns:

number of planned media assets (Long)

Throws:

ConnectorException

DataSourceException

NotImplementedException

getCountOfKeyValueRefsOfPlanning

Long getCountOfKeyValueRefsOfPlanning(String planningId,
 Context context)
                               throws NotImplementedException,
DataSourceException,
ConnectorException

This method returns a number of planned key values in given planning

Parameters:

planningId - planning identifier

context - context criteria

Returns:

number of planned media assets (Long)

Throws:

ConnectorException

DataSourceException

NotImplementedException

getCountOfPriceRefsOfPlanning

Long getCountOfPriceRefsOfPlanning(String planningId,
 Context context)
                            throws NotImplementedException,
DataSourceException,
ConnectorException

This method returns a number of planned prices in given planning

Parameters:

planningId - planning identifier

context - context criteria

Returns:

number of planned media assets (Long)

Throws:

ConnectorException

DataSourceException

NotImplementedException

getCountOfCordRefsOfPlanning

Long getCountOfCordRefsOfPlanning(String planningId,
 Context context)
                           throws NotImplementedException,
DataSourceException,
ConnectorException

This method returns a number of planned cords in given planning

Parameters:

planningId - planning identifier

context - context criteria

Returns:

number of planned media assets (Long)

Throws:

ConnectorException

DataSourceException

NotImplementedException

getCountOfSubBucketRefsOfPlanning

Long getCountOfSubBucketRefsOfPlanning(String planningId,
 Context context)
                                throws NotImplementedException,
DataSourceException,
ConnectorException

This method returns a number of planned sub-buckets in given planning

Parameters:

planningId - planning identifier

context - context criteria

Returns:

number of planned media assets (Long)

Throws:

ConnectorException

DataSourceException

NotImplementedException

addRootPlannings

void addRootPlannings(List<Planning> plannings)
               throws DataSourceException,
ConnectorException

This method add new plannings on root level

Parameters:

plannings - - list of planning to add

Throws:

ConnectorException

DataSourceException

deletePlannings

void deletePlannings(List<String> planningIds)
              throws ConnectorException

Throws:

ConnectorException

updatePlanning

void updatePlanning(Planning planning)
             throws ConnectorException

Throws:

ConnectorException

updatePlannings

void updatePlannings(List<Planning> plannings)
              throws ConnectorException

Throws:

ConnectorException

updateSequenceOfRootPlanning

void updateSequenceOfRootPlanning(List<Planning> plannings)
                           throws ConnectorException

This method sorts plannings on root level

Parameters:

plannings - - list of planning to sort

Throws:

ConnectorException

DataSourceException