com.sap.ip.collaboration.room.api
Interface IUserRoles
- public interface IUserRoles
Interface describing the role assignments of a single user. Instances of this
interface are used and returned in the interface IRoomUsers.
- See Also:
IRoomUsers
|
Method Summary |
boolean |
addRole(IRoomRole role)
Assign the user to a new role. |
boolean |
addRoles(IRoomRole[] roles)
Assign multiple roles to the user. |
IRoomRole[] |
getRoles()
Get all roles the user is assigned to |
String |
getUserId()
Get the id of the user |
boolean |
hasRole(IRoomRole role)
Check if the user is assigned to a specific role |
boolean |
isEmpty()
Check if the user is assigned to no roles at all |
boolean |
removeAllRoles()
Remove all roles from the user |
boolean |
removeRole(IRoomRole role)
Remove a specific role from the user |
getUserId
public String getUserId()
- Get the id of the user
- Returns:
- String containing the id of the user
getRoles
public IRoomRole[] getRoles()
- Get all roles the user is assigned to
- Returns:
- Array containing all roles of the user
hasRole
public boolean hasRole(IRoomRole role)
- Check if the user is assigned to a specific role
- Parameters:
role - the role for the check
- Returns:
- true if the user is assigned to the given role, false otherwise
removeAllRoles
public boolean removeAllRoles()
- Remove all roles from the user
- Returns:
- true if successful, false otherwise
removeRole
public boolean removeRole(IRoomRole role)
- Remove a specific role from the user
- Parameters:
role - the role to be removed from the user
- Returns:
- true if successful, false otherwise
isEmpty
public boolean isEmpty()
- Check if the user is assigned to no roles at all
- Returns:
- true if there are no roles assigned to the user, false if the user
is assigned to at least one role
addRole
public boolean addRole(IRoomRole role)
- Assign the user to a new role. If the user was already assigned to the
given role before the call, nothing happens.
- Returns:
- true if successful, false otherwise
addRoles
public boolean addRoles(IRoomRole[] roles)
- Assign multiple roles to the user. If the user was already assigned to
one or more of the given roles before the call, only the remaining roles
are assigned.
- Returns:
- true if successful, false otherwise
Copyright 2006 SAP AG. All rights reserved. No part of this publication may be reproduced or transmitted in any form or for any purpose without the express permission of SAP AG. The information contained herein may be changed without prior notice. Microsoft, Windows, Outlook, and PowerPoint are registered trademarks of Microsoft Corporation. Oracle is a registered trademark of Oracle Corporation. UNIX, X/Open, OSF/1, and Motif are registered trademarks of the Open Group. Citrix, ICA, Program Neighborhood, MetaFrame, WinFrame, VideoFrame, and MultiWin are trademarks or registered trademarks of Citrix Systems, Inc. HTML, XML, XHTML and W3C are trademarks or registered trademarks of W3C, World Wide Web Consortium, Massachusetts Institute of Technology. Java is a registered trademark of Sun Microsystems, Inc. JavaScript is a registered trademark of Sun Microsystems, Inc., used under license for technology invented and implemented by Netscape. MaxDB is a trademark of MySQL AB, Sweden. SAP, R/3, mySAP, mySAP.com, xApps, xApp, SAP NetWeaver, and other SAP products and services mentioned herein as well as their respective logos are trademarks or registered trademarks of SAP AG in Germany and in several other countries all over the world. All other product and service names mentioned are the trademarks of their respective companies. Data contained in this document serves informational purposes only. National product specifications may vary. These materials are subject to change without notice. These materials are provided by SAP AG and its affiliated companies ("SAP Group") for informational purposes only, without representation or warranty of any kind, and SAP Group shall not be liable for errors or omissions with respect to the materials. The only warranties for SAP Group products and services are those that are set forth in the express warranty statements accompanying such products and services, if any. Nothing herein should be construed as constituting an additional warranty.