atg.search.routing.command.search
Class Validation

java.lang.Object
  atg.search.routing.command.SearchXMLObject
      atg.search.routing.command.search.Validation

All Implemented Interfaces:

java.io.Serializable

public class Validation
extends atg.search.routing.command.SearchXMLObject
implements java.io.Serializable

Various checks on the validity of the request given the content

See Also:

Serialized Form

Field Summary

static java.lang.String

CLASS_VERSION Class version string

Constructor Summary

Validation()

Method Summary

boolean	equals(java.lang.Object pObject)
protected static Validation	fromXmlParser(atg.search.routing.utils.SearchMessageNode pXml)
java.util.List<ActiveSentenceZoneValidation>	getActiveSentenceZones() Returns indications of whether the activeSentenceZones relQuestSetting is set to a correctly when unstructured content is indexed
java.util.List<ActiveSolutionZoneValidation>	getActiveSolutionZones() Returns indications of whether the activeSolutionZones relQuestSetting is set to a correctly when structured content is indexed
protected void	getBodyXML(java.lang.StringBuilder sb)
java.util.List<ContextValidation>	getContexts() Returns indicators of whether the context option is set properly when dictionary adaptors are loaded
java.util.List<DocSortPropValidation>	getDocSortProps() Returns indicators of whether the docSortProp attribute is set to a valid property in the content
java.util.List<PropValidation>	getProps() Returns a List of validations where each indicates whether the property constraints refer to valid properties in the indexed content
java.util.List<RankConfigValidation>	getRankConfigs() Returns indicators of whether the rankConfig attribute is set properly when rank configurations are loaded
java.util.List<RankFormulaValidation>	getRankFormulas() Returns indicators of whether the ranking formula refers to valid properties in the content
java.util.List<RefineConfigValidation>	getRefineConfigs() Returns indicators of whether the refineConfig attribute is set properly when refine configurations are loaded
java.util.List<RefineElementValidation>	getRefineElements() Returns indicators of whether the refine configuration refers to valid properties in the content
java.lang.String	getRequestTag()
java.util.List<RuleModeValidation>	getRuleModes() Returns indicators of whether the ruleMode attribute is enabled (exec) when there are query rules loaded
java.util.List<SetValidation>	getSets() Returns a List of validations where each indicates whether the set constraints refer to valid document sets in the indexed content
java.util.List<SortPropValidation>	getSortProps() Returns indicators of whether the sortProp attribute is set to a valid property in the content
java.util.List<TargetLanguageValidation>	getTargetLanguages() Returns indicators of whether the targetLanguage option refers to a language with indexed content
int	hashCode()
void	setActiveSentenceZones(java.util.List<ActiveSentenceZoneValidation> pActiveSentenceZones) Sets indications of whether the activeSentenceZones relQuestSetting is set to a correctly when unstructured content is indexed
void	setActiveSolutionZones(java.util.List<ActiveSolutionZoneValidation> pActiveSolutionZones) Sets indicators of whether the activeSolutionZones relQuestSetting is set to a correctly when structured content is indexed
void	setContexts(java.util.List<ContextValidation> pContexts) Sets indicators of whether the context option is set properly when dictionary adaptors are loaded
void	setDocSortProps(java.util.List<DocSortPropValidation> pDocSortProps) Sets indicators of whether the docSortProp attribute is set to a valid property in the content
void	setProps(java.util.List<PropValidation> pProps) Sets the list of property validations
void	setRankConfigs(java.util.List<RankConfigValidation> pRankConfigs) Sets indicators of whether the rankConfig attribute is set properly when rank configurations are loaded
void	setRankFormulas(java.util.List<RankFormulaValidation> pRankFormulas) Sets indicators of whether the ranking formula refers to valid properties in the content
void	setRefineConfigs(java.util.List<RefineConfigValidation> pRefineConfigs) Sets indicators of whether the refineConfig attribute is set properly when refine configurations are loaded
void	setRefineElements(java.util.List<RefineElementValidation> pRefineElements) Sets indicators of whether the refine configuration refers to valid properties in the content
void	setRuleModes(java.util.List<RuleModeValidation> pRuleModes) Sets indicators of whether the ruleMode attribute is enabled (exec) when there are query rules loaded
void	setSets(java.util.List<SetValidation> pSets) Sets a List of validations where each indicates whether the set constraints refer to valid document sets in the indexed content
void	setSortProps(java.util.List<SortPropValidation> pSortProps) Sets the indicators of whether the sortProp attribute is set to a valid property in the content
void	setTargetLanguages(java.util.List<TargetLanguageValidation> pTargetLanguages) Sets indicators of whether the targetLanguage option refers to a language with indexed content

Methods inherited from class atg.search.routing.command.SearchXMLObject

appendComplexXml, appendOptionalAttr, appendOptionalElem, appendOptionalElem, appendOptionalElem, appendOptionalValue, appendRequiredAttr, appendRequiredElem, appendRequiredElem, appendRequiredValue, getAllAttributeXML, getAllBodyXML, getAttributeXML, getDefaultXmlBytes, getParentXMLObject, getXmlPath, isPrintedFirstChild, setParentXMLObject, setPrintedFirstChild, toString, toXML, toXML

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

CLASS_VERSION

public static java.lang.String CLASS_VERSION

Class version string

Constructor Detail

Validation

public Validation()

Method Detail

equals

public boolean equals(java.lang.Object pObject)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

getSets

public java.util.List<SetValidation> getSets()

Returns a List of validations where each indicates whether the set constraints refer to valid document sets in the indexed content

Returns:

List of validations where each indicates whether the set constraints refer to valid document sets in the indexed content

setSets

public void setSets(java.util.List<SetValidation> pSets)

Sets a List of validations where each indicates whether the set constraints refer to valid document sets in the indexed content

Parameters:

pSets - List of validations where each indicates whether the set constraints refer to valid document sets in the indexed content

getProps

public java.util.List<PropValidation> getProps()

Returns a List of validations where each indicates whether the property constraints refer to valid properties in the indexed content

Returns:

List of validations where each indicates whether the property constraints refer to valid properties in the indexed content

setProps

public void setProps(java.util.List<PropValidation> pProps)

Sets the list of property validations

Parameters:

pProps - list of property validations

getActiveSentenceZones

public java.util.List<ActiveSentenceZoneValidation> getActiveSentenceZones()

Returns indications of whether the activeSentenceZones relQuestSetting is set to a correctly when unstructured content is indexed

Returns:

Whether the activeSentenceZones relQuestSetting is set to a correctly when unstructured content is indexed

setActiveSentenceZones

public void setActiveSentenceZones(java.util.List<ActiveSentenceZoneValidation> pActiveSentenceZones)

Sets indications of whether the activeSentenceZones relQuestSetting is set to a correctly when unstructured content is indexed

Parameters:

pActiveSentenceZones - whether the activeSentenceZones relQuestSetting is set to a correctly when unstructured content is indexed

getActiveSolutionZones

public java.util.List<ActiveSolutionZoneValidation> getActiveSolutionZones()

Returns indications of whether the activeSolutionZones relQuestSetting is set to a correctly when structured content is indexed

Returns:

Whether the activeSolutionZones relQuestSetting is set to a correctly when structured content is indexed

setActiveSolutionZones

public void setActiveSolutionZones(java.util.List<ActiveSolutionZoneValidation> pActiveSolutionZones)

Sets indicators of whether the activeSolutionZones relQuestSetting is set to a correctly when structured content is indexed

Parameters:

pActiveSolutionZones - whether the activeSolutionZones relQuestSetting is set to a correctly when structured content is indexed

getSortProps

public java.util.List<SortPropValidation> getSortProps()

Returns indicators of whether the sortProp attribute is set to a valid property in the content

Returns:

Whether the sortProp attribute is set to a valid property in the content

setSortProps

public void setSortProps(java.util.List<SortPropValidation> pSortProps)

Sets the indicators of whether the sortProp attribute is set to a valid property in the content

Parameters:

pSortProps - whether the sortProp attribute is set to a valid property in the content

getDocSortProps

public java.util.List<DocSortPropValidation> getDocSortProps()

Returns indicators of whether the docSortProp attribute is set to a valid property in the content

Returns:

Whether the docSortProp attribute is set to a valid property in the content

setDocSortProps

public void setDocSortProps(java.util.List<DocSortPropValidation> pDocSortProps)

Sets indicators of whether the docSortProp attribute is set to a valid property in the content

Parameters:

pDocSortProps - whether the docSortProp attribute is set to a valid property in the content

getTargetLanguages

public java.util.List<TargetLanguageValidation> getTargetLanguages()

Returns indicators of whether the targetLanguage option refers to a language with indexed content

Returns:

Whether the targetLanguage option refers to a language with indexed content

setTargetLanguages

public void setTargetLanguages(java.util.List<TargetLanguageValidation> pTargetLanguages)

Sets indicators of whether the targetLanguage option refers to a language with indexed content

Parameters:

pTargetLanguages - whether the targetLanguage option refers to a language with indexed content

getRefineElements

public java.util.List<RefineElementValidation> getRefineElements()

Returns indicators of whether the refine configuration refers to valid properties in the content

Returns:

Whether the refine configuration refers to valid properties in the content

setRefineElements

public void setRefineElements(java.util.List<RefineElementValidation> pRefineElements)

Sets indicators of whether the refine configuration refers to valid properties in the content

Parameters:

pRefineElements - whether the refine configuration refers to valid properties in the content

getRankFormulas

public java.util.List<RankFormulaValidation> getRankFormulas()

Returns indicators of whether the ranking formula refers to valid properties in the content

Returns:

Whether the ranking formula refers to valid properties in the content

setRankFormulas

public void setRankFormulas(java.util.List<RankFormulaValidation> pRankFormulas)

Sets indicators of whether the ranking formula refers to valid properties in the content

Parameters:

pRankFormulas - whether the ranking formula refers to valid properties in the content

getContexts

public java.util.List<ContextValidation> getContexts()

Returns indicators of whether the context option is set properly when dictionary adaptors are loaded

Returns:

Whether the context option is set properly when dictionary adaptors are loaded

setContexts

public void setContexts(java.util.List<ContextValidation> pContexts)

Sets indicators of whether the context option is set properly when dictionary adaptors are loaded

Parameters:

pContexts - whether the context option is set properly when dictionary adaptors are loaded

getRefineConfigs

public java.util.List<RefineConfigValidation> getRefineConfigs()

Returns indicators of whether the refineConfig attribute is set properly when refine configurations are loaded

Returns:

Whether the refineConfig attribute is set properly when refine configurations are loaded

setRefineConfigs

public void setRefineConfigs(java.util.List<RefineConfigValidation> pRefineConfigs)

Sets indicators of whether the refineConfig attribute is set properly when refine configurations are loaded

Parameters:

pRefineConfigs - whether the refineConfig attribute is set properly when refine configurations are loaded

getRankConfigs

public java.util.List<RankConfigValidation> getRankConfigs()

Returns indicators of whether the rankConfig attribute is set properly when rank configurations are loaded

Returns:

Whether the rankConfig attribute is set properly when rank configurations are loaded

setRankConfigs

public void setRankConfigs(java.util.List<RankConfigValidation> pRankConfigs)

Sets indicators of whether the rankConfig attribute is set properly when rank configurations are loaded

Parameters:

pRankConfigs - whether the rankConfig attribute is set properly when rank configurations are loaded

getRuleModes

public java.util.List<RuleModeValidation> getRuleModes()

Returns indicators of whether the ruleMode attribute is enabled (exec) when there are query rules loaded

Returns:

Whether the ruleMode attribute is enabled (exec) when there are query rules loaded

setRuleModes

public void setRuleModes(java.util.List<RuleModeValidation> pRuleModes)

Sets indicators of whether the ruleMode attribute is enabled (exec) when there are query rules loaded

Parameters:

pRuleModes - whether the ruleMode attribute is enabled (exec) when there are query rules loaded

fromXmlParser

protected static Validation fromXmlParser(atg.search.routing.utils.SearchMessageNode pXml)

getRequestTag

public java.lang.String getRequestTag()

Specified by:

getRequestTag in class atg.search.routing.command.SearchXMLObject

getBodyXML

protected void getBodyXML(java.lang.StringBuilder sb)
                   throws atg.search.routing.command.IncompleteCommandException

Overrides:

getBodyXML in class atg.search.routing.command.SearchXMLObject

Throws:

atg.search.routing.command.IncompleteCommandException