com.stellent.cis.client.api.scs.user
Interface ISCSSavedSearch

All Superinterfaces:

ICISObject, ICISObjectInitializable, ICISSavedSearch, ISCSObject, java.io.Serializable

public interface ISCSSavedSearch
extends ICISSavedSearch, ISCSObject

Nested Class Summary

Nested classes/interfaces inherited from interface com.stellent.cis.client.api.common.ICISObjectInitializable

ICISObjectInitializable.AdapterVersionAware

Field Summary

Fields inherited from interface com.stellent.cis.client.api.common.ICISObject

FILTER_NULL_VALUE, FILTER_READONLY, FILTER_SYSTEM

Fields inherited from interface com.stellent.cis.client.api.common.ICISObject

FILTER_NULL_VALUE, FILTER_READONLY, FILTER_SYSTEM

Method Summary

java.lang.String	getDescription() Get the description of the saved search.
java.lang.String	getName() Get the name of the saved search
java.lang.String	getQuery()
int	getResultCount()
java.lang.String	getSortField()
java.lang.String	getSortOrder()
void	setDescription(java.lang.String description) Set the description
void	setName(java.lang.String name) Set the name of the saved search
void	setQuery(java.lang.String query) Set the content server query
void	setResultCount(int resultCount) Set the result count
void	setSortField(java.lang.String sortField) Set the field to sort on
void	setSortOrder(java.lang.String sortOrder)

Methods inherited from interface com.stellent.cis.client.api.common.ICISObject

getProperties, getPropertiesWithValue, getProperty, getPropertyAsString, getPropertyAsString, getPropertyDescriptors, hasProperty, setProperty, setProperty, setProperty

Methods inherited from interface com.stellent.cis.client.api.scs.ISCSObject

castObject, clearPropertyFilter, copyObject, getPropertyFilter, getSourceAdapter, getSourceObject, getSourceObjectPropertyType, mergeObject, mergeObject, removeProperty, setPropertyFilter, setRestrictedPropertyFilter, setSourceObjectPropertyType

Methods inherited from interface com.stellent.cis.client.api.common.ICISObject

getProperties, getPropertiesWithValue, getProperty, getPropertyAsString, getPropertyAsString, getPropertyDescriptors, hasProperty, setProperty, setProperty, setProperty

Methods inherited from interface com.stellent.cis.client.api.common.ICISObjectInitializable

intialize

Method Detail

getName

java.lang.String getName()

Description copied from interface: ICISSavedSearch

Get the name of the saved search

Specified by:

getName in interface ICISSavedSearch

Returns:

the name of the saved search

setName

void setName(java.lang.String name)

Set the name of the saved search

Parameters:

name - the unique search name

getDescription

java.lang.String getDescription()

Description copied from interface: ICISSavedSearch

Get the description of the saved search.

Specified by:

getDescription in interface ICISSavedSearch

Returns:

the description of the saved search

setDescription

void setDescription(java.lang.String description)

Set the description

Parameters:

description - the search description

getQuery

java.lang.String getQuery()

Returns:

the content server query

setQuery

void setQuery(java.lang.String query)

Set the content server query

Parameters:

query - the query

getSortField

java.lang.String getSortField()

Returns:

the sort field

setSortField

void setSortField(java.lang.String sortField)

Set the field to sort on

Parameters:

sortField - the sort field

getSortOrder

java.lang.String getSortOrder()

Returns:

the sort order

setSortOrder

void setSortOrder(java.lang.String sortOrder)

Parameters:

sortOrder - the sort order

getResultCount

int getResultCount()

Returns:

the number of results to return

setResultCount

void setResultCount(int resultCount)

Set the result count

Parameters:

resultCount - the number of results for this query