Package com.orchestranetworks.ui.form
Interface UIFormContext
- All Superinterfaces:
UIResourceLocator
,UISessionContext
Context provided by the user interface container
that helps when defining the various parts of a custom form.
- Since:
- 5.3.0
- See Also:
-
Method Summary
Modifier and TypeMethodDescriptionReturns the dataset containing the current record.Returns the current perspective.Returns the persisted record being edited.Returns the persisted record node being edited.Returns the current table in which the record is going to be created/modified.Returns the view context.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.getPreviousTabSelected
(String aTabbedPaneId) Returns the tab id selected prior to submit in the associatedtabbed pane
.Returns the value context of the root of the record.boolean
Returnstrue
if this form pane is displayed from a screen of the administration section.boolean
Returnstrue
if this form pane is displayed from a screen of the workflow section.boolean
Returnstrue
if the form is displayed in the context of a new record creation.boolean
Returnstrue
if the form is displayed in the context of the duplication of an existing record.Methods inherited from interface com.orchestranetworks.ui.UIResourceLocator
createWebComponentForRootSession, createWebComponentForSubSession, getURLForAjaxComponent, getURLForAjaxComponent, getURLForPerspectiveSelection, getURLForPerspectiveSelection, getURLForResource, getURLForResource, getURLForResource, getURLForResource, getURLForResource, getURLForRest, getURLForSelection, getURLForSelection, getURLForSelection, getURLForSelection, getURLForSelection, getURLForSelection, getURLForViewSelection
Methods inherited from interface com.orchestranetworks.ui.UISessionContext
getLocale, getSession
-
Method Details
-
isCreatingRecord
boolean isCreatingRecord()Returnstrue
if the form is displayed in the context of a new record creation. In this case, the persistent record does not yet exist. -
isDuplicatingRecord
boolean isDuplicatingRecord()Returnstrue
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. -
isCalledFromWorkflowContext
boolean isCalledFromWorkflowContext()Returnstrue
if this form pane is displayed from a screen of the workflow section. -
isCalledFromAdminContext
boolean isCalledFromAdminContext()Returnstrue
if this form pane is displayed from a screen of the administration section. -
getCurrentDataSet
Adaptation getCurrentDataSet()Returns the dataset containing the current record. -
getCurrentRecord
Adaptation getCurrentRecord()Returns the persisted record being edited. Returnsnull
if in creation mode.Note: it is recommended to access values by means of the method
getValueContext()
, except for specific needs. -
getCurrentRecordNode
SchemaNode getCurrentRecordNode()Returns the persisted record node being edited. Returnsnull
if in creation mode.Note: it is recommended to access values by means of the method
getValueContext()
, except for specific needs.- Since:
- 5.8.0
-
getCurrentTable
AdaptationTable getCurrentTable()Returns the current table in which the record is going to be created/modified. Never returns null. -
getValueContext
ValueContext getValueContext()Returns the value context of the root of the record. -
getOptionalRequestParameterValue
Returns the HTTP parameter values in the incoming request.- Since:
- 5.5.0
-
getOptionalRequestParameterValues
Returns the HTTP parameter values in the incoming request.- Since:
- 5.5.0
-
getPreviousTabSelected
Returns the tab id selected prior to submit in the associatedtabbed pane
.aTabbedPaneId
shall be a valid id of anUIFormPaneWithTabs
.- Parameters:
aTabbedPaneId
- the id of thetabbed pane
- Returns:
- the tab id selected prior to submit,
ornull
if it is the initial page load, or ifaTabbedPaneId
is not associated with a tabbed pane. - Since:
- 5.8.0
-
getCurrentPerspective
Perspective getCurrentPerspective()Returns the current perspective.- Since:
- 6.0.0
-
getCustomViewContext
UICustomViewContext getCustomViewContext()Returns the view context.- Since:
- 6.1.0
-