Skip navigation links

waggle.common.modules.hive
Interface XHiveModule.Server

All Superinterfaces:

XAPIInterface, XAPIInterface.Server

Enclosing interface:

XHiveModule

public static interface XHiveModule.Server

extends XAPIInterface.Server

Server interface for the Hive Module API.

Nested Class Summary

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

XAPIInterface.Client, XAPIInterface.Server

Method Summary

Integer	enterHive() Enter a Hive.
void	exitHive() Exit a Hive.
XSearchResultsInfo	findSimilar(XHiveFindSimilarInfo searchInfo) Search the Hive for items that are "similar" to something the client knows about.
XHiveInfo	getHive() Get the Hive Information DTO.
List<XPropertyInfo>	getHiveConfiguration() Get a Hive's configuration.
List<XPropertyInfo>	getHiveConfigurationProperties(List<String> propertyNames) Get the specified list of properties, overridden or not.
XHiveDetailsInfo	getHiveDetails() Get the Hive Extended Information DTO.
XSearchResultsInfo	searchHive(XHiveSearchInfo searchInfo) Search the Hive.
void	setHiveName(String name) Change the Hive's name.
void	setHiveState(XHiveState state) Change Hive state.
XHiveInfo	updateHive(XUpdater updater) Update a Hive.
void	updateHiveConfiguration(XUpdater updater) Update a Hive's configuration.

Method Detail

getHive

XHiveInfo getHive()

Get the Hive Information DTO.

Returns:

The Hive Information DTO.

getHiveDetails

XHiveDetailsInfo getHiveDetails()

Get the Hive Extended Information DTO.

Returns:

The Hive Extended Information DTO.

setHiveName

void setHiveName(String name)

Change the Hive's name.

Parameters:

name - The new name.

setHiveState

void setHiveState(XHiveState state)

Change Hive state.

Parameters:

state - The new state.

updateHive

XHiveInfo updateHive(XUpdater updater)

Update a Hive.

Parameters:

updater - The updater

Returns:

The updated Hive Information DTO.

getHiveConfiguration

List<XPropertyInfo> getHiveConfiguration()

Get a Hive's configuration. Only returns those properties that have been overridden.

Returns:

All overridden property values.

getHiveConfigurationProperties

List<XPropertyInfo> getHiveConfigurationProperties(List<String> propertyNames)

Get the specified list of properties, overridden or not.

Parameters:

propertyNames - The list of property values to return.

Returns:

The specified properties.

updateHiveConfiguration

void updateHiveConfiguration(XUpdater updater)

Update a Hive's configuration. Null values will remove the override.

Parameters:

updater - The updater. Null values will remove the override.

searchHive

XSearchResultsInfo searchHive(XHiveSearchInfo searchInfo)

Search the Hive.

Parameters:

searchInfo - Search string and results order.

Returns:

Search results.

findSimilar

XSearchResultsInfo findSimilar(XHiveFindSimilarInfo searchInfo)

Search the Hive for items that are "similar" to something the client knows about.

Parameters:

searchInfo - Search parameters.

Returns:

Search results.

enterHive

Integer enterHive()

Enter a Hive. Returns the number of unique client IDs that are entered into the hive from the current HTTP session (this is useful for warning the user if they're launching too many clients in a single session).

Returns:

the number of unique client IDs

exitHive

void exitHive()

Exit a Hive.

Skip navigation links