Package com.priint.pubserver.plugin.interfaces

Interface EntityManagerRemote

  • All Superinterfaces:
    PluginControl
    All Known Subinterfaces:
    EntityManagerLocal
    public interface EntityManagerRemote
extends PluginControl
    Remote interface for a entity manager class designed for working with publishing hub entities and models.
    Since:
    4.0.0

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      void addRootPlannings​(java.lang.String sessionId, java.lang.String entityModelIdentifier, java.util.List<Planning> planning)
      This method persists a List of Planning objects
      java.util.List<EntityItem> bulkInsert​(java.lang.String entityModelIdentifier, java.util.List<EntityItem> items)
      Insert a list of entity items within an entity model.
      java.util.List<EntityItem> bulkUpsert​(java.lang.String entityModelIdentifier, java.util.List<EntityItem> items)
      Upsert a list of entity items within an entity model.
      boolean canDeleteContentMetaData​(java.lang.String entityModelIdentifier, java.lang.String entityContentMetaDataId)
      This method returns true or false depending on the specified type of the ContentMetaData is allowed to delete
      void changeParentRealGridElementForPlannedBuckets​(java.lang.String sessionId, java.lang.String entityModelIdentifier, java.util.List<Planning> plannedBuckets, Planning realGridElement)
      This method move a the list of planned buckets to the new Real Grid Element
      java.util.List<java.lang.String> clonePlanning​(java.lang.String sessionId, java.lang.String entityModelIdentifier, java.lang.String searchStr, java.util.List<Planning> plannings, boolean asTemporary)
      This method clones Planning objects (with ContentMetaData) as new plannings with new identifiers
      void clonePlanningOfDocument​(java.lang.String sessionId, java.lang.String entityModelIdentifier, java.lang.String searchStr, java.lang.String sourceDocID, java.lang.String targetDocID)
      This method clones Planning objects (with ContentMetaData) to the new document
      java.util.List<EntityItem> commitItems​(java.lang.String entityModelIdentifier, java.util.List<EntityItem> items)
      Change (insert, update, or delete) a list of entity items within an entity model.
      void copyPlanningMetaData​(java.lang.String sessionId, java.lang.String entityModelIdentifier, java.lang.String searchStr, Planning source, java.util.List<Planning> destination, java.util.List<java.lang.String> filter)
      This method copies ContentMetaData of planning to the other ones
      java.util.List<DeleteEntityStatus> deleteEntityBuckets​(java.lang.String sessionId, java.lang.String entityModelIdentifier, java.util.List<Bucket> buckets)
      Deletes a List of Bucket.
      java.util.List<DeleteEntityStatus> deleteEntityContentMetaData​(java.lang.String sessionId, java.lang.String entityModelIdentifier, java.util.List<ContentMetaData> contentMetaDatalist)
      Delete a List of ContentMetaData.
      java.util.List<DeleteEntityStatus> deleteEntityCords​(java.lang.String sessionId, java.lang.String entityModelIdentifier, java.util.List<Cord> cords)
      Deletes a List of Cord.
      java.util.List<DeleteEntityStatus> deleteEntityKeyValues​(java.lang.String sessionId, java.lang.String entityModelIdentifier, java.util.List<KeyValue> keyValues)
      Deletes a List of KeyValue.
      java.util.List<DeleteEntityStatus> deleteEntityMediaAssets​(java.lang.String sessionId, java.lang.String entityModelIdentifier, java.util.List<MediaAsset> mediaAssets)
      Deletes a List of MediaAsset.
      java.util.List<DeleteEntityStatus> deleteEntityPrices​(java.lang.String sessionId, java.lang.String entityModelIdentifier, java.util.List<Price> prices)
      Deletes a List of Price.
      java.util.List<DeleteEntityStatus> deleteEntityTableDataCells​(java.lang.String sessionId, java.lang.String entityModelIdentifier, java.util.List<TableDataCell> tableDataCells)
      Deletes a List of TableDataCell.
      java.util.List<DeleteEntityStatus> deleteEntityTableDataRows​(java.lang.String sessionId, java.lang.String entityModelIdentifier, java.util.List<TableDataRow> tableDataRows)
      Deletes a List of TableDataRow.
      java.util.List<DeleteEntityStatus> deleteEntityTableDatas​(java.lang.String sessionId, java.lang.String entityModelIdentifier, java.util.List<TableData> tableDatas)
      Deletes a List of TableData.
      java.util.List<DeleteEntityStatus> deleteEntityTexts​(java.lang.String sessionId, java.lang.String entityModelIdentifier, java.util.List<Text> texts)
      Deletes a List of Text.
      void deletePlanning​(java.lang.String sessionId, java.lang.String entityModelIdentifier, java.util.List<Planning> planning)
      Deletes a List of Planning.
      void deletePlannings​(java.lang.String sessionId, java.lang.String entityModelIdentifier, java.util.List<Planning> planningList)  
      void duplicateModel​(java.lang.String oldModelId, java.lang.String newModelId, java.util.Map<java.lang.String,​java.lang.Object> additionalValues)
      Duplicate an entity model.
      java.lang.String exportModelToXML​(EntityModel entityModel)
      Exports an Entity Model with all its Entities and their dependencies to XML.
      java.util.List<Bucket> getBuckets​(java.lang.String sessionId, java.lang.String entityModelIdentifier, java.lang.String entityIdentifier, java.lang.String searchStr)
      Get a list of Entity Root Buckets
      java.util.List<Cord> getCords​(java.lang.String sessionId, java.lang.String entityModelIdentifier, java.lang.String entityIdentifier, java.lang.String searchString)
      Returns cords
      java.lang.Long getCountOfCordRefsOfPlanning​(java.lang.String sessionId, java.lang.String entityModelIdentifier, java.lang.String parentPlanningId, Context context)
      This method returns a number of planned cords in given planning
      java.lang.Long getCountOfKeyValueRefsOfPlanning​(java.lang.String sessionId, java.lang.String entityModelIdentifier, java.lang.String parentPlanningId, Context context)
      This method returns a number of planned key values in given planning
      java.lang.Long getCountOfMediaAssetRefsOfPlanning​(java.lang.String sessionId, java.lang.String entityModelIdentifier, java.lang.String parentPlanningId, Context context)
      This method returns a number of planned media assets in given planning
      java.lang.Long getCountOfPriceRefsOfPlanning​(java.lang.String sessionId, java.lang.String entityModelIdentifier, java.lang.String parentPlanningId, Context context)
      This method returns a number of planned prices in given planning
      java.lang.Long getCountOfSubBucketRefsOfPlanning​(java.lang.String sessionId, java.lang.String entityModelIdentifier, java.lang.String parentPlanningId, Context context)
      This method returns a number of planned sub-buckets in given planning
      java.lang.Long getCountOfTextRefsOfPlanning​(java.lang.String sessionId, java.lang.String entityModelIdentifier, java.lang.String parentPlanningId, Context context)
      This method returns a number of planned texts in given planning
      <T extends Entity>
      T      		 getEntity​(EntityModel entityModel, java.lang.String entityId, java.lang.Class<T> clazz)
      Gets an entity by its name from an entity model
      java.util.List<Bucket> getEntityBucketsByIdentifier​(java.lang.String sessionId, java.lang.String entityModelIdentifier, java.lang.String bucketId, java.lang.String entityId, Context context, java.lang.String searchStr)
      Get a List of Buckets by identifier
      java.util.List<Bucket> getEntityBucketsOfPlanning​(java.lang.String sessionId, java.lang.String entityModelIdentifier, java.lang.String entityId, java.lang.String parentPlanningId, java.lang.String resultEntityId, Context context, java.lang.String searchStr)
      Get a bucket assigned to the specified planning record
      <T extends Entity>
      T      		 getEntityByConnectorEntity​(java.lang.String entityModelIdentifier, java.lang.String connectorEntity, java.lang.Class<T> entityClass)
      Gets an entity from an entity model by a connector entity.
      java.util.List<Bucket> getEntityChildBuckets​(java.lang.String sessionId, java.lang.String entityModelIdentifier, java.lang.String entityId, java.lang.String parentBucketId, java.lang.String resultEntityId, Context context, java.lang.String searchStr)
      Get a list of child buckets of a parent bucket.
      java.util.List<Bucket> getEntityChildBucketsOfPlanning​(java.lang.String sessionId, java.lang.String entityModelIdentifier, java.lang.String entityId, java.lang.String parentPlanningId, java.lang.String resultEntityId, Context context, java.lang.String records, java.lang.String searchStr)
      Returns the list of buckets linked to subplannings of this planning.
      java.util.List<ContentMetaData> getEntityContentMetaDataByIdentifier​(java.lang.String sessionId, java.lang.String entityModelIdentifier, java.lang.String contentMetaDataId, java.lang.String entityId, Context context, java.lang.String searchStr)
      Get a list of ContentMetaData with the same identifier
      java.util.List<Bucket> getEntityCordedBuckets​(java.lang.String sessionId, java.lang.String entityModelIdentifier, java.lang.String entityId, java.lang.String parentBucketId, java.lang.String cordEntityId, Context context, java.lang.String searchStr)
      Get a list of Buckets related via cord to a source bucket.
      java.util.List<Bucket> getEntityCordedBucketsOfPlanning​(java.lang.String sessionId, java.lang.String entityModelIdentifier, java.lang.String entityId, java.lang.String parentPlanningId, java.lang.String resultEntityId, Context context, java.lang.String records, java.lang.String searchStr)
      Returns the list of target buckets of planned cords of this planning.
      java.util.List<Cord> getEntityCordsByIdentifier​(java.lang.String sessionId, java.lang.String entityModelIdentifier, java.lang.String cordId, java.lang.String entityId, Context context, java.lang.String searchStr)
      Get a list of Cords with the same identifier
      java.util.List<Cord> getEntityCordsOfBuckets​(java.lang.String sessionId, java.lang.String entityModelIdentifier, java.lang.String entityId, java.lang.String parentBucketId, java.lang.String resultEntityId, Context context, java.lang.String searchStr)
      Get a list of Cords for a source bucket
      java.util.List<Cord> getEntityCordsOfPlannedBucket​(java.lang.String sessionId, java.lang.String entityModelIdentifier, java.lang.String identifier, java.lang.String entityIdentifier, Context context, java.lang.String searchStr)
      Returns the list of Cords of the bucket linked to this planning, not the planned content of this planning record.
      java.util.List<KeyValue> getEntityKeyValuesByIdentifier​(java.lang.String sessionId, java.lang.String entityModelIdentifier, java.lang.String keyValueId, java.lang.String entityId, Context context, java.lang.String searchStr)
      Get a list of KeyValues with the same identifier
      java.util.List<KeyValue> getEntityKeyValuesOfBucket​(java.lang.String sessionId, java.lang.String entityModelIdentifier, java.lang.String entityId, java.lang.String parentBucketId, java.lang.String resultEntityId, Context context, java.lang.String searchStr)
      Get a List of KeyValues of a Bucket
      java.util.List<KeyValue> getEntityKeyValuesOfPlannedBucket​(java.lang.String sessionId, java.lang.String entityModelIdentifier, java.lang.String identifier, java.lang.String entityIdentifier, Context context, java.lang.String searchStr)
      Returns the list of Key Values of the bucket linked to this planning, not the planned content of this planning record.
      java.util.List<KeyValue> getEntityKeyValuesOfPlanning​(java.lang.String sessionId, java.lang.String entityModelIdentifier, java.lang.String entityId, java.lang.String parentPlanningId, java.lang.String resultEntityId, Context context, java.lang.String records, java.lang.String searchStr)
      Returns the list of planned KeyValues of the bucket linked to this planning.
      java.util.List<MediaAsset> getEntityMediaAssetsByIdentifier​(java.lang.String sessionId, java.lang.String entityModelIdentifier, java.lang.String mediaAssetId, java.lang.String entityId, Context context, java.lang.String searchStr)
      Get a list of MediaAssets with the same identifier
      java.util.List<MediaAsset> getEntityMediaAssetsOfBucket​(java.lang.String sessionId, java.lang.String entityModelIdentifier, java.lang.String entityId, java.lang.String parentBucketId, java.lang.String resultEntityId, Context context, java.lang.String searchStr)
      Get a list of media assets for a parent bucket.
      java.util.List<MediaAsset> getEntityMediaAssetsOfPlannedBucket​(java.lang.String sessionId, java.lang.String entityModelIdentifier, java.lang.String identifier, java.lang.String entityIdentifier, Context context, java.lang.String searchStr)
      Returns the list of Media Assets of the bucket linked to this planning, not the planned content of this planning record.
      java.util.List<MediaAsset> getEntityMediaAssetsOfPlanning​(java.lang.String sessionId, java.lang.String entityModelIdentifier, java.lang.String entityId, java.lang.String parentPlanningId, java.lang.String resultEntityId, Context context, java.lang.String records, java.lang.String searchStr)
      Returns the list of planned MediaAssets of the bucket linked to this planning.
      java.util.List<ContentMetaData> getEntityMetadataOfBucket​(java.lang.String sessionId, java.lang.String entityModelIdentifier, java.lang.String entityId, java.lang.String parentBucketId, java.lang.String resultEntityId, Context context, java.lang.String searchStr)
      Get a List of ContentMetaData of a Bucket
      java.util.List<ContentMetaData> getEntityMetadataOfCord​(java.lang.String sessionId, java.lang.String entityModelIdentifier, java.lang.String entityId, java.lang.String parentCordId, java.lang.String resultEntityId, Context context, java.lang.String searchStr)
      Get a List of ContentMetaData of a Cord
      java.util.List<ContentMetaData> getEntityMetadataOfKeyValue​(java.lang.String sessionId, java.lang.String entityModelIdentifier, java.lang.String entityId, java.lang.String parentKeyValueId, java.lang.String resultEntityId, Context context, java.lang.String searchStr)
      Get a List of ContentMetaData of a KeyValue
      java.util.List<ContentMetaData> getEntityMetadataOfMediaAsset​(java.lang.String sessionId, java.lang.String entityModelIdentifier, java.lang.String entityId, java.lang.String parentMediaAssetId, java.lang.String resultEntityId, Context context, java.lang.String searchStr)
      Get a List of ContentMetaData of a MediaAsset
      java.util.List<ContentMetaData> getEntityMetadataOfPlanning​(java.lang.String sessionId, java.lang.String entityModelIdentifier, java.lang.String entityId, java.lang.String parentPlanningId, java.lang.String resultEntityId, Context context, java.lang.String searchStr)
      Get a List of ContentMetaData of a Planning
      java.util.List<ContentMetaData> getEntityMetadataOfPrice​(java.lang.String sessionId, java.lang.String entityModelIdentifier, java.lang.String entityId, java.lang.String parentPriceId, java.lang.String resultEntityId, Context context, java.lang.String searchStr)
      Get a List of ContentMetaData of a Price
      java.util.List<ContentMetaData> getEntityMetadataOfTableData​(java.lang.String sessionId, java.lang.String entityModelIdentifier, java.lang.String entityId, java.lang.String parentTableDataId, java.lang.String resultEntityId, Context context, java.lang.String searchStr)
      Get a List of ContentMetaData of a TableData
      java.util.List<ContentMetaData> getEntityMetadataOfText​(java.lang.String sessionId, java.lang.String entityModelIdentifier, java.lang.String entityId, java.lang.String parentTextId, java.lang.String resultEntityId, Context context, java.lang.String searchStr)
      Get a List of ContentMetaData of a Text
      EntityModel getEntityModel​(java.lang.String entityModelIdentifier)
      Gets an entity model by identifier.
      java.util.Collection<java.lang.String> getEntityModelIdentifiers()
      Gets the identifiers of all entity models currently known to the manager.
      java.util.List<Planning> getEntityPlanningsByIdentifier​(java.lang.String sessionId, java.lang.String entityModelIdentifier, java.lang.String identifier, java.lang.String entityId, Context context, java.lang.String searchStr)
      Returns the planning record with the Id provided as parameter.
      java.util.List<Planning> getEntityPlanningsBySnippetId​(java.lang.String sessionId, java.lang.String entityModelIdentifier, java.lang.String identifier, java.lang.String resultEntityId, Context context, java.lang.String searchStr)
      Returns plannings with assigned snippet by snipppet id
      java.util.List<Planning> getEntityPlanningsBySnippetOrigin​(java.lang.String sessionId, java.lang.String entityModelIdentifier, java.lang.String snippetSourceId, java.lang.String resultEntityId, Context context, java.lang.String searchStr)  
      java.util.List<Planning> getEntityPlanningsBySourcePlanningId​(java.lang.String sessionId, java.lang.String entityModelIdentifier, java.lang.String sourcePlanningId, java.lang.String resultEntityId, Context context, java.lang.String searchStr)  
      java.util.List<Planning> getEntityPlanningsOfDocument​(java.lang.String sessionId, java.lang.String entityModelIdentifier, java.lang.String entityId, java.lang.String resultEntityId, Context context, java.lang.String searchStr)
      Returns the plannings of a particular document.
      java.util.List<Planning> getEntityPlanningsOfDocumentAndPage​(java.lang.String sessionId, java.lang.String entityModelIdentifier, java.lang.String entityId, java.lang.String resultEntityId, java.lang.String documentId, int pageIndex, Context context, java.lang.String searchStr)
      Returns the plannings of a page.
      java.util.List<Planning> getEntityPlanningsOfPage​(java.lang.String sessionId, java.lang.String entityModelIdentifier, java.lang.String entityId, java.lang.String resultEntityId, int pageIndex, Context context, java.lang.String searchStr)
      Returns the plannings of a page.
      java.util.List<Planning> getEntityPlanningsOfPageBySnippetOrigin​(java.lang.String sessionId, java.lang.String entityModelIdentifier, java.lang.String snippetSourceId, java.lang.String resultEntityId, int pageIndex, Context context, java.lang.String searchStr)  
      java.util.List<Planning> getEntityPlanningsOfPageBySourcePlanningId​(java.lang.String sessionId, java.lang.String entityModelIdentifier, java.lang.String sourcePlanningId, java.lang.String resultEntityId, int pageIndex, Context context, java.lang.String searchStr)  
      java.util.List<Price> getEntityPricesByIdentifier​(java.lang.String sessionId, java.lang.String entityModelIdentifier, java.lang.String priceId, java.lang.String entityId, Context context, java.lang.String searchStr)
      Get a list of prices with the same identifier
      java.util.List<Price> getEntityPricesOfBucket​(java.lang.String sessionId, java.lang.String entityModelIdentifier, java.lang.String entityId, java.lang.String parentBucketId, java.lang.String resultEntityId, Context context, java.lang.String searchStr)
      Get a list of prices for a parent bucket.
      java.util.List<Price> getEntityPricesOfPlannedBucket​(java.lang.String sessionId, java.lang.String entityModelIdentifier, java.lang.String identifier, java.lang.String entityIdentifier, Context context, java.lang.String searchStr)
      Returns the list of Prices of the bucket linked to this planning, not the planned content of this planning record.
      java.util.List<Price> getEntityPricesOfPlanning​(java.lang.String sessionId, java.lang.String entityModelIdentifier, java.lang.String entityId, java.lang.String parentPlanningId, java.lang.String resultEntityId, Context context, java.lang.String records, java.lang.String searchStr)
      Returns the list of planned Prices of the bucket linked to this planning.
      java.util.List<Bucket> getEntityRootBuckets​(java.lang.String sessionId, java.lang.String entityModelIdentifier, java.lang.String resultEntityId, Context context, java.lang.String searchStr)
      Get a list of Entity Root Buckets
      java.util.List<ContentMetaData> getEntityRootMetadataOfPlanning​(java.lang.String sessionId, java.lang.String entityModelIdentifier, java.lang.String entityId, java.lang.String parentPlanningId, java.lang.String resultEntityId, Context context, java.lang.String searchStr)  
      java.util.List<Planning> getEntitySubPlanningsOfPlanning​(java.lang.String sessionId, java.lang.String entityModelIdentifier, java.lang.String entityId, java.lang.String parentPlanningId, java.lang.String resultEntityId, Context context, java.lang.String records, java.lang.String searchStr)
      Returns the list of subplannings of this planning.
      java.util.List<TableData> getEntityTableDataByIdentifier​(java.lang.String sessionId, java.lang.String entityModelIdentifier, java.lang.String identifier, java.lang.String entityIdentifier, Context context, java.lang.String searchStr)
      Get a list of TableData with the same identifier
      java.util.List<TableData> getEntityTableDataOfBucket​(java.lang.String sessionId, java.lang.String entityModelIdentifier, java.lang.String entityId, java.lang.String parentBucketId, java.lang.String resultEntityId, Context context, java.lang.String searchStr)
      Get a list of TableData for a parent bucket.
      java.util.List<TableData> getEntityTableDataOfPlannedBucket​(java.lang.String sessionId, java.lang.String entityModelIdentifier, java.lang.String identifier, java.lang.String entityIdentifier, Context context, java.lang.String searchStr)
      Returns the list of Table Data of the bucket linked to this planning, not the planned content of this planning record.
      java.util.List<TableData> getEntityTableDataOfPlanning​(java.lang.String sessionId, java.lang.String entityModelIdentifier, Context context, java.lang.String identifier, java.lang.String entityId, java.lang.String resultEntityId, java.lang.String records, java.lang.String searchString)
      Returns list of planned TableData
      java.util.List<TableData> getEntityTableDataOfPlanning​(java.lang.String sessionId, java.lang.String entityModelIdentifier, java.lang.String entityId, java.lang.String parentPlanningId, java.lang.String resultEntityId, Context context, java.lang.String records, java.lang.String searchStr)
      Returns the list of planned TableData of the bucket linked to this planning.
      java.util.List<Text> getEntityTextsByIdentifier​(java.lang.String sessionId, java.lang.String entityModelIdentifier, java.lang.String textId, java.lang.String entityId, Context context, java.lang.String searchStr)
      Get a list of Texts with the same identifier
      java.util.List<Text> getEntityTextsOfBucket​(java.lang.String sessionId, java.lang.String entityModelIdentifier, java.lang.String entityId, java.lang.String parentBucketId, java.lang.String resultEntityId, Context context, java.lang.String searchStr)
      Get a list of texts for a parent bucket.
      java.util.List<Text> getEntityTextsOfPlannedBucket​(java.lang.String sessionId, java.lang.String entityModelIdentifier, java.lang.String identifier, java.lang.String entityIdentifier, Context context, java.lang.String searchStr)
      Returns the list of Texts of the bucket linked to this planning, not the planned content of this planning record.
      java.util.List<Text> getEntityTextsOfPlanning​(java.lang.String sessionId, java.lang.String entityModelIdentifier, java.lang.String entityId, java.lang.String parentPlanningId, java.lang.String resultEntityId, Context context, java.lang.String records, java.lang.String searchStr)
      Returns the list of planned Texts of the bucket linked to this planning.
      java.util.List<KeyValue> getKeyValues​(java.lang.String sessionId, java.lang.String entityModelIdentifier, java.lang.String entityIdentifier, java.lang.String searchString)
      Returns key values
      java.util.List<MediaAsset> getMediaAssets​(java.lang.String sessionId, java.lang.String entityModelIdentifier, java.lang.String entityIdentifier, java.lang.String searchString)
      Returns media assets
      java.util.List<Planning> getPlanningByIdentifier​(java.lang.String sessionId, java.lang.String identifier, java.lang.String searchStr)
      For internal use only
      java.util.List<Price> getPrices​(java.lang.String sessionId, java.lang.String entityModelIdentifier, java.lang.String entityIdentifier, java.lang.String searchString)
      Returns prices
      java.util.List<Text> getTexts​(java.lang.String sessionId, java.lang.String entityModelIdentifier, java.lang.String entityIdentifier, java.lang.String searchText)
      Returns texts
      EntityModel importModelfromXML​(java.lang.String xml)
      Imports an Entity Model with all its Entities and their dependencies from XML.
      void mergePlanningMetaData​(java.lang.String sessionId, java.lang.String entityModelIdentifier, java.lang.String searchStr, Planning source, java.util.List<Planning> destination, java.util.List<java.lang.String> filter)
      This method merges ContentMetaData of planning to the other ones (copy or replace if exist)
      void replaceConnector​(java.lang.String id, java.lang.String oldConnectorSpec, java.lang.String newConnectorSpec)
      Replacing a connectorSpec in all entities of entity model through a new value.
      java.util.List<Bucket> setEntityBuckets​(java.lang.String sessionId, java.lang.String entityModelIdentifier, java.lang.String searchStr, java.util.List<Bucket> buckets)
      Persist a List of Buckets
      java.util.List<ContentMetaData> setEntityContentMetaData​(java.lang.String sessionId, java.lang.String entityModelIdentifier, java.lang.String searchStr, java.util.List<ContentMetaData> contentMetaDataList)
      Persist a List of ContentMetaData
      java.util.List<Cord> setEntityCords​(java.lang.String sessionId, java.lang.String entityModelIdentifier, java.lang.String searchStr, java.util.List<Cord> cords)
      Persist a List of Cords
      java.util.List<KeyValue> setEntityKeyValues​(java.lang.String sessionId, java.lang.String entityModelIdentifier, java.lang.String searchStr, java.util.List<KeyValue> keyValues)
      Persist a List of KeyValues
      java.util.List<MediaAsset> setEntityMediaAssets​(java.lang.String sessionId, java.lang.String entityModelIdentifier, java.lang.String searchStr, java.util.List<MediaAsset> mediaAssets)
      Persist a List of MediaAssets
      java.util.List<Price> setEntityPrices​(java.lang.String sessionId, java.lang.String entityModelIdentifier, java.lang.String searchStr, java.util.List<Price> prices)
      Persist a List of Prices
      java.util.List<TableDataCell> setEntityTableDataCells​(java.lang.String sessionId, java.lang.String entityModelIdentifier, java.lang.String searchStr, java.util.List<TableDataCell> tableDataCells)
      Persist a List of TableDataCells
      java.util.List<TableDataRow> setEntityTableDataRows​(java.lang.String sessionId, java.lang.String entityModelIdentifier, java.lang.String searchStr, java.util.List<TableDataRow> tableDataRows)
      Persist a List of TableDataRows
      java.util.List<TableData> setEntityTableDatas​(java.lang.String sessionId, java.lang.String entityModelIdentifier, java.lang.String searchStr, java.util.List<TableData> tableDatas)
      Persist a List of TableDatas
      java.util.List<Text> setEntityTexts​(java.lang.String sessionId, java.lang.String entityModelIdentifier, java.lang.String searchStr, java.util.List<Text> texts)
      Persist a List of Texts
      void setPlanning​(java.lang.String sessionId, java.lang.String entityModelIdentifier, java.lang.String searchStr, java.util.List<Planning> planning)
      This method persists a Planning object
      void setPlanningTableCmdChanged​(java.lang.String sessionId, java.lang.String entityModelIdentifier, java.lang.String searchStr, Planning source, java.util.List<Planning> destination)
      This method sets tableCmdChanged property to plannings depending on source planning
      void updatePlanning​(java.lang.String sessionId, java.lang.String entityModelIdentifier, java.util.List<Planning> planningList)  
      void updateSequenceOfRootPlanning​(java.lang.String sessionId, java.lang.String entityModelIdentifier, java.util.List<Planning> planningList)
      This method sort a List of Planning objects on root level

    • Method Detail

      • importModelfromXML

        EntityModel importModelfromXML​(java.lang.String xml)
        Imports an Entity Model with all its Entities and their dependencies from XML.
        Parameters:
        xml - - XML must be valid according to the schema generated from this SDK version.
        Returns:
        EntityModel

      • exportModelToXML

        java.lang.String exportModelToXML​(EntityModel entityModel)
        Exports an Entity Model with all its Entities and their dependencies to XML.
        Parameters:
        entityModel -
        Returns:
        valid XML instance according to the schema generated from this SDK version.

      • getEntityModel

        EntityModel getEntityModel​(java.lang.String entityModelIdentifier)
        Gets an entity model by identifier.
        Parameters:
        entityModelIdentifier - model identifier
        Returns:
        Entity Model or null if there is no model with this id.
        See Also:
        getEntityModelIdentifiers()

      • getEntityModelIdentifiers

        java.util.Collection<java.lang.String> getEntityModelIdentifiers()
        Gets the identifiers of all entity models currently known to the manager.
        Returns:
        The ids of all models for use with e.g. getEntityModel(String)
        See Also:
        getEntityModel(String)

      • getEntityRootBuckets

        java.util.List<Bucket> getEntityRootBuckets​(java.lang.String sessionId,
                                            java.lang.String entityModelIdentifier,
                                            java.lang.String resultEntityId,
                                            Context context,
                                            java.lang.String searchStr)
                                     throws EntityManagerException
        Get a list of Entity Root Buckets
        Parameters:
        sessionId - id of the user session
        entityModelIdentifier - Identifier of the entity model
        resultEntityId - filter the result list by entities with this identifier
        context - Context as search filter (e.g country and language). Depending on the ContextDefinition in the Entity some or all fields of this context will be handed over to appropriate connector method.
        searchStr - Search string
        Returns:
        List of root buckets. Empty list if nothing was found.
        Throws:
        EntityManagerException
        See Also:
        Bucket

      • getEntityBucketsOfPlanning

        java.util.List<Bucket> getEntityBucketsOfPlanning​(java.lang.String sessionId,
                                                  java.lang.String entityModelIdentifier,
                                                  java.lang.String entityId,
                                                  java.lang.String parentPlanningId,
                                                  java.lang.String resultEntityId,
                                                  Context context,
                                                  java.lang.String searchStr)
                                           throws EntityManagerException
        Get a bucket assigned to the specified planning record
        Parameters:
        sessionId - id of the user session
        entityModelIdentifier - Identifier of the entity model
        entityId - Identifier of the entity within the entity model
        parentPlanningId - Identifier of the planning
        resultEntityId - filter the result list by entities with this identifier
        context - Context as search filter (e.g country and language). Depending on the ContextDefinition in the Entity some or all fields of this context will be handed over to appropriate connector method.
        searchStr - Search string
        Returns:
        List of Buckets. The list should have one element (one bucket). Empty list if nothing was found.
        Throws:
        EntityManagerException
        See Also:
        Bucket

      • getEntityChildBuckets

        java.util.List<Bucket> getEntityChildBuckets​(java.lang.String sessionId,
                                             java.lang.String entityModelIdentifier,
                                             java.lang.String entityId,
                                             java.lang.String parentBucketId,
                                             java.lang.String resultEntityId,
                                             Context context,
                                             java.lang.String searchStr)
                                      throws EntityManagerException
        Get a list of child buckets of a parent bucket.
        Parameters:
        sessionId - id of the user session
        entityModelIdentifier - Identifier of the entity model
        entityId - Identifier of the entity within the entity model
        parentBucketId - Identifier of the parent bucket
        resultEntityId - filter the result list by entities with this identifier
        context - Context as search filter (e.g country and language). Depending on the ContextDefinition in the Entity some or all fields of this context will be handed over to appropriate connector method.
        searchStr - Search string
        Returns:
        List of Child Buckets. Empty list if nothing was found.
        Throws:
        EntityManagerException
        See Also:
        Bucket

      • getEntityBucketsByIdentifier

        java.util.List<Bucket> getEntityBucketsByIdentifier​(java.lang.String sessionId,
                                                    java.lang.String entityModelIdentifier,
                                                    java.lang.String bucketId,
                                                    java.lang.String entityId,
                                                    Context context,
                                                    java.lang.String searchStr)
                                             throws EntityManagerException
        Get a List of Buckets by identifier
        Parameters:
        sessionId - id of the user session
        entityModelIdentifier - Identifier of the entity model
        bucketId - Identifier for the bucket
        entityId - Identifier of the entity within the entity model
        context - Context as search filter (e.g country and language). Depending on the ContextDefinition in the Entity some or all fields of this context will be handed over to appropriate connector method.
        searchStr - Search string
        Returns:
        List of Buckets. Empty list if nothing was found.
        Throws:
        EntityManagerException
        See Also:
        Bucket

      • getEntityKeyValuesOfBucket

        java.util.List<KeyValue> getEntityKeyValuesOfBucket​(java.lang.String sessionId,
                                                    java.lang.String entityModelIdentifier,
                                                    java.lang.String entityId,
                                                    java.lang.String parentBucketId,
                                                    java.lang.String resultEntityId,
                                                    Context context,
                                                    java.lang.String searchStr)
                                             throws EntityManagerException
        Get a List of KeyValues of a Bucket
        Parameters:
        sessionId - id of the user session
        entityModelIdentifier - Identifier of the entity model
        entityId - Identifier of the entity within the entity model
        parentBucketId - Identifier of the parent bucket
        resultEntityId - filter the result list by entities with this identifier
        context - Context as search filter (e.g country and language). Depending on the ContextDefinition in the Entity some or all fields of this context will be handed over to appropriate connector method.
        searchStr - Search string
        Returns:
        List of KeyValues. Empty list if nothing was found.
        Throws:
        EntityManagerException
        See Also:
        KeyValue

      • getEntityKeyValuesByIdentifier

        java.util.List<KeyValue> getEntityKeyValuesByIdentifier​(java.lang.String sessionId,
                                                        java.lang.String entityModelIdentifier,
                                                        java.lang.String keyValueId,
                                                        java.lang.String entityId,
                                                        Context context,
                                                        java.lang.String searchStr)
                                                 throws EntityManagerException
        Get a list of KeyValues with the same identifier
        Parameters:
        sessionId - id of the user session
        entityModelIdentifier - Identifier of the entity model
        keyValueId - Identifier of the KeyValue
        entityId - Identifier of the entity within the entity model
        context - Context as search filter (e.g country and language). Depending on the ContextDefinition in the Entity some or all fields of this context will be handed over to appropriate connector method.
        searchStr - Search string
        Returns:
        List of KeyValues. Empty list if nothing was found.
        Throws:
        EntityManagerException
        See Also:
        KeyValue

      • getEntityPricesOfBucket

        java.util.List<Price> getEntityPricesOfBucket​(java.lang.String sessionId,
                                              java.lang.String entityModelIdentifier,
                                              java.lang.String entityId,
                                              java.lang.String parentBucketId,
                                              java.lang.String resultEntityId,
                                              Context context,
                                              java.lang.String searchStr)
                                       throws EntityManagerException
        Get a list of prices for a parent bucket.
        Parameters:
        sessionId - id of the user session
        entityModelIdentifier - Identifier of the entity model
        entityId - Identifier of the entity within the entity model
        parentBucketId - Identifier of the parent bucket
        resultEntityId - filter the result list by entities with this identifier
        context - Context as search filter (e.g country and language). Depending on the ContextDefinition in the Entity some or all fields of this context will be handed over to appropriate connector method.
        searchStr - Search string
        Returns:
        List of Prices. Empty list if nothing was found.
        Throws:
        EntityManagerException
        See Also:
        Price

      • getEntityPricesByIdentifier

        java.util.List<Price> getEntityPricesByIdentifier​(java.lang.String sessionId,
                                                  java.lang.String entityModelIdentifier,
                                                  java.lang.String priceId,
                                                  java.lang.String entityId,
                                                  Context context,
                                                  java.lang.String searchStr)
                                           throws EntityManagerException
        Get a list of prices with the same identifier
        Parameters:
        sessionId - id of the user session
        entityModelIdentifier - Identifier of the entity model
        priceId - Identifier of the price
        entityId - Identifier of the entity within the entity model
        context - Context as search filter (e.g country and language). Depending on the ContextDefinition in the Entity some or all fields of this context will be handed over to appropriate connector method.
        searchStr - Search string
        Returns:
        List of Prices. Empty list if nothing was found.
        Throws:
        EntityManagerException
        See Also:
        Price

      • getEntityTextsOfBucket

        java.util.List<Text> getEntityTextsOfBucket​(java.lang.String sessionId,
                                            java.lang.String entityModelIdentifier,
                                            java.lang.String entityId,
                                            java.lang.String parentBucketId,
                                            java.lang.String resultEntityId,
                                            Context context,
                                            java.lang.String searchStr)
                                     throws EntityManagerException
        Get a list of texts for a parent bucket.
        Parameters:
        sessionId - id of the user session
        entityModelIdentifier - Identifier of the entity model
        entityId - Identifier of the entity within the entity model
        parentBucketId - Identifier of the parent bucket
        resultEntityId - filter the result list by entities with this identifier
        context - Context as search filter (e.g country and language). Depending on the ContextDefinition in the Entity some or all fields of this context will be handed over to appropriate connector method.
        searchStr - Search string
        Returns:
        List of Texts. Empty list if nothing was found.
        Throws:
        EntityManagerException
        See Also:
        Text

      • getEntityTextsByIdentifier

        java.util.List<Text> getEntityTextsByIdentifier​(java.lang.String sessionId,
                                                java.lang.String entityModelIdentifier,
                                                java.lang.String textId,
                                                java.lang.String entityId,
                                                Context context,
                                                java.lang.String searchStr)
                                         throws EntityManagerException
        Get a list of Texts with the same identifier
        Parameters:
        sessionId - id of the user session
        entityModelIdentifier - Identifier of the entity model
        textId - Identifier of the Text
        entityId - Identifier of the entity within the entity model
        context - Context as search filter (e.g country and language). Depending on the ContextDefinition in the Entity some or all fields of this context will be handed over to appropriate connector method.
        searchStr - Search string
        Returns:
        List of Texts. Empty list if nothing was found.
        Throws:
        EntityManagerException
        See Also:
        Text

      • getEntityMediaAssetsOfBucket

        java.util.List<MediaAsset> getEntityMediaAssetsOfBucket​(java.lang.String sessionId,
                                                        java.lang.String entityModelIdentifier,
                                                        java.lang.String entityId,
                                                        java.lang.String parentBucketId,
                                                        java.lang.String resultEntityId,
                                                        Context context,
                                                        java.lang.String searchStr)
                                                 throws EntityManagerException
        Get a list of media assets for a parent bucket.
        Parameters:
        sessionId - id of the user session
        entityModelIdentifier - Identifier of the entity model
        entityId - Identifier of the entity within the entity model
        parentBucketId - Identifier of the parent bucket
        resultEntityId - filter the result list by entities with this identifier
        context - Context as search filter (e.g country and language). Depending on the ContextDefinition in the Entity some or all fields of this context will be handed over to appropriate connector method.
        searchStr - Search string
        Returns:
        List of MediaAssets. Empty list if nothing was found.
        Throws:
        EntityManagerException
        See Also:
        MediaAsset

      • getEntityMediaAssetsByIdentifier

        java.util.List<MediaAsset> getEntityMediaAssetsByIdentifier​(java.lang.String sessionId,
                                                            java.lang.String entityModelIdentifier,
                                                            java.lang.String mediaAssetId,
                                                            java.lang.String entityId,
                                                            Context context,
                                                            java.lang.String searchStr)
                                                     throws EntityManagerException
        Get a list of MediaAssets with the same identifier
        Parameters:
        sessionId - id of the user session
        entityModelIdentifier - Identifier of the entity model
        mediaAssetId - Identifier of the MediaAsset
        entityId - Identifier of the entity within the entity model
        context - Context as search filter (e.g country and language). Depending on the ContextDefinition in the Entity some or all fields of this context will be handed over to appropriate connector method.
        searchStr - Search string
        Returns:
        List of MediaAssets. Empty list if nothing was found.
        Throws:
        EntityManagerException
        See Also:
        MediaAsset

      • getEntityCordedBuckets

        java.util.List<Bucket> getEntityCordedBuckets​(java.lang.String sessionId,
                                              java.lang.String entityModelIdentifier,
                                              java.lang.String entityId,
                                              java.lang.String parentBucketId,
                                              java.lang.String cordEntityId,
                                              Context context,
                                              java.lang.String searchStr)
                                       throws EntityManagerException
        Get a list of Buckets related via cord to a source bucket.

        Note: getEntityCordedBuckets is a special case because there are three entity identifiers involved.

        • source bucket entity identifier
        • destination bucket entity identifier
        • cord entity identifier

        The [resultEntityId] here means:

        • Get the buckets that are connected via a cord of type [resultEntityId].

        It does NOT mean:

        • Get the buckets of type [resultEntityId] that are connected via any type of cord to the source.
        Parameters:
        sessionId - id of the user session
        entityModelIdentifier -
        entityId - Identifier of the entity within the entity model
        parentBucketId - Identifier of the parent bucket
        cordEntityId - filter the result the list of cords by this entity identifier
        context - Context as search filter (e.g country and language). Depending on the ContextDefinition in the Entity some or all fields of this context will be handed over to appropriate connector method.
        searchStr - Search string
        Returns:
        List of buckets. Empty list if nothing was found.
        Throws:
        EntityManagerException
        See Also:
        Bucket

      • getEntityCordsOfBuckets

        java.util.List<Cord> getEntityCordsOfBuckets​(java.lang.String sessionId,
                                             java.lang.String entityModelIdentifier,
                                             java.lang.String entityId,
                                             java.lang.String parentBucketId,
                                             java.lang.String resultEntityId,
                                             Context context,
                                             java.lang.String searchStr)
                                      throws EntityManagerException
        Get a list of Cords for a source bucket
        Parameters:
        sessionId - id of the user session
        entityModelIdentifier -
        entityId - Identifier of the entity within the entity model
        parentBucketId - Identifier of the parent bucket
        resultEntityId - filter the result list by entities with this identifier
        context - Context as search filter (e.g country and language). Depending on the ContextDefinition in the Entity some or all fields of this context will be handed over to appropriate connector method.
        searchStr - Search string
        Returns:
        List of cords. Empty list if nothing was found.
        Throws:
        EntityManagerException
        See Also:
        Cord

      • getEntityCordsByIdentifier

        java.util.List<Cord> getEntityCordsByIdentifier​(java.lang.String sessionId,
                                                java.lang.String entityModelIdentifier,
                                                java.lang.String cordId,
                                                java.lang.String entityId,
                                                Context context,
                                                java.lang.String searchStr)
                                         throws EntityManagerException
        Get a list of Cords with the same identifier
        Parameters:
        sessionId - id of the user session
        entityModelIdentifier - Identifier of the entity model
        cordId - Identifier of the Cord
        entityId - Identifier of the entity within the entity model
        context - Context as search filter (e.g country and language). Depending on the ContextDefinition in the Entity some or all fields of this context will be handed over to appropriate connector method.
        searchStr - Search string
        Returns:
        List of Cords. Empty list if nothing was found.
        Throws:
        EntityManagerException
        Since:
        4.1.5

      • getEntityTableDataOfBucket

        java.util.List<TableData> getEntityTableDataOfBucket​(java.lang.String sessionId,
                                                     java.lang.String entityModelIdentifier,
                                                     java.lang.String entityId,
                                                     java.lang.String parentBucketId,
                                                     java.lang.String resultEntityId,
                                                     Context context,
                                                     java.lang.String searchStr)
                                              throws EntityManagerException
        Get a list of TableData for a parent bucket.
        Parameters:
        sessionId - id of the user session
        entityModelIdentifier - Identifier of the entity model
        entityId - Identifier of the entity within the entity model
        parentBucketId - Identifier of the parent bucket
        resultEntityId - filter the result list by entities with this identifier
        context - Context as search filter (e.g country and language). Depending on the ContextDefinition in the Entity some or all fields of this context will be handed over to appropriate connector method.
        searchStr - Search string
        Returns:
        List of TableData. Empty list if nothing was found.
        Throws:
        EntityManagerException
        See Also:
        Cord

      • getEntityTableDataOfPlanning

        java.util.List<TableData> getEntityTableDataOfPlanning​(java.lang.String sessionId,
                                                       java.lang.String entityModelIdentifier,
                                                       Context context,
                                                       java.lang.String identifier,
                                                       java.lang.String entityId,
                                                       java.lang.String resultEntityId,
                                                       java.lang.String records,
                                                       java.lang.String searchString)
                                                throws EntityManagerException
        Returns list of planned TableData
        Parameters:
        sessionId - ID of the current session
        entityModelIdentifier - identifier of the entity model
        context - (Context) context criteria, including documentId. Overrides content of context with static values from ContextDefinition in Entity.
        identifier - Identifier of the planning record
        entityId - id of the entity within the entity model
        resultEntityId - entity Id of the result records
        records - range of returned records
        searchString -
        Returns:
        List of TableData
        Throws:
        EntityManagerException

      • getEntityTableDataOfPlanning

        java.util.List<TableData> getEntityTableDataOfPlanning​(java.lang.String sessionId,
                                                       java.lang.String entityModelIdentifier,
                                                       java.lang.String entityId,
                                                       java.lang.String parentPlanningId,
                                                       java.lang.String resultEntityId,
                                                       Context context,
                                                       java.lang.String records,
                                                       java.lang.String searchStr)
                                                throws EntityManagerException

        Returns the list of planned TableData of the bucket linked to this planning.

        Parameters:
        sessionId - Id of the current session
        entityModelIdentifier - identifier of the entity model
        entityId - Id of the planning entity, at the time this is always "planning"
        parentPlanningId - Id of the parent planning record
        resultEntityId - Id of result entities, currently not evaluated
        context - Context as search filter (e.g country and language). Depending on the ContextDefinition in the Entity some or all fields of this context will be handed over to appropriate connector method.
        records - string describing the range of records to be returned. Currently "first" and "last" are evaluated, all other terms expand to "all".
        searchStr - additional search filter for result
        Returns:
        the List of planned TableData of the bucket linked to this planning; empty list, if no TableData exist.
        Throws:
        EntityManagerException

      • getEntityTableDataByIdentifier

        java.util.List<TableData> getEntityTableDataByIdentifier​(java.lang.String sessionId,
                                                         java.lang.String entityModelIdentifier,
                                                         java.lang.String identifier,
                                                         java.lang.String entityIdentifier,
                                                         Context context,
                                                         java.lang.String searchStr)
                                                  throws EntityManagerException
        Get a list of TableData with the same identifier
        Parameters:
        sessionId - id of the user session
        entityModelIdentifier - Identifier of the entity model
        identifier - Identifier of the TableData
        entityIdentifier - Identifier of the entity within the entity model
        context - Context as search filter (e.g country and language). Depending on the ContextDefinition in the Entity some or all fields of this context will be handed over to appropriate connector method.
        searchStr - Search string
        Returns:
        List of TableData. Empty list if nothing was found.
        Throws:
        EntityManagerException

      • setEntityBuckets

        java.util.List<Bucket> setEntityBuckets​(java.lang.String sessionId,
                                        java.lang.String entityModelIdentifier,
                                        java.lang.String searchStr,
                                        java.util.List<Bucket> buckets)
                                 throws EntityManagerException
        Persist a List of Buckets
        Parameters:
        sessionId - id of the user session
        entityModelIdentifier - Identifier of the entity model
        searchStr - Search string
        buckets - List of buckets
        Returns:
        List of Bucket
        Throws:
        EntityManagerException

      • setEntityKeyValues

        java.util.List<KeyValue> setEntityKeyValues​(java.lang.String sessionId,
                                            java.lang.String entityModelIdentifier,
                                            java.lang.String searchStr,
                                            java.util.List<KeyValue> keyValues)
                                     throws EntityManagerException
        Persist a List of KeyValues
        Parameters:
        sessionId - id of the user session
        entityModelIdentifier - Identifier of the entity model
        searchStr - Search string
        keyValues - List of KeyValue
        Returns:
        List of KeyValue.
        Throws:
        EntityManagerException

      • setEntityTexts

        java.util.List<Text> setEntityTexts​(java.lang.String sessionId,
                                    java.lang.String entityModelIdentifier,
                                    java.lang.String searchStr,
                                    java.util.List<Text> texts)
                             throws EntityManagerException
        Persist a List of Texts
        Parameters:
        sessionId - id of the user session
        entityModelIdentifier - Identifier of the entity model
        searchStr - Search string
        texts - List of Text
        Returns:
        List of Text.
        Throws:
        EntityManagerException

      • setEntityMediaAssets

        java.util.List<MediaAsset> setEntityMediaAssets​(java.lang.String sessionId,
                                                java.lang.String entityModelIdentifier,
                                                java.lang.String searchStr,
                                                java.util.List<MediaAsset> mediaAssets)
                                         throws EntityManagerException
        Persist a List of MediaAssets
        Parameters:
        sessionId - id of the user session
        entityModelIdentifier - Identifier of the entity model
        searchStr - Search string
        mediaAssets - List of MediaAsset
        Returns:
        List of MediaAsset.
        Throws:
        EntityManagerException

      • setEntityPrices

        java.util.List<Price> setEntityPrices​(java.lang.String sessionId,
                                      java.lang.String entityModelIdentifier,
                                      java.lang.String searchStr,
                                      java.util.List<Price> prices)
                               throws EntityManagerException
        Persist a List of Prices
        Parameters:
        sessionId - id of the user session
        entityModelIdentifier - Identifier of the entity model
        searchStr - Search string
        prices - List of Price
        Returns:
        List of Price.
        Throws:
        EntityManagerException

      • setEntityCords

        java.util.List<Cord> setEntityCords​(java.lang.String sessionId,
                                    java.lang.String entityModelIdentifier,
                                    java.lang.String searchStr,
                                    java.util.List<Cord> cords)
                             throws EntityManagerException
        Persist a List of Cords
        Parameters:
        sessionId - id of the user session
        entityModelIdentifier - Identifier of the entity model
        searchStr - Search string
        cords - List of Cords
        Returns:
        List of Cord.
        Throws:
        EntityManagerException

      • setEntityTableDatas

        java.util.List<TableData> setEntityTableDatas​(java.lang.String sessionId,
                                              java.lang.String entityModelIdentifier,
                                              java.lang.String searchStr,
                                              java.util.List<TableData> tableDatas)
                                       throws EntityManagerException
        Persist a List of TableDatas
        Parameters:
        sessionId - id of the user session
        entityModelIdentifier - Identifier of the entity model
        searchStr - Search string
        tableDatas - List of TableData
        Returns:
        List of TableData.
        Throws:
        EntityManagerException

      • setEntityTableDataRows

        java.util.List<TableDataRow> setEntityTableDataRows​(java.lang.String sessionId,
                                                    java.lang.String entityModelIdentifier,
                                                    java.lang.String searchStr,
                                                    java.util.List<TableDataRow> tableDataRows)
                                             throws EntityManagerException
        Persist a List of TableDataRows
        Parameters:
        sessionId - id of the user session
        entityModelIdentifier - Identifier of the entity model
        searchStr - Search string
        tableDataRows - List of TableDataRow
        Returns:
        List of TableDataRow.
        Throws:
        EntityManagerException

      • setEntityTableDataCells

        java.util.List<TableDataCell> setEntityTableDataCells​(java.lang.String sessionId,
                                                      java.lang.String entityModelIdentifier,
                                                      java.lang.String searchStr,
                                                      java.util.List<TableDataCell> tableDataCells)
                                               throws EntityManagerException
        Persist a List of TableDataCells
        Parameters:
        sessionId - id of the user session
        entityModelIdentifier - Identifier of the entity model
        searchStr - Search string
        tableDataCells - List of TableDataCell
        Returns:
        List of TableDataCell.
        Throws:
        EntityManagerException

      • getEntityPlanningsByIdentifier

        java.util.List<Planning> getEntityPlanningsByIdentifier​(java.lang.String sessionId,
                                                        java.lang.String entityModelIdentifier,
                                                        java.lang.String identifier,
                                                        java.lang.String entityId,
                                                        Context context,
                                                        java.lang.String searchStr)
                                                 throws EntityManagerException

        Returns the planning record with the Id provided as parameter.

        Parameters:
        sessionId - Id of the current session
        entityModelIdentifier - identifier of the entity model
        identifier - Id of the planning record
        entityId - Id of the planning entity, at the time this is always "Planning"
        context - Context as search filter (e.g country and language). Depending on the ContextDefinition in the Entity some or all fields of this context will be handed over to appropriate connector method.
        searchStr - additional search filter for result
        Returns:
        list of Planning with the given identifier. The list contains one element, if this planning exists, zero otherwise.
        Throws:
        EntityManagerException

      • getPlanningByIdentifier

        java.util.List<Planning> getPlanningByIdentifier​(java.lang.String sessionId,
                                                 java.lang.String identifier,
                                                 java.lang.String searchStr)

        For internal use only

        Parameters:
        sessionId - Id of the current session
        identifier - Id of the planning record
        searchStr - additional search filter for result

      • getEntityPlanningsOfPage

        java.util.List<Planning> getEntityPlanningsOfPage​(java.lang.String sessionId,
                                                  java.lang.String entityModelIdentifier,
                                                  java.lang.String entityId,
                                                  java.lang.String resultEntityId,
                                                  int pageIndex,
                                                  Context context,
                                                  java.lang.String searchStr)
                                           throws EntityManagerException

        Returns the plannings of a page.

        Parameters:
        sessionId - Id of the current session
        entityModelIdentifier - identifier of the entity model
        entityId - Id of the planning entity, at the time this is always "planning"
        resultEntityId - Id of result entities, currently not evaluated
        pageIndex - zero based index of the page
        context - Context as search filter (e.g country and language). Depending on the ContextDefinition in the Entity some or all fields of this context will be handed over to appropriate connector method.
        searchStr - additional search filter for result
        Returns:
        the list of Planning of this document; empty list, if no plannings exist.
        Throws:
        EntityManagerException

      • getEntityPlanningsOfDocumentAndPage

        java.util.List<Planning> getEntityPlanningsOfDocumentAndPage​(java.lang.String sessionId,
                                                             java.lang.String entityModelIdentifier,
                                                             java.lang.String entityId,
                                                             java.lang.String resultEntityId,
                                                             java.lang.String documentId,
                                                             int pageIndex,
                                                             Context context,
                                                             java.lang.String searchStr)
                                                      throws EntityManagerException

        Returns the plannings of a page.

        Parameters:
        sessionId - Id of the current session
        entityModelIdentifier - identifier of the entity model
        entityId - Id of the planning entity, at the time this is always "planning"
        resultEntityId - Id of result entities, currently not evaluated
        documentId - document Id
        pageIndex - zero based index of the page
        context - Context as search filter (e.g country and language). Depending on the ContextDefinition in the Entity some or all fields of this context will be handed over to appropriate connector method.
        searchStr - additional search filter for result
        Returns:
        the list of Planning of this document; empty list, if no plannings exist.
        Throws:
        EntityManagerException

      • getEntityPlanningsBySnippetId

        java.util.List<Planning> getEntityPlanningsBySnippetId​(java.lang.String sessionId,
                                                       java.lang.String entityModelIdentifier,
                                                       java.lang.String identifier,
                                                       java.lang.String resultEntityId,
                                                       Context context,
                                                       java.lang.String searchStr)
                                                throws EntityManagerException

        Returns plannings with assigned snippet by snipppet id

        Parameters:
        sessionId - Id of the current session
        entityModelIdentifier - identifier of the entity model
        identifier - Id of the snippet
        resultEntityId - Id of result entities, currently not evaluated
        context - Context as search filter (e.g country and language). Depending on the ContextDefinition in the Entity some or all fields of this context will be handed over to appropriate connector method.
        searchStr - additional search filter for result
        Returns:
        the list of Planning of this document; empty list, if no plannings exist.
        Throws:
        EntityManagerException

      • setPlanning

        void setPlanning​(java.lang.String sessionId,
                 java.lang.String entityModelIdentifier,
                 java.lang.String searchStr,
                 java.util.List<Planning> planning)
          throws EntityManagerException
        This method persists a Planning object
        Parameters:
        sessionId - id of the user session
        entityModelIdentifier - Identifier of the entity model
        searchStr - Search string
        planning - List of Planning objects to persist
        Throws:
        EntityManagerException

      • clonePlanning

        java.util.List<java.lang.String> clonePlanning​(java.lang.String sessionId,
                                               java.lang.String entityModelIdentifier,
                                               java.lang.String searchStr,
                                               java.util.List<Planning> plannings,
                                               boolean asTemporary)
                                        throws EntityManagerException
        This method clones Planning objects (with ContentMetaData) as new plannings with new identifiers
        Parameters:
        sessionId - id of the user session
        entityModelIdentifier - Identifier of the entity model
        searchStr - Search string
        plannings - List of Planning objects to clone
        asTemporary - Sets to true if one wants to clone as a temporary planning (it will not be visible in a document)
        Returns:
        the list of IDs of cloned plannings
        Throws:
        EntityManagerException

      • clonePlanningOfDocument

        void clonePlanningOfDocument​(java.lang.String sessionId,
                             java.lang.String entityModelIdentifier,
                             java.lang.String searchStr,
                             java.lang.String sourceDocID,
                             java.lang.String targetDocID)
                      throws EntityManagerException
        This method clones Planning objects (with ContentMetaData) to the new document
        Parameters:
        sessionId - id of the user session
        entityModelIdentifier - Identifier of the entity model
        searchStr - Search string
        sourceDocID - source document id
        targetDocID - target document id
        Throws:
        EntityManagerException

      • copyPlanningMetaData

        void copyPlanningMetaData​(java.lang.String sessionId,
                          java.lang.String entityModelIdentifier,
                          java.lang.String searchStr,
                          Planning source,
                          java.util.List<Planning> destination,
                          java.util.List<java.lang.String> filter)
                   throws EntityManagerException
        This method copies ContentMetaData of planning to the other ones
        Parameters:
        sessionId - id of the user session
        entityModelIdentifier - Identifier of the entity model
        searchStr - Search string
        source - Planning the ContentMetaData of which should be copied
        destination - List of plannings to copy content meta data
        filter - List of ContentMetaData identifiers to copy (empty list means that all meta data will be copied)
        Throws:
        EntityManagerException

      • mergePlanningMetaData

        void mergePlanningMetaData​(java.lang.String sessionId,
                           java.lang.String entityModelIdentifier,
                           java.lang.String searchStr,
                           Planning source,
                           java.util.List<Planning> destination,
                           java.util.List<java.lang.String> filter)
                    throws EntityManagerException
        This method merges ContentMetaData of planning to the other ones (copy or replace if exist)
        Parameters:
        sessionId - id of the user session
        entityModelIdentifier - Identifier of the entity model
        searchStr - Search string
        source - Planning the ContentMetaData of which should be merged
        destination - List of plannings to copy content meta data
        filter - List of ContentMetaData identifiers to merge (empty list means that all meta data will be merged)
        Throws:
        EntityManagerException

      • setPlanningTableCmdChanged

        void setPlanningTableCmdChanged​(java.lang.String sessionId,
                                java.lang.String entityModelIdentifier,
                                java.lang.String searchStr,
                                Planning source,
                                java.util.List<Planning> destination)
                         throws EntityManagerException
        This method sets tableCmdChanged property to plannings depending on source planning
        Parameters:
        sessionId - id of the user session
        entityModelIdentifier - Identifier of the entity model
        searchStr - Search string
        source - Planning the tableCmdChanged property of which should be used
        destination - List of plannings to update the tableCmdChanged property
        Throws:
        EntityManagerException

      • getTexts

        java.util.List<Text> getTexts​(java.lang.String sessionId,
                              java.lang.String entityModelIdentifier,
                              java.lang.String entityIdentifier,
                              java.lang.String searchText)
                       throws EntityManagerException
        Returns texts
        Parameters:
        sessionId -
        entityModelIdentifier -
        entityIdentifier -
        searchText -
        Returns:
        List of Text
        Throws:
        EntityManagerException

      • getMediaAssets

        java.util.List<MediaAsset> getMediaAssets​(java.lang.String sessionId,
                                          java.lang.String entityModelIdentifier,
                                          java.lang.String entityIdentifier,
                                          java.lang.String searchString)
                                   throws EntityManagerException
        Returns media assets
        Parameters:
        sessionId -
        entityModelIdentifier -
        entityIdentifier -
        searchString -
        Returns:
        List of MediaAsset
        Throws:
        EntityManagerException

      • getPrices

        java.util.List<Price> getPrices​(java.lang.String sessionId,
                                java.lang.String entityModelIdentifier,
                                java.lang.String entityIdentifier,
                                java.lang.String searchString)
                         throws EntityManagerException
        Returns prices
        Parameters:
        sessionId -
        entityModelIdentifier -
        entityIdentifier -
        searchString -
        Returns:
        List of Price
        Throws:
        EntityManagerException

      • getCords

        java.util.List<Cord> getCords​(java.lang.String sessionId,
                              java.lang.String entityModelIdentifier,
                              java.lang.String entityIdentifier,
                              java.lang.String searchString)
                       throws EntityManagerException
        Returns cords
        Parameters:
        sessionId -
        entityModelIdentifier -
        entityIdentifier -
        searchString -
        Returns:
        List of Cord
        Throws:
        EntityManagerException

      • getKeyValues

        java.util.List<KeyValue> getKeyValues​(java.lang.String sessionId,
                                      java.lang.String entityModelIdentifier,
                                      java.lang.String entityIdentifier,
                                      java.lang.String searchString)
                               throws EntityManagerException
        Returns key values
        Parameters:
        sessionId -
        entityModelIdentifier -
        entityIdentifier -
        searchString -
        Returns:
        List of Cord
        Throws:
        EntityManagerException

      • getEntityChildBucketsOfPlanning

        java.util.List<Bucket> getEntityChildBucketsOfPlanning​(java.lang.String sessionId,
                                                       java.lang.String entityModelIdentifier,
                                                       java.lang.String entityId,
                                                       java.lang.String parentPlanningId,
                                                       java.lang.String resultEntityId,
                                                       Context context,
                                                       java.lang.String records,
                                                       java.lang.String searchStr)
                                                throws EntityManagerException

        Returns the list of buckets linked to subplannings of this planning.

        Parameters:
        sessionId - Id of the current session
        entityModelIdentifier - identifier of the entity model
        entityId - Id of the planning entity, at the time this is always "planning"
        parentPlanningId - Id of the parent planning record
        resultEntityId - Id of result entities, currently not evaluated
        context - Context as search filter (e.g country and language). Depending on the ContextDefinition in the Entity some or all fields of this context will be handed over to appropriate connector method.
        records - string describing the range of records to be returned. Currently "first" and "last" are evaluated, all other terms expand to "all".
        searchStr - additional search filter for result
        Returns:
        the list of Bucket linked with subplannings of this planning; empty list, if no subplannings exist.
        Throws:
        EntityManagerException

      • getEntityCordedBucketsOfPlanning

        java.util.List<Bucket> getEntityCordedBucketsOfPlanning​(java.lang.String sessionId,
                                                        java.lang.String entityModelIdentifier,
                                                        java.lang.String entityId,
                                                        java.lang.String parentPlanningId,
                                                        java.lang.String resultEntityId,
                                                        Context context,
                                                        java.lang.String records,
                                                        java.lang.String searchStr)
                                                 throws EntityManagerException

        Returns the list of target buckets of planned cords of this planning.

        Parameters:
        sessionId - Id of the current session
        entityModelIdentifier - identifier of the entity model
        entityId - Id of the planning entity, at the time this is always "planning"
        parentPlanningId - Id of the parent planning record
        resultEntityId - Id of result entities, currently not evaluated
        context - Context as search filter (e.g country and language). Depending on the ContextDefinition in the Entity some or all fields of this context will be handed over to appropriate connector method.
        records - string describing the range of records to be returned. Currently "first" and "last" are evaluated, all other terms expand to "all".
        searchStr - additional search filter for result
        Returns:
        the list of target Bucket of planned cords of this planning record; empty list, if no cords exist.
        Throws:
        EntityManagerException

      • getEntityKeyValuesOfPlanning

        java.util.List<KeyValue> getEntityKeyValuesOfPlanning​(java.lang.String sessionId,
                                                      java.lang.String entityModelIdentifier,
                                                      java.lang.String entityId,
                                                      java.lang.String parentPlanningId,
                                                      java.lang.String resultEntityId,
                                                      Context context,
                                                      java.lang.String records,
                                                      java.lang.String searchStr)
                                               throws EntityManagerException

        Returns the list of planned KeyValues of the bucket linked to this planning.

        Parameters:
        sessionId - Id of the current session
        entityModelIdentifier - identifier of the entity model
        entityId - Id of the planning entity, at the time this is always "planning"
        parentPlanningId - Id of the parent planning record
        resultEntityId - Id of result entities, currently not evaluated
        context - Context as search filter (e.g country and language). Depending on the ContextDefinition in the Entity some or all fields of this context will be handed over to appropriate connector method.
        records - string describing the range of records to be returned. Currently "first" and "last" are evaluated, all other terms expand to "all".
        searchStr - additional search filter for result
        Returns:
        the list of planned KeyValue of the bucket linked to this planning; empty list, if no KeyValues exist.
        Throws:
        EntityManagerException

      • getEntityMediaAssetsOfPlanning

        java.util.List<MediaAsset> getEntityMediaAssetsOfPlanning​(java.lang.String sessionId,
                                                          java.lang.String entityModelIdentifier,
                                                          java.lang.String entityId,
                                                          java.lang.String parentPlanningId,
                                                          java.lang.String resultEntityId,
                                                          Context context,
                                                          java.lang.String records,
                                                          java.lang.String searchStr)
                                                   throws EntityManagerException

        Returns the list of planned MediaAssets of the bucket linked to this planning.

        Parameters:
        sessionId - Id of the current session
        entityModelIdentifier - identifier of the entity model
        entityId - Id of the planning entity, at the time this is always "planning"
        parentPlanningId - Id of the parent planning record
        resultEntityId - Id of result entities, currently not evaluated
        context - Context as search filter (e.g country and language). Depending on the ContextDefinition in the Entity some or all fields of this context will be handed over to appropriate connector method.
        records - string describing the range of records to be returned. Currently "first" and "last" are evaluated, all other terms expand to "all".
        searchStr - additional search filter for result
        Returns:
        the list of planned MediaAsset of the bucket linked to this planning; empty list, if no MediaAssets exist.
        Throws:
        EntityManagerException

      • getEntityPricesOfPlanning

        java.util.List<Price> getEntityPricesOfPlanning​(java.lang.String sessionId,
                                                java.lang.String entityModelIdentifier,
                                                java.lang.String entityId,
                                                java.lang.String parentPlanningId,
                                                java.lang.String resultEntityId,
                                                Context context,
                                                java.lang.String records,
                                                java.lang.String searchStr)
                                         throws EntityManagerException

        Returns the list of planned Prices of the bucket linked to this planning.

        Parameters:
        sessionId - Id of the current session
        entityModelIdentifier - identifier of the entity model
        entityId - Id of the planning entity, at the time this is always "planning"
        parentPlanningId - Id of the parent planning record
        resultEntityId - Id of result entities, currently not evaluated
        context - Context as search filter (e.g country and language). Depending on the ContextDefinition in the Entity some or all fields of this context will be handed over to appropriate connector method.
        records - string describing the range of records to be returned. Currently "first" and "last" are evaluated, all other terms expand to "all".
        searchStr - additional search filter for result
        Returns:
        the list of planned Price of the bucket linked to this planning; empty list, if no Prices exist.
        Throws:
        EntityManagerException

      • getEntityTextsOfPlanning

        java.util.List<Text> getEntityTextsOfPlanning​(java.lang.String sessionId,
                                              java.lang.String entityModelIdentifier,
                                              java.lang.String entityId,
                                              java.lang.String parentPlanningId,
                                              java.lang.String resultEntityId,
                                              Context context,
                                              java.lang.String records,
                                              java.lang.String searchStr)
                                       throws EntityManagerException

        Returns the list of planned Texts of the bucket linked to this planning.

        Parameters:
        sessionId - Id of the current session
        entityModelIdentifier - identifier of the entity model
        entityId - Id of the planning entity, at the time this is always "planning"
        parentPlanningId - Id of the parent planning record
        resultEntityId - Id of result entities, currently not evaluated
        context - Context as search filter (e.g country and language). Depending on the ContextDefinition in the Entity some or all fields of this context will be handed over to appropriate connector method.
        records - string describing the range of records to be returned. Currently "first" and "last" are evaluated, all other terms expand to "all".
        searchStr - additional search filter for result
        Returns:
        the list of planned Text of the bucket linked to this planning; empty list, if no Texts exist.
        Throws:
        EntityManagerException

      • getEntityTextsOfPlannedBucket

        java.util.List<Text> getEntityTextsOfPlannedBucket​(java.lang.String sessionId,
                                                   java.lang.String entityModelIdentifier,
                                                   java.lang.String identifier,
                                                   java.lang.String entityIdentifier,
                                                   Context context,
                                                   java.lang.String searchStr)
                                            throws EntityManagerException

        Returns the list of Texts of the bucket linked to this planning, not the planned content of this planning record.

        Parameters:
        sessionId - Id of the current session
        entityModelIdentifier - identifier of the entity model
        identifier - Id of the planning record
        entityIdentifier - Id of the entity
        context - Context as search filter (e.g country and language). Depending on the ContextDefinition in the Entity some or all fields of this context will be handed over to appropriate connector method.
        searchStr - additional search filter for result
        Returns:
        the list of Text of the bucket linked to this planning; empty list, if no Texts exist.
        Throws:
        EntityManagerException

      • getEntityCordsOfPlannedBucket

        java.util.List<Cord> getEntityCordsOfPlannedBucket​(java.lang.String sessionId,
                                                   java.lang.String entityModelIdentifier,
                                                   java.lang.String identifier,
                                                   java.lang.String entityIdentifier,
                                                   Context context,
                                                   java.lang.String searchStr)
                                            throws EntityManagerException

        Returns the list of Cords of the bucket linked to this planning, not the planned content of this planning record.

        Parameters:
        sessionId - Id of the current session
        entityModelIdentifier - identifier of the entity model
        identifier - Id of the planning record
        entityIdentifier - Id of the entity
        context - Context as search filter (e.g country and language). Depending on the ContextDefinition in the Entity some or all fields of this context will be handed over to appropriate connector method.
        searchStr - additional search filter for result
        Returns:
        the list of Text of the bucket linked to this planning; empty list, if no Texts exist.
        Throws:
        EntityManagerException

      • getEntityKeyValuesOfPlannedBucket

        java.util.List<KeyValue> getEntityKeyValuesOfPlannedBucket​(java.lang.String sessionId,
                                                           java.lang.String entityModelIdentifier,
                                                           java.lang.String identifier,
                                                           java.lang.String entityIdentifier,
                                                           Context context,
                                                           java.lang.String searchStr)
                                                    throws EntityManagerException

        Returns the list of Key Values of the bucket linked to this planning, not the planned content of this planning record.

        Parameters:
        sessionId - Id of the current session
        entityModelIdentifier - identifier of the entity model
        identifier - Id of the planning record
        entityIdentifier - Id of the entity
        context - Context as search filter (e.g country and language). Depending on the ContextDefinition in the Entity some or all fields of this context will be handed over to appropriate connector method.
        searchStr - additional search filter for result
        Returns:
        the list of KeyValue of the bucket linked to this planning; empty list, if no KeyValue exist.
        Throws:
        EntityManagerException

      • getEntityMediaAssetsOfPlannedBucket

        java.util.List<MediaAsset> getEntityMediaAssetsOfPlannedBucket​(java.lang.String sessionId,
                                                               java.lang.String entityModelIdentifier,
                                                               java.lang.String identifier,
                                                               java.lang.String entityIdentifier,
                                                               Context context,
                                                               java.lang.String searchStr)
                                                        throws EntityManagerException

        Returns the list of Media Assets of the bucket linked to this planning, not the planned content of this planning record.

        Parameters:
        sessionId - Id of the current session
        entityModelIdentifier - identifier of the entity model
        identifier - Id of the planning record
        entityIdentifier - Id of the entity
        context - Context as search filter (e.g country and language). Depending on the ContextDefinition in the Entity some or all fields of this context will be handed over to appropriate connector method.
        searchStr - additional search filter for result
        Returns:
        the list of MediaAsset of the bucket linked to this planning; empty list, if no MediaAsset exist.
        Throws:
        EntityManagerException

      • getEntityPricesOfPlannedBucket

        java.util.List<Price> getEntityPricesOfPlannedBucket​(java.lang.String sessionId,
                                                     java.lang.String entityModelIdentifier,
                                                     java.lang.String identifier,
                                                     java.lang.String entityIdentifier,
                                                     Context context,
                                                     java.lang.String searchStr)
                                              throws EntityManagerException

        Returns the list of Prices of the bucket linked to this planning, not the planned content of this planning record.

        Parameters:
        sessionId - Id of the current session
        entityModelIdentifier - identifier of the entity model
        identifier - Id of the planning record
        entityIdentifier - Id of the entity
        context - Context as search filter (e.g country and language). Depending on the ContextDefinition in the Entity some or all fields of this context will be handed over to appropriate connector method.
        searchStr - additional search filter for result
        Returns:
        the list of Price of the bucket linked to this planning; empty list, if no Price exist.
        Throws:
        EntityManagerException

      • getEntityTableDataOfPlannedBucket

        java.util.List<TableData> getEntityTableDataOfPlannedBucket​(java.lang.String sessionId,
                                                            java.lang.String entityModelIdentifier,
                                                            java.lang.String identifier,
                                                            java.lang.String entityIdentifier,
                                                            Context context,
                                                            java.lang.String searchStr)
                                                     throws EntityManagerException

        Returns the list of Table Data of the bucket linked to this planning, not the planned content of this planning record.

        Parameters:
        sessionId - Id of the current session
        entityModelIdentifier - identifier of the entity model
        identifier - Id of the planning record
        entityIdentifier - Id of the entity
        context - Context as search filter (e.g country and language). Depending on the ContextDefinition in the Entity some or all fields of this context will be handed over to appropriate connector method.
        searchStr - additional search filter for result
        Returns:
        the list of TableData of the bucket linked to this planning; empty list, if no TableData exist.
        Throws:
        EntityManagerException

      • deletePlanning

        void deletePlanning​(java.lang.String sessionId,
                    java.lang.String entityModelIdentifier,
                    java.util.List<Planning> planning)
             throws EntityManagerException
        Deletes a List of Planning.
        Parameters:
        sessionId - Id of the current session
        entityModelIdentifier - Identifier of the entity model
        planning - Entities to be deleted
        Throws:
        EntityManagerException

      • getEntityPlanningsOfDocument

        java.util.List<Planning> getEntityPlanningsOfDocument​(java.lang.String sessionId,
                                                      java.lang.String entityModelIdentifier,
                                                      java.lang.String entityId,
                                                      java.lang.String resultEntityId,
                                                      Context context,
                                                      java.lang.String searchStr)
                                               throws EntityManagerException

        Returns the plannings of a particular document.

        Parameters:
        sessionId - Id of the current session
        entityModelIdentifier - identifier of the entity model
        entityId - Id of the planning entity, at the time this is always "planning"
        resultEntityId - Id of result entities, currently not evaluated
        context - Context as search filter (e.g country and language). Depending on the ContextDefinition in the Entity some or all fields of this context will be handed over to appropriate connector method.
        searchStr - additional search filter for result
        Returns:
        the list of Planning of this document; empty list, if no plannings exist.
        Throws:
        EntityManagerException

      • getEntitySubPlanningsOfPlanning

        java.util.List<Planning> getEntitySubPlanningsOfPlanning​(java.lang.String sessionId,
                                                         java.lang.String entityModelIdentifier,
                                                         java.lang.String entityId,
                                                         java.lang.String parentPlanningId,
                                                         java.lang.String resultEntityId,
                                                         Context context,
                                                         java.lang.String records,
                                                         java.lang.String searchStr)
                                                  throws EntityManagerException

        Returns the list of subplannings of this planning.

        Parameters:
        sessionId - Id of the current session
        entityModelIdentifier - identifier of the entity model
        entityId - Id of the planning entity, at the time this is always "planning"
        parentPlanningId - Id of the parent planning record
        resultEntityId - Id of result entities, currently not evaluated
        context - Context as search filter (e.g country and language). Depending on the ContextDefinition in the Entity some or all fields of this context will be handed over to appropriate connector method.
        records - string describing the range of records to be returned. Currently "first" and "last" are evaluated, all other terms expand to "all".
        searchStr - additional search filter for result
        Returns:
        the list of subplannings of given planning; empty list, if no subplannings exist.
        Throws:
        EntityManagerException
        See Also:
        Planning

      • getEntityContentMetaDataByIdentifier

        java.util.List<ContentMetaData> getEntityContentMetaDataByIdentifier​(java.lang.String sessionId,
                                                                     java.lang.String entityModelIdentifier,
                                                                     java.lang.String contentMetaDataId,
                                                                     java.lang.String entityId,
                                                                     Context context,
                                                                     java.lang.String searchStr)
                                                              throws EntityManagerException
        Get a list of ContentMetaData with the same identifier
        Parameters:
        sessionId - id of the user session
        entityModelIdentifier - Identifier of the entity model
        contentMetaDataId - Identifier of the ContentMetaData
        entityId - Identifier of the entity within the entity model
        context - Context as search filter (e.g country and language). Depending on the ContextDefinition in the Entity some or all fields of this context will be handed over to appropriate connector method.
        searchStr - Search string
        Returns:
        List of ContentMetaData. Empty list if nothing was found.
        Throws:
        EntityManagerException

      • setEntityContentMetaData

        java.util.List<ContentMetaData> setEntityContentMetaData​(java.lang.String sessionId,
                                                         java.lang.String entityModelIdentifier,
                                                         java.lang.String searchStr,
                                                         java.util.List<ContentMetaData> contentMetaDataList)
                                                  throws EntityManagerException
        Persist a List of ContentMetaData
        Parameters:
        sessionId - id of the user session
        entityModelIdentifier - Identifier of the entity model
        searchStr - Search string
        contentMetaDataList - List of ContentMetaData
        Returns:
        List of ContentMetaData.
        Throws:
        EntityManagerException

      • getEntityMetadataOfBucket

        java.util.List<ContentMetaData> getEntityMetadataOfBucket​(java.lang.String sessionId,
                                                          java.lang.String entityModelIdentifier,
                                                          java.lang.String entityId,
                                                          java.lang.String parentBucketId,
                                                          java.lang.String resultEntityId,
                                                          Context context,
                                                          java.lang.String searchStr)
                                                   throws EntityManagerException
        Get a List of ContentMetaData of a Bucket
        Parameters:
        sessionId - id of the user session
        entityModelIdentifier - Identifier of the entity model
        entityId - Identifier of the entity within the entity model
        parentBucketId - Identifier of the parent bucket
        resultEntityId - filter the result list by entities with this identifier
        context - Context as search filter (e.g country and language). Depending on the ContextDefinition in the Entity some or all fields of this context will be handed over to appropriate connector method.
        searchStr - Search string
        Returns:
        List of ContentMetaData. Empty list if nothing was found.
        Throws:
        EntityManagerException

      • getEntityMetadataOfKeyValue

        java.util.List<ContentMetaData> getEntityMetadataOfKeyValue​(java.lang.String sessionId,
                                                            java.lang.String entityModelIdentifier,
                                                            java.lang.String entityId,
                                                            java.lang.String parentKeyValueId,
                                                            java.lang.String resultEntityId,
                                                            Context context,
                                                            java.lang.String searchStr)
                                                     throws EntityManagerException
        Get a List of ContentMetaData of a KeyValue
        Parameters:
        sessionId - id of the user session
        entityModelIdentifier - Identifier of the entity model
        entityId - Identifier of the entity within the entity model
        parentKeyValueId - Identifier of the parent keyValue
        resultEntityId - filter the result list by entities with this identifier
        context - Context as search filter (e.g country and language). Depending on the ContextDefinition in the Entity some or all fields of this context will be handed over to appropriate connector method.
        searchStr - Search string
        Returns:
        List of ContentMetaData. Empty list if nothing was found.
        Throws:
        EntityManagerException

      • getEntityMetadataOfPlanning

        java.util.List<ContentMetaData> getEntityMetadataOfPlanning​(java.lang.String sessionId,
                                                            java.lang.String entityModelIdentifier,
                                                            java.lang.String entityId,
                                                            java.lang.String parentPlanningId,
                                                            java.lang.String resultEntityId,
                                                            Context context,
                                                            java.lang.String searchStr)
                                                     throws EntityManagerException
        Get a List of ContentMetaData of a Planning
        Parameters:
        sessionId - id of the user session
        entityModelIdentifier - Identifier of the entity model
        entityId - Identifier of the entity within the entity model
        parentPlanningId - Identifier of the parent Planning
        resultEntityId - filter the result list by entities with this identifier
        context - Context as search filter (e.g country and language). Depending on the ContextDefinition in the Entity some or all fields of this context will be handed over to appropriate connector method.
        searchStr - Search string
        Returns:
        List of ContentMetaData. Empty list if nothing was found.
        Throws:
        EntityManagerException

      • getEntityRootMetadataOfPlanning

        java.util.List<ContentMetaData> getEntityRootMetadataOfPlanning​(java.lang.String sessionId,
                                                                java.lang.String entityModelIdentifier,
                                                                java.lang.String entityId,
                                                                java.lang.String parentPlanningId,
                                                                java.lang.String resultEntityId,
                                                                Context context,
                                                                java.lang.String searchStr)
                                                         throws EntityManagerException
        Throws:
        EntityManagerException

      • getEntityMetadataOfTableData

        java.util.List<ContentMetaData> getEntityMetadataOfTableData​(java.lang.String sessionId,
                                                             java.lang.String entityModelIdentifier,
                                                             java.lang.String entityId,
                                                             java.lang.String parentTableDataId,
                                                             java.lang.String resultEntityId,
                                                             Context context,
                                                             java.lang.String searchStr)
                                                      throws EntityManagerException
        Get a List of ContentMetaData of a TableData
        Parameters:
        sessionId - id of the user session
        entityModelIdentifier - Identifier of the entity model
        entityId - Identifier of the entity within the entity model
        parentTableDataId - Identifier of the parent TableData
        resultEntityId - filter the result list by entities with this identifier
        context - Context as search filter (e.g country and language). Depending on the ContextDefinition in the Entity some or all fields of this context will be handed over to appropriate connector method.
        searchStr - Search string
        Returns:
        List of ContentMetaData. Empty list if nothing was found.
        Throws:
        EntityManagerException

      • getEntityMetadataOfMediaAsset

        java.util.List<ContentMetaData> getEntityMetadataOfMediaAsset​(java.lang.String sessionId,
                                                              java.lang.String entityModelIdentifier,
                                                              java.lang.String entityId,
                                                              java.lang.String parentMediaAssetId,
                                                              java.lang.String resultEntityId,
                                                              Context context,
                                                              java.lang.String searchStr)
                                                       throws EntityManagerException
        Get a List of ContentMetaData of a MediaAsset
        Parameters:
        sessionId - id of the user session
        entityModelIdentifier - Identifier of the entity model
        entityId - Identifier of the entity within the entity model
        parentMediaAssetId - Identifier of the parent MediaAsset
        resultEntityId - filter the result list by entities with this identifier
        context - Context as search filter (e.g country and language). Overrides content of context with static values from ContextDefinition in Entity.
        searchStr - Search string
        Returns:
        List of ContentMetaData. Empty list if nothing was found.
        Throws:
        EntityManagerException

      • getEntityMetadataOfCord

        java.util.List<ContentMetaData> getEntityMetadataOfCord​(java.lang.String sessionId,
                                                        java.lang.String entityModelIdentifier,
                                                        java.lang.String entityId,
                                                        java.lang.String parentCordId,
                                                        java.lang.String resultEntityId,
                                                        Context context,
                                                        java.lang.String searchStr)
                                                 throws EntityManagerException
        Get a List of ContentMetaData of a Cord
        Parameters:
        sessionId - id of the user session
        entityModelIdentifier - Identifier of the entity model
        entityId - Identifier of the entity within the entity model
        parentCordId - Identifier of the parent Cord
        resultEntityId - filter the result list by entities with this identifier
        context - Context as search filter (e.g country and language). Overrides content of context with static values from ContextDefinition in Entity.
        searchStr - Search string
        Returns:
        List of ContentMetaData. Empty list if nothing was found.
        Throws:
        EntityManagerException

      • getEntityMetadataOfText

        java.util.List<ContentMetaData> getEntityMetadataOfText​(java.lang.String sessionId,
                                                        java.lang.String entityModelIdentifier,
                                                        java.lang.String entityId,
                                                        java.lang.String parentTextId,
                                                        java.lang.String resultEntityId,
                                                        Context context,
                                                        java.lang.String searchStr)
                                                 throws EntityManagerException
        Get a List of ContentMetaData of a Text
        Parameters:
        sessionId - id of the user session
        entityModelIdentifier - Identifier of the entity model
        entityId - Identifier of the entity within the entity model
        parentTextId - Identifier of the parent Text
        resultEntityId - filter the result list by entities with this identifier
        context - Context as search filter (e.g country and language). Overrides content of context with static values from ContextDefinition in Entity.
        searchStr - Search string
        Returns:
        List of ContentMetaData. Empty list if nothing was found.
        Throws:
        EntityManagerException

      • getEntityMetadataOfPrice

        java.util.List<ContentMetaData> getEntityMetadataOfPrice​(java.lang.String sessionId,
                                                         java.lang.String entityModelIdentifier,
                                                         java.lang.String entityId,
                                                         java.lang.String parentPriceId,
                                                         java.lang.String resultEntityId,
                                                         Context context,
                                                         java.lang.String searchStr)
                                                  throws EntityManagerException
        Get a List of ContentMetaData of a Price
        Parameters:
        sessionId - id of the user session
        entityModelIdentifier - Identifier of the entity model
        entityId - Identifier of the entity within the entity model
        parentPriceId - Identifier of the parent Price
        resultEntityId - filter the result list by entities with this identifier
        context - Context as search filter (e.g country and language). Overrides content of context with static values from ContextDefinition in Entity.
        searchStr - Search string
        Returns:
        List of ContentMetaData. Empty list if nothing was found.
        Throws:
        EntityManagerException

      • getBuckets

        java.util.List<Bucket> getBuckets​(java.lang.String sessionId,
                                  java.lang.String entityModelIdentifier,
                                  java.lang.String entityIdentifier,
                                  java.lang.String searchStr)
                           throws EntityManagerException
        Get a list of Entity Root Buckets
        Parameters:
        sessionId - id of the user session
        entityModelIdentifier - Identifier of the entity model
        entityIdentifier - Identifier of the entity within the entity model
        searchStr - Search string
        Returns:
        List of root Bucket. Empty list if nothing was found.
        Throws:
        EntityManagerException

      • changeParentRealGridElementForPlannedBuckets

        void changeParentRealGridElementForPlannedBuckets​(java.lang.String sessionId,
                                                  java.lang.String entityModelIdentifier,
                                                  java.util.List<Planning> plannedBuckets,
                                                  Planning realGridElement)
                                           throws EntityManagerException
        This method move a the list of planned buckets to the new Real Grid Element
        Parameters:
        sessionId - id of the user session
        entityModelIdentifier - Identifier of the entity model
        plannedBuckets - List of Planning objects to move to the new Real Grid Element
        realGridElement - new Real Grid Element
        Throws:
        EntityManagerException

      • duplicateModel

        void duplicateModel​(java.lang.String oldModelId,
                    java.lang.String newModelId,
                    java.util.Map<java.lang.String,​java.lang.Object> additionalValues)
             throws EntityManagerException
        Duplicate an entity model.

        Additional values are given in a simple hash map and set via bean population.

        oldModelId and newModelId can be identical in case either the tenant or connectorSpec will be changed through the operation. Otherwise an exception will be raised.

        Parameters:
        oldModelId - original model identifier
        newModelId - new model identifier
        additionalValues - optional field values to be replaced for the new model. This depends on the implementation of entity manager.
        Default entity manager of publishing hub currently supports "newLabel", "newDescription", "oldConnectorSpec", "newConnectorSpec", "oldTenant", "newTenant".
        Throws:
        EntityManagerException

      • replaceConnector

        void replaceConnector​(java.lang.String id,
                      java.lang.String oldConnectorSpec,
                      java.lang.String newConnectorSpec)
               throws EntityManagerException
        Replacing a connectorSpec in all entities of entity model through a new value.

        Entities using another connector or instance than oldConnectorSpec will not be affected by this operation.

        If old and new connectorSpec are identical an exception will be thrown.

        This method will most probably be implemented by using the duplicateModel(String, String, Map) method internally.

        Parameters:
        id - original model identifier
        oldConnectorSpec - current connector specification, e.g. "com.priint.MyConnetor:MyInstance".
        newConnectorSpec - new connector specification to replace the old one in model and all entities, e.g. "de.kontoso.YourConnetor:YourInstance".
        Throws:
        EntityManagerException

      • commitItems

        java.util.List<EntityItem> commitItems​(java.lang.String entityModelIdentifier,
                                       java.util.List<EntityItem> items)
                                throws EntityManagerException
        Change (insert, update, or delete) a list of entity items within an entity model. Within one commit different actions can be mixed.

        Only one connector is supported per call, i.e. for multiple connectors this method has to be called for each connector separately. Otherwise transactional integrity cannot be assured.

        Whether the operation is really transactional safe also depends on the specific connector. Some connectors may split the item list by the action type and run separate batches for insert, update, and delete. Please refer to the connector documentation for details.

        The method returns the state of the same items after the commit was completed. The status value will contain detailed information.

        For an item with command INSERT the returned item may contain a new identifier created by the content system.

        The exact procedure for commit depends on the connector. If an error occurs the connector may throw an exception, that will be returned to the caller (wrapped as EntityManagerException). It may also just return a list where some or all items have status EntityItem.Status.FAILED or EntityItem.Status.EXCEPTION.

        Parameters:
        entityModelIdentifier -
        items -
        Returns:
        a list of EntityItem after changing with a result status for each item.
        Throws:
        EntityManagerException - If any severe problem occurred during commit. Also thrown if items or entityModelIdentifier are null.

      • bulkInsert

        java.util.List<EntityItem> bulkInsert​(java.lang.String entityModelIdentifier,
                                      java.util.List<EntityItem> items)
                               throws EntityManagerException
        Insert a list of entity items within an entity model. Within one commit different actions can be mixed.

        Only one connector is supported per call, i.e. for multiple connectors this method has to be called for each connector separately. Otherwise transactional integrity cannot be assured.

        Whether the operation is really transactional safe also depends on the specific connector. Some connectors may split the item list by the action type and run separate batches for insert, update, and delete. Please refer to the connector documentation for details.

        The exact procedure for commit depends on the connector. If an error occurs the connector may throw an exception, that will be returned to the caller (wrapped as EntityManagerException). It may also just return a list where some or all items have status EntityItem.Status.FAILED or EntityItem.Status.EXCEPTION.

        Parameters:
        entityModelIdentifier -
        items -
        Returns:
        a list of EntityItem after changing with a result status for each item.
        Throws:
        EntityManagerException - If any severe problem occurred during commit. Also thrown if items or entityModelIdentifier are null.

      • bulkUpsert

        java.util.List<EntityItem> bulkUpsert​(java.lang.String entityModelIdentifier,
                                      java.util.List<EntityItem> items)
                               throws EntityManagerException
        Upsert a list of entity items within an entity model. Within one commit different actions can be mixed.

        Only one connector is supported per call, i.e. for multiple connectors this method has to be called for each connector separately. Otherwise transactional integrity cannot be assured.

        Whether the operation is really transactional safe also depends on the specific connector. Some connectors may split the item list by the action type and run separate batches for insert, update, and delete. Please refer to the connector documentation for details.

        The exact procedure for commit depends on the connector. If an error occurs the connector may throw an exception, that will be returned to the caller (wrapped as EntityManagerException). It may also just return a list where some or all items have status EntityItem.Status.FAILED or EntityItem.Status.EXCEPTION.

        Parameters:
        entityModelIdentifier -
        items -
        Returns:
        a list of EntityItem after changing with a result status for each item.
        Throws:
        EntityManagerException - If any severe problem occurred during commit. Also thrown if items or entityModelIdentifier are null.

      • canDeleteContentMetaData

        boolean canDeleteContentMetaData​(java.lang.String entityModelIdentifier,
                                 java.lang.String entityContentMetaDataId)
        This method returns true or false depending on the specified type of the ContentMetaData is allowed to delete
        Parameters:
        entityModelIdentifier - Identifier of the entity model
        entityContentMetaDataId - Entity identifier of the ContentMetaData

      • getEntityPlanningsBySourcePlanningId

        java.util.List<Planning> getEntityPlanningsBySourcePlanningId​(java.lang.String sessionId,
                                                              java.lang.String entityModelIdentifier,
                                                              java.lang.String sourcePlanningId,
                                                              java.lang.String resultEntityId,
                                                              Context context,
                                                              java.lang.String searchStr)
                                                       throws EntityManagerException
        Parameters:
        sessionId -
        entityModelIdentifier -
        sourcePlanningId -
        resultEntityId -
        context -
        searchStr -
        Returns:
        Throws:
        EntityManagerException

      • getEntityPlanningsOfPageBySourcePlanningId

        java.util.List<Planning> getEntityPlanningsOfPageBySourcePlanningId​(java.lang.String sessionId,
                                                                    java.lang.String entityModelIdentifier,
                                                                    java.lang.String sourcePlanningId,
                                                                    java.lang.String resultEntityId,
                                                                    int pageIndex,
                                                                    Context context,
                                                                    java.lang.String searchStr)
                                                             throws EntityManagerException
        Parameters:
        sessionId -
        entityModelIdentifier -
        sourcePlanningId -
        resultEntityId -
        pageIndex -
        context -
        searchStr -
        Returns:
        Throws:
        EntityManagerException

      • getEntityPlanningsBySnippetOrigin

        java.util.List<Planning> getEntityPlanningsBySnippetOrigin​(java.lang.String sessionId,
                                                           java.lang.String entityModelIdentifier,
                                                           java.lang.String snippetSourceId,
                                                           java.lang.String resultEntityId,
                                                           Context context,
                                                           java.lang.String searchStr)
                                                    throws EntityManagerException
        Parameters:
        sessionId -
        entityModelIdentifier -
        snippetSourceId -
        resultEntityId -
        context -
        searchStr -
        Returns:
        Throws:
        EntityManagerException

      • getEntityPlanningsOfPageBySnippetOrigin

        java.util.List<Planning> getEntityPlanningsOfPageBySnippetOrigin​(java.lang.String sessionId,
                                                                 java.lang.String entityModelIdentifier,
                                                                 java.lang.String snippetSourceId,
                                                                 java.lang.String resultEntityId,
                                                                 int pageIndex,
                                                                 Context context,
                                                                 java.lang.String searchStr)
                                                          throws EntityManagerException
        Parameters:
        sessionId -
        entityModelIdentifier -
        snippetSourceId -
        resultEntityId -
        pageIndex -
        context -
        searchStr -
        Returns:
        Throws:
        EntityManagerException

      • getCountOfMediaAssetRefsOfPlanning

        java.lang.Long getCountOfMediaAssetRefsOfPlanning​(java.lang.String sessionId,
                                                  java.lang.String entityModelIdentifier,
                                                  java.lang.String parentPlanningId,
                                                  Context context)
                                           throws EntityManagerException
        This method returns a number of planned media assets in given planning
        Parameters:
        sessionId -
        entityModelIdentifier -
        parentPlanningId -
        context -
        Returns:
        number of planned media assets (Long)
        Throws:
        EntityManagerException

      • getCountOfTextRefsOfPlanning

        java.lang.Long getCountOfTextRefsOfPlanning​(java.lang.String sessionId,
                                            java.lang.String entityModelIdentifier,
                                            java.lang.String parentPlanningId,
                                            Context context)
                                     throws EntityManagerException
        This method returns a number of planned texts in given planning
        Parameters:
        sessionId -
        entityModelIdentifier -
        parentPlanningId -
        context -
        Returns:
        number of planned media assets (Long)
        Throws:
        EntityManagerException

      • getCountOfKeyValueRefsOfPlanning

        java.lang.Long getCountOfKeyValueRefsOfPlanning​(java.lang.String sessionId,
                                                java.lang.String entityModelIdentifier,
                                                java.lang.String parentPlanningId,
                                                Context context)
                                         throws EntityManagerException
        This method returns a number of planned key values in given planning
        Parameters:
        sessionId -
        entityModelIdentifier -
        parentPlanningId -
        context -
        Returns:
        number of planned media assets (Long)
        Throws:
        EntityManagerException

      • getCountOfPriceRefsOfPlanning

        java.lang.Long getCountOfPriceRefsOfPlanning​(java.lang.String sessionId,
                                             java.lang.String entityModelIdentifier,
                                             java.lang.String parentPlanningId,
                                             Context context)
                                      throws EntityManagerException
        This method returns a number of planned prices in given planning
        Parameters:
        sessionId -
        entityModelIdentifier -
        parentPlanningId -
        context -
        Returns:
        number of planned media assets (Long)
        Throws:
        EntityManagerException

      • getCountOfCordRefsOfPlanning

        java.lang.Long getCountOfCordRefsOfPlanning​(java.lang.String sessionId,
                                            java.lang.String entityModelIdentifier,
                                            java.lang.String parentPlanningId,
                                            Context context)
                                     throws EntityManagerException
        This method returns a number of planned cords in given planning
        Parameters:
        sessionId -
        entityModelIdentifier -
        parentPlanningId -
        context -
        Returns:
        number of planned media assets (Long)
        Throws:
        EntityManagerException

      • getCountOfSubBucketRefsOfPlanning

        java.lang.Long getCountOfSubBucketRefsOfPlanning​(java.lang.String sessionId,
                                                 java.lang.String entityModelIdentifier,
                                                 java.lang.String parentPlanningId,
                                                 Context context)
                                          throws EntityManagerException
        This method returns a number of planned sub-buckets in given planning
        Parameters:
        sessionId -
        entityModelIdentifier -
        parentPlanningId -
        context -
        Returns:
        number of planned media assets (Long)
        Throws:
        EntityManagerException

      • addRootPlannings

        void addRootPlannings​(java.lang.String sessionId,
                      java.lang.String entityModelIdentifier,
                      java.util.List<Planning> planning)
               throws EntityManagerException
        This method persists a List of Planning objects
        Parameters:
        sessionId - id of the user session
        entityModelIdentifier - Identifier of the entity model
        planning - List of Planning objects to persist
        Throws:
        EntityManagerException

      • updateSequenceOfRootPlanning

        void updateSequenceOfRootPlanning​(java.lang.String sessionId,
                                  java.lang.String entityModelIdentifier,
                                  java.util.List<Planning> planningList)
                           throws EntityManagerException
        This method sort a List of Planning objects on root level
        Parameters:
        sessionId - id of the user session
        entityModelIdentifier - Identifier of the entity model
        planningList - List of Planning objects to persist
        Throws:
        EntityManagerException