Interface EntityManagerRemote
- All Superinterfaces:
PluginControl
- All Known Subinterfaces:
EntityManagerLocal
- Since:
- 4.0.0
-
Method Summary
Modifier and TypeMethodDescriptionvoidaddRootPlannings(String sessionId, String entityModelIdentifier, List<Planning> planning) This method persists a List of Planning objectsbulkInsert(String entityModelIdentifier, List<EntityItem> items) Insert a list of entity items within an entity model.bulkUpsert(String entityModelIdentifier, List<EntityItem> items) Upsert a list of entity items within an entity model.booleancanDeleteContentMetaData(String entityModelIdentifier, String entityContentMetaDataId) This method returns true or false depending on the specified type of the ContentMetaData is allowed to deletevoidchangeParentRealGridElementForPlannedBuckets(String sessionId, String entityModelIdentifier, List<Planning> plannedBuckets, Planning realGridElement) This method move a the list of planned buckets to the new Real Grid ElementclonePlanning(String sessionId, String entityModelIdentifier, String searchStr, List<Planning> plannings, boolean asTemporary) This method clones Planning objects (with ContentMetaData) as new plannings with new identifiersvoidclonePlanningOfDocument(String sessionId, String entityModelIdentifier, String searchStr, String sourceDocID, String targetDocID) This method clones Planning objects (with ContentMetaData) to the new documentcommitItems(String entityModelIdentifier, List<EntityItem> items) Change (insert, update, or delete) a list of entity items within an entity model.voidcopyPlanningMetaData(String sessionId, String entityModelIdentifier, String searchStr, Planning source, List<Planning> destination, List<String> filter) This method copies ContentMetaData of planning to the other onesdeleteEntityBuckets(String sessionId, String entityModelIdentifier, List<Bucket> buckets) deleteEntityContentMetaData(String sessionId, String entityModelIdentifier, List<ContentMetaData> contentMetaDatalist) Delete aListofContentMetaData.deleteEntityCords(String sessionId, String entityModelIdentifier, List<Cord> cords) deleteEntityKeyValues(String sessionId, String entityModelIdentifier, List<KeyValue> keyValues) deleteEntityMediaAssets(String sessionId, String entityModelIdentifier, List<MediaAsset> mediaAssets) Deletes aListofMediaAsset.deleteEntityPrices(String sessionId, String entityModelIdentifier, List<Price> prices) deleteEntityTableDataCells(String sessionId, String entityModelIdentifier, List<TableDataCell> tableDataCells) Deletes aListofTableDataCell.deleteEntityTableDataRows(String sessionId, String entityModelIdentifier, List<TableDataRow> tableDataRows) Deletes aListofTableDataRow.deleteEntityTableDatas(String sessionId, String entityModelIdentifier, List<TableData> tableDatas) deleteEntityTexts(String sessionId, String entityModelIdentifier, List<Text> texts) voiddeletePlanning(String sessionId, String entityModelIdentifier, List<Planning> planning) voiddeletePlannings(String sessionId, String entityModelIdentifier, List<Planning> planningList) voidDuplicate an entity model.exportModelToXML(EntityModel entityModel) Exports an Entity Model with all its Entities and their dependencies to XML.getBuckets(String sessionId, String entityModelIdentifier, String entityIdentifier, String searchStr) Get a list of Entity Root BucketsgetCords(String sessionId, String entityModelIdentifier, String entityIdentifier, String searchString) Returns cordsgetCountOfCordRefsOfPlanning(String sessionId, String entityModelIdentifier, String parentPlanningId, Context context) This method returns a number of planned cords in given planninggetCountOfKeyValueRefsOfPlanning(String sessionId, String entityModelIdentifier, String parentPlanningId, Context context) This method returns a number of planned key values in given planninggetCountOfMediaAssetRefsOfPlanning(String sessionId, String entityModelIdentifier, String parentPlanningId, Context context) This method returns a number of planned media assets in given planninggetCountOfPriceRefsOfPlanning(String sessionId, String entityModelIdentifier, String parentPlanningId, Context context) This method returns a number of planned prices in given planninggetCountOfSubBucketRefsOfPlanning(String sessionId, String entityModelIdentifier, String parentPlanningId, Context context) This method returns a number of planned sub-buckets in given planninggetCountOfTextRefsOfPlanning(String sessionId, String entityModelIdentifier, String parentPlanningId, Context context) This method returns a number of planned texts in given planning<T extends Entity>
TgetEntity(EntityModel entityModel, String entityId, Class<T> clazz) Gets an entity by its name from an entity modelgetEntityBucketsByIdentifier(String sessionId, String entityModelIdentifier, String bucketId, String entityId, Context context, String searchStr) Get a List of Buckets by identifiergetEntityBucketsByIdentifier(String sessionId, String entityModelIdentifier, String bucketId, String entityId, Context context, String searchStr, long ttl, TimeUnit ttlTimeUnit) Get a List of Buckets by identifiergetEntityBucketsOfPlanning(String sessionId, String entityModelIdentifier, String entityId, String parentPlanningId, String resultEntityId, Context context, String searchStr) Get a bucket assigned to the specified planning record<T extends Entity>
TgetEntityByConnectorEntity(String entityModelIdentifier, String connectorEntity, Class<T> entityClass) Gets an entity from an entity model by a connector entity.getEntityChildBuckets(String sessionId, String entityModelIdentifier, String entityId, String parentBucketId, String resultEntityId, Context context, String searchStr) Get a list of child buckets of a parent bucket.getEntityChildBuckets(String sessionId, String entityModelIdentifier, String entityId, String parentBucketId, String resultEntityId, Context context, String searchStr, long ttl, TimeUnit ttlTimeUnit) Get a list of child buckets of a parent bucket.getEntityChildBucketsOfPlanning(String sessionId, String entityModelIdentifier, String entityId, String parentPlanningId, String resultEntityId, Context context, String records, String searchStr) Returns the list of buckets linked to subplannings of this planning.getEntityContentMetaDataByIdentifier(String sessionId, String entityModelIdentifier, String contentMetaDataId, String entityId, Context context, String searchStr) Get a list of ContentMetaData with the same identifiergetEntityCordedBuckets(String sessionId, String entityModelIdentifier, String entityId, String parentBucketId, String cordEntityId, Context context, String searchStr) Get a list of Buckets related via cord to a source bucket.getEntityCordedBuckets(String sessionId, String entityModelIdentifier, String entityId, String parentBucketId, String cordEntityId, Context context, String searchStr, long ttl, TimeUnit ttlTimeUnit) Get a list of Buckets related via cord to a source bucket.getEntityCordedBucketsOfPlanning(String sessionId, String entityModelIdentifier, String entityId, String parentPlanningId, String resultEntityId, Context context, String records, String searchStr) Returns the list of target buckets of planned cords of this planning.getEntityCordsByIdentifier(String sessionId, String entityModelIdentifier, String cordId, String entityId, Context context, String searchStr) Get a list of Cords with the same identifiergetEntityCordsByIdentifier(String sessionId, String entityModelIdentifier, String cordId, String entityId, Context context, String searchStr, long ttl, TimeUnit ttlTimeUnit) Get a list of Cords with the same identifiergetEntityCordsOfBuckets(String sessionId, String entityModelIdentifier, String entityId, String parentBucketId, String resultEntityId, Context context, String searchStr) Get a list of Cords for a source bucketgetEntityCordsOfBuckets(String sessionId, String entityModelIdentifier, String entityId, String parentBucketId, String resultEntityId, Context context, String searchStr, long ttl, TimeUnit ttlTimeUnit) Get a list of Cords for a source bucketgetEntityCordsOfPlannedBucket(String sessionId, String entityModelIdentifier, String identifier, String entityIdentifier, Context context, String searchStr) Returns the list of Cords of the bucket linked to this planning, not the planned content of this planning record.getEntityKeyValuesByIdentifier(String sessionId, String entityModelIdentifier, String keyValueId, String entityId, Context context, String searchStr) Get a list of KeyValues with the same identifiergetEntityKeyValuesByIdentifier(String sessionId, String entityModelIdentifier, String keyValueId, String entityId, Context context, String searchStr, long ttl, TimeUnit ttlTimeUnit) Get a list of KeyValues with the same identifiergetEntityKeyValuesOfBucket(String sessionId, String entityModelIdentifier, String entityId, String parentBucketId, String resultEntityId, Context context, String searchStr) Get a List of KeyValues of a BucketgetEntityKeyValuesOfBucket(String sessionId, String entityModelIdentifier, String entityId, String parentBucketId, String resultEntityId, Context context, String searchStr, long ttl, TimeUnit ttlTimeUnit) Get a List of KeyValues of a BucketgetEntityKeyValuesOfPlannedBucket(String sessionId, String entityModelIdentifier, String identifier, String entityIdentifier, Context context, String searchStr) Returns the list of Key Values of the bucket linked to this planning, not the planned content of this planning record.getEntityKeyValuesOfPlanning(String sessionId, String entityModelIdentifier, String entityId, String parentPlanningId, String resultEntityId, Context context, String records, String searchStr) Returns the list of planned KeyValues of the bucket linked to this planning.getEntityMediaAssetsByIdentifier(String sessionId, String entityModelIdentifier, String mediaAssetId, String entityId, Context context, String searchStr) Get a list of MediaAssets with the same identifiergetEntityMediaAssetsByIdentifier(String sessionId, String entityModelIdentifier, String mediaAssetId, String entityId, Context context, String searchStr, long ttl, TimeUnit ttlTimeUnit) Get a list of MediaAssets with the same identifiergetEntityMediaAssetsOfBucket(String sessionId, String entityModelIdentifier, String entityId, String parentBucketId, String resultEntityId, Context context, String searchStr) Get a list of media assets for a parent bucket.getEntityMediaAssetsOfBucket(String sessionId, String entityModelIdentifier, String entityId, String parentBucketId, String resultEntityId, Context context, String searchStr, long ttl, TimeUnit ttlTimeUnit) Get a list of media assets for a parent bucket.getEntityMediaAssetsOfPlannedBucket(String sessionId, String entityModelIdentifier, String identifier, String entityIdentifier, Context context, String searchStr) Returns the list of Media Assets of the bucket linked to this planning, not the planned content of this planning record.getEntityMediaAssetsOfPlanning(String sessionId, String entityModelIdentifier, String entityId, String parentPlanningId, String resultEntityId, Context context, String records, String searchStr) Returns the list of planned MediaAssets of the bucket linked to this planning.getEntityMetadataOfBucket(String sessionId, String entityModelIdentifier, String entityId, String parentBucketId, String resultEntityId, Context context, String searchStr) Get a List of ContentMetaData of a BucketgetEntityMetadataOfCord(String sessionId, String entityModelIdentifier, String entityId, String parentCordId, String resultEntityId, Context context, String searchStr) Get a List of ContentMetaData of a CordgetEntityMetadataOfKeyValue(String sessionId, String entityModelIdentifier, String entityId, String parentKeyValueId, String resultEntityId, Context context, String searchStr) Get a List of ContentMetaData of a KeyValuegetEntityMetadataOfMediaAsset(String sessionId, String entityModelIdentifier, String entityId, String parentMediaAssetId, String resultEntityId, Context context, String searchStr) Get a List of ContentMetaData of a MediaAssetgetEntityMetadataOfPlanning(String sessionId, String entityModelIdentifier, String entityId, String parentPlanningId, String resultEntityId, Context context, String searchStr) Get a List of ContentMetaData of a PlanninggetEntityMetadataOfPrice(String sessionId, String entityModelIdentifier, String entityId, String parentPriceId, String resultEntityId, Context context, String searchStr) Get a List of ContentMetaData of a PricegetEntityMetadataOfTableData(String sessionId, String entityModelIdentifier, String entityId, String parentTableDataId, String resultEntityId, Context context, String searchStr) Get a List of ContentMetaData of a TableDatagetEntityMetadataOfText(String sessionId, String entityModelIdentifier, String entityId, String parentTextId, String resultEntityId, Context context, String searchStr) Get a List of ContentMetaData of a TextgetEntityModel(String entityModelIdentifier) Gets an entity model by identifier.Gets the identifiers of all entity models currently known to the manager.getEntityPlanningsByIdentifier(String sessionId, String entityModelIdentifier, String identifier, String entityId, Context context, String searchStr) Returns the planning record with the Id provided as parameter.getEntityPlanningsBySnippetId(String sessionId, String entityModelIdentifier, String identifier, String resultEntityId, Context context, String searchStr) Returns plannings with assigned snippet by snipppet idgetEntityPlanningsBySnippetOrigin(String sessionId, String entityModelIdentifier, String snippetSourceId, String resultEntityId, Context context, String searchStr) getEntityPlanningsBySourcePlanningId(String sessionId, String entityModelIdentifier, String sourcePlanningId, String resultEntityId, Context context, String searchStr) getEntityPlanningsOfDocument(String sessionId, String entityModelIdentifier, String entityId, String resultEntityId, Context context, String searchStr) Returns the plannings of a particular document.getEntityPlanningsOfDocumentAndPage(String sessionId, String entityModelIdentifier, String entityId, String resultEntityId, String documentId, int pageIndex, Context context, String searchStr) Returns the plannings of a page.getEntityPlanningsOfPage(String sessionId, String entityModelIdentifier, String entityId, String resultEntityId, int pageIndex, Context context, String searchStr) Returns the plannings of a page.getEntityPlanningsOfPageBySnippetOrigin(String sessionId, String entityModelIdentifier, String snippetSourceId, String resultEntityId, int pageIndex, Context context, String searchStr) getEntityPlanningsOfPageBySourcePlanningId(String sessionId, String entityModelIdentifier, String sourcePlanningId, String resultEntityId, int pageIndex, Context context, String searchStr) getEntityPricesByIdentifier(String sessionId, String entityModelIdentifier, String priceId, String entityId, Context context, String searchStr) Get a list of prices with the same identifiergetEntityPricesByIdentifier(String sessionId, String entityModelIdentifier, String priceId, String entityId, Context context, String searchStr, long ttl, TimeUnit ttlTimeUnit) Get a list of prices with the same identifiergetEntityPricesOfBucket(String sessionId, String entityModelIdentifier, String entityId, String parentBucketId, String resultEntityId, Context context, String searchStr) Get a list of prices for a parent bucket.getEntityPricesOfBucket(String sessionId, String entityModelIdentifier, String entityId, String parentBucketId, String resultEntityId, Context context, String searchStr, long ttl, TimeUnit ttlTimeUnit) Get a list of prices for a parent bucket.getEntityPricesOfPlannedBucket(String sessionId, String entityModelIdentifier, String identifier, String entityIdentifier, Context context, String searchStr) Returns the list of Prices of the bucket linked to this planning, not the planned content of this planning record.getEntityPricesOfPlanning(String sessionId, String entityModelIdentifier, String entityId, String parentPlanningId, String resultEntityId, Context context, String records, String searchStr) Returns the list of planned Prices of the bucket linked to this planning.getEntityRootBuckets(String sessionId, String entityModelIdentifier, String resultEntityId, Context context, String searchStr) Get a list of Entity Root BucketsgetEntityRootBuckets(String sessionId, String entityModelIdentifier, String resultEntityId, Context context, String searchStr, long ttl, TimeUnit ttlTimeUnit) Get a list of Entity Root BucketsgetEntityRootMetadataOfPlanning(String sessionId, String entityModelIdentifier, String entityId, String parentPlanningId, String resultEntityId, Context context, String searchStr) getEntitySubPlanningsOfPlanning(String sessionId, String entityModelIdentifier, String entityId, String parentPlanningId, String resultEntityId, Context context, String records, String searchStr) Returns the list of subplannings of this planning.getEntityTableDataByIdentifier(String sessionId, String entityModelIdentifier, String identifier, String entityIdentifier, Context context, String searchStr) Get a list of TableData with the same identifiergetEntityTableDataOfBucket(String sessionId, String entityModelIdentifier, String entityId, String parentBucketId, String resultEntityId, Context context, String searchStr) Get a list of TableData for a parent bucket.getEntityTableDataOfPlannedBucket(String sessionId, String entityModelIdentifier, String identifier, String entityIdentifier, Context context, String searchStr) Returns the list of Table Data of the bucket linked to this planning, not the planned content of this planning record.getEntityTableDataOfPlanning(String sessionId, String entityModelIdentifier, Context context, String identifier, String entityId, String resultEntityId, String records, String searchString) Returns list of planned TableDatagetEntityTableDataOfPlanning(String sessionId, String entityModelIdentifier, String entityId, String parentPlanningId, String resultEntityId, Context context, String records, String searchStr) Returns the list of planned TableData of the bucket linked to this planning.getEntityTextsByIdentifier(String sessionId, String entityModelIdentifier, String textId, String entityId, Context context, String searchStr) Get a list of Texts with the same identifiergetEntityTextsByIdentifier(String sessionId, String entityModelIdentifier, String textId, String entityId, Context context, String searchStr, long ttl, TimeUnit ttlTimeUnit) Get a list of Texts with the same identifiergetEntityTextsOfBucket(String sessionId, String entityModelIdentifier, String entityId, String parentBucketId, String resultEntityId, Context context, String searchStr) Get a list of texts for a parent bucket.getEntityTextsOfBucket(String sessionId, String entityModelIdentifier, String entityId, String parentBucketId, String resultEntityId, Context context, String searchStr, long ttl, TimeUnit ttlTimeUnit) Get a list of texts for a parent bucket.getEntityTextsOfPlannedBucket(String sessionId, String entityModelIdentifier, String identifier, String entityIdentifier, Context context, String searchStr) Returns the list of Texts of the bucket linked to this planning, not the planned content of this planning record.getEntityTextsOfPlanning(String sessionId, String entityModelIdentifier, String entityId, String parentPlanningId, String resultEntityId, Context context, String records, String searchStr) Returns the list of planned Texts of the bucket linked to this planning.getKeyValues(String sessionId, String entityModelIdentifier, String entityIdentifier, String searchString) Returns key valuesgetMediaAssets(String sessionId, String entityModelIdentifier, String entityIdentifier, String searchString) Returns media assetsgetPlanningByIdentifier(String sessionId, String identifier, String searchStr) For internal use onlygetPrices(String sessionId, String entityModelIdentifier, String entityIdentifier, String searchString) Returns pricesgetTexts(String sessionId, String entityModelIdentifier, String entityIdentifier, String searchText) Returns textsimportModelfromXML(String xml) Imports an Entity Model with all its Entities and their dependencies from XML.voidmergePlanningMetaData(String sessionId, String entityModelIdentifier, String searchStr, Planning source, List<Planning> destination, List<String> filter) This method merges ContentMetaData of planning to the other ones (copy or replace if exist)voidreplaceConnector(String id, String oldConnectorSpec, String newConnectorSpec) Replacing a connectorSpec in all entities of entity model through a new value.setEntityBuckets(String sessionId, String entityModelIdentifier, String searchStr, List<Bucket> buckets) Persist a List of BucketssetEntityContentMetaData(String sessionId, String entityModelIdentifier, String searchStr, List<ContentMetaData> contentMetaDataList) Persist a List of ContentMetaDataPersist a List of CordssetEntityKeyValues(String sessionId, String entityModelIdentifier, String searchStr, List<KeyValue> keyValues) Persist a List of KeyValuessetEntityMediaAssets(String sessionId, String entityModelIdentifier, String searchStr, List<MediaAsset> mediaAssets) Persist a List of MediaAssetssetEntityPrices(String sessionId, String entityModelIdentifier, String searchStr, List<Price> prices) Persist a List of PricessetEntityTableDataCells(String sessionId, String entityModelIdentifier, String searchStr, List<TableDataCell> tableDataCells) Persist a List of TableDataCellssetEntityTableDataRows(String sessionId, String entityModelIdentifier, String searchStr, List<TableDataRow> tableDataRows) Persist a List of TableDataRowssetEntityTableDatas(String sessionId, String entityModelIdentifier, String searchStr, List<TableData> tableDatas) Persist a List of TableDatasPersist a List of TextsvoidsetPlanning(String sessionId, String entityModelIdentifier, String searchStr, List<Planning> planning) This method persists a Planning objectvoidsetPlanningTableCmdChanged(String sessionId, String entityModelIdentifier, String searchStr, Planning source, List<Planning> destination) This method sets tableCmdChanged property to plannings depending on source planningvoidupdatePlanning(String sessionId, String entityModelIdentifier, List<Planning> planningList) voidupdateSequenceOfRootPlanning(String sessionId, String entityModelIdentifier, List<Planning> planningList) This method sort a List of Planning objects on root levelMethods inherited from interface com.priint.pubserver.plugin.interfaces.PluginControl
afterCreateConfigurations, afterDeleteConfigurations, afterUpdateConfigurations, createConfiguration, deleteConfigurations, initInstance, loadServerConfig, ping, updateConfigurations, validateConfigurations
-
Method Details
-
getEntity
Gets an entity by its name from an entity model- Parameters:
entityModel- Entity ModelentityId- Identifier of the Entity within the modelclazz- Class of the Entity (e.g.EntityBucket)- Returns:
- Entity or
nullif 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 modelconnectorEntity- ConnectorEntity StringentityClass- Class of Entity Object (likeEntityBucket)- Returns:
- Entity or
nullif no object with the connector string and entity type found in the model - See Also:
-
importModelfromXML
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
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
Gets an entity model by identifier.- Parameters:
entityModelIdentifier- model identifier- Returns:
- Entity Model or
nullif 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 sessionentityModelIdentifier- Identifier of the entity modelresultEntityId- filter the result list by entities with this identifiercontext- Context as search filter (e.g country and language). Depending on theContextDefinitionin theEntitysome 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 sessionentityModelIdentifier- Identifier of the entity modelresultEntityId- filter the result list by entities with this identifiercontext- Context as search filter (e.g country and language). Depending on theContextDefinitionin theEntitysome or all fields of this context will be handed over to appropriate connector method.searchStr- Search stringttl- 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 sessionentityModelIdentifier- Identifier of the entity modelentityId- Identifier of the entity within the entity modelparentPlanningId- Identifier of the planningresultEntityId- filter the result list by entities with this identifiercontext- Context as search filter (e.g country and language). Depending on theContextDefinitionin theEntitysome 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 sessionentityModelIdentifier- Identifier of the entity modelentityId- Identifier of the entity within the entity modelparentBucketId- Identifier of the parent bucketresultEntityId- filter the result list by entities with this identifiercontext- Context as search filter (e.g country and language). Depending on theContextDefinitionin theEntitysome 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 sessionentityModelIdentifier- Identifier of the entity modelentityId- Identifier of the entity within the entity modelparentBucketId- Identifier of the parent bucketresultEntityId- filter the result list by entities with this identifiercontext- Context as search filter (e.g country and language). Depending on theContextDefinitionin theEntitysome or all fields of this context will be handed over to appropriate connector method.searchStr- Search stringttl- 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 sessionentityModelIdentifier- Identifier of the entity modelbucketId- Identifier for the bucketentityId- Identifier of the entity within the entity modelcontext- Context as search filter (e.g country and language). Depending on theContextDefinitionin theEntitysome 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 sessionentityModelIdentifier- Identifier of the entity modelbucketId- Identifier for the bucketentityId- Identifier of the entity within the entity modelcontext- Context as search filter (e.g country and language). Depending on theContextDefinitionin theEntitysome or all fields of this context will be handed over to appropriate connector method.searchStr- Search stringttl- 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 sessionentityModelIdentifier- Identifier of the entity modelentityId- Identifier of the entity within the entity modelparentBucketId- Identifier of the parent bucketresultEntityId- filter the result list by entities with this identifiercontext- Context as search filter (e.g country and language). Depending on theContextDefinitionin theEntitysome 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 sessionentityModelIdentifier- Identifier of the entity modelentityId- Identifier of the entity within the entity modelparentBucketId- Identifier of the parent bucketresultEntityId- filter the result list by entities with this identifiercontext- Context as search filter (e.g country and language). Depending on theContextDefinitionin theEntitysome or all fields of this context will be handed over to appropriate connector method.searchStr- Search stringttl- 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 sessionentityModelIdentifier- Identifier of the entity modelkeyValueId- Identifier of the KeyValueentityId- Identifier of the entity within the entity modelcontext- Context as search filter (e.g country and language). Depending on theContextDefinitionin theEntitysome 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 sessionentityModelIdentifier- Identifier of the entity modelkeyValueId- Identifier of the KeyValueentityId- Identifier of the entity within the entity modelcontext- Context as search filter (e.g country and language). Depending on theContextDefinitionin theEntitysome or all fields of this context will be handed over to appropriate connector method.searchStr- Search stringttl- 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 sessionentityModelIdentifier- Identifier of the entity modelentityId- Identifier of the entity within the entity modelparentBucketId- Identifier of the parent bucketresultEntityId- filter the result list by entities with this identifiercontext- Context as search filter (e.g country and language). Depending on theContextDefinitionin theEntitysome 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 sessionentityModelIdentifier- Identifier of the entity modelentityId- Identifier of the entity within the entity modelparentBucketId- Identifier of the parent bucketresultEntityId- filter the result list by entities with this identifiercontext- Context as search filter (e.g country and language). Depending on theContextDefinitionin theEntitysome or all fields of this context will be handed over to appropriate connector method.searchStr- Search stringttl- 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 sessionentityModelIdentifier- Identifier of the entity modelpriceId- Identifier of the priceentityId- Identifier of the entity within the entity modelcontext- Context as search filter (e.g country and language). Depending on theContextDefinitionin theEntitysome 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 sessionentityModelIdentifier- Identifier of the entity modelpriceId- Identifier of the priceentityId- Identifier of the entity within the entity modelcontext- Context as search filter (e.g country and language). Depending on theContextDefinitionin theEntitysome or all fields of this context will be handed over to appropriate connector method.searchStr- Search stringttl- 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 sessionentityModelIdentifier- Identifier of the entity modelentityId- Identifier of the entity within the entity modelparentBucketId- Identifier of the parent bucketresultEntityId- filter the result list by entities with this identifiercontext- Context as search filter (e.g country and language). Depending on theContextDefinitionin theEntitysome 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 sessionentityModelIdentifier- Identifier of the entity modelentityId- Identifier of the entity within the entity modelparentBucketId- Identifier of the parent bucketresultEntityId- filter the result list by entities with this identifiercontext- Context as search filter (e.g country and language). Depending on theContextDefinitionin theEntitysome or all fields of this context will be handed over to appropriate connector method.searchStr- Search stringttl- 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 sessionentityModelIdentifier- Identifier of the entity modeltextId- Identifier of the TextentityId- Identifier of the entity within the entity modelcontext- Context as search filter (e.g country and language). Depending on theContextDefinitionin theEntitysome 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 sessionentityModelIdentifier- Identifier of the entity modeltextId- Identifier of the TextentityId- Identifier of the entity within the entity modelcontext- Context as search filter (e.g country and language). Depending on theContextDefinitionin theEntitysome or all fields of this context will be handed over to appropriate connector method.searchStr- Search stringttl- 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 sessionentityModelIdentifier- Identifier of the entity modelentityId- Identifier of the entity within the entity modelparentBucketId- Identifier of the parent bucketresultEntityId- filter the result list by entities with this identifiercontext- Context as search filter (e.g country and language). Depending on theContextDefinitionin theEntitysome 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 sessionentityModelIdentifier- Identifier of the entity modelentityId- Identifier of the entity within the entity modelparentBucketId- Identifier of the parent bucketresultEntityId- filter the result list by entities with this identifiercontext- Context as search filter (e.g country and language). Depending on theContextDefinitionin theEntitysome or all fields of this context will be handed over to appropriate connector method.searchStr- Search stringttl- 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 sessionentityModelIdentifier- Identifier of the entity modelmediaAssetId- Identifier of the MediaAssetentityId- Identifier of the entity within the entity modelcontext- Context as search filter (e.g country and language). Depending on theContextDefinitionin theEntitysome 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 sessionentityModelIdentifier- Identifier of the entity modelmediaAssetId- Identifier of the MediaAssetentityId- Identifier of the entity within the entity modelcontext- Context as search filter (e.g country and language). Depending on theContextDefinitionin theEntitysome or all fields of this context will be handed over to appropriate connector method.searchStr- Search stringttl- 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 sessionentityModelIdentifier-entityId- Identifier of the entity within the entity modelparentBucketId- Identifier of the parent bucketcordEntityId- filter the result the list of cords by this entity identifiercontext- Context as search filter (e.g country and language). Depending on theContextDefinitionin theEntitysome 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 sessionentityModelIdentifier-entityId- Identifier of the entity within the entity modelparentBucketId- Identifier of the parent bucketcordEntityId- filter the result the list of cords by this entity identifiercontext- Context as search filter (e.g country and language). Depending on theContextDefinitionin theEntitysome or all fields of this context will be handed over to appropriate connector method.searchStr- Search stringttl- 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 sessionentityModelIdentifier-entityId- Identifier of the entity within the entity modelparentBucketId- Identifier of the parent bucketresultEntityId- filter the result list by entities with this identifiercontext- Context as search filter (e.g country and language). Depending on theContextDefinitionin theEntitysome 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 sessionentityModelIdentifier-entityId- Identifier of the entity within the entity modelparentBucketId- Identifier of the parent bucketresultEntityId- filter the result list by entities with this identifiercontext- Context as search filter (e.g country and language). Depending on theContextDefinitionin theEntitysome or all fields of this context will be handed over to appropriate connector method.searchStr- Search stringttl- 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 sessionentityModelIdentifier- Identifier of the entity modelcordId- Identifier of the CordentityId- Identifier of the entity within the entity modelcontext- Context as search filter (e.g country and language). Depending on theContextDefinitionin theEntitysome 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 sessionentityModelIdentifier- Identifier of the entity modelcordId- Identifier of the CordentityId- Identifier of the entity within the entity modelcontext- Context as search filter (e.g country and language). Depending on theContextDefinitionin theEntitysome or all fields of this context will be handed over to appropriate connector method.searchStr- Search stringttl- 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 sessionentityModelIdentifier- Identifier of the entity modelentityId- Identifier of the entity within the entity modelparentBucketId- Identifier of the parent bucketresultEntityId- filter the result list by entities with this identifiercontext- Context as search filter (e.g country and language). Depending on theContextDefinitionin theEntitysome 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 sessionentityModelIdentifier- identifier of the entity modelcontext- (Context) context criteria, including documentId. Overrides content of context with static values fromContextDefinitioninEntity.identifier- Identifier of the planning recordentityId- id of the entity within the entity modelresultEntityId- entity Id of the result recordsrecords- range of returned recordssearchString-- Returns:
ListofTableData- 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 sessionentityModelIdentifier- identifier of the entity modelentityId- Id of the planning entity, at the time this is always "planning"parentPlanningId- Id of the parent planning recordresultEntityId- Id of result entities, currently not evaluatedcontext- Context as search filter (e.g country and language). Depending on theContextDefinitionin theEntitysome 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
Listof plannedTableDataof the bucket linked to this planning; empty list, if noTableDataexist. - 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 sessionentityModelIdentifier- Identifier of the entity modelidentifier- Identifier of the TableDataentityIdentifier- Identifier of the entity within the entity modelcontext- Context as search filter (e.g country and language). Depending on theContextDefinitionin theEntitysome or all fields of this context will be handed over to appropriate connector method.searchStr- Search string- Returns:
ListofTableData. 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 sessionentityModelIdentifier- Identifier of the entity modelsearchStr- Search stringbuckets- 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 sessionentityModelIdentifier- Identifier of the entity modelsearchStr- Search stringkeyValues- List ofKeyValue- 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 sessionentityModelIdentifier- Identifier of the entity modelsearchStr- Search stringtexts- List ofText- 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 sessionentityModelIdentifier- Identifier of the entity modelsearchStr- Search stringmediaAssets- List ofMediaAsset- 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 sessionentityModelIdentifier- Identifier of the entity modelsearchStr- Search stringprices- List ofPrice- 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 sessionentityModelIdentifier- Identifier of the entity modelsearchStr- Search stringcords- 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 sessionentityModelIdentifier- Identifier of the entity modelsearchStr- Search stringtableDatas- List ofTableData- 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 sessionentityModelIdentifier- Identifier of the entity modelsearchStr- Search stringtableDataRows- List ofTableDataRow- 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 sessionentityModelIdentifier- Identifier of the entity modelsearchStr- Search stringtableDataCells- List ofTableDataCell- 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 sessionentityModelIdentifier- identifier of the entity modelidentifier- Id of the planning recordentityId- Id of the planning entity, at the time this is always "Planning"context- Context as search filter (e.g country and language). Depending on theContextDefinitionin theEntitysome or all fields of this context will be handed over to appropriate connector method.searchStr- additional search filter for result- Returns:
- list of
Planningwith the given identifier. The list contains one element, if this planning exists, zero otherwise. - Throws:
EntityManagerException
-
getPlanningByIdentifier
For internal use only
- Parameters:
sessionId- Id of the current sessionidentifier- Id of the planning recordsearchStr- 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 sessionentityModelIdentifier- identifier of the entity modelentityId- Id of the planning entity, at the time this is always "planning"resultEntityId- Id of result entities, currently not evaluatedpageIndex- zero based index of the pagecontext- Context as search filter (e.g country and language). Depending on theContextDefinitionin theEntitysome or all fields of this context will be handed over to appropriate connector method.searchStr- additional search filter for result- Returns:
- the list of
Planningof 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 sessionentityModelIdentifier- identifier of the entity modelentityId- Id of the planning entity, at the time this is always "planning"resultEntityId- Id of result entities, currently not evaluateddocumentId- document IdpageIndex- zero based index of the pagecontext- Context as search filter (e.g country and language). Depending on theContextDefinitionin theEntitysome or all fields of this context will be handed over to appropriate connector method.searchStr- additional search filter for result- Returns:
- the list of
Planningof 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 sessionentityModelIdentifier- identifier of the entity modelidentifier- Id of the snippetresultEntityId- Id of result entities, currently not evaluatedcontext- Context as search filter (e.g country and language). Depending on theContextDefinitionin theEntitysome or all fields of this context will be handed over to appropriate connector method.searchStr- additional search filter for result- Returns:
- the list of
Planningof 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 sessionentityModelIdentifier- Identifier of the entity modelsearchStr- Search stringplanning- 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 sessionentityModelIdentifier- Identifier of the entity modelsearchStr- Search stringplannings- List of Planning objects to cloneasTemporary- 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 sessionentityModelIdentifier- Identifier of the entity modelsearchStr- Search stringsourceDocID- source document idtargetDocID- 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 sessionentityModelIdentifier- Identifier of the entity modelsearchStr- Search stringsource- Planning the ContentMetaData of which should be copieddestination- List of plannings to copy content meta datafilter- 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 sessionentityModelIdentifier- Identifier of the entity modelsearchStr- Search stringsource- Planning the ContentMetaData of which should be mergeddestination- List of plannings to copy content meta datafilter- 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 sessionentityModelIdentifier- Identifier of the entity modelsearchStr- Search stringsource- Planning the tableCmdChanged property of which should be useddestination- 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:
ListofText- 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:
ListofMediaAsset- Throws:
EntityManagerException
-
getPrices
List<Price> getPrices(String sessionId, String entityModelIdentifier, String entityIdentifier, String searchString) throws EntityManagerException Returns prices- Parameters:
sessionId-entityModelIdentifier-entityIdentifier-searchString-- Returns:
ListofPrice- Throws:
EntityManagerException
-
getCords
List<Cord> getCords(String sessionId, String entityModelIdentifier, String entityIdentifier, String searchString) throws EntityManagerException Returns cords- Parameters:
sessionId-entityModelIdentifier-entityIdentifier-searchString-- Returns:
ListofCord- 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:
ListofCord- 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 sessionentityModelIdentifier- identifier of the entity modelentityId- Id of the planning entity, at the time this is always "planning"parentPlanningId- Id of the parent planning recordresultEntityId- Id of result entities, currently not evaluatedcontext- Context as search filter (e.g country and language). Depending on theContextDefinitionin theEntitysome 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
Bucketlinked 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 sessionentityModelIdentifier- identifier of the entity modelentityId- Id of the planning entity, at the time this is always "planning"parentPlanningId- Id of the parent planning recordresultEntityId- Id of result entities, currently not evaluatedcontext- Context as search filter (e.g country and language). Depending on theContextDefinitionin theEntitysome 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
Bucketof 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 sessionentityModelIdentifier- identifier of the entity modelentityId- Id of the planning entity, at the time this is always "planning"parentPlanningId- Id of the parent planning recordresultEntityId- Id of result entities, currently not evaluatedcontext- Context as search filter (e.g country and language). Depending on theContextDefinitionin theEntitysome 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
KeyValueof 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 sessionentityModelIdentifier- identifier of the entity modelentityId- Id of the planning entity, at the time this is always "planning"parentPlanningId- Id of the parent planning recordresultEntityId- Id of result entities, currently not evaluatedcontext- Context as search filter (e.g country and language). Depending on theContextDefinitionin theEntitysome 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
MediaAssetof 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 sessionentityModelIdentifier- identifier of the entity modelentityId- Id of the planning entity, at the time this is always "planning"parentPlanningId- Id of the parent planning recordresultEntityId- Id of result entities, currently not evaluatedcontext- Context as search filter (e.g country and language). Depending on theContextDefinitionin theEntitysome 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
Priceof 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 sessionentityModelIdentifier- identifier of the entity modelentityId- Id of the planning entity, at the time this is always "planning"parentPlanningId- Id of the parent planning recordresultEntityId- Id of result entities, currently not evaluatedcontext- Context as search filter (e.g country and language). Depending on theContextDefinitionin theEntitysome 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
Textof 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 sessionentityModelIdentifier- identifier of the entity modelidentifier- Id of the planning recordentityIdentifier- Id of the entitycontext- Context as search filter (e.g country and language). Depending on theContextDefinitionin theEntitysome or all fields of this context will be handed over to appropriate connector method.searchStr- additional search filter for result- Returns:
- the list of
Textof 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 sessionentityModelIdentifier- identifier of the entity modelidentifier- Id of the planning recordentityIdentifier- Id of the entitycontext- Context as search filter (e.g country and language). Depending on theContextDefinitionin theEntitysome or all fields of this context will be handed over to appropriate connector method.searchStr- additional search filter for result- Returns:
- the list of
Textof 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 sessionentityModelIdentifier- identifier of the entity modelidentifier- Id of the planning recordentityIdentifier- Id of the entitycontext- Context as search filter (e.g country and language). Depending on theContextDefinitionin theEntitysome or all fields of this context will be handed over to appropriate connector method.searchStr- additional search filter for result- Returns:
- the list of
KeyValueof 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 sessionentityModelIdentifier- identifier of the entity modelidentifier- Id of the planning recordentityIdentifier- Id of the entitycontext- Context as search filter (e.g country and language). Depending on theContextDefinitionin theEntitysome or all fields of this context will be handed over to appropriate connector method.searchStr- additional search filter for result- Returns:
- the list of
MediaAssetof 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 sessionentityModelIdentifier- identifier of the entity modelidentifier- Id of the planning recordentityIdentifier- Id of the entitycontext- Context as search filter (e.g country and language). Depending on theContextDefinitionin theEntitysome or all fields of this context will be handed over to appropriate connector method.searchStr- additional search filter for result- Returns:
- the list of
Priceof 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 sessionentityModelIdentifier- identifier of the entity modelidentifier- Id of the planning recordentityIdentifier- Id of the entitycontext- Context as search filter (e.g country and language). Depending on theContextDefinitionin theEntitysome or all fields of this context will be handed over to appropriate connector method.searchStr- additional search filter for result- Returns:
- the list of
TableDataof 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 - Parameters:
sessionId- Id of the current sessionentityModelIdentifier- Identifier of the entity modelplanning- Entities to be deleted- Throws:
EntityManagerException
-
deleteEntityBuckets
List<DeleteEntityStatus> deleteEntityBuckets(String sessionId, String entityModelIdentifier, List<Bucket> buckets) throws EntityManagerException - Parameters:
sessionId- Id of the current sessionentityModelIdentifier- Identifier of the entity modelbuckets- Entities to be deleted- Returns:
ListofDeleteEntityStatus- Throws:
EntityManagerException
-
deleteEntityKeyValues
List<DeleteEntityStatus> deleteEntityKeyValues(String sessionId, String entityModelIdentifier, List<KeyValue> keyValues) throws EntityManagerException - Parameters:
sessionId- Id of the current sessionentityModelIdentifier- Identifier of the entity modelkeyValues- Entities to be deleted- Returns:
ListofDeleteEntityStatus- Throws:
EntityManagerException
-
deleteEntityTexts
List<DeleteEntityStatus> deleteEntityTexts(String sessionId, String entityModelIdentifier, List<Text> texts) throws EntityManagerException - Parameters:
sessionId- Id of the current sessionentityModelIdentifier- Identifier of the entity modeltexts- Entities to be deleted- Returns:
ListofDeleteEntityStatus- Throws:
EntityManagerException
-
deleteEntityMediaAssets
List<DeleteEntityStatus> deleteEntityMediaAssets(String sessionId, String entityModelIdentifier, List<MediaAsset> mediaAssets) throws EntityManagerException Deletes aListofMediaAsset.- Parameters:
sessionId- Id of the current sessionentityModelIdentifier- Identifier of the entity modelmediaAssets- Entities to be deleted- Returns:
ListofDeleteEntityStatus- Throws:
EntityManagerException
-
deleteEntityPrices
List<DeleteEntityStatus> deleteEntityPrices(String sessionId, String entityModelIdentifier, List<Price> prices) throws EntityManagerException - Parameters:
sessionId- Id of the current sessionentityModelIdentifier- Identifier of the entity modelprices- Entities to be deleted- Returns:
ListofDeleteEntityStatus- Throws:
EntityManagerException
-
deleteEntityCords
List<DeleteEntityStatus> deleteEntityCords(String sessionId, String entityModelIdentifier, List<Cord> cords) throws EntityManagerException - Parameters:
sessionId- Id of the current sessionentityModelIdentifier- Identifier of the entity modelcords- Entities to be deleted- Returns:
ListofDeleteEntityStatus- Throws:
EntityManagerException
-
deleteEntityTableDatas
List<DeleteEntityStatus> deleteEntityTableDatas(String sessionId, String entityModelIdentifier, List<TableData> tableDatas) throws EntityManagerException - Parameters:
sessionId- Id of the current sessionentityModelIdentifier- Identifier of the entity modeltableDatas- Entities to be deleted- Returns:
ListofDeleteEntityStatus- Throws:
EntityManagerException
-
deleteEntityTableDataRows
List<DeleteEntityStatus> deleteEntityTableDataRows(String sessionId, String entityModelIdentifier, List<TableDataRow> tableDataRows) throws EntityManagerException Deletes aListofTableDataRow.- Parameters:
sessionId- Id of the current sessionentityModelIdentifier- Identifier of the entity modeltableDataRows- Entities to be deleted- Returns:
ListofDeleteEntityStatus- Throws:
EntityManagerException
-
deleteEntityTableDataCells
List<DeleteEntityStatus> deleteEntityTableDataCells(String sessionId, String entityModelIdentifier, List<TableDataCell> tableDataCells) throws EntityManagerException Deletes aListofTableDataCell.- Parameters:
sessionId- Id of the current sessionentityModelIdentifier- Identifier of the entity modeltableDataCells- Entities to be deleted- Returns:
ListofDeleteEntityStatus- 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 sessionentityModelIdentifier- identifier of the entity modelentityId- Id of the planning entity, at the time this is always "planning"resultEntityId- Id of result entities, currently not evaluatedcontext- Context as search filter (e.g country and language). Depending on theContextDefinitionin theEntitysome or all fields of this context will be handed over to appropriate connector method.searchStr- additional search filter for result- Returns:
- the list of
Planningof 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 sessionentityModelIdentifier- identifier of the entity modelentityId- Id of the planning entity, at the time this is always "planning"parentPlanningId- Id of the parent planning recordresultEntityId- Id of result entities, currently not evaluatedcontext- Context as search filter (e.g country and language). Depending on theContextDefinitionin theEntitysome 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 sessionentityModelIdentifier- Identifier of the entity modelcontentMetaDataId- Identifier of the ContentMetaDataentityId- Identifier of the entity within the entity modelcontext- Context as search filter (e.g country and language). Depending on theContextDefinitionin theEntitysome 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 sessionentityModelIdentifier- Identifier of the entity modelsearchStr- Search stringcontentMetaDataList- List of ContentMetaData- Returns:
- List of
ContentMetaData. - Throws:
EntityManagerException
-
deleteEntityContentMetaData
List<DeleteEntityStatus> deleteEntityContentMetaData(String sessionId, String entityModelIdentifier, List<ContentMetaData> contentMetaDatalist) throws EntityManagerException Delete aListofContentMetaData.- Parameters:
sessionId- id of the user sessionentityModelIdentifier- Identifier of the entity modelcontentMetaDatalist- List of ContentMetaData- Returns:
ListofDeleteEntityStatus- 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 sessionentityModelIdentifier- Identifier of the entity modelentityId- Identifier of the entity within the entity modelparentBucketId- Identifier of the parent bucketresultEntityId- filter the result list by entities with this identifiercontext- Context as search filter (e.g country and language). Depending on theContextDefinitionin theEntitysome 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 sessionentityModelIdentifier- Identifier of the entity modelentityId- Identifier of the entity within the entity modelparentKeyValueId- Identifier of the parent keyValueresultEntityId- filter the result list by entities with this identifiercontext- Context as search filter (e.g country and language). Depending on theContextDefinitionin theEntitysome 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 sessionentityModelIdentifier- Identifier of the entity modelentityId- Identifier of the entity within the entity modelparentPlanningId- Identifier of the parent PlanningresultEntityId- filter the result list by entities with this identifiercontext- Context as search filter (e.g country and language). Depending on theContextDefinitionin theEntitysome 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 sessionentityModelIdentifier- Identifier of the entity modelentityId- Identifier of the entity within the entity modelparentTableDataId- Identifier of the parent TableDataresultEntityId- filter the result list by entities with this identifiercontext- Context as search filter (e.g country and language). Depending on theContextDefinitionin theEntitysome 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 sessionentityModelIdentifier- Identifier of the entity modelentityId- Identifier of the entity within the entity modelparentMediaAssetId- Identifier of the parent MediaAssetresultEntityId- filter the result list by entities with this identifiercontext- Context as search filter (e.g country and language). Overrides content of context with static values fromContextDefinitioninEntity.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 sessionentityModelIdentifier- Identifier of the entity modelentityId- Identifier of the entity within the entity modelparentCordId- Identifier of the parent CordresultEntityId- filter the result list by entities with this identifiercontext- Context as search filter (e.g country and language). Overrides content of context with static values fromContextDefinitioninEntity.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 sessionentityModelIdentifier- Identifier of the entity modelentityId- Identifier of the entity within the entity modelparentTextId- Identifier of the parent TextresultEntityId- filter the result list by entities with this identifiercontext- Context as search filter (e.g country and language). Overrides content of context with static values fromContextDefinitioninEntity.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 sessionentityModelIdentifier- Identifier of the entity modelentityId- Identifier of the entity within the entity modelparentPriceId- Identifier of the parent PriceresultEntityId- filter the result list by entities with this identifiercontext- Context as search filter (e.g country and language). Overrides content of context with static values fromContextDefinitioninEntity.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 sessionentityModelIdentifier- Identifier of the entity modelentityIdentifier- Identifier of the entity within the entity modelsearchStr- 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 sessionentityModelIdentifier- Identifier of the entity modelplannedBuckets- List of Planning objects to move to the new Real Grid ElementrealGridElement- new Real Grid Element- Throws:
EntityManagerException
-
duplicateModel
void duplicateModel(String oldModelId, String newModelId, Map<String, Object> additionalValues) throws EntityManagerExceptionDuplicate 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 identifiernewModelId- new model identifieradditionalValues- 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 identifieroldConnectorSpec- 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.FAILEDorEntityItem.Status.EXCEPTION.- Parameters:
entityModelIdentifier-items-- Returns:
- a list of
EntityItemafter 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.FAILEDorEntityItem.Status.EXCEPTION.- Parameters:
entityModelIdentifier-items-- Returns:
- a list of
EntityItemafter 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.FAILEDorEntityItem.Status.EXCEPTION.- Parameters:
entityModelIdentifier-items-- Returns:
- a list of
EntityItemafter 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
This method returns true or false depending on the specified type of the ContentMetaData is allowed to delete- Parameters:
entityModelIdentifier- Identifier of the entity modelentityContentMetaDataId- 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 sessionentityModelIdentifier- Identifier of the entity modelplanning- 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 sessionentityModelIdentifier- Identifier of the entity modelplanningList- List of Planning objects to persist- Throws:
EntityManagerException
-