com.sap.mdm.validation.commands
Class RetrieveValidationsCommand

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.RetrieveValidationsCommand

All Implemented Interfaces:

Command

public class RetrieveValidationsCommand

extends AbstractUserSessionCommand

A command to retrieve the list of validation rules for the specified table.

Constructor Summary

RetrieveValidationsCommand(ConnectionAccessor connection)
Creates an instance of this command.

RetrieveValidationsCommand(UserSessionContext ctx)
Creates a new instance of this command by context.

Method Summary

void	execute() Executes the command.
TableId	getTableId() Retrieves the table Id.
ValidationPropertiesResult	getValidationPropertiesResult() Returns the validation properties for a table.
ValidationProperties[]	getValidations() Deprecated. replaced by getValidationPropertiesResult()
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

isCommandComplete

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

RetrieveValidationsCommand

public RetrieveValidationsCommand(ConnectionAccessor connection)

Creates an instance of this command.

Parameters:

connection - the connection to the server

RetrieveValidationsCommand

public RetrieveValidationsCommand(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()

Retrieves the table Id.

Returns:

the table Id

setTableId

public void setTableId(TableId tableId)

Sets the table Id (required). The list of validations retrieved will be for this table.

Parameters:

tableId - the table Id

getValidations

public ValidationProperties[] getValidations()

Deprecated. replaced by getValidationPropertiesResult()

Retrieves the list of validations for a table.

Returns:

a list of validations

getValidationPropertiesResult

public ValidationPropertiesResult getValidationPropertiesResult()

Returns the validation properties for a table.

Returns:

validation properties