|
LEONARDI Application Composer - 8.9.0.40 by W4 S.A. | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface LySetBehaviorInterface
This interface defines the methods to implement in order to modify the behavior of a modification action. A modification action includes create, set and clone.
LySetController
Field Summary | |
---|---|
static java.lang.String |
__VERSION
File version |
static short |
STATUS_CANCEL
Code returned when there is no modification on the value for controlNewValue, checkNewValue and controlNewValues. |
static short |
STATUS_IGNORE
Code returned when there is no modification on the value for controlNewValue, checkNewValue and controlNewValues. |
static short |
STATUS_KO
Code returned when the value is not correct for controlNewValue, checkNewValue and controlNewValues. |
static short |
STATUS_OK
Code returned when the value is correct for controlNewValue, checkNewValue and controlNewValues. |
static short |
STATUS_WARNING
Code returned when the value is on warning for controlNewValue, checkNewValue and controlNewValues. |
Method Summary | |
---|---|
void |
addExtraValues(LySetController set,
LyValueSet values)
This method adds the given extra values before completing the current operation. |
short |
checkNewValue(LySetController set,
LyFieldInfoValue newValue)
Dynamicaly checks the given value for its associated field. |
short |
controlNewValue(LySetController set,
LyFieldInfoValue newValue)
This method controls the given value before creating or modifying an object. |
short |
controlNewValues(LySetController set,
LyValueSet newValues)
Global control of values before creating or modifying an object. |
boolean |
enableChoiceOption(LySetController set,
LyChoiceFieldInfo choice,
LyChoiceOption option)
Indicates if the given option is enabled on the given choice fieldInfo. |
boolean |
enableRelationLink(LySetController set,
LyRelationFieldInfo relation,
LyObject link)
Allows the given link object as a possible value for the given relation field info. |
boolean |
enableRelationLink(LySetController set,
LyRelationFieldInfo relation,
LyObject link,
boolean showError)
Allows the given link object as a possible value for the given relation field info. |
void |
endCommit(LySetController controller)
Invoked when controller is ending commit, default implementation does nothing |
boolean |
endSet(LySetController set,
LyValueSet values)
Final step of object set process. |
void |
formRestored(LySetController controller,
LyFormSave formSave)
Method called on form restore. |
void |
formSaved(LySetController controller,
LyFormSave formSave)
Method called on form save. |
int |
getAutoCompletionMaximum(LySetController set,
LyRelationFieldInfo relation)
Indicates the maximum number of values displayed in relation components for auto-completion. |
int |
getAutoCompletionMaximum(LySetController set,
LyTextFieldInfo fieldInfo)
Indicates the maximum number of values displayed in text components for auto-completion. |
java.lang.String[] |
getAutoCompletionValues(LySetController set,
LyTextFieldInfo fieldInfo)
Computes the list of values displayed in text components for auto-completion. |
java.util.Vector<LyChoiceOption> |
getChoiceDomain(LySetController set,
LyChoiceFieldInfo choice)
Gets domain (list of allowed options) of the given choice fieldInfo. |
java.lang.Object |
getDefaultValue(LySetController set,
LyFieldInfo fieldInfo)
Gets the default value of the given fieldInfo. |
LyContext.Position |
getInsertPosition(LySetController controller,
LyRelationFieldInfo relation)
Indicates if the operations of the controller context must be inserted at the beginning of the parent operations or at the end. |
java.lang.String |
getLinkShortLabel(LySetController set,
LyRelationFieldInfo relation,
LyObject link)
Gets the short label that must be used for the given relation fieldInfo. |
LyInfoList<LyClassInfo> |
getRelationClasses(LySetController set,
LyRelationFieldInfo relation)
Gets the list of available classInfo of the given relation fieldInfo. |
LyObjectList |
getRelationContext(LySetController set,
LyRelationFieldInfo relation)
Gets the list of objects of the given relation context. |
LyObjectList |
getRelationDomain(LySetController set,
LyRelationFieldInfo relation)
Gets relation domain (list of available links) for the given relation fieldInfo. |
LyObjectList |
getRelationDomain(LySetController set,
LyRelationFieldInfo relation,
java.lang.String prefix,
boolean fill)
Gets relation domain (list of available links) for the given relation fieldInfo with the given prefix for related objects. |
LyFilter |
getRelationFilter(LySetController controller,
LyRelationFieldInfo relation,
LyClassInfo classInfo)
Gets the filter of the given relation and the given class. |
LyInfoDataList<LyAction,LyClassInfo> |
getTransverseActions(LySetController set,
LyFieldInfo fieldInfo)
Gets actions enabled by the given field. |
LyInfoDataList<LyAction,LyClassInfo> |
getTransverseActions(LySetController set,
LyRelationFieldInfo relation)
Gets actions enabled by the given relation. |
boolean |
isEditable(LySetController set,
LyFieldInfo fieldInfo)
Checks if the given fieldInfo is editable or not for the given controller. |
boolean |
isEnabled(LySetController set,
LyFieldInfo fieldInfo)
Checks if the given fieldInfo is enabled or not for the given controller. |
java.lang.String |
isLocked(LySetController controller,
LyObject object)
Checks if given object is locked for edition. |
boolean |
isOptional(LySetController set,
LyFieldInfo fieldInfo)
Checks if the given fieldInfo is optional or not for the given controller. |
boolean |
isValidGroup(LySetController set,
LyChoiceFieldInfo choice,
LyChoiceOption option,
LyChoiceOptionGroup group)
Checks if the given options group is valid for the given option of the choice fieldinfo. |
boolean |
lockObject(LySetController controller,
LyObject object,
boolean lock)
Locks/Unlocks given object for edition. |
boolean |
needCheck(LySetController set,
LyFieldInfo fieldInfo)
Indicates if the given fieldInfo needs to be checked when the value is modified (in creation and set mode). |
void |
propagate(LySetController set,
LyFieldInfoValue newValue)
Progates modifications of the given field on all other fields. |
void |
startCommit(LySetController controller)
Invoked when controller is starting to commit, default implementation does nothing |
boolean |
useEditTable(LySetController controller,
LyArrayFieldInfo array)
Checks if an edit table should be used for the given array field. |
boolean |
useEditTable(LySetController controller,
LyRelationFieldInfo relation)
Checks if an edit table should be used for the given relation field. |
boolean |
useLocalCompletion(LySetController set,
LyRelationFieldInfo relation)
Indicates if auto-completion on the given relation fieldInfo is managed by the graphical component or by the field controller. |
boolean |
useSingleContext(LySetController controller,
LyRelationFieldInfo parentRelation)
Indicates if the given controller must link its context to its parent context |
boolean |
validateChoiceOption(LySetController set,
LyChoiceFieldInfo choice,
LyChoiceOption option)
Indicates if the given option is hidden on the given choice fieldInfo. |
Methods inherited from interface leon.app.behaviorinterface.LyConsultBehaviorInterface |
---|
enableRelationHRef, getAction, setObject |
Methods inherited from interface leon.app.behaviorinterface.LyFormBehaviorInterface |
---|
getImage, getValue, isDisplayed |
Methods inherited from interface leon.app.behaviorinterface.LyActionBehaviorInterface |
---|
endAction, getClientContext, getContextTitle, getHelpFile, getImage, getImageTooltip, getKeyValue, getMenuItemImage, getTitle, reset, startAction |
Methods inherited from interface leon.app.behaviorinterface.LyBehaviorInterface |
---|
free, handleDemand, init |
Field Detail |
---|
static final java.lang.String __VERSION
static final short STATUS_CANCEL
STATUS_CANCEL
: the operation is cancelledSTATUS_IGNORE
: the value is not modifiedSTATUS_OK
: the value is correctSTATUS_KO
: the value is not correctSTATUS_WARNING
: the value is on warning
static final short STATUS_IGNORE
STATUS_CANCEL
,
Constant Field Valuesstatic final short STATUS_OK
STATUS_CANCEL
,
Constant Field Valuesstatic final short STATUS_KO
STATUS_CANCEL
,
Constant Field Valuesstatic final short STATUS_WARNING
STATUS_CANCEL
,
Constant Field ValuesMethod Detail |
---|
boolean isOptional(LySetController set, LyFieldInfo fieldInfo)
set
- the current LySetController instancefieldInfo
- the target fieldInfo to test
boolean isEditable(LySetController set, LyFieldInfo fieldInfo)
set
- the current LySetController instancefieldInfo
- the target fieldInfo to test
boolean isEnabled(LySetController set, LyFieldInfo fieldInfo)
set
- the current LySetController instancefieldInfo
- the target fieldInfo to test
int getAutoCompletionMaximum(LySetController set, LyTextFieldInfo fieldInfo)
set
- the current LySetController instance.fieldInfo
- the target text fieldInfo to test.
java.lang.String[] getAutoCompletionValues(LySetController set, LyTextFieldInfo fieldInfo)
set
- the current LySetController instance.fieldInfo
- the target text fieldInfo to test.
java.util.Vector<LyChoiceOption> getChoiceDomain(LySetController set, LyChoiceFieldInfo choice)
set
- the current LySetController instancechoice
- target choice fieldInfo
LyChoiceOption
allowed for this choice field infoboolean isValidGroup(LySetController set, LyChoiceFieldInfo choice, LyChoiceOption option, LyChoiceOptionGroup group)
set
- the current set controllerchoice
- the choice fieldInfooption
- the choiceOptiongroup
- the choiceOption group
boolean enableChoiceOption(LySetController set, LyChoiceFieldInfo choice, LyChoiceOption option)
set
- the current LySetController instancechoice
- choiceFieldInfo that contains this optionoption
- the option to enabled
boolean validateChoiceOption(LySetController set, LyChoiceFieldInfo choice, LyChoiceOption option)
set
- the current LySetController instancechoice
- choiceFieldInfo that contains this optionoption
- the option to check
LyObjectList getRelationDomain(LySetController set, LyRelationFieldInfo relation)
set
- the current LySetController instancerelation
- the target relation field
boolean enableRelationLink(LySetController set, LyRelationFieldInfo relation, LyObject link, boolean showError)
set
- the current LySetController instancerelation
- the relation that contains the linklink
- the link to enabledshowError
- indicates if an error should be shown if the given link is rejected.
boolean enableRelationLink(LySetController set, LyRelationFieldInfo relation, LyObject link)
set
- the current LySetController instancerelation
- the relation that contains the linklink
- the link to enabled
LyInfoList<LyClassInfo> getRelationClasses(LySetController set, LyRelationFieldInfo relation)
set
- the current LySetController instancerelation
- the target relation fieldInfo
LyObjectList getRelationContext(LySetController set, LyRelationFieldInfo relation)
set
- the current LySetController instancerelation
- the target relation fieldInfo
int getAutoCompletionMaximum(LySetController set, LyRelationFieldInfo relation)
set
- the current LySetController instance.relation
- the target relation fieldInfo to test.
LyObjectList getRelationDomain(LySetController set, LyRelationFieldInfo relation, java.lang.String prefix, boolean fill)
set
- the current LySetController instancerelation
- the target relation fieldprefix
- the prefix for related objectsfill
- indicates whether the domain must be filtered with given prefix or not
java.lang.String getLinkShortLabel(LySetController set, LyRelationFieldInfo relation, LyObject link)
set
- the current LySetController instancerelation
- the target relation fieldlink
- the object represented by the link
boolean useLocalCompletion(LySetController set, LyRelationFieldInfo relation)
set
- the current LySetController instancerelation
- the fieldInfo that may need to be checked
LyInfoDataList<LyAction,LyClassInfo> getTransverseActions(LySetController set, LyRelationFieldInfo relation)
set
- the current LySetController instancerelation
- the relation that may enabled some actions
LyInfoDataList<LyAction,LyClassInfo> getTransverseActions(LySetController set, LyFieldInfo fieldInfo)
set
- the current LySetController instancefieldInfo
- the field that may enabled some actions
java.lang.Object getDefaultValue(LySetController set, LyFieldInfo fieldInfo)
set
- the current LySetController instance.fieldInfo
- the fieldInfo that contains the value.
boolean needCheck(LySetController set, LyFieldInfo fieldInfo)
set
- the current LySetController instancefieldInfo
- the fieldInfo that may need to be checked
void propagate(LySetController set, LyFieldInfoValue newValue)
set
- the current LySetController instancenewValue
- new field info value to propagateshort controlNewValue(LySetController set, LyFieldInfoValue newValue)
set
- the current LySetController instancenewValue
- field info value to check. This value cannot be null.
STATUS_IGNORE
if the value has not changeSTATUS_OK
if the value is correctSTATUS_KO
if the value is not correctSTATUS_WARNING
if the value is on warningshort checkNewValue(LySetController set, LyFieldInfoValue newValue)
set
- the current LySetController instancenewValue
- field info value to check.
short controlNewValues(LySetController set, LyValueSet newValues)
set
- the current LySetController instancenewValues
- Set of values to control
void addExtraValues(LySetController set, LyValueSet values)
set
- the current LySetController instancevalues
- Current set of values. Additionnal values must be add to this setboolean endSet(LySetController set, LyValueSet values)
set
- the current LySetController instancevalues
- Set of values for the modified object
LyFilter getRelationFilter(LySetController controller, LyRelationFieldInfo relation, LyClassInfo classInfo)
getRelationDomain(LySetController, LyRelationFieldInfo)
method when the target objets of the relation need to be filtered.
controller
- the current LyController instancerelation
- the relation field info we want to filterclassInfo
- ClassInfo for which we look for an associated filter.
boolean useEditTable(LySetController controller, LyArrayFieldInfo array)
controller
- The current LySetController instance.array
- The array field info.
boolean useEditTable(LySetController controller, LyRelationFieldInfo relation)
controller
- The current LySetController instance.relation
- The relation field info.
void startCommit(LySetController controller)
controller
- The current LySetController instance.void endCommit(LySetController controller)
controller
- The current LySetController instance.LyContext.Position getInsertPosition(LySetController controller, LyRelationFieldInfo relation)
controller
- the set controllerrelation
- the relation field
void formSaved(LySetController controller, LyFormSave formSave)
controller
- The current LySetController instance.formSave
- The formSave that was created.void formRestored(LySetController controller, LyFormSave formSave)
controller
- The current LySetController instance.formSave
- The formSave that was restored.boolean useSingleContext(LySetController controller, LyRelationFieldInfo parentRelation)
controller
- The current LySetController instance.parentRelation
- the parent relation for this controller (may be null)java.lang.String isLocked(LySetController controller, LyObject object)
controller
- The current LySetController instance.object
- Object to be checked.
boolean lockObject(LySetController controller, LyObject object, boolean lock)
controller
- The current LySetController instance.object
- Object to be locked/unlocked.lock
- True if lock is required, false for unlock.
|
(c) January 2013 - W4 S.A. | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |