public interface Tag extends GenericTag<Tag,TagStructure>
Modifier and Type | Method and Description |
---|---|
void |
addAlias(String pAlias)
Add an alias to this tag.
|
Tag |
addChild(String pName,
String pDescription)
Adds tag as a child of this tag in the same tag structure.
|
Tag |
addChild(String pTagId,
String pName,
String pDescription)
Adds tag as a child of this tag in the same tag structure.
|
Tag |
addChildWithAliases(String pName,
String pDescription,
List<String> pAliases)
Adds tag as a child of this tag in the same tag structure.
|
Tag |
addChildWithAliases(String pTagId,
String pName,
String pDescription,
List<String> pAliases)
Adds tag as a child of this tag in the same tag structure.
|
void |
delete()
Deletes this tag.
|
void |
deleteAlias(String pAlias)
Delete an alias from this tag.
|
String |
toPathString(String pDelimiter)
Traverses the ancestors of the tag until the root and returns a
string containing the names of those tags, separated by the specified
pDelimiter . |
void |
update(String pName,
String pDescription)
Updates this tag in the backend with specified name and description.
|
void |
update(Tag pParent)
Update this tag's parent in the backend with specified parent.
|
getAliases, getChildren, getChildren, getChildrenCount, getDescription, getID, getIdentifier, getLastModified, getName, getParent, getTagStructure, getUUID
Tag addChild(String pName, String pDescription) throws ClassificationException
pName
- the name of the new tag.pDescription
- the description of the new tag.ClassificationException
- if adding tag fails.Tag addChild(String pTagId, String pName, String pDescription) throws ClassificationException
pTagId
- is the identifier of the tag to be created.pName
- the name of the new tag.pDescription
- the description of the new tag.ClassificationException
- if adding tag fails.Tag addChildWithAliases(String pName, String pDescription, List<String> pAliases) throws ClassificationException
pName
- the name of the new tag.pDescription
- the description of the new tag.pAliases
- the list of aliases to be created with this tag.ClassificationException
- if adding tag fails.Tag addChildWithAliases(String pTagId, String pName, String pDescription, List<String> pAliases) throws ClassificationException
pTagId
- is the identifier of the tag to be created.pName
- the name of the new tag.pDescription
- the description of the new tag.pAliases
- the list of aliases to be created with this tag.ClassificationException
- if adding tag fails.void update(String pName, String pDescription) throws ClassificationException
Tag
instance. If you want to get the updated Tag
instance, you have to get it again with the identifier.pName
- the new name of the tag.pDescription
- the new description of the tag.ClassificationException
- if update tag fails.void update(Tag pParent) throws ClassificationException
Tag
instance. If you want to get the updated Tag
instance, you have to get it again with the identifier.pParent
- the new parent of the tag.ClassificationException
- if update tag fails.void delete() throws ClassificationException
ClassificationException
- if tag deletion fails.void addAlias(String pAlias) throws ClassificationException
pAlias
- the name of the alias.ClassificationException
- it alias adding fails.void deleteAlias(String pAlias) throws ClassificationException
pAlias
- the name of the alias.ClassificationException
- it alias deletion fails.String toPathString(String pDelimiter) throws ClassificationException
pDelimiter
. Returns the tag name if a tag has no parents.pDelimiter
- the string to insert between the parent tags if
there are more than one.ClassificationException
- if it
is not possible to traverse to a tag's parent© 1998- 2021 Escenic AS