com.sap.ip.collaboration.room.api

Interface IPrincipalRoles

All Known Subinterfaces:

IPrincipalSetRoles, IUserRoles

public interface IPrincipalRoles

Interface describing assessments of PrincipalRoles.

Method Summary

boolean	addRole(IRoomRole role) Assign the principal to a new role.
boolean	addRoles(IRoomRole[] roles) Assign multiple roles to the principal.
IRoomRole[]	getRoles() Get all roles the principal is assigned to
boolean	hasRole(IRoomRole role) Check if the principal is assigned to a specific role
boolean	isEmpty() Check if the principal is assigned to no roles at all
boolean	removeAllRoles() Remove all roles from the principal
boolean	removeRole(IRoomRole role) Remove a specific role from the principal

Method Detail

getRoles

IRoomRole[] getRoles()

Get all roles the principal is assigned to

Returns:

Array containing all roles of the principal

hasRole

boolean hasRole(IRoomRole role)

Check if the principal is assigned to a specific role

Parameters:

role - the role for the check

Returns:

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

removeAllRoles

boolean removeAllRoles()

Remove all roles from the principal

Returns:

true if successful, false otherwise

removeRole

boolean removeRole(IRoomRole role)

Remove a specific role from the principal

Parameters:

role - the role to be removed from the principal

Returns:

true if successful, false otherwise

isEmpty

boolean isEmpty()

Check if the principal is assigned to no roles at all

Returns:

true if there are no roles assigned to the principal, false if the principal is assigned to at least one role

addRole

boolean addRole(IRoomRole role)

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

Parameters:

newRole - the new role for the principal

Returns:

true if successful, false otherwise

addRoles

boolean addRoles(IRoomRole[] roles)

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

Parameters:

newRoles - Array containing all roles to be assigned to the principal

Returns:

true if successful, false otherwise

Access Rights

This class can be accessed from:

SC	DC	Public Part	ACH
[sap.com] KMC-COLL	[sap.com] tc/kmc/coll/room	api	EP-KM-CRS