Skip navigation links

waggle.common.modules.track
Interface XTrackModule.Server

All Superinterfaces:

XAPIInterface, XAPIInterface.Server

Enclosing interface:

XTrackModule

public static interface XTrackModule.Server

extends XAPIInterface.Server

Server interface for the Track Module API.

Nested Class Summary

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

XAPIInterface.Client, XAPIInterface.Server

Method Summary

XTrackInfo	createTrack(String name) Create a new Track.
List<XTrackInfo>	getDiscoverableTracks() Get all discoverable Tracks.
List<XTrackInfo>	getDiscoverableTracksForUser(XObjectID userID) Get all Tracks discoverable by the caller that the specified User is a member of.
List<XTrackInfo>	getNewTracks() Get the new Tracks accessible to the current User.
List<XTrackInfo>	getSortedTracks() Get the Conversations that the current user is a member of.
List<XTrackInfo>	getTopActiveTracks(int limit) Return the top active Tracks that are accessible to the current User.
XTrackInfo	getTrack(XObjectID trackID) Get info about a Track.
List<waggle.common.modules.object.infos.XObjectInfo>	getTrackDirectMembers(XObjectID trackID) Get set of all Users in all Track Conversations you can view.
List<XUserInfo>	getTrackMembership(XObjectID trackID) Get set of all Users in all Track Conversations you can view.
List<XTrackInfo>	getTracks() Get info about all Tracks in which the current User is a member.
List<XTrackInfo>	getTracksInCommon(XObjectID userID) Get Tracks that are in common with another User.
XSearchResultsInfo	searchTrack(XObjectID trackID, XTrackSearchInfo searchInfo) Search the content of a Track.
void	setTrackName(XObjectID trackID, String name) Change a Track's name.

Method Detail

createTrack

XTrackInfo createTrack(String name)

Create a new Track.

Parameters:

name - The name of the Track.

Returns:

Info about the created Track.

getTrack

XTrackInfo getTrack(XObjectID trackID)

Get info about a Track.

Parameters:

trackID - The Track.

Returns:

Information about the Track.

getTracks

List<XTrackInfo> getTracks()

Get info about all Tracks in which the current User is a member.

Returns:

Information about all Tracks in which the current User is a member.

getTopActiveTracks

List<XTrackInfo> getTopActiveTracks(int limit)

Return the top active Tracks that are accessible to the current User.

Parameters:

limit - Maximum number of records to return.

Returns:

The top active Tracks that are accessible to the current User.

getNewTracks

List<XTrackInfo> getNewTracks()

Get the new Tracks accessible to the current User.

Returns:

The new Tracks accessible to the current User, most recently created first.

getDiscoverableTracks

List<XTrackInfo> getDiscoverableTracks()

Get all discoverable Tracks. The return value will not include Conversations in which the User has Viewer access.

Returns:

All discoverable Tracks.

getDiscoverableTracksForUser

List<XTrackInfo> getDiscoverableTracksForUser(XObjectID userID)

Get all Tracks discoverable by the caller that the specified User is a member of.

Parameters:

userID - The other User.

Returns:

All Tracks discoverable by the caller that the specified User is a member of.

getSortedTracks

List<XTrackInfo> getSortedTracks()

Get the Conversations that the current user is a member of.

Returns:

The Conversations that the current user is a member of, most recently created first.

setTrackName

void setTrackName(XObjectID trackID,
                  String name)

Change a Track's name.

Parameters:

trackID - The Track.

name - The new name.

searchTrack

XSearchResultsInfo searchTrack(XObjectID trackID,
                               XTrackSearchInfo searchInfo)

Search the content of a Track.

Parameters:

trackID - The Track.

searchInfo - The search string.

Returns:

Info about the Artifacts matching the search.

getTrackDirectMembers

List<waggle.common.modules.object.infos.XObjectInfo> getTrackDirectMembers(XObjectID trackID)

Get set of all Users in all Track Conversations you can view.

Parameters:

trackID - The Track.

Returns:

The set of all Users you can know about.

getTrackMembership

List<XUserInfo> getTrackMembership(XObjectID trackID)

Get set of all Users in all Track Conversations you can view.

Parameters:

trackID - The Track.

Returns:

The set of all Users you can know about.

getTracksInCommon

List<XTrackInfo> getTracksInCommon(XObjectID userID)

Get Tracks that are in common with another User.

Parameters:

userID - The User.

Returns:

The Tracks that are in common.

Skip navigation links