PRIM_WEB.Route (PRIM_WEB.Route)
A simple component class that associates a path string with the Visual LANSA Web View class that is to be displayed when the route's FullPath matches the path component of the current URL
Ancestors - PRIM_WEB.Routable (PRIM_WEB.Routable) Object (PRIM_OBJT)
The Route class associates a path string with the Visual LANSA web view component.
It is displayed when the path string matches the current URL path component.
The parent property of this class can be used to form a tree of routes where the FullPath of a route is derived from the FullPath of its parent and the route's Path string.
The FullPath in the Common Property of the Route Class should be: /Customers/{CustomerId}.
The Access property of the PRIM_WEB.Route class flags protected routes. Visual LANSA does not apply meaning to protected routes. The application code is responsible for the appropriate actions to ensure route integrity. Usually, it requires to Sign In to the route if the user is not signed in at the time the route is accessed.
| Name | Description |
|---|---|
| Access | Read-write property that supports three values - *SQLNULL, Public and Protected. The default is *SQLNULL. When the routing framework attempts to resolve a route's Access, *SQLNULL is used to indicate that the Access property of the route's parent should be used. When the top of the tree is reached, Public is used |
| ComponentClassName | ComponentClassName is the name of the component's class. Inherited from Object (PRIM_OBJT) |
| ComponentMembers | ComponentMembers provides access to all the member components of this component Inherited from Object (PRIM_OBJT) |
| ComponentPatternName | ComponentPatternName is used to qualify the class of the component. Inherited from Object (PRIM_OBJT) |
| ComponentTag | Generic space allowing a value to be stored for the instance Inherited from Object (PRIM_OBJT) |
| ComponentType | ComponentType gives you access to the type information about the component Inherited from Object (PRIM_OBJT) |
| ComponentTypeName | ComponentTypeName is the fully qualified name of the component's class. Inherited from Object (PRIM_OBJT) |
| FullPath | Read-only property that provides a path string that includes the FullPath of the route's parent |
| IsProtected | A read-only boolean property that resolves that Access property up the parent chain to determine if the route is protected or not |
| Name | Name identifies the component Inherited from Object (PRIM_OBJT) |
| OnCloseAction | This property supports four values - *SQLNULL, DropInstance, KeepInstance, KeepRealized. The default is *SQLNULL. DropInstance is used to reset the reference to the view being closed which means that a new instance will be created the next time this route is activated. KeepInstance retains the component instance but does not keep it realized. KeepRealized keeps the component instance in its realized state. When the routing framework attempts to resolve a route's OnCloseAction, *SQLNULL is used to indicate that the OnCloseAction property of the route's parent should be used. When the top of the tree is reached, DropInstance is used. When this property is changed after the associated view is closed, the selected OnCloseAction is applied to the component instance |
| Owner | Owner owns this component Inherited from Object (PRIM_OBJT) |
| Parent | A property that controls where in the path hierarchy this route belongs. Use a Router as the parent when the route defines a topmost path, or another route component that will qualify the route's path |
| Path | A string that defines the values to be used to match against the current URL path component. Use the '{name}' format for a path segment should the segment need to identify a variable. Use the form '/name/partialname*' for a wildcard path. The asterisk must be at the end of the path segment |
| Redirect | A string that defines a new path should the current route match the current URL path component. Make sure the value starts with a forward slash ('/') if the new path is an absolute path and is to be append to the current application's URL root path. When the string does not begin with a forward slash it is treated as a relative path and is appended to the current URL's path component |
| RelatedReference | Reference to an object instance to be stored for this item that provides a convenient, generic storage point that joins the Routable instance to a data object. This data object is then available to support specific processing of a routable object, like the storage of additional user interface components and data for authorization checks. Inherited from PRIM_WEB.Routable (PRIM_WEB.Routable) |
| Router | A read-only property that traverses up the parent chain to find the first parent that is a PRIM_WEB.Router or *NULL if not found Inherited from PRIM_WEB.Routable (PRIM_WEB.Routable) |
| View | Name of the web view repository component that will be displayed when the route's path matches the current URL path component. The files that implement the web view will not be downloaded to the browser until the view is required. It will be downloaded asynchronously |
| Name | Description |
|---|---|
| CreateInstance | CreateInstance is signalled when an instance of a component is created Inherited from PRIM_WEB.Route (PRIM_WEB.Route) |
| DestroyInstance | DestroyInstance is signalled when an instance of a component is about to be destroyed Inherited from PRIM_WEB.Route (PRIM_WEB.Route) |
| Name | Description |
|---|---|
| CreateRoute | Method to support creation of a route when building a dynamic router Inherited from PRIM_WEB.Routable (PRIM_WEB.Routable)
Result, Path, View, Parent |