com.fatwire.assetapi.query

Class QueryProperties

java.lang.Object

com.fatwire.assetapi.query.QueryProperties

@Exported
public final class QueryProperties
extends Object

This class defines property keys and values for Query

Constructor Summary

Constructors

Constructor and Description
QueryProperties()

Method Summary

Modifier and Type	Method and Description
float	getConfidence() Gets the confidence sepcified for richtext search
boolean	getIsBasicSearch() Gets if to use Asset.Search for flex asset type, default to be false if the value is not set by the setter method.
boolean	getIsCaseSensitive() Gets whether the flex asset search is case sensitive or not, default to be false if the value is not set by the setter method.
boolean	getIsImmediateOnly() Gets whether to only retrieve the immediate attribute values from flex asset attributes, default value is true
boolean	getIsLowerEqual() Gets whether the lower bound contains equal or not for range search, default to be false if the value is not set by the setter method.
boolean	getIsUpperEqual() Gets whether the upper bound contains equal or not for range search, default to be false if the value is not set by the setter method.
int	getLoadDependency() Gets what kind of depency to log when loading assets returned from Query
int	getMaxAnswers() Gets the max answers specified for richtext search
int	getMaxRows() Gets the max number of items the query wants to return
String	getParser() Gets the search-engine dependent parser for richtext search.
Long	getSite() Gets the site id for the Query
int	getStartIndex() Gets the starting index to limit items returned by query
boolean	isFixedList() Gets whether search contains a set of assets whose identities will not change.
boolean	isReadAll() Gets whether all the attributes of the assettype/subtype will be read
void	setConfidence(float fConfidence) Sets the confidence value for richtext search
void	setFixedList(boolean isFixedList) Sets whether search contains a set of assets whose identities will not change.
void	setIsBasicSearch(boolean bIsBasicSearch) Specifies whether to use Asset.Search for flex asset type
void	setIsCaseSensitive(boolean bIsCaseSensitive) Specifies whether the flex asset search is case sensitive or not
void	setIsImmediateOnly(boolean bIsImmediateOnly) Specifies whether to only retrieve the immediate attribute values from flex asset attributes
void	setIsLowerEqual(boolean bIsLowerEqual) Specifies whether the lower bound contains equal or not for range search
void	setIsUpperEqual(boolean bIsUpperEqual) Specifies whether the upper bound contains equal or not for range search
void	setLoadDependency(int loadDependency) Sets the load dependency for the assets that would be returned by the Query
void	setMaxAnswers(int iMaxAnswers) Sets the maxAnswers value for richtext search
void	setMaxRows(int iMaxRows) set the max number of items to return from the query
void	setParser(String sParser) Sets the search-engine dependent parser for richtext search.
void	setReadAll(boolean readAll) Sets whether all the attributes of the assettype/subtype will be read
void	setSite(Long site) Sets the site id for the query
void	setStartIndex(int startIndex) Sets the starting index to limit items returned by query

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

QueryProperties

public QueryProperties()

Method Detail

getMaxRows

public int getMaxRows()

Gets the max number of items the query wants to return

Returns:

the max number of items

setMaxRows

public void setMaxRows(int iMaxRows)

set the max number of items to return from the query

Parameters:

iMaxRows - the number

getIsBasicSearch

public boolean getIsBasicSearch()

Gets if to use Asset.Search for flex asset type, default to be false if the value is not set by the setter method.

Returns:

true indicates using Asset.Search, false indicates not using Asset.Search

setIsBasicSearch

public void setIsBasicSearch(boolean bIsBasicSearch)

Specifies whether to use Asset.Search for flex asset type

Parameters:

bIsBasicSearch - true indicates using Asset.Search, false indicates not using Asset.Search

getIsLowerEqual

public boolean getIsLowerEqual()

Gets whether the lower bound contains equal or not for range search, default to be false if the value is not set by the setter method.

Returns:

true indicates lower bound contains equal, false indicates lower bound does not contain equal

setIsLowerEqual

public void setIsLowerEqual(boolean bIsLowerEqual)

Specifies whether the lower bound contains equal or not for range search

Parameters:

bIsLowerEqual - true indicates lower bound contains equal, false indicates lower bound does not contain equal

getIsUpperEqual

public boolean getIsUpperEqual()

Gets whether the upper bound contains equal or not for range search, default to be false if the value is not set by the setter method.

Returns:

true indicates upper bound contains equal, false indicates upper bound does not contain equal

setIsUpperEqual

public void setIsUpperEqual(boolean bIsUpperEqual)

Specifies whether the upper bound contains equal or not for range search

Parameters:

bIsUpperEqual - true indicates upper bound contains equal, false indicates upper bound does not contain equal

getIsCaseSensitive

public boolean getIsCaseSensitive()

Gets whether the flex asset search is case sensitive or not, default to be false if the value is not set by the setter method.

Returns:

true indicates the flex asset search is case sensitive, false indicates it is not

setIsCaseSensitive

public void setIsCaseSensitive(boolean bIsCaseSensitive)

Specifies whether the flex asset search is case sensitive or not

Parameters:

bIsCaseSensitive - true indicates the flex asset search is case sensitive, false indicates it is not

getIsImmediateOnly

public boolean getIsImmediateOnly()

Gets whether to only retrieve the immediate attribute values from flex asset attributes, default value is true

Returns:

true only retrieve the child attribute value, false means retrieving the inherited parent values too

setIsImmediateOnly

public void setIsImmediateOnly(boolean bIsImmediateOnly)

Specifies whether to only retrieve the immediate attribute values from flex asset attributes

Parameters:

bIsImmediateOnly - true only retrieve the child attribute value, false means retrieving the inherited parent values too

getParser

public String getParser()

Gets the search-engine dependent parser for richtext search. Default is null.

Returns:

the String parser name

setParser

public void setParser(String sParser)

Sets the search-engine dependent parser for richtext search. Applies only when getIsBasicSearch() is false.

Parameters:

sParser - the parser name

getConfidence

public float getConfidence()

Gets the confidence sepcified for richtext search

Returns:

the confidence value

setConfidence

public void setConfidence(float fConfidence)

Sets the confidence value for richtext search

Parameters:

fConfidence - the float value fo the confidence

getMaxAnswers

public int getMaxAnswers()

Gets the max answers specified for richtext search

Returns:

the value of maxAnswers

setMaxAnswers

public void setMaxAnswers(int iMaxAnswers)

Sets the maxAnswers value for richtext search

Parameters:

iMaxAnswers - the int value of the maxAnswers

getLoadDependency

public int getLoadDependency()

Gets what kind of depency to log when loading assets returned from Query

Returns:

the value of the dependency

setLoadDependency

public void setLoadDependency(int loadDependency)

Sets the load dependency for the assets that would be returned by the Query

Parameters:

loadDependency - the value of the dependency

getSite

public Long getSite()

Gets the site id for the Query

Returns:

the site id

setSite

public void setSite(Long site)

Sets the site id for the query

Parameters:

site - the site id

isReadAll

public boolean isReadAll()

Gets whether all the attributes of the assettype/subtype will be read

Returns:

true indicates all the attributes will be read; false indicates the attributes will be specified in the query

setReadAll

public void setReadAll(boolean readAll)

Sets whether all the attributes of the assettype/subtype will be read

Parameters:

readAll - true indicates all the attributes will be read; false indicates the attributes will be specified in the query

getStartIndex

public int getStartIndex()

Gets the starting index to limit items returned by query

Returns:

starting index

setStartIndex

public void setStartIndex(int startIndex)

Sets the starting index to limit items returned by query

Parameters:

startIndex - the number

isFixedList

public boolean isFixedList()

Gets whether search contains a set of assets whose identities will not change. Only applies when setIsBasicSearch(false).

Returns:

indicates whether list of assets not expected to change.

setFixedList

public void setFixedList(boolean isFixedList)

Sets whether search contains a set of assets whose identities will not change. Only applies when setIsBasicSearch(false). Setting to true will also prevent the logging of unknown dependencies.

Parameters:

isFixedList - default is false.