Skip navigation links

waggle.common.modules.tag
Interface XTagModule.Server

All Superinterfaces:

XAPIInterface, XAPIInterface.Server

Enclosing interface:

XTagModule

public static interface XTagModule.Server

extends XAPIInterface.Server

Server interface for the Tag Module API.

Nested Class Summary

Nested classes/interfaces inherited from interface waggle.core.api.XAPIInterface

XAPIInterface.Client, XAPIInterface.Server

Method Summary

XTagInfo	createPrivateTag(String name) Create a new private Tag.
XTagInfo	createPrivateTagAndTag(String name, XObjectID tagableID) Create a new private Tag and tag a Tagable.
XTagInfo	createPublicTag(String name) Create a new public Tag.
XTagInfo	createPublicTagAndTag(String name, XObjectID tagableID) Create a new public Tag and tag a Tagable.
void	deleteTag(XObjectID tagID) Delete an existing Tag.
List<XTagInfo>	getConversationTagCloud(XObjectID conversationID, int limit) Get a Track's public and private Tag cloud.
List<XTagInfo>	getPrivateTagCloud() Get a private Tag cloud.
List<XTagInfo>	getPublicTagCloud() Get a public Tag cloud.
XTagTagablesInfo	getTag(XObjectID tagID) Get a Tag and it's Tagables.
Collection<XTagInfo>	getTagableTags(XObjectID tagableID) Get the set of Tags used to Tag the specified Tagable.
List<XTagInfo>	getTagCloud() Get a public and private Tag cloud.
List<XTagTagablesInfo>	getTags(List<XObjectID> tagIDs) Get a set of Tags and their Tagables.
List<XTagInfo>	getTrackTagCloud(XObjectID trackID, int limit) Get a Track's public and private Tag cloud.
void	setTagName(XObjectID tagID, String name) Set Tag name.
void	tag(XObjectID tagID, XObjectID tagableID) Add a Tag to an existing Tagable.
void	untag(XObjectID tagID, XObjectID tagableID) Remove a Tag from an existing Tagable.

Method Detail

createPublicTag

XTagInfo createPublicTag(String name)

Create a new public Tag.

Parameters:

name - The name of the public Tag.

Returns:

Info for the created tag.

createPublicTagAndTag

XTagInfo createPublicTagAndTag(String name,
                               XObjectID tagableID)

Create a new public Tag and tag a Tagable. If an existing Tag of the specified name exists that Tag will be used.

Parameters:

name - The name of the public Tag.

tagableID - The Tagable.

Returns:

Info for the created tag.

createPrivateTag

XTagInfo createPrivateTag(String name)

Create a new private Tag.

Parameters:

name - The name of the private Tag.

Returns:

Info for the created tag.

createPrivateTagAndTag

XTagInfo createPrivateTagAndTag(String name,
                                XObjectID tagableID)

Create a new private Tag and tag a Tagable. If an existing Tag of the specified name exists that Tag will be used.

Parameters:

name - The name of the private Tag.

tagableID - The Tagable.

Returns:

Info for the created tag.

getTagCloud

List<XTagInfo> getTagCloud()

Get a public and private Tag cloud.

Returns:

The a public and private Tag cloud.

getPublicTagCloud

List<XTagInfo> getPublicTagCloud()

Get a public Tag cloud.

Returns:

The a public Tag cloud.

getPrivateTagCloud

List<XTagInfo> getPrivateTagCloud()

Get a private Tag cloud.

Returns:

The a private Tag cloud.

getTrackTagCloud

List<XTagInfo> getTrackTagCloud(XObjectID trackID,
                                int limit)

Get a Track's public and private Tag cloud.

Parameters:

trackID - The Track.

limit - return limit.

Returns:

The a public and private Tag cloud.

getConversationTagCloud

List<XTagInfo> getConversationTagCloud(XObjectID conversationID,
                                       int limit)

Get a Track's public and private Tag cloud.

Parameters:

conversationID - The Conversation.

limit - return limit.

Returns:

The a public and private Tag cloud.

getTag

XTagTagablesInfo getTag(XObjectID tagID)

Get a Tag and it's Tagables.

Parameters:

tagID - The Tag.

Returns:

The Tag information DTO.

getTags

List<XTagTagablesInfo> getTags(List<XObjectID> tagIDs)

Get a set of Tags and their Tagables.

Parameters:

tagIDs - The Tags.

Returns:

The Tag information DTOs.

setTagName

void setTagName(XObjectID tagID,
                String name)

Set Tag name.

Parameters:

tagID - The Tag.

name - The new name.

deleteTag

void deleteTag(XObjectID tagID)

Delete an existing Tag.

Parameters:

tagID - The Tag.

tag

void tag(XObjectID tagID,
         XObjectID tagableID)

Add a Tag to an existing Tagable.

Parameters:

tagID - The Tag.

tagableID - The Tagable.

untag

void untag(XObjectID tagID,
           XObjectID tagableID)

Remove a Tag from an existing Tagable.

Parameters:

tagID - The Tag.

tagableID - The Tagable.

getTagableTags

Collection<XTagInfo> getTagableTags(XObjectID tagableID)

Get the set of Tags used to Tag the specified Tagable.

Parameters:

tagableID - The Tagable.

Returns:

The set of Tags used to Tag the specified Tagable.

Skip navigation links