Package net.bluemind.tag.api
Interface ITags
- All Superinterfaces:
IDataShardSupport
,IRestoreCrudSupport<Tag>
,IRestoreItemCrudSupport<Tag>
,IRestoreSupport<Tag>
@Path("/tags/{containerUid}")
public interface ITags
extends IDataShardSupport, IRestoreItemCrudSupport<Tag>
This API is used to manage per-user invalid input: '&' per-domain lists of
Tag
(keyword and color).
The containerUid is obtained from ITagUids.getDefaultUserTags(String)
or can be a domain uid (ie. domain name).-
Method Summary
Modifier and TypeMethodDescriptionall()
Find allTag
s.allUids()
List allTag
uids in the container.ContainerChangeset
of the container starting at given version.void
Create a newTag
.void
Delete aTag
.getComplete
(String uid) Fetch aTag
from its uid.multipleGet
(List<String> uids) Fetch multipleTag
s from their uids.void
Update aTag
.updates
(TagChanges changes) Update multiple tags at once.Methods inherited from interface net.bluemind.core.container.api.IDataShardSupport
xfer
Methods inherited from interface net.bluemind.core.container.api.IRestoreSupport
get, restore
-
Method Details
-
create
Create a newTag
. Tags can be associated with items and may be used to categorize items or for searching.- Parameters:
uid
- The unique identifiertag
-Tag
that will be created.- Throws:
ServerFault
- If anything goes wrong
-
update
Update aTag
.- Parameters:
uid
- The unique identifiertag
-Tag
that will be created.- Throws:
ServerFault
- If anything goes wrong
-
delete
Delete aTag
.- Specified by:
delete
in interfaceIRestoreCrudSupport<Tag>
- Parameters:
uid
- The unique identifier of theTag
tag
-Tag
that will be created.- Throws:
ServerFault
- If anything goes wrong
-
getComplete
Fetch aTag
from its uid.- Specified by:
getComplete
in interfaceIRestoreItemCrudSupport<Tag>
- Parameters:
uid
- The unique identifier- Returns:
ItemValue<Tag>
- Throws:
ServerFault
- If anything goes wrong
-
multipleGet
Fetch multipleTag
s from their uids.- Parameters:
uids
- the unique identifiers to fetch- Returns:
- a list of
ItemValue<Tag>
- Throws:
ServerFault
- If anything goes wrong
-
all
Find allTag
s. Domain tags are not returned when this method is invoked onITagUids.defaultTags(String)
.- Returns:
- list of
Tag
s - Throws:
ServerFault
- If anything goes wrong
-
updates
Update multiple tags at once.- Parameters:
changes
- the batch of changes to apply- Throws:
ServerFault
- If anything goes wrong
-
changeset
ContainerChangeset
of the container starting at given version.- Parameters:
since
- version of first change to retrieve- Throws:
ServerFault
- If anything goes wrong
-
allUids
List allTag
uids in the container.- Returns:
- a list of
Tag
uid - Throws:
ServerFault
- If anything goes wrong
-