com.ibm.commerce.foundation.server.services.dataaccess

Class SelectionCriteria

  • java.lang.Object
    • com.ibm.commerce.foundation.server.services.dataaccess.SelectionCriteria
  • Direct Known Subclasses:
    SearchExpression


    public class SelectionCriteria
    extends java.lang.Object

    The search expression object represents the information that can be extracted from the Expression elements of the Get verb. The Expression indicates the search expression to perform using an extended XPath notation to indicate the search criteria. The search criteria is composed of a XPath expression that represents the logical model with addition control parameters that will influence the search results.

    This object is used when processing Get requests.

    .
    • Field Summary

      Fields 
      Modifier and Type Field and Description
      static java.lang.String COPYRIGHT
      IBM Copyright notice field.
    • Constructor Summary

      Constructors 
      Constructor and Description
      SelectionCriteria()
      Creates an instance of the search expression object.
      SelectionCriteria(java.lang.String astrXPath, java.lang.String astrComponentId)
      Creates an instance of the search expression object for a given XPath expression.
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method and Description
      java.lang.String getAccessProfile()
      This method returns the access profile that has been specified in the search expression.
      java.lang.String getComponentId()
      Gets the component identifier.
      java.util.Map getControlParameters()
      This method returns the additional control parameters that are found in the XPath search expression.
      java.math.BigInteger getPagingMaxItems()
      This method returns the paging information that specifies the maximum items to return as part of the search expression.
      java.lang.String getPagingRecordSetReferenceId()
      Returns a paging reference identifier for a paging request.
      java.lang.Boolean getPagingRecordSetSaveIndicator()
      This method returns the paging information of whether to cache the results of the query because a simular query may be executed later to retrieve the next page of items.
      java.math.BigInteger getPagingRecordSetStartNumber()
      This method returns the index of the first record to be retrieved from the query result set.
      java.lang.Boolean getPagingUniqueIndicator()
      This method returns the paging information of the unique indicator.
      java.util.List getSearchAttributes()
      Reserved for IBM internal use.
      java.lang.String getSearchProfile()
      This method returns name of the search profile in the current search request.
      java.lang.String getXPath()
      This method returns the XPath expression of the expression to execute.
      java.lang.String getXPathKey()
      This method returns the key representation of the XPath expression.
      java.util.Map getXPathParameters()
      This method returns the XPath parameters.
      SearchParameters getXPathSearchParameters()
      Returns the parameters of the search() function when specified in the first predicate of the XPath expression.
      void setAccessProfile(java.lang.String accessProfile)
      This method sets the access profile that has been specified in the the search expression.
      void setComponentId(java.lang.String componentId)
      Sets the component identifier.
      void setControlParameters(java.util.Map controlParameters)
      This method sets the additional control parameters of the search expression.
      void setPagingMaxItems(java.math.BigInteger pagingMaxItems)
      This method sets the paging information that specifies the maximun number of items to return.
      void setPagingRecordSetReferenceId(java.lang.String pagingRecordSetReferenceId)
      Sets the paging reference identifier to resolve resolve paging information on the subsequent requests.
      void setPagingRecordSetSaveIndicator(java.lang.Boolean pagingRecordSetSaveIndicator)
      This method sets the paging information on whether to save the query results because the next page of information may be requested in the immediate future.
      void setPagingRecordSetStartNumber(java.math.BigInteger pagingRecordSetStartNumber)
      This method sets the index of the first record to be retrieved from the query result set.
      void setPagingUniqueIndicator(java.lang.Boolean pagingUniqueIndicator)
      This method sets the paging information of the unique indicator.
      void setSearchAttributes(java.util.List searchAttrs)
      Reserved for IBM internal use.
      void setSearchProfile(java.lang.String searchProfile)
      This method sets the search profile specified in the search expression.
      void setXPath(java.lang.String astrXPath)
      This method sets the XPath expression to execute.
      void setXPathKey(java.lang.String pathKey)
      This method sets the key representation of the XPath search expression.
      void setXPathParameter(RelationalExpression aParameter)
      This method sets an XPath parameter.
      void setXPathParameters(java.util.Map aXPathParameters)
      This method sets the XPath parameters found with the XPath expression.
      void setXPathSearchParameters(SearchParameters aSearchParameters)
      Sets the parameters of the search() function when specified in the first predicate of the XPath expression.
      java.io.Serializable toCacheKeyString()
      Returns a string that can be used as a cache key for the search expression.
      java.lang.String toString()
      Returns a String object representing this SelectionCriteria object.
      • Methods inherited from class java.lang.Object

        equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
    • Field Detail

      • COPYRIGHT

        public static final java.lang.String COPYRIGHT
        IBM Copyright notice field.
        See Also:
        Constant Field Values
    • Constructor Detail

      • SelectionCriteria

        public SelectionCriteria()
        Creates an instance of the search expression object.
      • SelectionCriteria

        public SelectionCriteria(java.lang.String astrXPath,
                                 java.lang.String astrComponentId)
        Creates an instance of the search expression object for a given XPath expression.
        Parameters:
        astrXPath - - XPath expression
        astrComponentId - - component identifier
    • Method Detail

      • getSearchProfile

        public java.lang.String getSearchProfile()
        This method returns name of the search profile in the current search request.
        Returns:
        The search profile name
      • setSearchProfile

        public void setSearchProfile(java.lang.String searchProfile)
        This method sets the search profile specified in the search expression.
        Parameters:
        searchProfile - the search profile
      • getAccessProfile

        public java.lang.String getAccessProfile()
        This method returns the access profile that has been specified in the search expression. The access profile is a special control parameter found in the expression.
        Returns:
        The access profile of the search expression.
      • setAccessProfile

        public void setAccessProfile(java.lang.String accessProfile)
        This method sets the access profile that has been specified in the the search expression.
        Parameters:
        accessProfile - The access profile that has been specified.
      • getControlParameters

        public java.util.Map getControlParameters()
        This method returns the additional control parameters that are found in the XPath search expression.
        Returns:
        The additional control parameters.
      • setControlParameters

        public void setControlParameters(java.util.Map controlParameters)
        This method sets the additional control parameters of the search expression.
        Parameters:
        controlParameters - Additional search expression control parameters.
      • getPagingMaxItems

        public java.math.BigInteger getPagingMaxItems()
        This method returns the paging information that specifies the maximum items to return as part of the search expression.
        Returns:
        The maximun number of nouns to return.
      • setPagingMaxItems

        public void setPagingMaxItems(java.math.BigInteger pagingMaxItems)
        This method sets the paging information that specifies the maximun number of items to return.
        Parameters:
        pagingMaxItems - The maximun number of items to return.
      • getPagingRecordSetSaveIndicator

        public java.lang.Boolean getPagingRecordSetSaveIndicator()
        This method returns the paging information of whether to cache the results of the query because a simular query may be executed later to retrieve the next page of items.
        Returns:
        Whether the query can be cached because the next page of information can be requested in the immediate future.
      • setPagingRecordSetSaveIndicator

        public void setPagingRecordSetSaveIndicator(java.lang.Boolean pagingRecordSetSaveIndicator)
        This method sets the paging information on whether to save the query results because the next page of information may be requested in the immediate future.
        Parameters:
        pagingRecordSetSaveIndicator - Whether the next page of information is retrieved in the immediate future.
      • getPagingRecordSetStartNumber

        public java.math.BigInteger getPagingRecordSetStartNumber()
        This method returns the index of the first record to be retrieved from the query result set.
        Returns:
        The index of the first record to be returned
      • setPagingRecordSetStartNumber

        public void setPagingRecordSetStartNumber(java.math.BigInteger pagingRecordSetStartNumber)
        This method sets the index of the first record to be retrieved from the query result set.
        Parameters:
        pagingRecordSetStartNumber - The index of the first record to be returned
      • getPagingUniqueIndicator

        public java.lang.Boolean getPagingUniqueIndicator()
        This method returns the paging information of the unique indicator.
        Returns:
        The unique idicator.
      • setPagingUniqueIndicator

        public void setPagingUniqueIndicator(java.lang.Boolean pagingUniqueIndicator)
        This method sets the paging information of the unique indicator.
        Parameters:
        pagingUniqueIndicator - The unique indicator.
      • getXPath

        public java.lang.String getXPath()
        This method returns the XPath expression of the expression to execute.
        Returns:
        The XPath expression to execute.
      • setXPath

        public void setXPath(java.lang.String astrXPath)
        This method sets the XPath expression to execute.
        Parameters:
        astrXPath - The XPath search expression.
      • getXPathKey

        public java.lang.String getXPathKey()
        This method returns the key representation of the XPath expression.
        Returns:
        The key representation of the XPath search expression.
      • setXPathKey

        public void setXPathKey(java.lang.String pathKey)
        This method sets the key representation of the XPath search expression.
        Parameters:
        pathKey - The XPath search expression key.
      • getSearchAttributes

        public java.util.List getSearchAttributes()
        Reserved for IBM internal use.
        Returns:
        list of search parameters
      • setSearchAttributes

        public void setSearchAttributes(java.util.List searchAttrs)
        Reserved for IBM internal use.
        Parameters:
        searchAttrs -
      • getXPathParameters

        public java.util.Map getXPathParameters()
        This method returns the XPath parameters.
        Returns:
        A map of parameters represented by the RelationalExpression objects keyed by the parameter name.
      • setXPathParameters

        public void setXPathParameters(java.util.Map aXPathParameters)
        This method sets the XPath parameters found with the XPath expression.
        Parameters:
        aXPathParameters - A map of parameters represented by the RelationalExpression objects keyed by the parameter name
      • setXPathParameter

        public void setXPathParameter(RelationalExpression aParameter)
        This method sets an XPath parameter.
        Parameters:
        aParameter - - XPath parameter
      • getPagingRecordSetReferenceId

        public java.lang.String getPagingRecordSetReferenceId()
        Returns a paging reference identifier for a paging request. This identifier is used resolve paging information on a subsequent request.
        Returns:
        the reference id of the paging record set
      • setPagingRecordSetReferenceId

        public void setPagingRecordSetReferenceId(java.lang.String pagingRecordSetReferenceId)
        Sets the paging reference identifier to resolve resolve paging information on the subsequent requests.
        Parameters:
        pagingRecordSetReferenceId - the reference id of the paging record set
      • getXPathSearchParameters

        public SearchParameters getXPathSearchParameters()
        Returns the parameters of the search() function when specified in the first predicate of the XPath expression.
        Returns:
        SearchParameters object
      • setXPathSearchParameters

        public void setXPathSearchParameters(SearchParameters aSearchParameters)
        Sets the parameters of the search() function when specified in the first predicate of the XPath expression.
        Parameters:
        aSearchParameters - - search parameters
      • setComponentId

        public final void setComponentId(java.lang.String componentId)
        Sets the component identifier.
        Parameters:
        componentId - - component identifier
      • getComponentId

        public final java.lang.String getComponentId()
        Gets the component identifier.
        Returns:
        component identifier
      • toString

        public java.lang.String toString()
        Returns a String object representing this SelectionCriteria object.
        Overrides:
        toString in class java.lang.Object
        Returns:
        string representation
      • toCacheKeyString

        public java.io.Serializable toCacheKeyString()
        Returns a string that can be used as a cache key for the search expression.
        Returns:
        the cache key string.