com.sap.mdm.data.commands
Class RetrieveLimitedQualifierValuesCommand

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

public class RetrieveLimitedQualifierValuesCommand
extends AbstractUserSessionCommand

Retrieves the limited list of qualifier values.


Constructor Summary
RetrieveLimitedQualifierValuesCommand(ConnectionAccessor connection)
          Creates an instance.
RetrieveLimitedQualifierValuesCommand(UserSessionContext ctx)
          Creates a new instance of this command by context.
 
Method Summary
 PickList getPickList()
          Returns the limited pick list.
 FieldId getQualifiedLookupFieldId()
          Returns the qualified lookup field Id.
 FieldId getQualifierFieldId()
          Returns the qualifier field Id.
 MdmValue[] getQualifierValues()
          Deprecated. replaced by getPickList()
 Search getSearch()
          Returns the search criteria.
 void setQualifiedLookupFieldId(FieldId qualifiedLookupFieldId)
          Sets the qualified lookup field Id (required).
 void setQualifierFieldId(FieldId qualifierFieldId)
          Sets the qualifier field Id (required).
 void setSearch(Search search)
          Sets the search criteria (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

RetrieveLimitedQualifierValuesCommand

public RetrieveLimitedQualifierValuesCommand(ConnectionAccessor connection)
Creates an instance.

Parameters:
connection - the connection to the MDM server

RetrieveLimitedQualifierValuesCommand

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

Parameters:
ctx - the user session context.
Method Detail

getSearch

public Search getSearch()
Returns the search criteria. The search criteria specifies the search table and what to search for.

Returns:
the search criteria

setSearch

public void setSearch(Search search)
Sets the search criteria (required). The search criteria specifies the search table and what to search for.

Parameters:
search - the search criteria

getQualifiedLookupFieldId

public FieldId getQualifiedLookupFieldId()
Returns the qualified lookup field Id.

Returns:
the qualified lookup field Id

setQualifiedLookupFieldId

public void setQualifiedLookupFieldId(FieldId qualifiedLookupFieldId)
Sets the qualified lookup field Id (required).

Parameters:
qualifiedLookupFieldId - the qualified lookup field Id

getQualifierFieldId

public FieldId getQualifierFieldId()
Returns the qualifier field Id.

Returns:
the qualifier field Id

setQualifierFieldId

public void setQualifierFieldId(FieldId qualifierFieldId)
Sets the qualifier field Id (required). The qualifier field should be a lookup field or a boolean field.

Parameters:
qualifierFieldId - the qualifier field Id

getQualifierValues

public MdmValue[] getQualifierValues()
Deprecated. replaced by getPickList()

Returns the list of limited qualifier values.

Returns:
qualifier values

getPickList

public PickList getPickList()
Returns the limited pick list.

Returns:
the limited pick list
Since:
5.5 SP6 Patch 03


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.