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

getPlanningByIdentifier

java.util.List<Planning> getPlanningByIdentifier(java.lang.String identifier,
                                                 ConnectorEntity connectorEntity,
                                                 java.lang.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

java.util.List<Planning> getPlanningByDocument(java.lang.String documentId,
                                               ConnectorEntity connectorEntity,
                                               java.lang.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
java.util.List<Planning> getPlanningByPage(java.lang.String pageId,
                                           ConnectorEntity connectorEntity,
                                           java.lang.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

java.util.List<Planning> getPlanningByPage(java.lang.String pageIndex,
                                           Context context,
                                           ConnectorEntity connectorEntity,
                                           java.lang.String resultEntityId,
                                           java.lang.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

java.util.List<Planning> getPlanningByDocumentAndPage(java.lang.String documentId,
                                                      java.lang.String pageIndex,
                                                      Context context,
                                                      ConnectorEntity connectorEntity,
                                                      java.lang.String resultEntityId,
                                                      java.lang.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,
                 java.lang.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 java.util.Map<java.lang.String,Planning> clonePlanningsOfDocument(java.lang.String login,
                                                                                java.lang.String sourceDocumentId,
                                                                                java.lang.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

java.util.List<Planning> getSubPlanning(java.lang.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(java.util.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

java.util.List<Planning> getPlanningsBySnippetId(java.lang.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

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

Parameters:

sourcePlanningId -

context -

resultEntityId -

searchString -

Returns:

Throws:

DataSourceException

ConnectorException

getPlanningsOfPageBySourcePlanningId

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

Parameters:

sourcePlanningId -

pageIndex -

context -

resultEntityId -

searchString -

Returns:

Throws:

DataSourceException

ConnectorException

getPlanningsBySnippetOrigin

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

Parameters:

snippetOriginId -

context -

resultEntityId -

searchString -

Returns:

Throws:

DataSourceException

ConnectorException

getPlanningsOfPageBySnippetOrigin

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

Parameters:

snippetOriginId -

pageIndex -

context -

resultEntityId -

searchString -

Returns:

Throws:

DataSourceException

ConnectorException

getCountOfMediaAssetRefsOfPlanning

java.lang.Long getCountOfMediaAssetRefsOfPlanning(java.lang.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

java.lang.Long getCountOfTextRefsOfPlanning(java.lang.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

java.lang.Long getCountOfKeyValueRefsOfPlanning(java.lang.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

java.lang.Long getCountOfPriceRefsOfPlanning(java.lang.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

java.lang.Long getCountOfCordRefsOfPlanning(java.lang.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

java.lang.Long getCountOfSubBucketRefsOfPlanning(java.lang.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(java.util.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(java.util.List<java.lang.String> planningIds)
              throws ConnectorException

Throws:

ConnectorException

updatePlanning

void updatePlanning(Planning planning)
             throws ConnectorException

Throws:

ConnectorException

updatePlannings

void updatePlannings(java.util.List<Planning> plannings)
              throws ConnectorException

Throws:

ConnectorException

updateSequenceOfRootPlanning

void updateSequenceOfRootPlanning(java.util.List<Planning> plannings)
                           throws ConnectorException

This method sorts plannings on root level

Parameters:

plannings - - list of planning to sort

Throws:

ConnectorException

DataSourceException