Interface WidgetValidationContext
- All Known Subinterfaces:
WidgetListValidationContext
- Since:
- 5.8.0
- See Also:
-
Method Summary
Modifier and TypeMethodDescriptionReturns the node located at the specified path.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.getPermission
(Path aPath) Returns the current user's access rights on the node specified by a path.Returns the current session.Returns the value to the specified path.Returns the validation context of the current node.getValueContext
(Path aPath) Returns the validation context of the specified node.Returns a string that uniquely identifies the current component in the current page.getWidgetName
(Path aPath) Returns the custom widget name based on the given path.getWidgetName
(String aLocalId) Returns the custom widget name based on the given string.Returns the custom widget name of the parent component.
-
Method Details
-
getValue
Returns the value to the specified path.- Parameters:
aPath
- the location of the target relative to the current node (for maximizing reusability, it is advised to use a relative path)
-
getSession
Session getSession()Returns the current session. -
getValueContext
ValueContextForInputValidation getValueContext()Returns the validation context of the current node. -
getValueContext
Returns the validation context of the specified node. -
getOptionalRequestParameterValue
Returns the HTTP parameter value in the incoming request. -
getOptionalRequestParameterValues
Returns the HTTP parameter values in the incoming request. -
getNode
Returns the node located at the specified path.- See Also:
-
getWidgetName
String getWidgetName()Returns a string that uniquely identifies the current component in the current page.The widget name is only to be used on custom external components (with the HTML attribute name or id for example). It must not be used to manipulate native components or widgets. Native components are internal and the widget name policy can be modified at any time.
-
getWidgetName
Returns the custom widget name based on the given path. Can be used as a prefix or a suffix to generate identifiers of inner input components.The widget name is only to be used on custom external components (with the HTML attribute name or id for example). It must not be used to manipulate native components or widgets. Native components are internal and the widget name policy can be modified at any time.
- Parameters:
aPath
- location of the target relative to the current node (for maximizing reusability, it is advised to use a relative path)
-
getWidgetName
Returns the custom widget name based on the given string. Can be used as a prefix or a suffix to generate identifiers of inner input components.The widget name is only to be used on custom external components (with the HTML attribute name or id for example). It must not be used to manipulate native components or widgets. Native components are internal and the widget name policy can be modified at any time.
- Parameters:
aLocalId
- must respect the pattern[a-zA-Z0-9_.-]+
-
getWidgetNameOfParent
String getWidgetNameOfParent()Returns the custom widget name of the parent component. Can be used as a prefix or a suffix to generate identifiers of inner input components.The web name is only to be used on custom external components (with the HTML attribute name or id for example). It must not be used to manipulate native components or widgets. Native components are internal and the web name policy can be modified at any time.
-
getPermission
Returns the current user's access rights on the node specified by a path.- Parameters:
aPath
- the path of the node. The path must be relative to the path of the current widget.- Throws:
PathAccessException
- to report that the path is invalid.- See Also:
-