com.sap.mdm.search
Class Search

java.lang.Object
  com.sap.mdm.search.SearchGroup
      com.sap.mdm.search.Search

All Implemented Interfaces:

java.lang.Cloneable, SearchItem

public class Search

extends SearchGroup

implements java.lang.Cloneable

A search object specifying a set of criteria, mainly to limit down the number of 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

java.lang.Object	clone() Clones this object.
static Search	deserialize(java.lang.String value) Deserialize the string into a search object.
boolean	equals(java.lang.Object obj)
int	getRegionLayer() Returns the region layer.
TableId	getSearchTableId() Returns the search table Id.
int	getType() Returns the search item type.
int	hashCode()
boolean	isIncludeCheckoutRecords() Indicates the record set to search on includes checked out records or not.
java.lang.String	serialize() Serialize the search object into a string.
void	setIncludeCheckoutRecords(boolean isIncludeCheckoutRecords) Indicates the record set to search on includes checked out records or not (optional).
void	setRegionLayer(int regionLayer) Specifies in which region layers the string is search in.
java.lang.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

clone

public java.lang.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(java.lang.Object obj)

Overrides:

equals in class SearchGroup

hashCode

public int hashCode()

Overrides:

hashCode in class SearchGroup

toString

public java.lang.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()

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)

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

serialize

public java.lang.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(java.lang.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