com.sap.mdm.commands
Class CreateUserSessionCommand

java.lang.Object
  extended bycom.sap.mdm.commands.AbstractCommandBase
      extended bycom.sap.mdm.commands.AbstractCommandSessionless
          extended bycom.sap.mdm.commands.CreateUserSessionCommand
All Implemented Interfaces:
Command, PassportSupport

public class CreateUserSessionCommand
extends AbstractCommandSessionless

A command to create a user session. A user session is needed to perform repository content tasks such as limiting records, creating a new record, updating a record, etc.

See Also:
AuthenticateUserSessionCommand, TrustedUserSessionCommand

Constructor Summary
CreateUserSessionCommand(ConnectionAccessor connection)
          Creates a new instance of this command.
 
Method Summary
 String getApplicationName()
          Returns the application name.
 RegionProperties getDataRegion()
          Returns the data region in use.
 Locale getInterfaceRegion()
          Returns the interface region in use.
 RepositoryIdentifier getRepositoryIdentifier()
          Returns the specified repository.
 String getUserSession()
          Returns the user session ID.
 void setApplicationName(String applicationName)
          Sets the application name.
 void setDataRegion(RegionProperties dataRegion)
          Sets the data region to use for the session (required).
 void setInterfaceRegion(Locale interfaceRegion)
          Sets the interface region to use for the session (optional).
 void setRepositoryIdentifier(RepositoryIdentifier reposId)
          Specifies the repository to operate on (required).
 
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

CreateUserSessionCommand

public CreateUserSessionCommand(ConnectionAccessor connection)
Creates a new instance of this command.

Parameters:
connection - the connections to the server
Method Detail

setRepositoryIdentifier

public void setRepositoryIdentifier(RepositoryIdentifier reposId)
Specifies the repository to operate on (required).

Parameters:
reposId - the repository

getRepositoryIdentifier

public RepositoryIdentifier getRepositoryIdentifier()
Returns the specified repository.

Returns:
the repository

getUserSession

public String getUserSession()
Returns the user session ID.

Returns:
the user session ID

getDataRegion

public RegionProperties getDataRegion()
Returns the data region in use.

Returns:
the data region

setDataRegion

public void setDataRegion(RegionProperties dataRegion)
Sets the data region to use for the session (required). It is mainly use with multi-lingual fields. This data region specifies language layer in effect when retrieving and/or updating field values.

Parameters:
dataRegion - the data region to use

getInterfaceRegion

public Locale getInterfaceRegion()
Returns the interface region in use.

Returns:
the interface region

setInterfaceRegion

public void setInterfaceRegion(Locale interfaceRegion)
Sets the interface region to use for the session (optional). The default interface region is English.

Parameters:
interfaceRegion - the interface region to use

getApplicationName

public String getApplicationName()
Returns the application name. The default is "SAP MDM Java API".

Returns:
an application name
Since:
7.1

setApplicationName

public void setApplicationName(String applicationName)
Sets the application name. This application name appears in the MDM Console.

Parameters:
applicationName - an application name
Since:
7.1


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.