com.sap.mdm.assignment.commands
Class ExecuteAssignmentCommand

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.ExecuteAssignmentCommand
All Implemented Interfaces:
Command, PassportSupport

public class ExecuteAssignmentCommand
extends AbstractUserSessionCommand

Execute an assignment on a set of records.

Like validations, MDM assignments are MDM expressions, except that instead of returning a Boolean success or failure result, they can return a data value of any type; and instead of displaying the expression result for each record in a column in the Records pane, they can assign it to the value of the specified user-editable field.

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

Since:
7.1 SP4
See Also:
RetrieveAssignmentsCommand

Constructor Summary
ExecuteAssignmentCommand(ConnectionAccessor connection)
          Constructor
ExecuteAssignmentCommand(UserSessionContext ctx)
          Creates a new instance of this command by context.
 
Method Summary
 void execute()
          Executes the command.
 AssignmentId getAssignmentId()
          Returns the assignment Id.
 RecordId[] getFailedRecords()
          Returns the records that failed assignment.
 RecordId[] getRecordIds()
          Returns the record Ids to execute assignment on.
 Integer getReturnCode(RecordId recordId)
          Returns the reason the record failed assignment.
 RecordId[] getSucceededRecords()
          Returns the records that were successfully assigned.
 TableId getTableId()
          Returns the table Id.
 ValidationResult getValidationResult()
          Returns the validation results.
 boolean isCommitOnWarning()
          Indicates whether the record should be committed if the record failed the "warning" validations.
 boolean isSlice()
          Returns whether slicing is enabled.
 void setAssignmentId(AssignmentId assignmentId)
          Sets the assignment to execute (required).
 void setCommitOnWarning(boolean isCommitOnWarning)
          Indicates whether the record should be committed if the record failed the "warning" validations (optional).
 void setRecordIds(RecordId[] recordIds)
          Sets the records to execute the assignment on (required).
 void setSlice(boolean isSlice)
          Enable slicing during assignment.
 void setTableId(TableId tableId)
          Sets the table Id (required).
 
Methods inherited from class com.sap.mdm.commands.AbstractCommand
getSession, setSession
 
Methods inherited from class com.sap.mdm.commands.AbstractCommandBase
getPassport, isCommandComplete, setPassport
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ExecuteAssignmentCommand

public ExecuteAssignmentCommand(ConnectionAccessor connection)
Constructor

Parameters:
connection - a connection to the MDM server

ExecuteAssignmentCommand

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

Parameters:
ctx - the user session context.
Method Detail

execute

public void execute()
             throws CommandException,
                    ValidationException
Description copied from interface: Command
Executes the command.

Specified by:
execute in interface Command
Overrides:
execute in class AbstractCommandBase
Throws:
CommandException
ValidationException

getTableId

public TableId getTableId()
Returns the table Id.

Returns:
a table Id

setTableId

public void setTableId(TableId tableId)
Sets the table Id (required).

Parameters:
tableId - a table Id

getRecordIds

public RecordId[] getRecordIds()
Returns the record Ids to execute assignment on.

Returns:
record Ids

setRecordIds

public void setRecordIds(RecordId[] recordIds)
Sets the records to execute the assignment on (required).


getAssignmentId

public AssignmentId getAssignmentId()
Returns the assignment Id.

Returns:
an assignment Id

setAssignmentId

public void setAssignmentId(AssignmentId assignmentId)
Sets the assignment to execute (required).

Parameters:
assignmentId - an assignmentId

setSlice

public void setSlice(boolean isSlice)
Enable slicing during assignment.

Parameters:
isSlice - true to enable, false to disable
Since:
7.1 SP6

isSlice

public boolean isSlice()
Returns whether slicing is enabled.

Returns:
true to enable, false to disable
Since:
7.1 SP6

getFailedRecords

public RecordId[] getFailedRecords()
Returns the records that failed assignment.

Note: When slicing is enabled, records are divided into subsets. For a given subset of records, if a record failed the operation, the whole subset of records are marked as failed. It is not possible to determine which record in the subset triggered the failure.

Returns:
the list of failed records
Since:
7.1 SP6

getSucceededRecords

public RecordId[] getSucceededRecords()
Returns the records that were successfully assigned.

Returns:
the list of succeeded records
Since:
7.1 SP6

getReturnCode

public Integer getReturnCode(RecordId recordId)
Returns the reason the record failed assignment.

Parameters:
recordId - a record Id
Returns:
returns the return code for the failed record; if it's not a failed record, return null
Since:
7.1 SP6
See Also:
RC

isCommitOnWarning

public boolean isCommitOnWarning()
Indicates whether the record should be committed if the record failed the "warning" validations.

Returns:
true to commit, false otherwise
Since:
7.1 SP7

setCommitOnWarning

public void setCommitOnWarning(boolean isCommitOnWarning)
Indicates whether the record should be committed if the record failed the "warning" validations (optional). The default is true.

Note, when multiple records are specified, the behavior is as follow:

  • false - any record triggering a warned and/or error validation will terminate assignment for all records; no assignment was done for any of the records
  • true - any record triggering a error validation will terminate assignment for all records; no assignment was done for any of the records
In addition, the validation results returned by getValidationResult() will only contain the one record that triggered the validation failure. The other records that could had potentially triggered more validation failures are not included.

Parameters:
isCommitOnWarning - true to commit, false otherwise
Since:
7.1 SP7

getValidationResult

public ValidationResult getValidationResult()
Returns the validation results. See setCommitOnWarning(boolean) for limitations.

Returns:
validation results
Since:
7.1 SP7


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.