public interface UIFormRequestContext
UIForm
Modifier and Type | Method and Description |
---|---|
String |
displayOccurrence(Object aValue,
SchemaNode aNode,
boolean useLabels)
Returns a string for displaying the specified value of the specified node,
according to the current locale of this context.
|
Adaptation |
getCurrentDataSet()
Returns the dataset currently selected.
|
HierarchyNode |
getHierarchyNode()
Returns current hierarchy node if the current
UIForm
is instantiated in the context of a hierarchy. |
Locale |
getLocale()
Returns the current locale of the user session.
|
SchemaNode |
getNode(Path aPath)
Returns the node located at the specified path.
|
String |
getOptionalRequestParameterValue(String aParameterName)
Returns the HTTP parameter value in the incoming request.
|
String[] |
getOptionalRequestParameterValues(String aParameterName)
Returns the HTTP parameter values in the incoming request.
|
Session |
getSession()
Returns the current session.
|
SchemaNode |
getTableNode()
Returns the table node to which the form is attached, as specified in the data model.
|
Object |
getValue(Path aPath)
Returns the value at the specified path.
|
ValueContextForInputValidation |
getValueContext(Path aPath)
Returns the validation context of the specified node.
|
String |
getWebNameFor(String aLocalId)
Returns a string that uniquely identifies the entity specified in the context of the current
form in the current page.
|
String |
getWebNameForPath(Path aPath)
Returns a string that uniquely identifies the entity specified in the context of the current
form in the current page.
|
boolean |
isCreatingRecord()
Returns
true if the form is displayed in
the context of a new record creation. |
boolean |
isDuplicatingRecord()
Returns
true if the form is displayed in
the context of the duplication of an existing record. |
Locale getLocale()
Session getSession()
HierarchyNode getHierarchyNode()
UIForm
is instantiated in the context of a hierarchy.
Returns null
otherwise.
This method allows to specialize the look and feel of user interface according to the hierarchy context.
Object getValue(Path aPath)
aPath
- the location of the target relative to the current node (for maximizing reusability,
it is advised to use a relative path)SchemaNode getTableNode()
SchemaNode getNode(Path aPath)
SchemaNode.getNode(Path)
String getWebNameFor(String aLocalId)
String getWebNameForPath(Path aPath)
aPath
- location of the target relative to the current node (for maximizing reusability,
it is advised to use a relative path)ValueContextForInputValidation getValueContext(Path aPath)
String getOptionalRequestParameterValue(String aParameterName)
String[] getOptionalRequestParameterValues(String aParameterName)
String displayOccurrence(Object aValue, SchemaNode aNode, boolean useLabels)
The specified value must be related to the specified node.
boolean isCreatingRecord()
true
if the form is displayed in
the context of a new record creation. In this case, the persistent record
does not yet exist.boolean isDuplicatingRecord()
true
if the form is displayed in
the context of the duplication of an existing record. In this case, the target persistent record
does not yet exist.Adaptation getCurrentDataSet()