com.sap.mdm.search
Class Search

java.lang.Object
  extended bycom.sap.mdm.search.SearchGroup
      extended bycom.sap.mdm.search.Search
All Implemented Interfaces:
Cloneable, SearchItem
Direct Known Subclasses:
TupleSearch

public class Search
extends SearchGroup
implements Cloneable

A search object specifying a set of criteria, mainly to limit down the number of records.


Nested Class Summary
 class Search.CheckOutSearchType
          Contains enumerations indicating how check out records are treated when searching for records.
 
Field Summary
static int STANDARD_OPERATOR
          Specifies an AND operation on the operands on the same level.
 
Fields inherited from class com.sap.mdm.search.SearchGroup
AND_OPERATOR, OR_OPERATOR
 
Fields inherited from interface com.sap.mdm.search.SearchItem
SEARCH, SEARCH_GROUP, SEARCH_PARAMETER
 
Constructor Summary
Search(TableId searchTableId)
          Constructor with the specified parameter.
 
Method Summary
 SearchItem addTupleFilteringItem(SearchGroup searchGroup)
          Adds a tuple filtering item.
 Object clone()
          Clones this object.
static Search deserialize(String value)
          Deserialize the string into a search object.
 boolean equals(Object obj)
           
 int getCheckoutSearchType()
          Returns the check out search type.
 int getFilteringGroupOperator()
          Returns the logical operator for the search group.
 int getRegionLayer()
          Returns the region layer.
 TableId getSearchTableId()
          Returns the search table Id.
 SearchItem[] getTupleFilteringItems()
          Get tuple filtering items.
 int getType()
          Returns the search item type.
 int hashCode()
           
 boolean isIncludeCheckoutRecords()
          Deprecated. replaced by getCheckoutSearchType()
 SearchItem removeTupleFilteringItem(int index)
          Removes the tuple filtering item from the list.
 String serialize()
          Serialize the search object into a string.
 void setCheckoutSearchType(int checkOutSearchType)
          Sets the check out search type (optional).
 void setFilteringGroupOperator(int operator)
          Sets the logical operator for tuple filtering criteria.
 void setIncludeCheckoutRecords(boolean isIncludeCheckoutRecords)
          Deprecated. replaced by setCheckoutSearchType(int)
 void setRegionLayer(int regionLayer)
          Specifies in which region layers the string is search in.
 String toString()
           
 
Methods inherited from class com.sap.mdm.search.SearchGroup
addSearchItem, addSearchItem, clear, getComparisonOperator, getSearchItem, getSearchItems, removeSearchItem, setComparisonOperator
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

STANDARD_OPERATOR

public static final int STANDARD_OPERATOR
Specifies an AND operation on the operands on the same level.

See Also:
SearchGroup, SearchGroup.AND_OPERATOR, Constant Field Values
Constructor Detail

Search

public Search(TableId searchTableId)
Constructor with the specified parameter.

Parameters:
searchTableId - the search table Id
Method Detail

addTupleFilteringItem

public SearchItem addTupleFilteringItem(SearchGroup searchGroup)
Adds a tuple filtering item.

Since:
7.1 SP9.

removeTupleFilteringItem

public SearchItem removeTupleFilteringItem(int index)
Removes the tuple filtering item from the list.

Parameters:
index - the index of the tuple filtering item
Returns:
filtering Item to be removed
Since:
7.1 SP9.

getTupleFilteringItems

public SearchItem[] getTupleFilteringItems()
Get tuple filtering items.

Returns:
the tuple filtering items
Since:
7.1 SP9.

setFilteringGroupOperator

public void setFilteringGroupOperator(int operator)
Sets the logical operator for tuple filtering criteria.

Parameters:
operator -
Since:
7.1 SP9.
  • AND_OPERATOR
  • OR_OPERATOR

  • getFilteringGroupOperator

    public int getFilteringGroupOperator()
    Returns the logical operator for the search group.

    Returns:
    the logical operator
  • AND_OPERATOR
  • OR_OPERATOR
    Since:
    7.1 SP9.

  • clone

    public Object clone()
    Description copied from interface: SearchItem
    Clones this object.

    Specified by:
    clone in interface SearchItem
    Overrides:
    clone in class SearchGroup

    equals

    public boolean equals(Object obj)
    Overrides:
    equals in class SearchGroup

    hashCode

    public int hashCode()
    Overrides:
    hashCode in class SearchGroup

    toString

    public String toString()
    Overrides:
    toString in class SearchGroup

    getType

    public int getType()
    Description copied from interface: SearchItem
    Returns the search item type.

    Specified by:
    getType in interface SearchItem
    Overrides:
    getType in class SearchGroup

    getSearchTableId

    public TableId getSearchTableId()
    Returns the search table Id.

    Returns:
    the search table Id

    isIncludeCheckoutRecords

    public boolean isIncludeCheckoutRecords()
    Deprecated. replaced by getCheckoutSearchType()

    Indicates the record set to search on includes checked out records or not.

    Returns:
    true to include checked out records, otherwise false
    Since:
    SP6 Patch 02

    setIncludeCheckoutRecords

    public void setIncludeCheckoutRecords(boolean isIncludeCheckoutRecords)
    Deprecated. replaced by setCheckoutSearchType(int)

    Indicates the record set to search on includes checked out records or not (optional). The default is false.

    Parameters:
    isIncludeCheckoutRecords - true to include checked out records, otherwise false
    Since:
    SP6 Patch 02

    getCheckoutSearchType

    public int getCheckoutSearchType()
    Returns the check out search type.

    Returns:
    the check out search type
    Since:
    7.1 SP5
    See Also:
    Search.CheckOutSearchType

    setCheckoutSearchType

    public void setCheckoutSearchType(int checkOutSearchType)
    Sets the check out search type (optional). The default is Search.CheckOutSearchType.STANDARD.

    Parameters:
    checkOutSearchType - the check out search type
    Since:
    7.1 SP5
    See Also:
    Search.CheckOutSearchType

    serialize

    public String serialize()
    Serialize the search object into a string. It's not meant for long term storage.

    Returns:
    the string representing the search object
    Since:
    SP6 Patch 02
    See Also:
    deserialize(String)

    deserialize

    public static Search deserialize(String value)
    Deserialize the string into a search object.

    Parameters:
    value - the string representation for the search object
    Returns:
    a search object
    Since:
    SP6 Patch 02
    See Also:
    serialize()

    getRegionLayer

    public int getRegionLayer()
    Returns the region layer.

    Returns:
    a region layer
    Since:
    SP6 Patch 02

    setRegionLayer

    public void setRegionLayer(int regionLayer)
    Specifies in which region layers the string is search in. It is use for multilingual text fields. Legal values are RegionalLayer.CURRENT and RegionalLayer.PRIMARY_INHERITED. The default is RegionalLayer.CURRENT.

    Parameters:
    regionLayer - a region layer
    Since:
    SP6 Patch 02


    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.