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 Details

    • getEntity

      <T extends Entity> T getEntity(EntityModel entityModel, String entityId, Class<T> clazz)
      Gets an entity by its name from an entity model
      Parameters:
      entityModel - Entity Model
      entityId - Identifier of the Entity within the model
      clazz - Class of the Entity (e.g. EntityBucket)
      Returns:
      Entity or null if entity of the given id and type could not be found.
      See Also:
    • getEntityByConnectorEntity

      <T extends Entity> T getEntityByConnectorEntity(String entityModelIdentifier, String connectorEntity, Class<T> entityClass)
      Gets an entity from an entity model by a connector entity.
      Parameters:
      entityModelIdentifier - Identifier of the entity model
      connectorEntity - ConnectorEntity String
      entityClass - Class of Entity Object (like EntityBucket)
      Returns:
      Entity or null if no object with the connector string and entity type found in the model
      See Also:
    • importModelfromXML

      EntityModel importModelfromXML(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

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

      Collection<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:
    • getEntityRootBuckets

      List<Bucket> getEntityRootBuckets(String sessionId, String entityModelIdentifier, String resultEntityId, Context context, 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:
    • getEntityRootBuckets

      List<Bucket> getEntityRootBuckets(String sessionId, String entityModelIdentifier, String resultEntityId, Context context, String searchStr, long ttl, TimeUnit ttlTimeUnit) 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
      ttl - TTL (Time-To-Live) value for caching the data.
      ttlTimeUnit - Time unit for the TTL value, specifying the granularity (e.g., seconds, minutes).
      Returns:
      List of root buckets. Empty list if nothing was found.
      Throws:
      EntityManagerException
      See Also:
    • getEntityBucketsOfPlanning

      List<Bucket> getEntityBucketsOfPlanning(String sessionId, String entityModelIdentifier, String entityId, String parentPlanningId, String resultEntityId, Context context, 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:
    • getEntityChildBuckets

      List<Bucket> getEntityChildBuckets(String sessionId, String entityModelIdentifier, String entityId, String parentBucketId, String resultEntityId, Context context, 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:
    • getEntityChildBuckets

      List<Bucket> getEntityChildBuckets(String sessionId, String entityModelIdentifier, String entityId, String parentBucketId, String resultEntityId, Context context, String searchStr, long ttl, TimeUnit ttlTimeUnit) 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
      ttl - TTL (Time-To-Live) value for caching the data.
      ttlTimeUnit - Time unit for the TTL value, specifying the granularity (e.g., seconds, minutes).
      Returns:
      List of Child Buckets. Empty list if nothing was found.
      Throws:
      EntityManagerException
      See Also:
    • getEntityBucketsByIdentifier

      List<Bucket> getEntityBucketsByIdentifier(String sessionId, String entityModelIdentifier, String bucketId, String entityId, Context context, 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:
    • getEntityBucketsByIdentifier

      List<Bucket> getEntityBucketsByIdentifier(String sessionId, String entityModelIdentifier, String bucketId, String entityId, Context context, String searchStr, long ttl, TimeUnit ttlTimeUnit) 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
      ttl - TTL (Time-To-Live) value for caching the data.
      ttlTimeUnit - Time unit for the TTL value, specifying the granularity (e.g., seconds, minutes).
      Returns:
      List of Buckets. Empty list if nothing was found.
      Throws:
      EntityManagerException
      See Also:
    • getEntityKeyValuesOfBucket

      List<KeyValue> getEntityKeyValuesOfBucket(String sessionId, String entityModelIdentifier, String entityId, String parentBucketId, String resultEntityId, Context context, 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:
    • getEntityKeyValuesOfBucket

      List<KeyValue> getEntityKeyValuesOfBucket(String sessionId, String entityModelIdentifier, String entityId, String parentBucketId, String resultEntityId, Context context, String searchStr, long ttl, TimeUnit ttlTimeUnit) 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
      ttl - TTL (Time-To-Live) value for caching the data.
      ttlTimeUnit - Time unit for the TTL value, specifying the granularity (e.g., seconds, minutes).
      Returns:
      List of KeyValues. Empty list if nothing was found.
      Throws:
      EntityManagerException
      See Also:
    • getEntityKeyValuesByIdentifier

      List<KeyValue> getEntityKeyValuesByIdentifier(String sessionId, String entityModelIdentifier, String keyValueId, String entityId, Context context, 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:
    • getEntityKeyValuesByIdentifier

      List<KeyValue> getEntityKeyValuesByIdentifier(String sessionId, String entityModelIdentifier, String keyValueId, String entityId, Context context, String searchStr, long ttl, TimeUnit ttlTimeUnit) 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
      ttl - TTL (Time-To-Live) value for caching the data.
      ttlTimeUnit - Time unit for the TTL value, specifying the granularity (e.g., seconds, minutes).
      Returns:
      List of KeyValues. Empty list if nothing was found.
      Throws:
      EntityManagerException
      See Also:
    • getEntityPricesOfBucket

      List<Price> getEntityPricesOfBucket(String sessionId, String entityModelIdentifier, String entityId, String parentBucketId, String resultEntityId, Context context, 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:
    • getEntityPricesOfBucket

      List<Price> getEntityPricesOfBucket(String sessionId, String entityModelIdentifier, String entityId, String parentBucketId, String resultEntityId, Context context, String searchStr, long ttl, TimeUnit ttlTimeUnit) 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
      ttl - TTL (Time-To-Live) value for caching the data.
      ttlTimeUnit - Time unit for the TTL value, specifying the granularity (e.g., seconds, minutes).
      Returns:
      List of Prices. Empty list if nothing was found.
      Throws:
      EntityManagerException
      See Also:
    • getEntityPricesByIdentifier

      List<Price> getEntityPricesByIdentifier(String sessionId, String entityModelIdentifier, String priceId, String entityId, Context context, 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:
    • getEntityPricesByIdentifier

      List<Price> getEntityPricesByIdentifier(String sessionId, String entityModelIdentifier, String priceId, String entityId, Context context, String searchStr, long ttl, TimeUnit ttlTimeUnit) 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
      ttl - TTL (Time-To-Live) value for caching the data.
      ttlTimeUnit - Time unit for the TTL value, specifying the granularity (e.g., seconds, minutes).
      Returns:
      List of Prices. Empty list if nothing was found.
      Throws:
      EntityManagerException
      See Also:
    • getEntityTextsOfBucket

      List<Text> getEntityTextsOfBucket(String sessionId, String entityModelIdentifier, String entityId, String parentBucketId, String resultEntityId, Context context, 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:
    • getEntityTextsOfBucket

      List<Text> getEntityTextsOfBucket(String sessionId, String entityModelIdentifier, String entityId, String parentBucketId, String resultEntityId, Context context, String searchStr, long ttl, TimeUnit ttlTimeUnit) 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
      ttl - TTL (Time-To-Live) value for caching the data.
      ttlTimeUnit - Time unit for the TTL value, specifying the granularity (e.g., seconds, minutes).
      Returns:
      List of Texts. Empty list if nothing was found.
      Throws:
      EntityManagerException
      See Also:
    • getEntityTextsByIdentifier

      List<Text> getEntityTextsByIdentifier(String sessionId, String entityModelIdentifier, String textId, String entityId, Context context, 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:
    • getEntityTextsByIdentifier

      List<Text> getEntityTextsByIdentifier(String sessionId, String entityModelIdentifier, String textId, String entityId, Context context, String searchStr, long ttl, TimeUnit ttlTimeUnit) 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
      ttl - TTL (Time-To-Live) value for caching the data.
      ttlTimeUnit - Time unit for the TTL value, specifying the granularity (e.g., seconds, minutes).
      Returns:
      List of Texts. Empty list if nothing was found.
      Throws:
      EntityManagerException
      See Also:
    • getEntityMediaAssetsOfBucket

      List<MediaAsset> getEntityMediaAssetsOfBucket(String sessionId, String entityModelIdentifier, String entityId, String parentBucketId, String resultEntityId, Context context, 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:
    • getEntityMediaAssetsOfBucket

      List<MediaAsset> getEntityMediaAssetsOfBucket(String sessionId, String entityModelIdentifier, String entityId, String parentBucketId, String resultEntityId, Context context, String searchStr, long ttl, TimeUnit ttlTimeUnit) 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
      ttl - TTL (Time-To-Live) value for caching the data.
      ttlTimeUnit - Time unit for the TTL value, specifying the granularity (e.g., seconds, minutes).
      Returns:
      List of MediaAssets. Empty list if nothing was found.
      Throws:
      EntityManagerException
      See Also:
    • getEntityMediaAssetsByIdentifier

      List<MediaAsset> getEntityMediaAssetsByIdentifier(String sessionId, String entityModelIdentifier, String mediaAssetId, String entityId, Context context, 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:
    • getEntityMediaAssetsByIdentifier

      List<MediaAsset> getEntityMediaAssetsByIdentifier(String sessionId, String entityModelIdentifier, String mediaAssetId, String entityId, Context context, String searchStr, long ttl, TimeUnit ttlTimeUnit) 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
      ttl - TTL (Time-To-Live) value for caching the data.
      ttlTimeUnit - Time unit for the TTL value, specifying the granularity (e.g., seconds, minutes).
      Returns:
      List of MediaAssets. Empty list if nothing was found.
      Throws:
      EntityManagerException
      See Also:
    • getEntityCordedBuckets

      List<Bucket> getEntityCordedBuckets(String sessionId, String entityModelIdentifier, String entityId, String parentBucketId, String cordEntityId, Context context, 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:
    • getEntityCordedBuckets

      List<Bucket> getEntityCordedBuckets(String sessionId, String entityModelIdentifier, String entityId, String parentBucketId, String cordEntityId, Context context, String searchStr, long ttl, TimeUnit ttlTimeUnit) 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
      ttl - TTL (Time-To-Live) value for caching the data.
      ttlTimeUnit - Time unit for the TTL value, specifying the granularity (e.g., seconds, minutes).
      Returns:
      List of buckets. Empty list if nothing was found.
      Throws:
      EntityManagerException
      See Also:
    • getEntityCordsOfBuckets

      List<Cord> getEntityCordsOfBuckets(String sessionId, String entityModelIdentifier, String entityId, String parentBucketId, String resultEntityId, Context context, 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:
    • getEntityCordsOfBuckets

      List<Cord> getEntityCordsOfBuckets(String sessionId, String entityModelIdentifier, String entityId, String parentBucketId, String resultEntityId, Context context, String searchStr, long ttl, TimeUnit ttlTimeUnit) 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
      ttl - TTL (Time-To-Live) value for caching the data.
      ttlTimeUnit - Time unit for the TTL value, specifying the granularity (e.g., seconds, minutes).
      Returns:
      List of cords. Empty list if nothing was found.
      Throws:
      EntityManagerException
      See Also:
    • getEntityCordsByIdentifier

      List<Cord> getEntityCordsByIdentifier(String sessionId, String entityModelIdentifier, String cordId, String entityId, Context context, 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
    • getEntityCordsByIdentifier

      List<Cord> getEntityCordsByIdentifier(String sessionId, String entityModelIdentifier, String cordId, String entityId, Context context, String searchStr, long ttl, TimeUnit ttlTimeUnit) 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
      ttl - TTL (Time-To-Live) value for caching the data.
      ttlTimeUnit - Time unit for the TTL value, specifying the granularity (e.g., seconds, minutes).
      Returns:
      List of Cords. Empty list if nothing was found.
      Throws:
      EntityManagerException
      Since:
      4.1.5
    • getEntityTableDataOfBucket

      List<TableData> getEntityTableDataOfBucket(String sessionId, String entityModelIdentifier, String entityId, String parentBucketId, String resultEntityId, Context context, 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:
    • getEntityTableDataOfPlanning

      List<TableData> getEntityTableDataOfPlanning(String sessionId, String entityModelIdentifier, Context context, String identifier, String entityId, String resultEntityId, String records, 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

      List<TableData> getEntityTableDataOfPlanning(String sessionId, String entityModelIdentifier, String entityId, String parentPlanningId, String resultEntityId, Context context, String records, 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

      List<TableData> getEntityTableDataByIdentifier(String sessionId, String entityModelIdentifier, String identifier, String entityIdentifier, Context context, 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

      List<Bucket> setEntityBuckets(String sessionId, String entityModelIdentifier, String searchStr, 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

      List<KeyValue> setEntityKeyValues(String sessionId, String entityModelIdentifier, String searchStr, 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

      List<Text> setEntityTexts(String sessionId, String entityModelIdentifier, String searchStr, 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

      List<MediaAsset> setEntityMediaAssets(String sessionId, String entityModelIdentifier, String searchStr, 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

      List<Price> setEntityPrices(String sessionId, String entityModelIdentifier, String searchStr, 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

      List<Cord> setEntityCords(String sessionId, String entityModelIdentifier, String searchStr, 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

      List<TableData> setEntityTableDatas(String sessionId, String entityModelIdentifier, String searchStr, 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

      List<TableDataRow> setEntityTableDataRows(String sessionId, String entityModelIdentifier, String searchStr, 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

      List<TableDataCell> setEntityTableDataCells(String sessionId, String entityModelIdentifier, String searchStr, 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

      List<Planning> getEntityPlanningsByIdentifier(String sessionId, String entityModelIdentifier, String identifier, String entityId, Context context, 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

      List<Planning> getPlanningByIdentifier(String sessionId, String identifier, 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

      List<Planning> getEntityPlanningsOfPage(String sessionId, String entityModelIdentifier, String entityId, String resultEntityId, int pageIndex, Context context, 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

      List<Planning> getEntityPlanningsOfDocumentAndPage(String sessionId, String entityModelIdentifier, String entityId, String resultEntityId, String documentId, int pageIndex, Context context, 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

      List<Planning> getEntityPlanningsBySnippetId(String sessionId, String entityModelIdentifier, String identifier, String resultEntityId, Context context, 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(String sessionId, String entityModelIdentifier, String searchStr, 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

      List<String> clonePlanning(String sessionId, String entityModelIdentifier, String searchStr, 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(String sessionId, String entityModelIdentifier, String searchStr, String sourceDocID, 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(String sessionId, String entityModelIdentifier, String searchStr, Planning source, List<Planning> destination, List<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(String sessionId, String entityModelIdentifier, String searchStr, Planning source, List<Planning> destination, List<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(String sessionId, String entityModelIdentifier, String searchStr, Planning source, 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

      List<Text> getTexts(String sessionId, String entityModelIdentifier, String entityIdentifier, String searchText) throws EntityManagerException
      Returns texts
      Parameters:
      sessionId -
      entityModelIdentifier -
      entityIdentifier -
      searchText -
      Returns:
      List of Text
      Throws:
      EntityManagerException
    • getMediaAssets

      List<MediaAsset> getMediaAssets(String sessionId, String entityModelIdentifier, String entityIdentifier, String searchString) throws EntityManagerException
      Returns media assets
      Parameters:
      sessionId -
      entityModelIdentifier -
      entityIdentifier -
      searchString -
      Returns:
      List of MediaAsset
      Throws:
      EntityManagerException
    • getPrices

      List<Price> getPrices(String sessionId, String entityModelIdentifier, String entityIdentifier, String searchString) throws EntityManagerException
      Returns prices
      Parameters:
      sessionId -
      entityModelIdentifier -
      entityIdentifier -
      searchString -
      Returns:
      List of Price
      Throws:
      EntityManagerException
    • getCords

      List<Cord> getCords(String sessionId, String entityModelIdentifier, String entityIdentifier, String searchString) throws EntityManagerException
      Returns cords
      Parameters:
      sessionId -
      entityModelIdentifier -
      entityIdentifier -
      searchString -
      Returns:
      List of Cord
      Throws:
      EntityManagerException
    • getKeyValues

      List<KeyValue> getKeyValues(String sessionId, String entityModelIdentifier, String entityIdentifier, String searchString) throws EntityManagerException
      Returns key values
      Parameters:
      sessionId -
      entityModelIdentifier -
      entityIdentifier -
      searchString -
      Returns:
      List of Cord
      Throws:
      EntityManagerException
    • getEntityChildBucketsOfPlanning

      List<Bucket> getEntityChildBucketsOfPlanning(String sessionId, String entityModelIdentifier, String entityId, String parentPlanningId, String resultEntityId, Context context, String records, 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

      List<Bucket> getEntityCordedBucketsOfPlanning(String sessionId, String entityModelIdentifier, String entityId, String parentPlanningId, String resultEntityId, Context context, String records, 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

      List<KeyValue> getEntityKeyValuesOfPlanning(String sessionId, String entityModelIdentifier, String entityId, String parentPlanningId, String resultEntityId, Context context, String records, 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

      List<MediaAsset> getEntityMediaAssetsOfPlanning(String sessionId, String entityModelIdentifier, String entityId, String parentPlanningId, String resultEntityId, Context context, String records, 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

      List<Price> getEntityPricesOfPlanning(String sessionId, String entityModelIdentifier, String entityId, String parentPlanningId, String resultEntityId, Context context, String records, 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

      List<Text> getEntityTextsOfPlanning(String sessionId, String entityModelIdentifier, String entityId, String parentPlanningId, String resultEntityId, Context context, String records, 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

      List<Text> getEntityTextsOfPlannedBucket(String sessionId, String entityModelIdentifier, String identifier, String entityIdentifier, Context context, 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

      List<Cord> getEntityCordsOfPlannedBucket(String sessionId, String entityModelIdentifier, String identifier, String entityIdentifier, Context context, 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

      List<KeyValue> getEntityKeyValuesOfPlannedBucket(String sessionId, String entityModelIdentifier, String identifier, String entityIdentifier, Context context, 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

      List<MediaAsset> getEntityMediaAssetsOfPlannedBucket(String sessionId, String entityModelIdentifier, String identifier, String entityIdentifier, Context context, 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

      List<Price> getEntityPricesOfPlannedBucket(String sessionId, String entityModelIdentifier, String identifier, String entityIdentifier, Context context, 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

      List<TableData> getEntityTableDataOfPlannedBucket(String sessionId, String entityModelIdentifier, String identifier, String entityIdentifier, Context context, 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(String sessionId, String entityModelIdentifier, 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
    • deleteEntityBuckets

      List<DeleteEntityStatus> deleteEntityBuckets(String sessionId, String entityModelIdentifier, List<Bucket> buckets) throws EntityManagerException
      Deletes a List of Bucket.
      Parameters:
      sessionId - Id of the current session
      entityModelIdentifier - Identifier of the entity model
      buckets - Entities to be deleted
      Returns:
      List of DeleteEntityStatus
      Throws:
      EntityManagerException
    • deleteEntityKeyValues

      List<DeleteEntityStatus> deleteEntityKeyValues(String sessionId, String entityModelIdentifier, List<KeyValue> keyValues) throws EntityManagerException
      Deletes a List of KeyValue.
      Parameters:
      sessionId - Id of the current session
      entityModelIdentifier - Identifier of the entity model
      keyValues - Entities to be deleted
      Returns:
      List of DeleteEntityStatus
      Throws:
      EntityManagerException
    • deleteEntityTexts

      List<DeleteEntityStatus> deleteEntityTexts(String sessionId, String entityModelIdentifier, List<Text> texts) throws EntityManagerException
      Deletes a List of Text.
      Parameters:
      sessionId - Id of the current session
      entityModelIdentifier - Identifier of the entity model
      texts - Entities to be deleted
      Returns:
      List of DeleteEntityStatus
      Throws:
      EntityManagerException
    • deleteEntityMediaAssets

      List<DeleteEntityStatus> deleteEntityMediaAssets(String sessionId, String entityModelIdentifier, List<MediaAsset> mediaAssets) throws EntityManagerException
      Deletes a List of MediaAsset.
      Parameters:
      sessionId - Id of the current session
      entityModelIdentifier - Identifier of the entity model
      mediaAssets - Entities to be deleted
      Returns:
      List of DeleteEntityStatus
      Throws:
      EntityManagerException
    • deleteEntityPrices

      List<DeleteEntityStatus> deleteEntityPrices(String sessionId, String entityModelIdentifier, List<Price> prices) throws EntityManagerException
      Deletes a List of Price.
      Parameters:
      sessionId - Id of the current session
      entityModelIdentifier - Identifier of the entity model
      prices - Entities to be deleted
      Returns:
      List of DeleteEntityStatus
      Throws:
      EntityManagerException
    • deleteEntityCords

      List<DeleteEntityStatus> deleteEntityCords(String sessionId, String entityModelIdentifier, List<Cord> cords) throws EntityManagerException
      Deletes a List of Cord.
      Parameters:
      sessionId - Id of the current session
      entityModelIdentifier - Identifier of the entity model
      cords - Entities to be deleted
      Returns:
      List of DeleteEntityStatus
      Throws:
      EntityManagerException
    • deleteEntityTableDatas

      List<DeleteEntityStatus> deleteEntityTableDatas(String sessionId, String entityModelIdentifier, List<TableData> tableDatas) throws EntityManagerException
      Deletes a List of TableData.
      Parameters:
      sessionId - Id of the current session
      entityModelIdentifier - Identifier of the entity model
      tableDatas - Entities to be deleted
      Returns:
      List of DeleteEntityStatus
      Throws:
      EntityManagerException
    • deleteEntityTableDataRows

      List<DeleteEntityStatus> deleteEntityTableDataRows(String sessionId, String entityModelIdentifier, List<TableDataRow> tableDataRows) throws EntityManagerException
      Deletes a List of TableDataRow.
      Parameters:
      sessionId - Id of the current session
      entityModelIdentifier - Identifier of the entity model
      tableDataRows - Entities to be deleted
      Returns:
      List of DeleteEntityStatus
      Throws:
      EntityManagerException
    • deleteEntityTableDataCells

      List<DeleteEntityStatus> deleteEntityTableDataCells(String sessionId, String entityModelIdentifier, List<TableDataCell> tableDataCells) throws EntityManagerException
      Deletes a List of TableDataCell.
      Parameters:
      sessionId - Id of the current session
      entityModelIdentifier - Identifier of the entity model
      tableDataCells - Entities to be deleted
      Returns:
      List of DeleteEntityStatus
      Throws:
      EntityManagerException
    • getEntityPlanningsOfDocument

      List<Planning> getEntityPlanningsOfDocument(String sessionId, String entityModelIdentifier, String entityId, String resultEntityId, Context context, 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

      List<Planning> getEntitySubPlanningsOfPlanning(String sessionId, String entityModelIdentifier, String entityId, String parentPlanningId, String resultEntityId, Context context, String records, 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:
    • getEntityContentMetaDataByIdentifier

      List<ContentMetaData> getEntityContentMetaDataByIdentifier(String sessionId, String entityModelIdentifier, String contentMetaDataId, String entityId, Context context, 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

      List<ContentMetaData> setEntityContentMetaData(String sessionId, String entityModelIdentifier, String searchStr, 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
    • deleteEntityContentMetaData

      List<DeleteEntityStatus> deleteEntityContentMetaData(String sessionId, String entityModelIdentifier, List<ContentMetaData> contentMetaDatalist) throws EntityManagerException
      Delete a List of ContentMetaData.
      Parameters:
      sessionId - id of the user session
      entityModelIdentifier - Identifier of the entity model
      contentMetaDatalist - List of ContentMetaData
      Returns:
      List of DeleteEntityStatus
      Throws:
      EntityManagerException
    • getEntityMetadataOfBucket

      List<ContentMetaData> getEntityMetadataOfBucket(String sessionId, String entityModelIdentifier, String entityId, String parentBucketId, String resultEntityId, Context context, 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

      List<ContentMetaData> getEntityMetadataOfKeyValue(String sessionId, String entityModelIdentifier, String entityId, String parentKeyValueId, String resultEntityId, Context context, 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

      List<ContentMetaData> getEntityMetadataOfPlanning(String sessionId, String entityModelIdentifier, String entityId, String parentPlanningId, String resultEntityId, Context context, 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

      List<ContentMetaData> getEntityRootMetadataOfPlanning(String sessionId, String entityModelIdentifier, String entityId, String parentPlanningId, String resultEntityId, Context context, String searchStr) throws EntityManagerException
      Throws:
      EntityManagerException
    • getEntityMetadataOfTableData

      List<ContentMetaData> getEntityMetadataOfTableData(String sessionId, String entityModelIdentifier, String entityId, String parentTableDataId, String resultEntityId, Context context, 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

      List<ContentMetaData> getEntityMetadataOfMediaAsset(String sessionId, String entityModelIdentifier, String entityId, String parentMediaAssetId, String resultEntityId, Context context, 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

      List<ContentMetaData> getEntityMetadataOfCord(String sessionId, String entityModelIdentifier, String entityId, String parentCordId, String resultEntityId, Context context, 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

      List<ContentMetaData> getEntityMetadataOfText(String sessionId, String entityModelIdentifier, String entityId, String parentTextId, String resultEntityId, Context context, 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

      List<ContentMetaData> getEntityMetadataOfPrice(String sessionId, String entityModelIdentifier, String entityId, String parentPriceId, String resultEntityId, Context context, 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

      List<Bucket> getBuckets(String sessionId, String entityModelIdentifier, String entityIdentifier, 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(String sessionId, String entityModelIdentifier, 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(String oldModelId, String newModelId, Map<String,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(String id, String oldConnectorSpec, 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

      List<EntityItem> commitItems(String entityModelIdentifier, 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

      List<EntityItem> bulkInsert(String entityModelIdentifier, 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

      List<EntityItem> bulkUpsert(String entityModelIdentifier, 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(String entityModelIdentifier, 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

      List<Planning> getEntityPlanningsBySourcePlanningId(String sessionId, String entityModelIdentifier, String sourcePlanningId, String resultEntityId, Context context, String searchStr) throws EntityManagerException
      Parameters:
      sessionId -
      entityModelIdentifier -
      sourcePlanningId -
      resultEntityId -
      context -
      searchStr -
      Returns:
      Throws:
      EntityManagerException
    • getEntityPlanningsOfPageBySourcePlanningId

      List<Planning> getEntityPlanningsOfPageBySourcePlanningId(String sessionId, String entityModelIdentifier, String sourcePlanningId, String resultEntityId, int pageIndex, Context context, String searchStr) throws EntityManagerException
      Parameters:
      sessionId -
      entityModelIdentifier -
      sourcePlanningId -
      resultEntityId -
      pageIndex -
      context -
      searchStr -
      Returns:
      Throws:
      EntityManagerException
    • getEntityPlanningsBySnippetOrigin

      List<Planning> getEntityPlanningsBySnippetOrigin(String sessionId, String entityModelIdentifier, String snippetSourceId, String resultEntityId, Context context, String searchStr) throws EntityManagerException
      Parameters:
      sessionId -
      entityModelIdentifier -
      snippetSourceId -
      resultEntityId -
      context -
      searchStr -
      Returns:
      Throws:
      EntityManagerException
    • getEntityPlanningsOfPageBySnippetOrigin

      List<Planning> getEntityPlanningsOfPageBySnippetOrigin(String sessionId, String entityModelIdentifier, String snippetSourceId, String resultEntityId, int pageIndex, Context context, String searchStr) throws EntityManagerException
      Parameters:
      sessionId -
      entityModelIdentifier -
      snippetSourceId -
      resultEntityId -
      pageIndex -
      context -
      searchStr -
      Returns:
      Throws:
      EntityManagerException
    • getCountOfMediaAssetRefsOfPlanning

      Long getCountOfMediaAssetRefsOfPlanning(String sessionId, String entityModelIdentifier, 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

      Long getCountOfTextRefsOfPlanning(String sessionId, String entityModelIdentifier, 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

      Long getCountOfKeyValueRefsOfPlanning(String sessionId, String entityModelIdentifier, 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

      Long getCountOfPriceRefsOfPlanning(String sessionId, String entityModelIdentifier, 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

      Long getCountOfCordRefsOfPlanning(String sessionId, String entityModelIdentifier, 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

      Long getCountOfSubBucketRefsOfPlanning(String sessionId, String entityModelIdentifier, 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(String sessionId, String entityModelIdentifier, 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
    • deletePlannings

      void deletePlannings(String sessionId, String entityModelIdentifier, List<Planning> planningList) throws EntityManagerException
      Throws:
      EntityManagerException
    • updatePlanning

      void updatePlanning(String sessionId, String entityModelIdentifier, List<Planning> planningList) throws EntityManagerException
      Throws:
      EntityManagerException
    • updateSequenceOfRootPlanning

      void updateSequenceOfRootPlanning(String sessionId, String entityModelIdentifier, 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