com.flexive.shared
Class FxPhraseQuery

java.lang.Object
  extended by com.flexive.shared.FxPhraseQuery
All Implemented Interfaces:
java.io.Serializable

public class FxPhraseQuery
extends java.lang.Object
implements java.io.Serializable

Query for phrases

Since:
3.2.0
Author:
Markus Plesser (markus.plesser@ucs.at), UCS - unique computing solutions gmbh (http://www.ucs.at)
See Also:
Serialized Form

Nested Class Summary
static class FxPhraseQuery.MatchMode
           
static class FxPhraseQuery.SortMode
           
 
Constructor Summary
FxPhraseQuery()
           
 
Method Summary
 FxPhraseQueryResult execute(int page, int pageSize)
          Execute this query returning the result set
 FxPhraseCategorySelection getCategories()
           
 FxPhraseQuery.MatchMode getKeyMatchMode()
           
 java.lang.String getKeyQuery()
           
 java.lang.Long[] getPhraseMandators()
           
 java.lang.Long getResultLanguage()
           
 java.lang.Long getSearchLanguage()
           
 FxPhraseQuery.SortMode getSortMode()
           
 FxPhraseQuery.MatchMode getTagMatchMode()
           
 java.lang.String getTagQuery()
           
 java.lang.Long getTreeNode()
           
 java.lang.Long getTreeNodeMandator()
           
 java.lang.Long[] getTreeNodeMappingOwner()
           
 FxPhraseQuery.MatchMode getValueMatchMode()
           
 java.lang.String getValueQuery()
           
 boolean isFetchFullPhraseInfo()
           
 boolean isIncludeChildNodes()
           
 boolean isIncludeHidden()
           
 boolean isKeyMatchRestricted()
           
 boolean isLanguageFallback()
           
 boolean isMixMandators()
           
 boolean isOnlyUnassignedPhrases()
           
 boolean isOwnMandatorTop()
           
 boolean isPhraseMandatorRestricted()
           
 boolean isResultLanguageRestricted()
           
 boolean isSearchLanguageRestricted()
           
 boolean isSortByKey()
           
 boolean isSortByPos()
           
 boolean isSortByTag()
           
 boolean isSortByValue()
           
 boolean isTagMatchRestricted()
           
 boolean isTreeNodeMappingOwnerRestricted()
           
 boolean isTreeNodeRestricted()
           
 boolean isValueMatchRestricted()
           
 FxPhraseQuery reset()
           
 void setCategories(FxPhraseCategorySelection categories)
           
 void setFetchFullPhraseInfo(boolean fetchFullPhraseInfo)
           
 void setIncludeChildNodes(boolean includeChildNodes)
           
 void setIncludeHidden(boolean includeHidden)
           
 void setKeyMatchMode(FxPhraseQuery.MatchMode keyMatchMode)
           
 void setKeyQuery(java.lang.String keyQuery)
           
 void setLanguageFallback(boolean languageFallback)
           
 void setMixMandators(boolean mixMandators)
           
 void setOnlyUnassignedPhrases(boolean onlyUnassignedPhrases)
           
 void setOwnMandatorTop(boolean ownMandatorTop)
           
 void setPhraseMandators(java.lang.Long... phraseMandators)
           
 void setResultLanguage(java.lang.Long resultLanguage)
           
 void setSearchLanguage(java.lang.Long searchLanguage)
           
 void setSortMode(FxPhraseQuery.SortMode sortMode)
           
 FxPhraseQuery setTagMatch(FxPhraseQuery.MatchMode matchMode, java.lang.String query)
           
 void setTagMatchMode(FxPhraseQuery.MatchMode tagMatchMode)
           
 void setTagQuery(java.lang.String tagQuery)
           
 void setTreeNode(java.lang.Long treeNode)
           
 void setTreeNodeMandator(java.lang.Long treeNodeMandator)
           
 void setTreeNodeMappingOwner(java.lang.Long... treeNodeMappingOwner)
           
 void setValueMatchMode(FxPhraseQuery.MatchMode valueMatchMode)
           
 void setValueQuery(java.lang.String valueQuery)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

FxPhraseQuery

public FxPhraseQuery()
Method Detail

reset

public FxPhraseQuery reset()

setTagMatch

public FxPhraseQuery setTagMatch(FxPhraseQuery.MatchMode matchMode,
                                 java.lang.String query)

getSearchLanguage

public java.lang.Long getSearchLanguage()

setSearchLanguage

public void setSearchLanguage(java.lang.Long searchLanguage)

isSearchLanguageRestricted

public boolean isSearchLanguageRestricted()

getResultLanguage

public java.lang.Long getResultLanguage()

setResultLanguage

public void setResultLanguage(java.lang.Long resultLanguage)

isResultLanguageRestricted

public boolean isResultLanguageRestricted()

getTagQuery

public java.lang.String getTagQuery()

setTagQuery

public void setTagQuery(java.lang.String tagQuery)

getTagMatchMode

public FxPhraseQuery.MatchMode getTagMatchMode()

setTagMatchMode

public void setTagMatchMode(FxPhraseQuery.MatchMode tagMatchMode)

isTagMatchRestricted

public boolean isTagMatchRestricted()

getKeyQuery

public java.lang.String getKeyQuery()

setKeyQuery

public void setKeyQuery(java.lang.String keyQuery)

getKeyMatchMode

public FxPhraseQuery.MatchMode getKeyMatchMode()

setKeyMatchMode

public void setKeyMatchMode(FxPhraseQuery.MatchMode keyMatchMode)

isKeyMatchRestricted

public boolean isKeyMatchRestricted()

getValueQuery

public java.lang.String getValueQuery()

setValueQuery

public void setValueQuery(java.lang.String valueQuery)

getValueMatchMode

public FxPhraseQuery.MatchMode getValueMatchMode()

setValueMatchMode

public void setValueMatchMode(FxPhraseQuery.MatchMode valueMatchMode)

isValueMatchRestricted

public boolean isValueMatchRestricted()

getTreeNode

public java.lang.Long getTreeNode()

setTreeNode

public void setTreeNode(java.lang.Long treeNode)

isTreeNodeRestricted

public boolean isTreeNodeRestricted()

isIncludeChildNodes

public boolean isIncludeChildNodes()

setIncludeChildNodes

public void setIncludeChildNodes(boolean includeChildNodes)

getTreeNodeMandator

public java.lang.Long getTreeNodeMandator()

setTreeNodeMandator

public void setTreeNodeMandator(java.lang.Long treeNodeMandator)

getPhraseMandators

public java.lang.Long[] getPhraseMandators()

setPhraseMandators

public void setPhraseMandators(java.lang.Long... phraseMandators)

isPhraseMandatorRestricted

public boolean isPhraseMandatorRestricted()

getTreeNodeMappingOwner

public java.lang.Long[] getTreeNodeMappingOwner()

setTreeNodeMappingOwner

public void setTreeNodeMappingOwner(java.lang.Long... treeNodeMappingOwner)

isTreeNodeMappingOwnerRestricted

public boolean isTreeNodeMappingOwnerRestricted()

isMixMandators

public boolean isMixMandators()

setMixMandators

public void setMixMandators(boolean mixMandators)

isFetchFullPhraseInfo

public boolean isFetchFullPhraseInfo()

setFetchFullPhraseInfo

public void setFetchFullPhraseInfo(boolean fetchFullPhraseInfo)

getSortMode

public FxPhraseQuery.SortMode getSortMode()

setSortMode

public void setSortMode(FxPhraseQuery.SortMode sortMode)

isSortByPos

public boolean isSortByPos()

isSortByKey

public boolean isSortByKey()

isSortByValue

public boolean isSortByValue()

isSortByTag

public boolean isSortByTag()

isOwnMandatorTop

public boolean isOwnMandatorTop()

setOwnMandatorTop

public void setOwnMandatorTop(boolean ownMandatorTop)

isOnlyUnassignedPhrases

public boolean isOnlyUnassignedPhrases()

setOnlyUnassignedPhrases

public void setOnlyUnassignedPhrases(boolean onlyUnassignedPhrases)

isLanguageFallback

public boolean isLanguageFallback()

setLanguageFallback

public void setLanguageFallback(boolean languageFallback)

isIncludeHidden

public boolean isIncludeHidden()

setIncludeHidden

public void setIncludeHidden(boolean includeHidden)

getCategories

public FxPhraseCategorySelection getCategories()

setCategories

public void setCategories(FxPhraseCategorySelection categories)

execute

public FxPhraseQueryResult execute(int page,
                                   int pageSize)
Execute this query returning the result set

Parameters:
page - page of the result set to load
pageSize - number of results per page
Returns:
FxPhraseQueryResult