|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
@StableMinor(version="4.1", sinceVersion="4.0") public interface IMetaDataManager
Manager interface for meta data related operations
Method Summary | |
---|---|
String |
add(SessionConfig sessionConfig,
MetaDataConfig metaDataConfig,
ITransaction transaction)
Adds the meta data config. |
String |
addComment(SessionConfig sessionConfig,
CommentConfig commentConfig,
ITransaction transaction)
Add the comment. |
String |
addPublishedToPrincipal(SessionConfig sessionConfig,
PublishToPrincipalConfig publishToPrincipalConfig,
ITransaction transaction)
Adds the publish to principal config. |
String |
addVersion(SessionConfig sessionConfig,
VersionConfig versionConfig,
ITransaction transaction)
Adds the version information. |
void |
delete(SessionConfig sessionConfig,
Collection<String> metaDataIds,
ITransaction transaction)
Deletes the meta data configs for the given collection of meta data ids. |
void |
delete(SessionConfig sessionConfig,
String metaDataId,
ITransaction transaction)
Deletes the meta data config for the given meta data id. |
void |
deleteByItemIds(SessionConfig sessionConfig,
Collection<String> itemIds,
String serviceId,
ITransaction transaction)
Deletes the meta data configs for the given collection of itemIds associated to the given serviceId. |
void |
deletePublishedToPrincipal(SessionConfig sessionConfig,
String metaDataId,
ITransaction transaction)
Deletes all publish to principal config for the given meta data. |
void |
deletePublishedToPrincipalByPrincipalId(SessionConfig sessionConfig,
String principalId,
ITransaction transaction)
Delete the published to principal informations for all meta data published to the specified principal. |
void |
deleteVersion(SessionConfig sessionConfig,
String versionId,
ITransaction transaction)
Deletes version information. |
MetaDataConfig |
get(SessionConfig sessionConfig,
String metaDataId,
ITransaction transaction)
Gets the meta data config. |
Collection<LanguageConfig> |
getAssociatedContents(SessionConfig sessionConfig,
String tableName,
String primaryKeyFieldId,
String primaryNameFieldId,
String languageContentId,
ITransaction transaction)
Gets all language associated contents with the given content. |
Collection<MetaDataConfig> |
getByItemId(SessionConfig sessionConfig,
String itemId,
boolean considerInactiveVersion,
ITransaction transaction)
Gets a Collection of meta data configs associated to the same content (identified by the itemId). |
Collection<MetaDataConfig> |
getByItemId(SessionConfig sessionConfig,
String itemId,
ITransaction transaction)
Gets a Collection of meta data configs associated to the same content (identified by the itemId). |
Collection<MetaDataConfig> |
getByItemIdAndServiceId(SessionConfig sessionConfig,
String itemId,
String serviceId,
String sourceId,
boolean considerInactiveVersion,
ITransaction transaction)
Gets a Collection of meta data configs associated to the same content (identified by the itemId, serviceId and sourceId). |
Collection<MetaDataConfig> |
getByItemIdAndServiceId(SessionConfig sessionConfig,
String itemId,
String serviceId,
String sourceId,
ITransaction transaction)
Gets a Collection of meta data configs associated to the same content (identified by the itemId, serviceId and sourceId). |
MetaDataConfig |
getByItemIdAndServiceInstanceId(SessionConfig sessionConfig,
String itemId,
String serviceInstanceId,
String sourceId,
boolean considerInactiveVersion,
ITransaction transaction)
Gets the meta data config associated to the content (identified by the itemId, serviceInstanceId and sourceId). |
MetaDataConfig |
getByItemIdAndServiceInstanceId(SessionConfig sessionConfig,
String itemId,
String serviceInstanceId,
String sourceId,
ITransaction transaction)
Gets the meta data config associated to the content (identified by the itemId, serviceInstanceId and sourceId). |
List<MetaDataConfig> |
getByParentServiceInstanceId(SessionConfig sessionConfig,
String parentServiceInstanceId,
ITransaction transaction)
Gets all meta data configs associated to a content that was created by the given service instance, wheter the meta data are directly associated with the service instance or not. |
List<CommentConfig> |
getComments(SessionConfig sessionConfig,
String metaDataId,
ITransaction transaction)
Gets the comments associated with the given meta data. |
Collection<LanguageConfig> |
getContentsByLanguageAssociation(SessionConfig sessionConfig,
String tableName,
String primaryKeyFieldId,
String primaryKeyValue,
String primaryNameFieldId,
String serviceInstanceId,
String nameFilterValue,
String selectedLanguageId,
String languageContentId,
ITransaction transaction)
Gets all contents that might be associated by language with the given content. |
String |
getIdByVersionContentIdAndServiceInstanceId(SessionConfig sessionConfig,
String versionContentId,
String serviceInstanceId,
ITransaction transaction)
Gets meta data id for the given content (identified by versionContentId and serviceInstanceId). |
Collection<String> |
getIdsByServiceInstanceId(SessionConfig sessionConfig,
String serviceInstanceId,
ITransaction transaction)
Gets all meta data ids associated with the given service instance. |
Collection<String> |
getIdsByVersionContentIdAndServiceId(SessionConfig sessionConfig,
String versionContentId,
String serviceId,
ITransaction transaction)
Gets meta data id for the given content (identified by versionContentId and serviceId). |
Collection<MetaDataConfig> |
getMetaDataToExpireByServiceId(SessionConfig sessionConfig,
String serviceId,
ITransaction transaction)
Gets all published meta data configs of the given serviceId that are outside the publishing period according to publishing dates. |
Collection<MetaDataConfig> |
getMetaDataToExpireHighlightByServiceId(SessionConfig sessionConfig,
String serviceId,
ITransaction transaction)
Gets all currently set as highlight meta data configs of the given serviceId that are outside the highlight period according to highlight publishing date. |
Collection<MetaDataConfig> |
getMetaDataToPublishByServiceId(SessionConfig sessionConfig,
String serviceId,
ITransaction transaction)
Gets all unpublished meta data configs of the given serviceId that are inside the publishing period according to publishing dates. |
int |
getNumComments(SessionConfig sessionConfig,
String metaDataId,
ITransaction transaction)
Gets the number of comments associated with given meta data. |
int |
getNumVersions(SessionConfig sessionConfig,
String itemId,
String serviceInstanceId,
String sourceId,
ITransaction transaction)
Gets the number of versions (ignoring meta data plurality) existent for a given content. |
String |
getParentServiceInstanceId(SessionConfig sessionConfig,
String itemId,
String serviceId,
ITransaction transaction)
Gets the service instance where the given content (identified by itemId and serviceId) was created. |
Collection<PublishToPrincipalConfig> |
getPublishedToPrincipalsByMetaDataId(SessionConfig sessionConfig,
String metaDataId,
ITransaction transaction)
Gets a collection of publish to principals config for the given meta data. |
Collection<String> |
getSourceIdsByServiceId(String serviceId,
ITransaction transaction)
Returns a list of sources of a given service that are being referenced by existing metadata. |
VersionConfig |
getVersion(SessionConfig sessionConfig,
String versionId,
ITransaction transaction)
Gets the version information. |
String |
getVersionContentIdByItemIdAndServiceId(SessionConfig sessionConfig,
String itemId,
String serviceId,
String sourceId,
ITransaction transaction)
Gets the version content id of the content (identified by itemId, service id and source id). |
String |
getVersionContentIdByItemIdAndServiceInstanceId(SessionConfig sessionConfig,
String itemId,
String serviceInstanceId,
String sourceId,
ITransaction transaction)
Gets the version content id of the content (identified by itemId, service instance id and source id). |
Collection<VersionConfig> |
getVersionsByVersionContentId(SessionConfig sessionConfig,
String versionContentId,
boolean includeActiveOnly,
boolean getAllMetaDataVersions,
ITransaction transaction)
Get versions information by version content id. |
Collection<String> |
getVersionsItemIds(SessionConfig sessionConfig,
Collection<String> itemIds,
String serviceInstanceId,
String sourceId,
ITransaction transaction)
Gets a collection of itemIds containing all the versions of each version represented by an itemId on the collection given. |
void |
update(SessionConfig sessionConfig,
MetaDataConfig metaDataConfig,
ITransaction transaction)
Updates the meta data config |
void |
updateHighlight(SessionConfig sessionConfig,
Collection<MetaDataConfig> metaDataConfigs,
ITransaction transaction)
Updates highligt status of the given collection of meta data configs setting it as false (such as there is no "Start highlight date"). |
void |
updatePublished(SessionConfig sessionConfig,
Collection<MetaDataConfig> metaDataConfigs,
boolean newPublishedValue,
ITransaction transaction)
Updates published status of the given collection of meta data configs with the given value. |
void |
updateVersion(SessionConfig sessionConfig,
VersionConfig versionConfig,
ITransaction transaction)
Updates the version information. |
Method Detail |
---|
MetaDataConfig get(SessionConfig sessionConfig, String metaDataId, ITransaction transaction) throws ManagerException, PortalException
sessionConfig
- metaDataId
- transaction
-
ManagerException
PortalException
Collection<MetaDataConfig> getByItemId(SessionConfig sessionConfig, String itemId, ITransaction transaction) throws ManagerException, PortalException
sessionConfig
- itemId
- transaction
-
ManagerException
PortalException
Collection<MetaDataConfig> getByItemId(SessionConfig sessionConfig, String itemId, boolean considerInactiveVersion, ITransaction transaction) throws ManagerException, PortalException
sessionConfig
- itemId
- considerInactiveVersion
- transaction
-
ManagerException
PortalException
Collection<MetaDataConfig> getByItemIdAndServiceId(SessionConfig sessionConfig, String itemId, String serviceId, String sourceId, ITransaction transaction) throws ManagerException, PortalException
sessionConfig
- itemId
- serviceId
- sourceId
- transaction
-
ManagerException
PortalException
Collection<MetaDataConfig> getByItemIdAndServiceId(SessionConfig sessionConfig, String itemId, String serviceId, String sourceId, boolean considerInactiveVersion, ITransaction transaction) throws ManagerException, PortalException
sessionConfig
- itemId
- serviceId
- sourceId
- considerInactiveVersion
- TODOtransaction
-
ManagerException
PortalException
MetaDataConfig getByItemIdAndServiceInstanceId(SessionConfig sessionConfig, String itemId, String serviceInstanceId, String sourceId, ITransaction transaction) throws ManagerException, PortalException
sessionConfig
- itemId
- serviceInstanceId
- sourceId
- transaction
-
ManagerException
PortalException
MetaDataConfig getByItemIdAndServiceInstanceId(SessionConfig sessionConfig, String itemId, String serviceInstanceId, String sourceId, boolean considerInactiveVersion, ITransaction transaction) throws ManagerException, PortalException
sessionConfig
- itemId
- serviceInstanceId
- sourceId
- considerInactiveVersion
- TODOtransaction
-
ManagerException
PortalException
String getParentServiceInstanceId(SessionConfig sessionConfig, String itemId, String serviceId, ITransaction transaction) throws ManagerException, PortalException
sessionConfig
- itemId
- serviceId
- transaction
-
ManagerException
PortalException
Collection<String> getIdsByServiceInstanceId(SessionConfig sessionConfig, String serviceInstanceId, ITransaction transaction) throws ManagerException, PortalException
sessionConfig
- serviceInstanceId
- transaction
-
ManagerException
PortalException
List<MetaDataConfig> getByParentServiceInstanceId(SessionConfig sessionConfig, String parentServiceInstanceId, ITransaction transaction) throws ManagerException, PortalException
sessionConfig
- parentServiceInstanceId
- transaction
-
ManagerException
PortalException
String add(SessionConfig sessionConfig, MetaDataConfig metaDataConfig, ITransaction transaction) throws ManagerException, PortalException
sessionConfig
- metaDataConfig
- transaction
-
ManagerException
PortalException
void update(SessionConfig sessionConfig, MetaDataConfig metaDataConfig, ITransaction transaction) throws ManagerException, PortalException
sessionConfig
- metaDataConfig
- transaction
-
ManagerException
PortalException
void delete(SessionConfig sessionConfig, String metaDataId, ITransaction transaction) throws ManagerException, PortalException
sessionConfig
- metaDataId
- transaction
-
ManagerException
PortalException
void delete(SessionConfig sessionConfig, Collection<String> metaDataIds, ITransaction transaction) throws ManagerException, PortalException
sessionConfig
- metaDataIds
- transaction
-
ManagerException
PortalException
void deleteByItemIds(SessionConfig sessionConfig, Collection<String> itemIds, String serviceId, ITransaction transaction) throws ManagerException, PortalException
sessionConfig
- itemIds
- serviceId
- transaction
-
ManagerException
PortalException
Collection<MetaDataConfig> getMetaDataToPublishByServiceId(SessionConfig sessionConfig, String serviceId, ITransaction transaction) throws ManagerException, PortalException
sessionConfig
- serviceId
- transaction
-
ManagerException
PortalException
Collection<MetaDataConfig> getMetaDataToExpireByServiceId(SessionConfig sessionConfig, String serviceId, ITransaction transaction) throws ManagerException, PortalException
sessionConfig
- serviceId
- transaction
-
ManagerException
PortalException
Collection<MetaDataConfig> getMetaDataToExpireHighlightByServiceId(SessionConfig sessionConfig, String serviceId, ITransaction transaction) throws ManagerException, PortalException
sessionConfig
- serviceId
- transaction
-
ManagerException
PortalException
void updatePublished(SessionConfig sessionConfig, Collection<MetaDataConfig> metaDataConfigs, boolean newPublishedValue, ITransaction transaction) throws ManagerException, PortalException
sessionConfig
- metaDataConfigs
- newPublishedValue
- transaction
-
ManagerException
PortalException
void updateHighlight(SessionConfig sessionConfig, Collection<MetaDataConfig> metaDataConfigs, ITransaction transaction) throws ManagerException, PortalException
sessionConfig
- metaDataConfigs
- transaction
-
ManagerException
PortalException
int getNumComments(SessionConfig sessionConfig, String metaDataId, ITransaction transaction) throws ManagerException, PortalException
sessionConfig
- metaDataId
- transaction
-
ManagerException
PortalException
List<CommentConfig> getComments(SessionConfig sessionConfig, String metaDataId, ITransaction transaction) throws ManagerException, PortalException
sessionConfig
- metaDataId
- transaction
-
ManagerException
PortalException
String addComment(SessionConfig sessionConfig, CommentConfig commentConfig, ITransaction transaction) throws ManagerException, PortalException
sessionConfig
- commentConfig
- transaction
-
ManagerException
PortalException
Collection<PublishToPrincipalConfig> getPublishedToPrincipalsByMetaDataId(SessionConfig sessionConfig, String metaDataId, ITransaction transaction) throws ManagerException, PortalException
sessionConfig
- metaDataId
- transaction
-
ManagerException
PortalException
String addPublishedToPrincipal(SessionConfig sessionConfig, PublishToPrincipalConfig publishToPrincipalConfig, ITransaction transaction) throws ManagerException, PortalException
sessionConfig
- publishToPrincipalConfig
- transaction
-
ManagerException
PortalException
void deletePublishedToPrincipal(SessionConfig sessionConfig, String metaDataId, ITransaction transaction) throws ManagerException, PortalException
sessionConfig
- metaDataId
- transaction
-
ManagerException
PortalException
Collection<LanguageConfig> getContentsByLanguageAssociation(SessionConfig sessionConfig, String tableName, String primaryKeyFieldId, String primaryKeyValue, String primaryNameFieldId, String serviceInstanceId, String nameFilterValue, String selectedLanguageId, String languageContentId, ITransaction transaction) throws ManagerException, PortalException
sessionConfig
- tableName
- The table name of the serviceprimaryKeyFieldId
- Primary Key column name of the table of the service.primaryKeyValue
- Primary Key value of the given content on the table of the
service.primaryNameFieldId
- Primary Name column name of the table of the service.serviceInstanceId
- nameFilterValue
- Value used for a "like filter" over the primary name of the
associable contents.selectedLanguageId
- Selected language for the given content.languageContentId
- Language content id for the given content.transaction
-
ManagerException
PortalException
Collection<LanguageConfig> getAssociatedContents(SessionConfig sessionConfig, String tableName, String primaryKeyFieldId, String primaryNameFieldId, String languageContentId, ITransaction transaction) throws ManagerException, PortalException
sessionConfig
- tableName
- The table name of the serviceprimaryKeyFieldId
- Primary Key column name of the table of the service.primaryNameFieldId
- Primary Name column name of the table of the service.languageContentId
- Language content id for the given content.transaction
-
ManagerException
PortalException
Collection<String> getVersionsItemIds(SessionConfig sessionConfig, Collection<String> itemIds, String serviceInstanceId, String sourceId, ITransaction transaction) throws ManagerException, PortalException
sessionConfig
- itemIds
- serviceInstanceId
- sourceId
- transaction
-
ManagerException
PortalException
int getNumVersions(SessionConfig sessionConfig, String itemId, String serviceInstanceId, String sourceId, ITransaction transaction) throws ManagerException, PortalException
sessionConfig
- itemId
- serviceInstanceId
- sourceId
- transaction
-
ManagerException
PortalException
String getVersionContentIdByItemIdAndServiceInstanceId(SessionConfig sessionConfig, String itemId, String serviceInstanceId, String sourceId, ITransaction transaction) throws ManagerException, PortalException
sessionConfig
- itemId
- serviceInstanceId
- sourceId
- transaction
-
ManagerException
PortalException
String getVersionContentIdByItemIdAndServiceId(SessionConfig sessionConfig, String itemId, String serviceId, String sourceId, ITransaction transaction) throws ManagerException, PortalException
sessionConfig
- itemId
- serviceInstanceId
- sourceId
- transaction
-
ManagerException
PortalException
VersionConfig getVersion(SessionConfig sessionConfig, String versionId, ITransaction transaction) throws ManagerException, PortalException
sessionConfig
- versionId
- transaction
-
ManagerException
PortalException
String addVersion(SessionConfig sessionConfig, VersionConfig versionConfig, ITransaction transaction) throws ManagerException, PortalException
sessionConfig
- versionConfig
- transaction
-
ManagerException
PortalException
void updateVersion(SessionConfig sessionConfig, VersionConfig versionConfig, ITransaction transaction) throws ManagerException, PortalException
sessionConfig
- versionConfig
- transaction
-
ManagerException
PortalException
void deleteVersion(SessionConfig sessionConfig, String versionId, ITransaction transaction) throws ManagerException, PortalException
sessionConfig
- versionId
- transaction
-
ManagerException
PortalException
Collection<VersionConfig> getVersionsByVersionContentId(SessionConfig sessionConfig, String versionContentId, boolean includeActiveOnly, boolean getAllMetaDataVersions, ITransaction transaction) throws ManagerException, PortalException
sessionConfig
- versionContentId
- includeActiveOnly
- If true, filters query so it will return only active versions.getAllMetaDataVersions
- If true, query will consider meta data plurality. That means
that if the given content is published for multiple service
instances, the collection returned will contain information
for each version of each service instance that the content is
published to. If false, query will not consider meta data
plurality and so, returned collection items will contain no
information on metaDataId and collection will have as many
items as the number of times content was edited, independent
of the number of service instances that it is published to.transaction
-
ManagerException
PortalException
String getIdByVersionContentIdAndServiceInstanceId(SessionConfig sessionConfig, String versionContentId, String serviceInstanceId, ITransaction transaction) throws ManagerException, PortalException
sessionConfig
- versionContentId
- serviceInstanceId
- transaction
-
ManagerException
PortalException
Collection<String> getIdsByVersionContentIdAndServiceId(SessionConfig sessionConfig, String versionContentId, String serviceId, ITransaction transaction) throws ManagerException, PortalException
sessionConfig
- versionContentId
- serviceId
- transaction
-
ManagerException
PortalException
void deletePublishedToPrincipalByPrincipalId(SessionConfig sessionConfig, String principalId, ITransaction transaction) throws ManagerException, PortalException
sessionConfig
- principalId
- transaction
-
ManagerException
PortalException
Collection<String> getSourceIdsByServiceId(String serviceId, ITransaction transaction) throws ManagerException, PortalException
serviceId
- service identifiertransaction
- transaction
DaoException
PortalException
ManagerException
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |