Skip navigation links

com.fatwire.assetapi.data
Interface TagManager

public interface TagManager

Method Summary

void	addTag(java.lang.String tagname, AssetId asset) Adds a tag to given asset.
void	addTag(java.lang.String category, java.lang.String tagName, java.lang.String tagValue, AssetId asset) Adds a tag to given asset.
void	addTag(java.lang.String type, java.lang.String tagName, java.lang.String tagValue, AssetId asset, boolean isAssetSave, boolean isAfterPublish) Add a tag to the give asset.
void	deleteTags(AssetId asset, boolean isAssetSave, boolean isPublish) Completely delete all tags for given asset
void	deleteVoids() Delete all voided tags
java.util.List<java.lang.String>	getAllTags(java.util.List<AssetId> assetIds) Get all the tags assigned to the give list of assets
java.util.List<Tag>	getAllTags(java.lang.String category, boolean excludeVoided) Return list of tags given parameters.
java.util.List<AssetId>	getAssets(java.lang.String category, java.lang.String tagName) Return list of asset ids given category and tag name.
java.util.List<AssetId>	getAssets(java.lang.String category, java.lang.String tagName, java.lang.String tagValue, java.lang.String owner) Return list of asset ids given parameters.
java.util.List<java.lang.String>	getCommonTags(java.util.List<AssetId> assetIds) Get all the tags common to the give list of assets
java.util.List<java.lang.String>	getSystemTags() Get all available tags in the system
java.util.List<TagNode>	getSystemTagTree() Get all available tags in the system as TagNodes.
java.util.List<Tag>	getTags(java.lang.String category, AssetId asset) Return non-voided tags given category and asset id.
java.util.List<Tag>	getTags(java.lang.String type, AssetId asset, boolean excludeVoid) Get all tags of given type and asset.
void	removeTag(java.lang.String category, java.lang.String tagName, AssetId asset) Removes tag from asset.
void	saveTags(java.util.List<AssetId> assetIds, java.lang.String[] newTags, java.lang.String[] deleteTags) Save and delete tags for multiple assets.
void	saveTags(java.util.List<Tag> tags) Saves given list of tags.
java.util.List<Tag>	saveTags(java.util.List<Tag> tags, boolean isAssetSave, boolean isAfterPublish) Saves given list of tags.

Method Detail

addTag

void addTag(java.lang.String tagname,
            AssetId asset)
            throws AssetAccessException

Adds a tag to given asset. If the tag already exists, it'll be replaced.

Parameters:

tagname - tag name

Throws:

AssetAccessException

addTag

void addTag(java.lang.String category,
            java.lang.String tagName,
            java.lang.String tagValue,
            AssetId asset)
            throws AssetAccessException

Adds a tag to given asset. If the tag already exists, it'll be replaced. Similar to #addTag(String).

Parameters:

category - tag category. A value of empty string is equivalent to null.

tagName - tag name

tagValue - tag value

asset - asset identifier

Throws:

AssetAccessException

saveTags

void saveTags(java.util.List<Tag> tags)
              throws AssetAccessException

Saves given list of tags. Similar to TagManager.addTag(String, String, String, AssetId).

Parameters:

tags - list of tags

Throws:

AssetAccessException

getTags

java.util.List<Tag> getTags(java.lang.String category,
                            AssetId asset)

Return non-voided tags given category and asset id. A render dependency is logged against the asset.

Parameters:

category - tag category. If set to null or empty String, this method will return tags of any category

asset - asset identifier

Returns:

list of tags

getAssets

java.util.List<AssetId> getAssets(java.lang.String category,
                                  java.lang.String tagName)

Return list of asset ids given category and tag name. A render dependency is logged against the tag name.

Parameters:

category - tag category. If set to null or empty String, this method will ignore category

tagName - tag name

Returns:

list of asset ids

getAssets

java.util.List<AssetId> getAssets(java.lang.String category,
                                  java.lang.String tagName,
                                  java.lang.String tagValue,
                                  java.lang.String owner)

Return list of asset ids given parameters. A render dependency is logged against the tag name.

Parameters:

category - tag category. If set to null or empty String, this method will ignore category

tagName - tag name

tagValue - tag value

owner - owner of tag

Returns:

list of asset ids

getAllTags

java.util.List<Tag> getAllTags(java.lang.String category,
                               boolean excludeVoided)

Return list of tags given parameters.

Parameters:

category - tag category. If set to null or empty String, this method will ignore category

excludeVoided - false includes voided tags.

Returns:

list of tag

removeTag

void removeTag(java.lang.String category,
               java.lang.String tagName,
               AssetId asset)
               throws AssetAccessException

Removes tag from asset. This method only voids the tag.

Parameters:

category - tag category. If set to null or empty String, this method will ignore category

tagName - tag name

asset - asset identifier

Throws:

AssetAccessException

deleteVoids

void deleteVoids()
                 throws AssetAccessException

Delete all voided tags

Throws:

AssetAccessException

getAllTags

java.util.List<java.lang.String> getAllTags(java.util.List<AssetId> assetIds)

Get all the tags assigned to the give list of assets

Parameters:

assetIds - of unique asset ids

Returns:

a list of tags

getCommonTags

java.util.List<java.lang.String> getCommonTags(java.util.List<AssetId> assetIds)

Get all the tags common to the give list of assets

Parameters:

assetIds - of unique asset ids

Returns:

a list of tags

getSystemTags

java.util.List<java.lang.String> getSystemTags()

Get all available tags in the system

Returns:

a list of tags

saveTags

void saveTags(java.util.List<AssetId> assetIds,
              java.lang.String[] newTags,
              java.lang.String[] deleteTags)
              throws AssetAccessException

Save and delete tags for multiple assets.

Parameters:

assetIds - the asset ids

newTags - a list of new tags to assign to the assets

deleteTags - a list of tags to delete from the assets

Throws:

AssetAccessException

getSystemTagTree

java.util.List<TagNode> getSystemTagTree()

Get all available tags in the system as TagNodes. This is useful in displaying tags as a Tree.

Returns:

a list of TagNodes

getTags

java.util.List<Tag> getTags(java.lang.String type,
                            AssetId asset,
                            boolean excludeVoid)

Get all tags of given type and asset. Logs dep against the asset.

Parameters:

type -

asset -

excludeVoid -

Returns:

a list of tags

saveTags

java.util.List<Tag> saveTags(java.util.List<Tag> tags,
                             boolean isAssetSave,
                             boolean isAfterPublish)
                             throws AssetAccessException

Saves given list of tags. it'll update if tag already exist(based on category,tagname,resource), otherwise it'll add. return map of tags that were saved.

Throws:

AssetAccessException

addTag

void addTag(java.lang.String type,
            java.lang.String tagName,
            java.lang.String tagValue,
            AssetId asset,
            boolean isAssetSave,
            boolean isAfterPublish)
            throws AssetAccessException

Add a tag to the give asset.

Parameters:

type -

tagName -

tagValue -

asset -

Throws:

AssetAccessException

deleteTags

void deleteTags(AssetId asset,
                boolean isAssetSave,
                boolean isPublish)
                throws AssetAccessException

Completely delete all tags for given asset

Parameters:

asset -

Throws:

AssetAccessException

Skip navigation links