|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
public interface PhraseEngine
Phrase engine
| Method Summary | |
|---|---|
void |
assignPhrase(long assignmentOwner,
long nodeId,
long nodeMandator,
long phraseId,
long phraseMandator,
long pos,
boolean checkPositioning)
Assign a phrase to a node. |
void |
assignPhrase(long assignmentOwner,
long nodeId,
long nodeMandator,
java.lang.String phraseKey,
long phraseMandator,
long pos,
boolean checkPositioning)
Assign a phrase to a node. |
void |
assignPhrases(long position,
long assignmentOwner,
long nodeId,
long nodeMandator,
FxPhrase[] phrases)
Assign phrases at a given position to a node |
void |
clearPhrases(FxPhraseCategorySelection categories,
long mandatorId)
Remove all phrases that belong to the requested mandator |
void |
clearPhrases(long mandatorId)
Remove all phrases that belong to the requested mandator |
void |
clearTree(long mandatorId)
Remove all tree nodes that belong to the requested mandator |
java.util.List<FxPhraseTreeNodePosition> |
getAssignedNodes(int category,
java.lang.String phraseKey,
long... mandator)
Get all assignments for a phrase. |
java.util.List<FxPhraseTreeNodePosition> |
getAssignedNodes(long phraseId,
long phraseMandator,
long... mandator)
Get all assignments for a phrase. |
java.util.List<FxPhraseTreeNodePosition> |
getAssignedNodes(java.lang.String phraseKey,
long... mandator)
Get all assignments for a phrase. |
FxPhrase |
loadPhrase(int category,
java.lang.String phraseKey,
long... mandators)
Load first available FxPhrase instances of a phrase |
FxPhrase |
loadPhrase(java.lang.String phraseKey,
long... mandators)
Load first available FxPhrase instances of a phrase |
java.util.List<FxPhrase> |
loadPhrases(int category,
java.lang.String phraseKeyPrefix,
long... mandators)
Load all FxPhrase instances of a phrase with the requested key prefix |
java.util.List<FxPhrase> |
loadPhrases(java.lang.String phraseKeyPrefix,
long... mandators)
Load all FxPhrase instances of a phrase with the requested key prefix |
java.util.List<FxPhraseTreeNode> |
loadPhraseTree(boolean mandator2top,
long... mandators)
Load all root nodes and child nodes for up to 2 mandators |
java.util.List<FxPhraseTreeNode> |
loadPhraseTree(int category,
boolean mandator2top,
long... mandators)
Load all root nodes and child nodes for up to 2 mandators |
FxPhraseTreeNode |
loadPhraseTreeNode(long nodeId,
long mandatorId,
boolean mandator2top,
long... mandators)
Load a tree nodes and its child nodes for up to 2 mandators |
java.lang.String |
loadPhraseValue(long language,
java.lang.String phraseKey,
long... mandators)
Load a phrase value in the requested language |
FxString |
loadPhraseValue(java.lang.String phraseKey,
long... mandators)
Load all available translation of a phrase |
void |
moveTreeNode(long nodeId,
long mandatorId,
int delta)
Move a tree node delta positions (within its own mandator) |
void |
moveTreeNodeAssignment(long assignmentOwner,
long nodeId,
long nodeMandatorId,
long phraseId,
long phraseMandator,
int delta)
"Move" the position of an assignment |
void |
removeAssignmentsFromNode(long nodeId,
long nodeMandator)
Remove all phrase assignments from a node. |
int |
removeMandatorPhrases(FxPhraseCategorySelection categories,
long mandator)
Removes all phrases of the requested mandator and all its mappings (but not if used in tree nodes!) |
int |
removeMandatorPhrases(long mandator)
Removes all phrases of the requested mandator and all its mappings (but not if used in tree nodes!) |
boolean |
removePhrase(int category,
java.lang.String phraseKey,
long mandator)
Remove the phrase identified by its key and mandator and all its mappings |
boolean |
removePhrase(java.lang.String phraseKey,
long mandator)
Remove the phrase identified by its key and mandator and all its mappings |
boolean |
removePhraseAssignment(long assignmentOwner,
long nodeId,
long nodeMandator,
long phraseId,
long phraseMandator)
Remove an assign of a phrase from a node. |
int |
removePhrases(int category,
java.lang.String phraseKeyPrefix,
long mandator)
Remove all phrases with a key starting with phraseKeyPrefix and mandator |
int |
removePhrases(java.lang.String phraseKeyPrefix,
long mandator)
Remove all phrases with a key starting with phraseKeyPrefix and mandator |
void |
removeTreeNode(long nodeId,
long mandatorId)
Remove a tree node, moving its children up one level and removing all assignments to this node |
long |
savePhrase(int category,
java.lang.String phraseKey,
FxString value,
FxPhraseSearchValueConverter converter,
java.lang.Object tag,
long mandator)
Save or create a phrase |
long |
savePhrase(int category,
java.lang.String phraseKey,
FxString value,
long mandator)
Save or create a phrase (tag will be removed existing phrases!) |
long |
savePhrase(int category,
java.lang.String phraseKey,
FxString value,
java.lang.Object tag,
long mandator)
Save or create a phrase |
long |
savePhrase(java.lang.String phraseKey,
FxString value,
FxPhraseSearchValueConverter converter,
long mandator)
Save or create a phrase (tag will be removed existing phrases!) |
long |
savePhrase(java.lang.String phraseKey,
FxString value,
FxPhraseSearchValueConverter converter,
java.lang.Object tag,
long mandator)
Save or create a phrase |
long |
savePhrase(java.lang.String phraseKey,
FxString value,
long mandator)
Save or create a phrase (tag will be removed existing phrases!) |
long |
savePhrase(java.lang.String phraseKey,
FxString value,
java.lang.Object tag,
long mandator)
Save or create a phrase |
FxPhraseTreeNode |
saveTreeNode(FxPhraseTreeNode node)
Save or create a tree node. |
FxPhraseQueryResult |
search(FxPhraseQuery query)
Execute the requested query, returning all results in one page |
FxPhraseQueryResult |
search(FxPhraseQuery query,
int page,
int pageSize)
Execute the requested query with paging |
void |
setPhraseHidden(int category,
java.lang.String phraseKey,
long mandator,
boolean hidden)
Set a phrases hidden flag |
void |
setPhraseHidden(java.lang.String phraseKey,
long mandator,
boolean hidden)
Set a phrases hidden flag |
void |
setPhraseTreeNodeParent(long nodeId,
long nodeMandator,
long parentId,
long parentMandator)
Set the parent of a phrase tree node. |
void |
syncDivisionResources(long targetMandator,
FxPhraseSearchValueConverter converter)
Clear all phrases for the targetMandator and copy the division resources as phrases (using the targetMandator as owner) |
void |
syncPhraseNodeSequencer(long mandatorId)
Synchronize the phrase node sequencer to match the current max id + 1 |
void |
syncPhraseSequencer(long mandatorId)
Synchronize the phrase sequencer to match the current max id + 1 |
| Method Detail |
|---|
long savePhrase(java.lang.String phraseKey,
FxString value,
long mandator)
throws FxNoAccessException
phraseKey - phrase keyvalue - phrase valuemandator - phrase mandator
FxNoAccessException - if the requested mandator is not the callers mandator
long savePhrase(int category,
java.lang.String phraseKey,
FxString value,
long mandator)
throws FxNoAccessException
category - phrase categoryphraseKey - phrase keyvalue - phrase valuemandator - phrase mandator
FxNoAccessException - if the requested mandator is not the callers mandator
long savePhrase(java.lang.String phraseKey,
FxString value,
FxPhraseSearchValueConverter converter,
long mandator)
throws FxNoAccessException
phraseKey - phrase keyvalue - phrase valueconverter - converter for value used for search operationsmandator - phrase mandator
FxNoAccessException - if the requested mandator is not the callers mandator
long savePhrase(java.lang.String phraseKey,
FxString value,
java.lang.Object tag,
long mandator)
throws FxNoAccessException
phraseKey - phrase keyvalue - phrase valuetag - String if single language or FxString if multilanguagemandator - phrase mandator
FxNoAccessException - if the requested mandator is not the callers mandator
long savePhrase(int category,
java.lang.String phraseKey,
FxString value,
java.lang.Object tag,
long mandator)
throws FxNoAccessException
category - phrase categoryphraseKey - phrase keyvalue - phrase valuetag - String if single language or FxString if multilanguagemandator - phrase mandator
FxNoAccessException - if the requested mandator is not the callers mandator
long savePhrase(java.lang.String phraseKey,
FxString value,
FxPhraseSearchValueConverter converter,
java.lang.Object tag,
long mandator)
throws FxNoAccessException
phraseKey - phrase keyvalue - phrase valueconverter - converter for value used for search operationstag - String if single language or FxString if multilanguagemandator - phrase mandator
FxNoAccessException - if the requested mandator is not the callers mandator
long savePhrase(int category,
java.lang.String phraseKey,
FxString value,
FxPhraseSearchValueConverter converter,
java.lang.Object tag,
long mandator)
throws FxNoAccessException
category - phrase categoryphraseKey - phrase keyvalue - phrase valueconverter - converter for value used for search operationstag - String if single language or FxString if multilanguagemandator - phrase mandator
FxNoAccessException - if the requested mandator is not the callers mandator
void setPhraseHidden(java.lang.String phraseKey,
long mandator,
boolean hidden)
throws FxNoAccessException
phraseKey - phrase keymandator - phrase mandatorhidden - hidden flag
FxNoAccessException - if the requested mandator is not the callers mandator
void setPhraseHidden(int category,
java.lang.String phraseKey,
long mandator,
boolean hidden)
throws FxNoAccessException
category - phrase categoryphraseKey - phrase keymandator - phrase mandatorhidden - hidden flag
FxNoAccessException - if the requested mandator is not the callers mandator
boolean removePhrase(java.lang.String phraseKey,
long mandator)
throws FxNoAccessException,
FxEntryInUseException
phraseKey - phrase keymandator - phrase mandator
FxNoAccessException - if the requested mandator is not the callers mandator
FxEntryInUseException - if the phrase is in use by the tree
boolean removePhrase(int category,
java.lang.String phraseKey,
long mandator)
throws FxNoAccessException,
FxEntryInUseException
category - phrase categoryphraseKey - phrase keymandator - phrase mandator
FxNoAccessException - if the requested mandator is not the callers mandator
FxEntryInUseException - if the phrase is in use by the tree
int removePhrases(java.lang.String phraseKeyPrefix,
long mandator)
throws FxNoAccessException,
FxEntryInUseException
phraseKeyPrefix - phrase key prefixmandator - phrase mandator
FxNoAccessException - if the requested mandator is not the callers mandator
FxEntryInUseException - if the phrase is in use by the tree
int removePhrases(int category,
java.lang.String phraseKeyPrefix,
long mandator)
throws FxNoAccessException,
FxEntryInUseException
category - phrase categoryphraseKeyPrefix - phrase key prefixmandator - phrase mandator
FxNoAccessException - if the requested mandator is not the callers mandator
FxEntryInUseException - if the phrase is in use by the tree
int removeMandatorPhrases(long mandator)
throws FxNoAccessException,
FxEntryInUseException
mandator - requested mandator
FxNoAccessException - if the requested mandator is not the callers mandator
FxEntryInUseException - if phrases are in use by the tree
int removeMandatorPhrases(FxPhraseCategorySelection categories,
long mandator)
throws FxNoAccessException,
FxEntryInUseException
categories - phrase categoriesmandator - requested mandator
FxNoAccessException - if the requested mandator is not the callers mandator
FxEntryInUseException - if phrases are in use by the tree
java.lang.String loadPhraseValue(long language,
java.lang.String phraseKey,
long... mandators)
throws FxNotFoundException
language - language of the valuephraseKey - phrase keymandators - list of mandators to try loading the key from (in the requested order)
FxNotFoundException - if no value for the requested language was found or the phrase key does not exist
FxString loadPhraseValue(java.lang.String phraseKey,
long... mandators)
throws FxNotFoundException
phraseKey - phrase keymandators - list of mandators to try loading the key from (in the requested order)
FxNotFoundException - if the phrase key does not exist
FxPhrase loadPhrase(java.lang.String phraseKey,
long... mandators)
throws FxNotFoundException
phraseKey - phrase keymandators - list of mandators to try loading the key from (in the requested order)
FxNotFoundException - if the phrase key does not exist
FxPhrase loadPhrase(int category,
java.lang.String phraseKey,
long... mandators)
throws FxNotFoundException
category - phrase categoryphraseKey - phrase keymandators - list of mandators to try loading the key from (in the requested order)
FxNotFoundException - if the phrase key does not exist
java.util.List<FxPhrase> loadPhrases(java.lang.String phraseKeyPrefix,
long... mandators)
phraseKeyPrefix - phrase key prefixmandators - list of mandators to try loading the key from (in the requested order)
java.util.List<FxPhrase> loadPhrases(int category,
java.lang.String phraseKeyPrefix,
long... mandators)
category - phrase categoryphraseKeyPrefix - phrase key prefixmandators - list of mandators to try loading the key from (in the requested order)
void clearPhrases(long mandatorId)
throws FxNoAccessException,
FxEntryInUseException
mandatorId - requested mandator
FxNoAccessException - if the requested mandator is not the callers mandator
FxEntryInUseException - if phrases are in use by the phrase tree
void clearPhrases(FxPhraseCategorySelection categories,
long mandatorId)
throws FxNoAccessException,
FxEntryInUseException
categories - categories to removemandatorId - requested mandator
FxNoAccessException - if the requested mandator is not the callers mandator
FxEntryInUseException - if phrases are in use by the phrase treevoid syncPhraseSequencer(long mandatorId)
mandatorId - mandator
FxPhraseTreeNode saveTreeNode(FxPhraseTreeNode node)
throws FxNoAccessException,
FxNotFoundException
node - the node the create or update
FxNoAccessException - if the requested mandator is not the callers mandator
FxNotFoundException - if either the parent node or the phrase dont exist
void setPhraseTreeNodeParent(long nodeId,
long nodeMandator,
long parentId,
long parentMandator)
throws FxNoAccessException,
FxNotFoundException
nodeId - node idnodeMandator - node mandatorparentId - parent node idparentMandator - parent node mandator
FxNoAccessException - if the node mandator is not the calling users mandator
FxNotFoundException - if either of the nodes are not foundvoid syncPhraseNodeSequencer(long mandatorId)
mandatorId - mandator
java.util.List<FxPhraseTreeNode> loadPhraseTree(boolean mandator2top,
long... mandators)
mandator2top - insert nodes of mandator 2 at the top or bottom?mandators - mandators
java.util.List<FxPhraseTreeNode> loadPhraseTree(int category,
boolean mandator2top,
long... mandators)
category - phrase categorymandator2top - insert nodes of mandator 2 at the top or bottom?mandators - mandators
FxPhraseTreeNode loadPhraseTreeNode(long nodeId,
long mandatorId,
boolean mandator2top,
long... mandators)
throws FxNotFoundException
nodeId - node idmandatorId - mandator idmandator2top - insert nodes of mandator 2 at the top or bottom?mandators - mandators
FxNotFoundException - if no node with the requested id/mandator exists
void moveTreeNode(long nodeId,
long mandatorId,
int delta)
throws FxNoAccessException,
FxNotFoundException
nodeId - node idmandatorId - mandator id of the nodedelta - delat to move
FxNoAccessException - if the requested mandator is not the callers mandator
FxNotFoundException - if no node with the requested id/mandator exists
void removeTreeNode(long nodeId,
long mandatorId)
throws FxNoAccessException,
FxNotFoundException
nodeId - node idmandatorId - mandator of the node
FxNoAccessException - if the requested mandator is not the callers mandator
FxNotFoundException - if no node with the requested id/mandator exists
void clearTree(long mandatorId)
throws FxNoAccessException
mandatorId - requested mandator
FxNoAccessException - if the requested mandator is not the callers mandator
void assignPhrase(long assignmentOwner,
long nodeId,
long nodeMandator,
long phraseId,
long phraseMandator,
long pos,
boolean checkPositioning)
throws FxNotFoundException,
FxNoAccessException
assignmentOwner - mandator which is the "owner" of this assignmentnodeId - node idnodeMandator - node mandatorphraseId - phrase idphraseMandator - phrase mandatorpos - positioncheckPositioning - insert at the given position moving other nodes or just write the position without any moving around
FxNoAccessException - if the requested assignmentOwner is not the callers mandator
FxNotFoundException - if either the node or phrase were not found
void assignPhrase(long assignmentOwner,
long nodeId,
long nodeMandator,
java.lang.String phraseKey,
long phraseMandator,
long pos,
boolean checkPositioning)
throws FxNotFoundException,
FxNoAccessException
assignmentOwner - mandator which is the "owner" of this assignmentnodeId - node idnodeMandator - node mandatorphraseKey - phrase keyphraseMandator - phrase mandatorpos - positioncheckPositioning - insert at the given position moving other nodes or just write the position without any moving around
FxNoAccessException - if the requested assignmentOwner is not the callers mandator
FxNotFoundException - if either the node or phrase were not found
void assignPhrases(long position,
long assignmentOwner,
long nodeId,
long nodeMandator,
FxPhrase[] phrases)
throws FxApplicationException
position - requested positionassignmentOwner - mandator which is the "owner" of this assignmentnodeId - node idnodeMandator - node mandatorphrases - phrases to assign
FxApplicationException - on errors
void moveTreeNodeAssignment(long assignmentOwner,
long nodeId,
long nodeMandatorId,
long phraseId,
long phraseMandator,
int delta)
throws FxNotFoundException,
FxNoAccessException
assignmentOwner - mandator which is the "owner" of this assignmentnodeId - node idnodeMandatorId - node mandatorphraseId - phrase idphraseMandator - phrase mandatordelta - delta to move
FxNoAccessException - if the requested assignmentOwner is not the callers mandator
FxNotFoundException - if either the node or phrase were not found
boolean removePhraseAssignment(long assignmentOwner,
long nodeId,
long nodeMandator,
long phraseId,
long phraseMandator)
throws FxNotFoundException,
FxNoAccessException
assignmentOwner - mandator which is the "owner" of this assignmentnodeId - node idnodeMandator - node mandatorphraseId - phrase idphraseMandator - phrase mandator
FxNoAccessException - if the requested assignmentOwner is not the callers mandator
FxNotFoundException - if either the node or phrase were not found
void removeAssignmentsFromNode(long nodeId,
long nodeMandator)
nodeId - node idnodeMandator - node mandator id
java.util.List<FxPhraseTreeNodePosition> getAssignedNodes(java.lang.String phraseKey,
long... mandator)
phraseKey - phrase keymandator - assignment owner mandators
java.util.List<FxPhraseTreeNodePosition> getAssignedNodes(int category,
java.lang.String phraseKey,
long... mandator)
category - phrase categoryphraseKey - phrase keymandator - assignment owner mandators
java.util.List<FxPhraseTreeNodePosition> getAssignedNodes(long phraseId,
long phraseMandator,
long... mandator)
phraseId - phrase IdphraseMandator - phrase mandator idmandator - assignment owner mandators
FxPhraseQueryResult search(FxPhraseQuery query)
query - query
FxPhraseQueryResult search(FxPhraseQuery query,
int page,
int pageSize)
query - querypage - the page to returnpageSize - number of entries per page
void syncDivisionResources(long targetMandator,
FxPhraseSearchValueConverter converter)
throws FxApplicationException
targetMandator - mandator to use for the phrasesconverter - converter for search values
FxApplicationException - on errors
FxNoAccessException - if not run as global supervisor or member of the mandator
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||