Skip navigation links

waggle.common.modules.aggregate
Interface XAggregateModule.Server

All Superinterfaces:

XAPIInterface, XAPIInterface.Server

Enclosing interface:

XAggregateModule

public static interface XAggregateModule.Server

extends XAPIInterface.Server

Server interface for the Aggregate Module API.

Nested Class Summary

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

XAPIInterface.Client, XAPIInterface.Server

Method Summary

void	addTrackToAggregate(XObjectID aggregateID, XObjectID trackID) Add a Track to an Aggregate.
XObjectID	createAggregate(String name) Add an Aggregate to the end of the list of the user's Aggregates.
XAggregateInfo	getAggregate(XObjectID aggregateID) Get specified Aggregate definition.
XAggregateInfo	getAggregateForTrack(XObjectID trackID) Get the Aggregate that contains a given Track.
List<XAggregateInfo>	getAggregates() Get all Aggregate definitions.
Collection<XObjectID>	getNewTracksNotInAnyAggregate() Get IDs of all accessible new Tracks, that are not in any of the User's Aggregates.
List<XTrackGetInfo>	getTracksNotInAnyAggregate() Get all accessible Tracks, that are not in any of the User's Aggregates.
void	moveAggregate(XObjectID aggregateID, XObjectID beforeAggregateID) Move an existing Aggregate in the list of this user's Aggregates.
void	moveTrack(XObjectID fromAggregateID, XObjectID toAggregateID, XObjectID trackID) Move a Track from one Aggregate to another.
void	moveTrackWithinAggregate(XObjectID aggregateID, XObjectID trackID, XObjectID beforeTrackID) Move a Track within an Aggregate.
void	removeAggregate(XObjectID aggregateID) Remove an Aggregate.
void	removeTrackFromAggregate(XObjectID aggregateID, XObjectID trackID) Remove a Track from an Aggregate.
void	removeTrackFromAllAggregates(XObjectID trackID) Remove a Track from all Aggregates.
void	renameAggregate(XObjectID aggregateID, String name) Rename an existing Aggregate.

Method Detail

createAggregate

XObjectID createAggregate(String name)

Add an Aggregate to the end of the list of the user's Aggregates.

Parameters:

name - The Aggregate's name.

Returns:

The ID.

renameAggregate

void renameAggregate(XObjectID aggregateID,
                     String name)

Rename an existing Aggregate.

Parameters:

aggregateID - The Aggregate.

name - The new Aggregate name.

moveAggregate

void moveAggregate(XObjectID aggregateID,
                   XObjectID beforeAggregateID)

Move an existing Aggregate in the list of this user's Aggregates.

Parameters:

aggregateID - The Aggregate.

beforeAggregateID - The Aggregate before which aggregateID will be moved. If null, the Aggregate will be moved to the end of the list.

removeAggregate

void removeAggregate(XObjectID aggregateID)

Remove an Aggregate.

Parameters:

aggregateID - The Aggregate.

addTrackToAggregate

void addTrackToAggregate(XObjectID aggregateID,
                         XObjectID trackID)

Add a Track to an Aggregate.

Parameters:

aggregateID - The Aggregate.

trackID - The Track.

moveTrack

void moveTrack(XObjectID fromAggregateID,
               XObjectID toAggregateID,
               XObjectID trackID)

Move a Track from one Aggregate to another. It will be removed from the first Aggregate, and added to the second Aggregate (at the end of the list).

Parameters:

fromAggregateID - The Aggregate from which the Track should be moved.

toAggregateID - The Aggregate to which the Track should be moved.

trackID - The Track to be repositioned.

moveTrackWithinAggregate

void moveTrackWithinAggregate(XObjectID aggregateID,
                              XObjectID trackID,
                              XObjectID beforeTrackID)

Move a Track within an Aggregate.

Parameters:

aggregateID - The Aggregate.

trackID - The Track to be repositioned.

beforeTrackID - The Track before which (@code trackID} will be moved. If null, the Track will be moved to the end of the list.

removeTrackFromAggregate

void removeTrackFromAggregate(XObjectID aggregateID,
                              XObjectID trackID)

Remove a Track from an Aggregate.

Parameters:

aggregateID - The Aggregate.

trackID - The Track.

removeTrackFromAllAggregates

void removeTrackFromAllAggregates(XObjectID trackID)

Remove a Track from all Aggregates.

Parameters:

trackID - The Track ID.

getAggregate

XAggregateInfo getAggregate(XObjectID aggregateID)

Get specified Aggregate definition.

Parameters:

aggregateID - The Aggregate.

Returns:

The Aggregate definition.

getAggregateForTrack

XAggregateInfo getAggregateForTrack(XObjectID trackID)

Get the Aggregate that contains a given Track. This assumes that each Track can only be in a single Aggregate.

Parameters:

trackID - The Track.

Returns:

The Aggregate definition.

getAggregates

List<XAggregateInfo> getAggregates()

Get all Aggregate definitions.

Returns:

All Aggregate definitions.

getTracksNotInAnyAggregate

List<XTrackGetInfo> getTracksNotInAnyAggregate()

Get all accessible Tracks, that are not in any of the User's Aggregates.

Returns:

All the user's accessible Tracks which are not in any of the User's Aggregates.

getNewTracksNotInAnyAggregate

Collection<XObjectID> getNewTracksNotInAnyAggregate()

Get IDs of all accessible new Tracks, that are not in any of the User's Aggregates.

Returns:

IDs of all accessible new Tracks which are not in any of the User's Aggregates.

Skip navigation links