org.moock.unity.core
Interface RoomManagementServices


public interface RoomManagementServices

Interface for handling services associated with Room Management such as creation and destruction.

Author:
Derek Clayton
See Also:
Services

Method Summary
 boolean addNamespace(java.lang.String namespace)
          Add a Namespace to the server.
 java.lang.String getManifest()
          Return an XML String representing the tree of Objects (Rooms, Namespaces) deployed to the Server.
 java.util.HashSet getNamespaceList()
          Returns a list of the names of Namespace ID's deployed to the server.
 java.util.HashSet getRoomList()
          Returns a list of the names of room ID's deployed to the server.
 void killRoom(java.lang.String fqRoomID)
          Kills the Room specified by fqRoomID.
 void removeNamespace(java.lang.String namespace)
          Remove a Namespace from the server.
 java.lang.String spawnRoom(RoomDefinition props)
          Creates a new Room according to the given RoomDefinition.
 

Method Detail

killRoom

public void killRoom(java.lang.String fqRoomID)
              throws org.moock.unity.core.exception.RoomNotFoundException,
                     org.moock.unity.core.exception.NamespaceNotFoundException
Kills the Room specified by fqRoomID.

spawnRoom

public java.lang.String spawnRoom(RoomDefinition props)
                           throws org.moock.unity.core.exception.SpawnRoomException
Creates a new Room according to the given RoomDefinition. If the roomid in RoomDefinition is null it generates a unique roomid.
Returns:
the roomid of the spawned room

getRoomList

public java.util.HashSet getRoomList()
Returns a list of the names of room ID's deployed to the server.

getNamespaceList

public java.util.HashSet getNamespaceList()
Returns a list of the names of Namespace ID's deployed to the server.

addNamespace

public boolean addNamespace(java.lang.String namespace)
                     throws org.moock.unity.core.exception.NamespaceAlreadyExistsException
Add a Namespace to the server. Returns true if the addition was successful.

getManifest

public java.lang.String getManifest()
Return an XML String representing the tree of Objects (Rooms, Namespaces) deployed to the Server.

removeNamespace

public void removeNamespace(java.lang.String namespace)
                     throws org.moock.unity.core.exception.NamespaceNotFoundException,
                            org.moock.unity.core.exception.NamespaceSecurityException
Remove a Namespace from the server.