com.whizzosoftware.hobson.api.presence.store

Interface PresenceStore

public interface PresenceStore

Method Summary

Modifier and Type	Method and Description
void	close() Cleans up and closes the presence store.
void	deletePresenceEntity(PresenceEntityContext ctx) Deletes an existing presence entity.
void	deletePresenceLocation(PresenceLocationContext ctx) Deletes a presence location.
java.util.Collection<PresenceEntity>	getAllPresenceEntities(HubContext ctx) Returns a collection of all presence entities.
java.util.Collection<PresenceLocation>	getAllPresenceLocations(HubContext ctx) Returns a collection of all presence locations.
PresenceEntity	getPresenceEntity(PresenceEntityContext ctx) Returns a presence entity.
PresenceLocation	getPresenceLocation(PresenceLocationContext ctx) Returns a presence location.
void	performHousekeeping() Allows the presence store to perform whatever implementation-specific housekeeping tasks are needed.
void	savePresenceEntity(PresenceEntity pe) Saves a presence entity.
void	savePresenceLocation(PresenceLocation pl) Saves a presence location.

Method Detail

close

void close()

Cleans up and closes the presence store.

deletePresenceEntity

void deletePresenceEntity(PresenceEntityContext ctx)

Deletes an existing presence entity.

Parameters:

ctx - the context of the presence entity

deletePresenceLocation

void deletePresenceLocation(PresenceLocationContext ctx)

Deletes a presence location.

Parameters:

ctx - the presence location context

getAllPresenceEntities

java.util.Collection<PresenceEntity> getAllPresenceEntities(HubContext ctx)

Returns a collection of all presence entities.

Parameters:

ctx - the hub context

Returns:

a collection of PresenceEntity instances

getAllPresenceLocations

java.util.Collection<PresenceLocation> getAllPresenceLocations(HubContext ctx)

Returns a collection of all presence locations.

Parameters:

ctx - the hub context

Returns:

a collection of PresenceLocation instances

getPresenceEntity

PresenceEntity getPresenceEntity(PresenceEntityContext ctx)

Returns a presence entity.

Parameters:

ctx - the context of the presence entity

Returns:

a PresenceEntity instance

getPresenceLocation

PresenceLocation getPresenceLocation(PresenceLocationContext ctx)

Returns a presence location.

Parameters:

ctx - the presence location context

Returns:

a PresenceLocation instance

performHousekeeping

void performHousekeeping()

Allows the presence store to perform whatever implementation-specific housekeeping tasks are needed.

savePresenceEntity

void savePresenceEntity(PresenceEntity pe)

Saves a presence entity.

Parameters:

pe - the presence entity to save

savePresenceLocation

void savePresenceLocation(PresenceLocation pl)

Saves a presence location.

Parameters:

pl - the presence location to save