com.sap.mdm.security.commands
Class GetUserRolesCommand

java.lang.Object
  extended bycom.sap.mdm.commands.AbstractCommandBase
      extended bycom.sap.mdm.commands.AbstractCommand
          extended bycom.sap.mdm.session.AbstractSessionCommand
              extended bycom.sap.mdm.session.AbstractRepositorySessionCommand
                  extended bycom.sap.mdm.security.commands.GetUserRolesCommand
All Implemented Interfaces:
Command, PassportSupport

public class GetUserRolesCommand
extends AbstractRepositorySessionCommand

A command to retrieve the array of roles for the specified user.

Since:
7.1

Constructor Summary
GetUserRolesCommand(ConnectionAccessor connection)
          Creates a new instance of the command.
GetUserRolesCommand(RepositorySessionContext ctx)
          Creates a new instance of the command by context.
 
Method Summary
 boolean getIsLoadPermissions()
          Indicates if the user permissions to output roles should be loaded or not.
 RoleProperties[] getRoles()
          Returns the roles of the specified user.
 String getUserName()
          Returns the user name.
 void setIsLoadPermissions(boolean isLoadPermissions)
          Specify if the user permissions to output roles should be loaded or not (optional).
 void setUserName(String userName)
          The name of user whom roles should be retrieved (required).
 
Methods inherited from class com.sap.mdm.commands.AbstractCommand
getSession, setSession
 
Methods inherited from class com.sap.mdm.commands.AbstractCommandBase
execute, getPassport, isCommandComplete, setPassport
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

GetUserRolesCommand

public GetUserRolesCommand(ConnectionAccessor connection)
Creates a new instance of the command.

Parameters:
connection - the connections to the server.

GetUserRolesCommand

public GetUserRolesCommand(RepositorySessionContext ctx)
                    throws ConnectionException,
                           SessionException
Creates a new instance of the command by context.

Parameters:
ctx - the repository session context.
Method Detail

setUserName

public void setUserName(String userName)
The name of user whom roles should be retrieved (required). If constructor with MDM session context is used then default user will be taken from the context

Parameters:
userName - The user name to set.

getUserName

public String getUserName()
Returns the user name.

Returns:
the user name.

setIsLoadPermissions

public void setIsLoadPermissions(boolean isLoadPermissions)
Specify if the user permissions to output roles should be loaded or not (optional). The default value is true. Note: in case you choose to load the roles permission the performance of the command will be affected.

Parameters:
isLoadPermissions - indicates if load roles permissions or not.

getIsLoadPermissions

public boolean getIsLoadPermissions()
Indicates if the user permissions to output roles should be loaded or not.

Returns:
if roles permissions should be loaded.

getRoles

public RoleProperties[] getRoles()
Returns the roles of the specified user.

Returns:
the roles.


Copyright 2004-2007 by SAP AG. All Rights Reserved.

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.