com.sap.ip.collaboration.room.api

Interface IRoomPrincipalSets

All Known Subinterfaces:

IRoomPrincipals

public interface IRoomPrincipalSets

Interface describing a snapshot of the current group-role assignments in a room.
This interface should not be used directly. Please use IRoomPrincipals instead

Method Summary

Modifier and Type	Method and Description
IPrincipalSetRoles	addPrincipalSetRole(String principalSetId, IRoomRole role) Assign a new role to a principalSet.
boolean	addPrincipalSetRoles(IRoomPrincipalSets refPrincipalSets) Copy all principalSet-role assignments from another IRoomPrincipalSets object to this object.
IPrincipalSetRoles	addPrincipalSetRoles(String principalSetId, IRoomRole[] roles) Assign multiple roles to a principalSet.
boolean	containsPrincipalSet(String principalSetId) Check if a principalSet is contained
boolean	containsUser(String userId, boolean recursively) Check if a user is contained (recursively)
boolean	deleteAllPrincipalSets() Remove all principalSets from all roles in this snapshot
boolean	deletePrincipalSet(String principalSetId) Remove a specific principalSet from all roles in this snapshot
String[]	getAllPrincipalSets() Get the ids of all principalSets
IRoomRole[]	getPrincipalSetRoles(String principalSetId) Get all roles a specific principalSet is assigned to
IPrincipalSetRoles	getPrincipalSetRolesObject(String principalSetId) Get a specific principalSet and all assigned roles to the principalSets
boolean	hasPrincipalSetRole(String principalSetId, IRoomRole role) Check if a principalSet is assigned to a specific role
boolean	removePrincipalSetRole(String principalSetId, IRoomRole role) Remove a specific role from a principalSet

Method Detail

getAllPrincipalSets

String[] getAllPrincipalSets()

Get the ids of all principalSets

Returns:

Array containing all principalSet ids

containsPrincipalSet

boolean containsPrincipalSet(String principalSetId)

Check if a principalSet is contained

Parameters:

principalSetId - the id of the principalSet

Returns:

true if the given principalSet is assigned to one or more roles, false otherwise

containsUser

boolean containsUser(String userId,
                     boolean recursively)

Check if a user is contained (recursively)

Parameters:

userId - the id of the user

recursively - true or false

Returns:

true if the given user is assigned to one or more roles, false otherwise

getPrincipalSetRolesObject

IPrincipalSetRoles getPrincipalSetRolesObject(String principalSetId)

Get a specific principalSet and all assigned roles to the principalSets

Parameters:

principalSetId - the id of the principalSet

Returns:

IPrincipalSetRoles object for the given principalSet or null if the principalSet is not assigned to any role

getPrincipalSetRoles

IRoomRole[] getPrincipalSetRoles(String principalSetId)

Get all roles a specific principalSet is assigned to

Parameters:

principalSetId - the id of the principalSet

Returns:

Array containing all roles the given principalSet is assigned to

hasPrincipalSetRole

boolean hasPrincipalSetRole(String principalSetId,
                            IRoomRole role)

Check if a principalSet is assigned to a specific role

Parameters:

principalSetId - the id of the principalSet

role - the role object

Returns:

true if the given principalSet is assigned to the given role, false otherwise

addPrincipalSetRole

IPrincipalSetRoles addPrincipalSetRole(String principalSetId,
                                       IRoomRole role)

Assign a new role to a principalSet. If the principalSet was already assigned to the given role before the call, nothing happens.

Parameters:

principalSetId - the id of the principalSet

role - the role object

Returns:

IPrincipalSetRoles object for the given principalSet reflecting the change in the role assignments

addPrincipalSetRoles

IPrincipalSetRoles addPrincipalSetRoles(String principalSetId,
                                        IRoomRole[] roles)

Assign multiple roles to a principalSet. If the principalSet was already assigned to one or more of the given roles before the call, only the remaining roles are assigned.

Parameters:

principalSetId - the id of the principalSet

roles - Array containing the new roles for the principalSet

Returns:

IPrincipalSetRoles object for the given principalSet reflecting the changes in the role assignments

addPrincipalSetRoles

boolean addPrincipalSetRoles(IRoomPrincipalSets refPrincipalSets)

Copy all principalSet-role assignments from another IRoomPrincipalSets object to this object. Previously existing assignments on this object are preserved.

Parameters:

refPrincipalSets - the IRoomPrincipalSets object containing the principalSet-role

Returns:

boolean assignments to be copied

deleteAllPrincipalSets

boolean deleteAllPrincipalSets()

Remove all principalSets from all roles in this snapshot

Returns:

true if removal was successful, false otherwise

deletePrincipalSet

boolean deletePrincipalSet(String principalSetId)

Remove a specific principalSet from all roles in this snapshot

Parameters:

principalSetId - the id of the principalSet to be removed

Returns:

true if removal was successful, false otherwise

removePrincipalSetRole

boolean removePrincipalSetRole(String principalSetId,
                               IRoomRole role)

Remove a specific role from a principalSet

Parameters:

principalSetId - the id of the principalSet

role - the role to be removed from the principalSet

Returns:

true if removal was successful, false otherwise