com.sap.mdm.data.commands
Class RetrieveLimitedAttributesCommand

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

public class RetrieveLimitedAttributesCommand
extends AbstractUserSessionCommand

A command for retrieving the list of limited attributes based on the search criteria.


Constructor Summary
RetrieveLimitedAttributesCommand(ConnectionAccessor connection)
          Creates an instance.
RetrieveLimitedAttributesCommand(UserSessionContext ctx)
          Creates a new instance of this command by context.
 
Method Summary
 int getAttributePriority()
          Returns the attribute priority to filter out.
 AttributeProperties[] getAttributes()
          Returns the list of limited attributes.
 Search getSearch()
          Returns the search criteria.
 SearchDimension getSearchDimension(int index)
          Returns the search dimension for the selected attribute specified by the index.
 int getSearchTableMatchCount()
          Returns the match count for the search table, based on the search criteria.
 FieldId getTaxonomyFieldId()
          Returns the taxonomy field Id.
 void setAttributePriority(int attributePriority)
          Sets the attribute priority to filter out (optional).
 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

RetrieveLimitedAttributesCommand

public RetrieveLimitedAttributesCommand(ConnectionAccessor connection)
Creates an instance.

Parameters:
connection - the connection to the MDM server

RetrieveLimitedAttributesCommand

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

getAttributes

public AttributeProperties[] getAttributes()
Returns the list of limited attributes.

Returns:
the list of limited attributes

getAttributePriority

public int getAttributePriority()
Returns the attribute priority to filter out.

Returns:
the attribute priority
See Also:
AttributeLink

setAttributePriority

public void setAttributePriority(int attributePriority)
Sets the attribute priority to filter out (optional). The default is the lowest priority.

Parameters:
attributePriority -
See Also:
AttributeLink

getSearchDimension

public SearchDimension getSearchDimension(int index)
Returns the search dimension for the selected attribute specified by the index. This is a convenient method for establishing a search dimension given an attribute is selected.

Parameters:
index - an index value
Returns:
a search dimension

getSearchTableMatchCount

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

Returns:
the count


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.