com.sap.ip.collaboration.room.api.relman

Interface IRelationManager

public interface IRelationManager

Interface describing relation manager used to relate and unrelate rooms via their room ids along relation types defined in the configuration framework.

See Also:

com.sap.ip.collaboration.room.api.relman.RelationManager

Method Summary

void	deleteRoomRelations(String roomId) Delete all room relations to and from the given room.
void	deleteRoomRelations(String roomId, String associationId) Delete all room relations using the given relation type to and from the given room.
List	getAllAssociationIds() Get all relation type ids as an unmodifiable list sorted alphabetically by the id.
String	getAssociationLabel(String associationId, Locale locale) Get localized relation type name by relation type id.
Map	getRelatedRoomsFromRoom(String sourceRoomId) Get all related rooms from the given room.
List	getRelatedRoomsFromRoom(String sourceRoomId, String associationId) Get all related rooms from the given room using the given relation type.
Map	getRelatedRoomsToRoom(String targetRoomId) Get all related rooms to the given room.
List	getRelatedRoomsToRoom(String targetRoomId, String associationId) Get all related rooms to the given room using the given relation type.
void	orderRoomRelation(String sourceRoomId, String targetRoomId, String associationId, IOrderedRelationPosition orderedRelationPosition) Order room relation, i.e. place the relation from source room to target room using the given relation type according to the given order position.
void	relateRoom(String sourceRoomId, String targetRoomId, String associationId) Relate source room to target room using the given relation type.
void	unrelateRoom(String sourceRoomId, String targetRoomId, String associationId) Unrelate source room from target room using the given relation type.

Method Detail

getAllAssociationIds

public List getAllAssociationIds()

Get all relation type ids as an unmodifiable list sorted alphabetically by the id.

Returns:

all relation type ids as an unmodifiable list sorted alphabetically by the id

getAssociationLabel

public String getAssociationLabel(String associationId,
                                  Locale locale)

Get localized relation type name by relation type id.

Parameters:

associationId - relation type id

locale - locale

Returns:

localized relation type name

relateRoom

public void relateRoom(String sourceRoomId,
                       String targetRoomId,
                       String associationId)
                throws ResourceException

Relate source room to target room using the given relation type.

Parameters:

sourceRoomId - source room id

targetRoomId - target room id

associationId - relation type id

Throws:

ResourceException - Exception raised in failure situation

unrelateRoom

public void unrelateRoom(String sourceRoomId,
                         String targetRoomId,
                         String associationId)
                  throws ResourceException

Unrelate source room from target room using the given relation type.

Parameters:

sourceRoomId - source room id

targetRoomId - target room id

associationId - relation type id

Throws:

ResourceException - Exception raised in failure situation

deleteRoomRelations

public void deleteRoomRelations(String roomId)
                         throws ResourceException

Delete all room relations to and from the given room.

Parameters:

roomId - room id

Throws:

ResourceException - Exception raised in failure situation

deleteRoomRelations

public void deleteRoomRelations(String roomId,
                                String associationId)
                         throws ResourceException

Delete all room relations using the given relation type to and from the given room.

Parameters:

roomId - room id

associationId - relation type id

Throws:

ResourceException - Exception raised in failure situation

orderRoomRelation

public void orderRoomRelation(String sourceRoomId,
                              String targetRoomId,
                              String associationId,
                              IOrderedRelationPosition orderedRelationPosition)
                       throws ResourceException

Order room relation, i.e. place the relation from source room to target room using the given relation type according to the given order position.

Parameters:

sourceRoomId - source room id

targetRoomId - target room id

associationId - relation type id

orderedRelationPosition - order position

Throws:

ResourceException - Exception raised in failure situation

See Also:

IOrderedRelationPosition

getRelatedRoomsFromRoom

public Map getRelatedRoomsFromRoom(String sourceRoomId)
                            throws ResourceException

Get all related rooms from the given room.

Parameters:

sourceRoomId - source room id

Returns:

map indexed by relation type ids of lists of related rooms sorted by its ordering position

Throws:

ResourceException - Exception raised in failure situation

getRelatedRoomsFromRoom

public List getRelatedRoomsFromRoom(String sourceRoomId,
                                    String associationId)
                             throws ResourceException

Get all related rooms from the given room using the given relation type.

Parameters:

sourceRoomId - source room id

associationId - relation type id

Returns:

list of related rooms sorted by its ordering position

Throws:

ResourceException - Exception raised in failure situation

getRelatedRoomsToRoom

public Map getRelatedRoomsToRoom(String targetRoomId)
                          throws ResourceException

Get all related rooms to the given room.

Parameters:

targetRoomId - target room id

Returns:

map indexed by relation type ids of lists of related rooms sorted by its ordering position

Throws:

ResourceException - Exception raised in failure situation

getRelatedRoomsToRoom

public List getRelatedRoomsToRoom(String targetRoomId,
                                  String associationId)
                           throws ResourceException

Get all related rooms to the given room using the given relation type.

Parameters:

targetRoomId - target room id

associationId - relation type id

Returns:

list of related rooms sorted by its ordering position

Throws:

ResourceException - Exception raised in failure situation