com.sap.mdm.assignment.commands
Class RetrieveAssignmentsCommand

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.AbstractUserSessionCommand
                  extended bycom.sap.mdm.assignment.commands.RetrieveAssignmentsCommand
All Implemented Interfaces:
Command, PassportSupport

public class RetrieveAssignmentsCommand
extends AbstractUserSessionCommand

A command to retrieve the list of assignments for the specified table or tuple definition.

Please refer to the Assignments section in the MDM Data Manager Reference Guide for more information.

Since:
7.1 SP4
See Also:
ExecuteAssignmentCommand

Constructor Summary
RetrieveAssignmentsCommand(ConnectionAccessor connection)
          Creates an instance of this command.
RetrieveAssignmentsCommand(UserSessionContext ctx)
          Creates a new instance of this command by context.
 
Method Summary
 AssignmentProperties[] getAssignments()
          Returns the list of assignments.
 Id getContainerId()
          Retrieves the container Id.
 void setContainerId(Id containerId)
          Sets the container Id (optional).
 
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

RetrieveAssignmentsCommand

public RetrieveAssignmentsCommand(ConnectionAccessor connection)
Creates an instance of this command.

Parameters:
connection - the connection to the server

RetrieveAssignmentsCommand

public RetrieveAssignmentsCommand(UserSessionContext ctx)
                           throws ConnectionException,
                                  SessionException
Creates a new instance of this command by context.

Parameters:
ctx - the user session context.
Method Detail

getContainerId

public Id getContainerId()
Retrieves the container Id.

Returns:
a container Id

setContainerId

public void setContainerId(Id containerId)
Sets the container Id (optional). It can be a table Id or a tuple definition Id. The default is to retrieve assignments for all tables and tuple definitions.

Parameters:
containerId - the container Id

getAssignments

public AssignmentProperties[] getAssignments()
Returns the list of assignments.

Returns:
a list of assignments


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.