com.sap.mdm.validation.commands
Class RetrieveValidationsCommand

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

public class RetrieveValidationsCommand
extends AbstractUserSessionCommand

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


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
 TableId getTableId()
          Retrieves the table Id.
 TupleDefinitionId getTupleDefinitionId()
          Retrieves the tuple definition Id.
 ValidationPropertiesResult getValidationPropertiesResult()
          Returns the validation properties for a table.
 ValidationProperties[] getValidations()
          Deprecated. replaced by getValidationPropertiesResult()
 boolean isIncludeLinkedTupleValidations()
          Returns a boolean indicating if the command is set to retrieve tuple validations linked to the table specified by the setTableId(TableId) method.
 void setIncludeLinkedTupleValidations(boolean includeLinkedTupleValidations)
          Specifies whether to retrieve tuple validations linked to the specified table (optional).
 void setTableId(TableId tableId)
          Sets the table Id (required*).
 void setTupleDefinitionId(TupleDefinitionId tupleDefinitionId)
          Sets the tuple definition Id (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

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

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

getTupleDefinitionId

public TupleDefinitionId getTupleDefinitionId()
Retrieves the tuple definition Id.

Returns:
the tuple definition Id
Since:
7.1

setTupleDefinitionId

public void setTupleDefinitionId(TupleDefinitionId tupleDefinitionId)
Sets the tuple definition Id (required*). The list of validations retrieved will be for this tuple definition.

Parameters:
tupleDefinitionId - the tuple definition Id
Since:
7.1

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

isIncludeLinkedTupleValidations

public boolean isIncludeLinkedTupleValidations()
Returns a boolean indicating if the command is set to retrieve tuple validations linked to the table specified by the setTableId(TableId) method.

Returns:
True if set to retrieve tuple validations, otherwise false
Since:
7.1 SP08

setIncludeLinkedTupleValidations

public void setIncludeLinkedTupleValidations(boolean includeLinkedTupleValidations)
Specifies whether to retrieve tuple validations linked to the specified table (optional). Default is false.

Note:

This method will only work if setTableId(TableId) is used.

Parameters:
includeLinkedTupleValidations - a boolean specifying whether to retrieve tuple validations
Since:
7.1 SP08


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.