String classifier
String type
String id
String augmentationKey
InternationalizedMessage label
InternationalizedMessage description
Integer order
String scope
boolean translatable
List<E> conditionals
Map<K,V> attributes
Map<K,V> components
Map<K,V> actions
Map<K,V> endpoints
boolean hidden
ExplanatoryMessage helpText
ExplanatoryMessage tooltip
InternationalizedMessage hint
InternationalizedMessage description
InternationalizedMessage message
ExplanatoryMessage.Placement placement
String name
String value
String connective
String componentId
Component targeted by a ComponentRoute that this will provide a
link to.String path
Alternative to Link.componentId to provide a static path as a link, e.g. "/products/:id".
This will take second priority to Link.componentId if you need to statically reference a
path.
This supports any valid URL path that https://github.com/pillarjs/path-to-regexp/tree/v1.7.0 understands, e.g. "/products", "/products/:id", and "/categories/:id?" are all valid URL paths. Must start with a slash, and optionally may include any path parameters as necessary.
Map<K,V> params
int errorLimit
int limit
PollableOptions.PollStrategy<S extends PollableOptions.PollStrategy<S>> strategy
int interval
int interval
int min
int max
int start
int increment
PollableOptions.PollStrategyType type
String field
String matchStrategy
CollectionConditionalMatchStrategy#ALL,
this will match only when all collection members are a match. If
CollectionConditionalMatchStrategy#ANY, this will match when at least one collection
member is a match.List<E> conditionals
boolean matchIfEmpty
String type
String uri
Endpoint.Method method
String scope
Map<K,V> params
Map<K,V> headers
List<E> mapParams
TransformBody transformRequestBody
TransformBody transformResponseBody
String name
Object defaultValue
boolean readOnly
boolean required
boolean showInQueryBuilder
InternationalizedMessage requiredMessage
InternationalizedMessage placeholder
AbstractValidationSchema<S extends AbstractValidationSchema<S>> validationSchema
String value
InternationalizedMessage label
The user-friendly text that the user sees as the select option
This label can be a message key for I18n concerns
String color
Map<K,V> attributes
String name
InternationalizedMessage message
List<E> args
String from
String to
PropertyMapping.ROOT then all properties from PropertyMapping.from will be mapped
to the root object.String operation
Object value
PropertyMapping.to This is ignored if
PropertyMapping.from is definedboolean copy
String message
String path
This supports any valid URL path that https://github.com/pillarjs/path-to-regexp/tree/v1.7.0 understands, e.g. "/products", "/products/:id", and "/categories/:id?" are all valid URL paths. Must start with a slash, and optionally may include any path parameters as necessary.
String componentId
Component.id(java.lang.String) of the Component that will be rendered for this route.String componentName
ComponentRoute.componentId for non-metadata-driven components like "not found"
views.
This should not be used if ComponentRoute.componentId is provided.List<E> scopes
boolean exact
Whether or not the route requires an exact match to render. This is typically true, but can be set to false when you have a component that needs support for sub-routes.
Setting this to Boolean.FALSE will allow partial matching of the url. See the table
below for how exact and non-exact routes work.
| path | location.pathname | exact | matches? |
|---|---|---|---|
/one |
/one/two |
true |
no |
/one |
/one/two |
false |
yes |
Refer to https://reacttraining.com/react-router/web/api/Route/exact-bool for more details.
int order
The order of this route. This can be used to ensure that routes are returned in a certain order. The ordering of routes can matter as a route that is provided earlier takes precedence over a route provided later.
As an example, take a route with a path of "/products/create" and one with a path of "/products/:id". If "/products/create" comes after "/products/:id", then it will never be matched, because they are equal precedence and "/products/:id" will match first.
Predicate<T> predicate
Predicate for this route. This will be used to evaluate whether or not this route
should be returned for a given WebRequest.Copyright © 2021. All rights reserved.