com.sap.mdm.validation.commands
Class ValidateRecordsCommand

java.lang.Object
  com.sap.mdm.commands.AbstractCommandBase
      com.sap.mdm.commands.AbstractCommand
          com.sap.mdm.session.AbstractSessionCommand
              com.sap.mdm.session.AbstractUserSessionCommand
                  com.sap.mdm.validation.commands.ValidateRecordsCommand

All Implemented Interfaces:

Command

public class ValidateRecordsCommand

extends AbstractUserSessionCommand

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

void	execute() Executes the command.
RecordId[]	getRecordIds() Returns the list of records to validate.
TableId	getTableId() Returns the table Id.
ValidationId[]	getValidationIds() Returns the list of validations.
ValidationResult	getValidationResult() Returns the validation result.
void	setRecordIds(RecordId[] recordIds) Sets the list of records to validate (required).
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.commands.AbstractCommand

getSession, setSession

Methods inherited from class com.sap.mdm.commands.AbstractCommandBase

isCommandComplete

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

execute

public void execute()
             throws CommandException

Description copied from interface: Command

Executes the command.

Throws:

CommandException - if there is an error in executing the command.

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.

Returns:

a list of records Ids

setRecordIds

public void setRecordIds(RecordId[] recordIds)

Sets the list of records to validate (required).

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