de.tif.jacob.screen
Interface IDomain

All Superinterfaces:

IGuiElement

public interface IDomain
extends IGuiElement

Nested Class Summary

Nested classes/interfaces inherited from interface de.tif.jacob.screen.IGuiElement

IGuiElement.GroupState

Field Summary

static java.lang.String	RCS_ID The internal revision control system id.
static java.lang.String	RCS_REV The internal revision control system id in short form.

Fields inherited from interface de.tif.jacob.screen.IGuiElement

NEW, SEARCH, SELECTED, UNDEFINED, UPDATE

Method Summary

void	clear(IClientContext context) Clears this domain, i.e. the domains data accessor and input fields will be reset to their default values.
IForm	getCurrentForm(IClientContext context) Returns the current form of this domain, i.e. the visible form if this domain becomes the active domain.
java.util.List	getGuiRepresentations(java.lang.String tableAlias, java.lang.String fieldName) Returns the GUI elements which are related to the given table alias and field name.
java.lang.String	getInputFieldValue(java.lang.String formName, java.lang.String fieldName) Returns the GUI value of the hands over GUI element.
void	setCurrentForm(IClientContext context, IForm form) Sets the current visible form of this domain.
void	setInputFieldValue(java.lang.String formName, java.lang.String fieldName, java.lang.String value) Sets the value of a GUI field in the group.

Methods inherited from interface de.tif.jacob.screen.IGuiElement

findByName, getApplicationDefinition, getChildren, getDataStatus, getGroupTableAlias, getI18NLabel, getLabel, getName, getParent, getPathName, hasChild, isEnabled, isVisible, setBackgroundColor, setColor, setEnable, setLabel, setVisible

Field Detail

RCS_ID

static final java.lang.String RCS_ID

The internal revision control system id.

See Also:

Constant Field Values

RCS_REV

static final java.lang.String RCS_REV

The internal revision control system id in short form.

See Also:

Constant Field Values

Method Detail

clear

void clear(IClientContext context)
           throws java.lang.Exception

Clears this domain, i.e. the domains data accessor and input fields will be reset to their default values.

Parameters:

context - The current client context

Throws:

java.lang.Exception

getCurrentForm

IForm getCurrentForm(IClientContext context)

Returns the current form of this domain, i.e. the visible form if this domain becomes the active domain.

Parameters:

context - The current client context

Returns:

the current form of this domain

setCurrentForm

void setCurrentForm(IClientContext context,
                    IForm form)
                    throws java.lang.Exception

Sets the current visible form of this domain.

Note: This domain becomes the active domain, if this is not already the case!

Parameters:

context - The current client context

form - The form to become the current visible form.

Throws:

java.lang.Exception

setInputFieldValue

void setInputFieldValue(java.lang.String formName,
                        java.lang.String fieldName,
                        java.lang.String value)
                        throws java.lang.Exception

Sets the value of a GUI field in the group.

Parameters:

formName - The name of the form (the parent) of the field element.

fieldName - The GUI input field name. Not the database field name.

value - The value of the input field.

Throws:

java.lang.Exception

getInputFieldValue

java.lang.String getInputFieldValue(java.lang.String formName,
                                    java.lang.String fieldName)
                                    throws java.lang.Exception

Returns the GUI value of the hands over GUI element.

Parameters:

formName - The name of the form (the parent) of the field element.

fieldName - the name of the input field

Returns:

the visible value of the input field

Throws:

java.lang.Exception - throws an Exception if the field does not exist or is not an input field.

getGuiRepresentations

java.util.List getGuiRepresentations(java.lang.String tableAlias,
                                     java.lang.String fieldName)

Returns the GUI elements which are related to the given table alias and field name.

Parameters:

tableAlias - The table alias for that you want the GUI input element

fieldName - The field name for that you want the GUI input element.

Returns:

List of ISingleDataGuiElement which are related to the database field.