com.sap.mdm.data.commands
Class RetrieveLimitedAttributeValuesCommand

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

public class RetrieveLimitedAttributeValuesCommand
extends AbstractUserSessionCommand

A command for retrieving the list of limited attribute values.

See Also:
RetrieveLimitedAttributesCommand

Constructor Summary
RetrieveLimitedAttributeValuesCommand(ConnectionAccessor connection)
          Creates an instance.
RetrieveLimitedAttributeValuesCommand(UserSessionContext ctx)
          Creates a new instance of this command by context.
 
Method Summary
 AttributeId getAttributeId()
          Returns the attribute Id.
 AttributeProperties[] getAttributes()
          Returns the attribute definitions.
 MdmValue[] getAttributeValues()
          Deprecated. replaced by getPickLists()
 PickList[] getPickLists()
          Returns the list of limited attributes.
 Search getSearch()
          Returns the search criteria.
 int getSearchTableMatchCount()
          Returns the match count for the search table, based on the search criteria.
 FieldId getTaxonomyFieldId()
          Returns the taxonomy field Id.
 boolean isRetrieveResultCounts()
          Returns true if result counts should be retrieved, otherwise returns false.
 void setAttributeId(AttributeId attributeId)
          Sets the attribute Id (optional).
 void setRetrieveResultCounts(boolean isRetrieveResultCounts)
          Specifies whether to retrieve result counts or not.
 void setSearch(Search search)
          Sets the search criteria (required).
 void setTaxonomyFieldId(FieldId taxonomyFieldId)
          Sets the taxonomy field 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

RetrieveLimitedAttributeValuesCommand

public RetrieveLimitedAttributeValuesCommand(ConnectionAccessor connection)
Creates an instance.

Parameters:
connection - the connection to the MDM server

RetrieveLimitedAttributeValuesCommand

public RetrieveLimitedAttributeValuesCommand(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

getTaxonomyFieldId

public FieldId getTaxonomyFieldId()
Returns the taxonomy field Id.

Returns:
the taxonomy field Id

setTaxonomyFieldId

public void setTaxonomyFieldId(FieldId taxonomyFieldId)
Sets the taxonomy field Id (required).

Parameters:
taxonomyFieldId - the taxonomy field Id

getAttributeId

public AttributeId getAttributeId()
Returns the attribute Id.

Returns:
the attribute Id

setAttributeId

public void setAttributeId(AttributeId attributeId)
Sets the attribute Id (optional). The default is to retrieve the limited values for all attributes.

Parameters:
attributeId - the attribute Id.

getPickLists

public PickList[] getPickLists()
Returns the list of limited attributes.

Returns:
the list of limited attributes
Since:
5.5 SP6 Patch 4

getAttributeValues

public MdmValue[] getAttributeValues()
Deprecated. replaced by getPickLists()

Retrieves the list of limited attribute values. If this command is setup to retrieve attribute values for multiple attributes, this method will a null. Please use getPickLists() instead.

Returns:
the list of limited attribute values

getAttributes

public AttributeProperties[] getAttributes()
Returns the attribute definitions.

Returns:
attribute definitions
Since:
5.5 SP6 Patch 04

getSearchTableMatchCount

public int getSearchTableMatchCount()
Returns the match count for the search table, based on the search criteria.

Returns:
the count

isRetrieveResultCounts

public boolean isRetrieveResultCounts()
Returns true if result counts should be retrieved, otherwise returns false.

Returns:
true if result counts should be retrieved, otherwise returns false
Since:
7.1 SP 3

setRetrieveResultCounts

public void setRetrieveResultCounts(boolean isRetrieveResultCounts)
Specifies whether to retrieve result counts or not.

Parameters:
isRetrieveResultCounts - true if result counts should be retrieved, otherwise returns false
Since:
7.1 SP 3


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.