com.adobe.livecycle.crc.sharepoint.client.types
Class SearchFilter

java.lang.Object
  com.adobe.livecycle.crc.sharepoint.client.types.SearchFilter

All Implemented Interfaces:

java.io.Externalizable, java.io.Serializable

public class SearchFilter
extends java.lang.Object
implements java.io.Externalizable

This filter allows you specify search criteria thereby paginating the Sharepoint search. This filter allows to set only range, offset, sort properties, trim duplicates

See Also:

Serialized Form

Field Summary

static long

serialVersionUID

Constructor Summary

SearchFilter()

Method Summary

int	getCount()
java.util.List	getSortByProperties()
int	getStartAt()
boolean	isTrimDuplicates()
void	readExternal(java.io.ObjectInput in)
void	setCount(int count)
void	setSortByProperties(java.util.List sortByProperties)
void	setStartAt(int startAt)
void	setTrimDuplicates(boolean trimDuplicates)
java.lang.String	toString() prints out the fields in the form of a query constructed later.
void	writeExternal(java.io.ObjectOutput out)

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

serialVersionUID

public static final long serialVersionUID

See Also:

Constant Field Values

Constructor Detail

SearchFilter

public SearchFilter()

Method Detail

writeExternal

public void writeExternal(java.io.ObjectOutput out)
                   throws java.io.IOException

Specified by:

writeExternal in interface java.io.Externalizable

Throws:

java.io.IOException

readExternal

public void readExternal(java.io.ObjectInput in)
                  throws java.io.IOException,
                         java.lang.ClassNotFoundException

Specified by:

readExternal in interface java.io.Externalizable

Throws:

java.io.IOException

java.lang.ClassNotFoundException

getStartAt

public int getStartAt()

Returns:

startAt

setStartAt

public void setStartAt(int startAt)

Parameters:

startAt - Specifies the offset of the results returned by the search query

See Also:

Default: 1

getCount

public int getCount()

Returns:

count

setCount

public void setCount(int count)

Parameters:

count - Specifies the maximum number of results to return by the search query

See Also:

Default: 10

getSortByProperties

public java.util.List getSortByProperties()

Returns:

sortByProperties

setSortByProperties

public void setSortByProperties(java.util.List sortByProperties)

Parameters:

sortByProperties - Contains information for sorting the search results returned by the search query

See Also:

If no sortByProperties are specified, then results will be sorted by Rank.

isTrimDuplicates

public boolean isTrimDuplicates()

Returns:

trimDuplicates

setTrimDuplicates

public void setTrimDuplicates(boolean trimDuplicates)

Parameters:

trimDuplicates - Specifies whether duplicates are removed before the search results are returned by the search query

See Also:

Default: false

toString

public java.lang.String toString()

prints out the fields in the form of a query constructed later.

Overrides:

toString in class java.lang.Object