public interface UIFormContext extends UIResourceLocator, UISessionContext
UIForm
Modifier and Type | Method and Description |
---|---|
Adaptation |
getCurrentDataSet()
Returns the dataset containing the current record.
|
Perspective |
getCurrentPerspective()
Returns the current perspective.
|
Adaptation |
getCurrentRecord()
Returns the persisted record being edited.
|
SchemaNode |
getCurrentRecordNode()
Returns the persisted record node being edited.
|
AdaptationTable |
getCurrentTable()
Returns the current table in which the record is going to be created/modified.
|
String |
getOptionalRequestParameterValue(String aParameterName)
Returns the HTTP parameter values in the incoming request.
|
String[] |
getOptionalRequestParameterValues(String aParameterName)
Returns the HTTP parameter values in the incoming request.
|
String |
getPreviousTabSelected(String aTabbedPaneId)
Returns the tab id selected prior to submit in the associated
tabbed pane . |
ValueContext |
getValueContext()
Returns the value context of the root of the record.
|
boolean |
isCalledFromAdminContext()
Returns
true if this form pane is displayed from a screen of the administration section. |
boolean |
isCalledFromWorkflowContext()
Returns
true if this form pane is displayed from a screen of the workflow section. |
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. |
createWebComponentForRootSession, createWebComponentForSubSession, getURLForAjaxComponent, getURLForAjaxComponent, getURLForPerspectiveSelection, getURLForPerspectiveSelection, getURLForResource, getURLForResource, getURLForResource, getURLForResource, getURLForResource, getURLForRest, getURLForSelection, getURLForSelection, getURLForSelection, getURLForSelection, getURLForSelection, getURLForSelection, getURLForViewSelection
getLocale, getSession
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.boolean isCalledFromWorkflowContext()
true
if this form pane is displayed from a screen of the workflow section.boolean isCalledFromAdminContext()
true
if this form pane is displayed from a screen of the administration section.Adaptation getCurrentDataSet()
Adaptation getCurrentRecord()
null
if in
creation mode.
Note: it is recommended to access values by means of the
method getValueContext()
, except for specific needs.
SchemaNode getCurrentRecordNode()
null
if in
creation mode.
Note: it is recommended to access values by means of the
method getValueContext()
, except for specific needs.
AdaptationTable getCurrentTable()
ValueContext getValueContext()
String getOptionalRequestParameterValue(String aParameterName)
String[] getOptionalRequestParameterValues(String aParameterName)
String getPreviousTabSelected(String aTabbedPaneId)
tabbed pane
.
aTabbedPaneId
shall be a valid id of an UIFormPaneWithTabs
.
aTabbedPaneId
- the id of the tabbed pane
null
if it is the initial page load,
or if aTabbedPaneId
is not associated with a tabbed pane.Perspective getCurrentPerspective()