Interface PublishingManagementConnector
- All Superinterfaces:
PluginControl
- All Known Subinterfaces:
ConnectorLocal
- All Known Implementing Classes:
AbstractConnector
This interface contains methods used by planning.
-
Method Summary
Modifier and TypeMethodDescriptionvoidaddRootPlannings(List<Planning> plannings) This method add new plannings on root levelvoidchangeParentRealGridElementForPlannedBuckets(List<Planning> planningList, Planning realGridElemet) This method moves list of Planning to another Real Grid elementclonePlanningsOfDocument(String login, String sourceDocumentId, String targetDocumentId) This method clones plannings from one document to the othervoiddeletePlannings(List<String> planningIds) getCountOfCordRefsOfPlanning(String planningId, Context context) This method returns a number of planned cords in given planninggetCountOfKeyValueRefsOfPlanning(String planningId, Context context) This method returns a number of planned key values in given planninggetCountOfMediaAssetRefsOfPlanning(String planningId, Context context) This method returns a number of planned media assets in given planninggetCountOfPriceRefsOfPlanning(String planningId, Context context) This method returns a number of planned prices in given planninggetCountOfSubBucketRefsOfPlanning(String planningId, Context context) This method returns a number of planned sub-buckets in given planninggetCountOfTextRefsOfPlanning(String planningId, Context context) This method returns a number of planned texts in given planninggetPlanningByDocument(String documentId, ConnectorEntity connectorEntity, String searchStr) This method returns a List of Planning objects searched by the referenced documentIdgetPlanningByDocumentAndPage(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 documentgetPlanningByIdentifier(String identifier, ConnectorEntity connectorEntity, String searchStr) This method returns a List of Planning objects searched by their IdentifiergetPlanningByPage(String pageId, ConnectorEntity connectorEntity, String searchStr) Deprecated.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 documentgetPlanningsBySnippetId(String snippetId) This method returns plannings with assigned snippet by snippet idgetPlanningsBySnippetOrigin(String snippetOriginId, Context context, String resultEntityId, String searchString) getPlanningsBySourcePlanningId(String sourcePlanningId, Context context, String resultEntityId, String searchString) getPlanningsOfPageBySnippetOrigin(String snippetOriginId, int pageIndex, Context context, String resultEntityId, String searchString) getPlanningsOfPageBySourcePlanningId(String sourcePlanningId, int pageIndex, Context context, String resultEntityId, String searchString) getSubPlanning(String parentPlanningId) This method returns sub PlanningvoidsetPlanning(Planning planning, String searchStr) This method persist a Planning objectvoidupdatePlanning(Planning planning) voidupdatePlannings(List<Planning> plannings) voidupdateSequenceOfRootPlanning(List<Planning> plannings) This method sorts plannings on root levelMethods 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 identifierconnectorEntity- connector entitysearchStr- search string- Returns:
- list of Planning
- Throws:
ConnectorExceptionDataSourceException
-
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 IdconnectorEntity- connector entitysearchStr- search string- Returns:
- list of Planning
- Throws:
ConnectorExceptionDataSourceException
-
getPlanningByPage
@Deprecated List<Planning> getPlanningByPage(String pageId, ConnectorEntity connectorEntity, String searchStr) throws DataSourceException, ConnectorException Deprecated.This method returns a List of Planning objects searched by the referenced pageId- Parameters:
pageId- page IdconnectorEntity- connector entitysearchStr- search string- Returns:
- list of Planning
- Throws:
ConnectorExceptionDataSourceException
-
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 documentcontext- context criteria, including documentIdconnectorEntity- connector entityresultEntityId- entity Id of the result recordssearchString- search string- Returns:
- list of Planning
- Throws:
ConnectorExceptionDataSourceException
-
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 IDpageIndex- zero based index of the page in the documentcontext- context criteria, including documentIdconnectorEntity- connector entityresultEntityId- entity Id of the result recordssearchString- search string- Returns:
- list of Planning
- Throws:
ConnectorExceptionDataSourceException
-
setPlanning
void setPlanning(Planning planning, String searchStr) throws DataSourceException, ConnectorException This method persist a Planning object- Parameters:
planning- planning object to persistsearchStr- search string- Throws:
ConnectorExceptionDataSourceException
-
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 namesourceDocumentId- source document IdtargetDocumentId- target document Id- Returns:
- map with original planning id as a key and a new planning as value
- Throws:
ConnectorExceptionDataSourceException
-
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:
ConnectorExceptionDataSourceException
-
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 PlanningrealGridElemet- realGridElelemt- Throws:
ConnectorExceptionDataSourceException
-
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:
ConnectorExceptionDataSourceException
-
getPlanningsBySourcePlanningId
List<Planning> getPlanningsBySourcePlanningId(String sourcePlanningId, Context context, String resultEntityId, String searchString) throws DataSourceException, ConnectorException - Parameters:
sourcePlanningId-context-resultEntityId-searchString-- Returns:
- Throws:
DataSourceExceptionConnectorException
-
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:
DataSourceExceptionConnectorException
-
getPlanningsBySnippetOrigin
List<Planning> getPlanningsBySnippetOrigin(String snippetOriginId, Context context, String resultEntityId, String searchString) throws DataSourceException, ConnectorException - Parameters:
snippetOriginId-context-resultEntityId-searchString-- Returns:
- Throws:
DataSourceExceptionConnectorException
-
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:
DataSourceExceptionConnectorException
-
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 identifiercontext- context criteria- Returns:
- number of planned media assets (Long)
- Throws:
ConnectorExceptionDataSourceExceptionNotImplementedException
-
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 identifiercontext- context criteria- Returns:
- number of planned media assets (Long)
- Throws:
ConnectorExceptionDataSourceExceptionNotImplementedException
-
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 identifiercontext- context criteria- Returns:
- number of planned media assets (Long)
- Throws:
ConnectorExceptionDataSourceExceptionNotImplementedException
-
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 identifiercontext- context criteria- Returns:
- number of planned media assets (Long)
- Throws:
ConnectorExceptionDataSourceExceptionNotImplementedException
-
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 identifiercontext- context criteria- Returns:
- number of planned media assets (Long)
- Throws:
ConnectorExceptionDataSourceExceptionNotImplementedException
-
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 identifiercontext- context criteria- Returns:
- number of planned media assets (Long)
- Throws:
ConnectorExceptionDataSourceExceptionNotImplementedException
-
addRootPlannings
This method add new plannings on root level- Parameters:
plannings- - list of planning to add- Throws:
ConnectorExceptionDataSourceException
-
deletePlannings
- Throws:
ConnectorException
-
updatePlanning
- Throws:
ConnectorException
-
updatePlannings
- Throws:
ConnectorException
-
updateSequenceOfRootPlanning
This method sorts plannings on root level- Parameters:
plannings- - list of planning to sort- Throws:
ConnectorExceptionDataSourceException
-
getPlanningByPage(String, Context, ConnectorEntity, String, String)