com.sap.mdm.data.commands
Class AbstractRecordIdsCommand

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.data.commands.AbstractRecordIdsCommand
All Implemented Interfaces:
Command, PassportSupport
Direct Known Subclasses:
AbstractRecordsByIdCommand, AddRecordsToWorkflowJobCommand, CreateWorkflowJobCommand, RemoveRecordsFromWorkflowJobCommand, SetWorkflowRecordApproveStateCommand, SetWorkflowRecordDoneStateCommand, SplitWorkflowJobCommand, ValidateRecordsCommand

public abstract class AbstractRecordIdsCommand
extends AbstractUserSessionCommand

This class is abstract implementation for all commands dealing with repository information by record IDs.

See Also:
CheckinRecordsCommand, CheckoutRecordsCommand, RollbackRecordsCommand, RetrieveRecordsKeyMappingsCommand

Constructor Summary
AbstractRecordIdsCommand(ConnectionAccessor connection)
          Constructor
AbstractRecordIdsCommand(UserSessionContext ctx)
          Creates a new instance of this command by context.
 
Method Summary
 void addRecordId(RecordId recordId)
          Adds a record ID to the list of IDs that should be retrieved from repository.
 void clearRecordIds()
          Clears the set of record IDs.
 boolean containsRecordId(RecordId recordId)
          Checks if the specified record ID is contained in the list of IDs that should be retrieved from repository.
 RecordId[] getRecordIds()
          Gets the record IDs that should be retrieved from repository.
 void removeRecordId(RecordId recordId)
          Removes a record ID from the list of IDs that should be retrieved from repository.
 void setRecordIds(RecordId[] recordIds)
          Sets the record IDs that should be retrieved from repository (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

AbstractRecordIdsCommand

public AbstractRecordIdsCommand(ConnectionAccessor connection)
Constructor

Parameters:
connection - a connection to the MDM server

AbstractRecordIdsCommand

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

Parameters:
ctx - the user session context.
Method Detail

setRecordIds

public void setRecordIds(RecordId[] recordIds)
Sets the record IDs that should be retrieved from repository (required*).

Parameters:
recordIds - array of record IDs

getRecordIds

public RecordId[] getRecordIds()
Gets the record IDs that should be retrieved from repository.

Returns:
array of record IDs

addRecordId

public void addRecordId(RecordId recordId)
Adds a record ID to the list of IDs that should be retrieved from repository.

Parameters:
recordId - record ID

removeRecordId

public void removeRecordId(RecordId recordId)
Removes a record ID from the list of IDs that should be retrieved from repository.

Parameters:
recordId - record ID

containsRecordId

public boolean containsRecordId(RecordId recordId)
Checks if the specified record ID is contained in the list of IDs that should be retrieved from repository.

Parameters:
recordId - record ID
Returns:
true if the record is found, otherwise false

clearRecordIds

public void clearRecordIds()
Clears the set of record IDs.



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.