com.sap.mdm.validation.commands
Class ValidateRecordsCommand

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

public class ValidateRecordsCommand
extends AbstractRecordIdsCommand

Validates records in the MDM repository against the specified validation rules. The results of the validations execution specify which validation rule failed. The results also specify which record failed.

See Also:
ValidateNewRecordValuesCommand

Constructor Summary
ValidateRecordsCommand(ConnectionAccessor connection)
          Creates an instance of this command.
ValidateRecordsCommand(UserSessionContext ctx)
          Creates a new instance of this command by context.
 
Method Summary
 RecordId[] getFailedRecords()
          Returns the records that didn't validate.
 RecordId[] getRecordIds()
          Returns the list of records to validate.
 Integer getReturnCode(RecordId recordId)
          Returns the reason the record failed assignment.
 RecordId[] getSucceededRecords()
          Returns the records that were validated.
 TableId getTableId()
          Returns the table Id.
 ValidationId[] getValidationIds()
          Returns the list of validations.
 ValidationResult getValidationResult()
          Returns the validation result.
 boolean isSlice()
          Returns whether slicing is enabled.
 void setRecordIds(RecordId[] recordIds)
          Sets the list of records to validate (required).
 void setSlice(boolean isSlice)
          Enable slicing during record validation.
 void setTableId(TableId tableId)
          Sets the table Id (required).
 void setValidationIds(ValidationId[] validationIds)
          Sets the list of validations to validate the records against (optional).
 
Methods inherited from class com.sap.mdm.data.commands.AbstractRecordIdsCommand
addRecordId, clearRecordIds, containsRecordId, removeRecordId
 
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

ValidateRecordsCommand

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

Parameters:
connection - the connection to the MDM server

ValidateRecordsCommand

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

Parameters:
ctx - the user session context.
Method Detail

getTableId

public TableId getTableId()
Returns the table Id.

Returns:
a table Id

setTableId

public void setTableId(TableId tableId)
Sets the table Id (required). The records specified are from this table.

Parameters:
tableId - a table Id

getRecordIds

public RecordId[] getRecordIds()
Returns the list of records to validate.

Overrides:
getRecordIds in class AbstractRecordIdsCommand
Returns:
a list of records Ids

setRecordIds

public void setRecordIds(RecordId[] recordIds)
Sets the list of records to validate (required).

Overrides:
setRecordIds in class AbstractRecordIdsCommand
Parameters:
recordIds - a list of record Ids

getValidationIds

public ValidationId[] getValidationIds()
Returns the list of validations.

Returns:
a list of validation Ids

setValidationIds

public void setValidationIds(ValidationId[] validationIds)
Sets the list of validations to validate the records against (optional). If the validation Ids are not set, the automatic validation rules are used to validate the records.

Parameters:
validationIds - a list of validation Ids
See Also:
RetrieveValidationsCommand

getValidationResult

public ValidationResult getValidationResult()
Returns the validation result. The validation result specifies which records and validations failed.

Returns:
a validation result

setSlice

public void setSlice(boolean isSlice)
Enable slicing during record validation.

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

isSlice

public boolean isSlice()
Returns whether slicing is enabled.

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

getFailedRecords

public RecordId[] getFailedRecords()
Returns the records that didn't validate. It doesn't indicate the records failed record validations, i.e. invalid record Id. Use getValidationResult() to determine if a record pass validation or not.

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 SP7

getSucceededRecords

public RecordId[] getSucceededRecords()
Returns the records that were validated. It doesn't indicate the records successfully pass record validations. Use getValidationResult() to determine if a record pass validation or not.

Returns:
the list of succeeded records
Since:
7.1 SP7

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 SP7
See Also:
RC


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.