io.jmix.ui.navigation

Interface UrlRouting.RouteGenerator

All Known Implementing Classes:

WebUrlRouting.RouteGeneratorImpl

Enclosing interface:

UrlRouting

public static interface UrlRouting.RouteGenerator

Provides API to generate routes for screens with optional URL parameters.

Method Summary

Modifier and Type	Method and Description
default java.lang.String	getEditorRoute(java.lang.Object entity) Generates route for default editor with the given entity.
default java.lang.String	getEditorRoute(java.lang.Object entity, java.lang.Class<? extends Screen> screenClass) Generates route for editor with the given screenClass and entity.
java.lang.String	getEditorRoute(java.lang.Object entity, java.lang.Class<? extends Screen> screenClass, java.util.Map<java.lang.String,java.lang.String> urlParams) Generates route for editor with the given screenClass and entity and urlParams.
java.lang.String	getEditorRoute(java.lang.Object entity, java.util.Map<java.lang.String,java.lang.String> urlParams) Generates route for default editor with the given entity and urlParams.
default java.lang.String	getEditorRoute(java.lang.Object entity, java.lang.String screenId) Generates route for editor with the given screenId and entity.
java.lang.String	getEditorRoute(java.lang.Object entity, java.lang.String screenId, java.util.Map<java.lang.String,java.lang.String> urlParams) Generates route for editor with the given screenId and entity and urlParams.
default java.lang.String	getRoute(java.lang.Class<? extends Screen> screenClass) Generates route for screen with the given screenClass.
java.lang.String	getRoute(java.lang.Class<? extends Screen> screenClass, java.util.Map<java.lang.String,java.lang.String> urlParams) Generates route for screen with the given screenClass and urlParams.
default java.lang.String	getRoute(java.lang.String screenId) Generates route for screen with the given screenId.
java.lang.String	getRoute(java.lang.String screenId, java.util.Map<java.lang.String,java.lang.String> urlParams) Generates route for screen with the given screenId and urlParams.

Method Detail

getRoute

default java.lang.String getRoute(java.lang.String screenId)

Generates route for screen with the given screenId.

Parameters:

screenId - screen id

Returns:

generated route

getRoute

default java.lang.String getRoute(java.lang.Class<? extends Screen> screenClass)

Generates route for screen with the given screenClass.

Parameters:

screenClass - screen class

Returns:

generated route

getEditorRoute

default java.lang.String getEditorRoute(java.lang.Object entity)

Generates route for default editor with the given entity.

Entity id will be passed as URL param.

Parameters:

entity - entity to edit

Returns:

generated route

getEditorRoute

default java.lang.String getEditorRoute(java.lang.Object entity,
                                        java.lang.String screenId)

Generates route for editor with the given screenId and entity.

Entity id will be passed as URL param.

Parameters:

entity - entity to edit

screenId - editor screen id

Returns:

generated route

getEditorRoute

default java.lang.String getEditorRoute(java.lang.Object entity,
                                        java.lang.Class<? extends Screen> screenClass)

Generates route for editor with the given screenClass and entity.

Parameters:

entity - entity to edit

screenClass - editor screen class

Returns:

generated route

getRoute

java.lang.String getRoute(java.lang.String screenId,
                          java.util.Map<java.lang.String,java.lang.String> urlParams)

Generates route for screen with the given screenId and urlParams.

Parameters:

screenId - screen id

urlParams - URL params

Returns:

generated route

getRoute

java.lang.String getRoute(java.lang.Class<? extends Screen> screenClass,
                          java.util.Map<java.lang.String,java.lang.String> urlParams)

Generates route for screen with the given screenClass and urlParams.

Parameters:

screenClass - screen class

urlParams - URL params

Returns:

generated route

getEditorRoute

java.lang.String getEditorRoute(java.lang.Object entity,
                                java.util.Map<java.lang.String,java.lang.String> urlParams)

Generates route for default editor with the given entity and urlParams.

Entity id will be passed as URL param.

Parameters:

entity - entity to edit

urlParams - URL params

Returns:

generated route

getEditorRoute

java.lang.String getEditorRoute(java.lang.Object entity,
                                java.lang.String screenId,
                                java.util.Map<java.lang.String,java.lang.String> urlParams)

Generates route for editor with the given screenId and entity and urlParams.

Entity id will be passed as URL param.

Parameters:

entity - entity to edit

screenId - editor screen id

urlParams - URL params

Returns:

generated route

getEditorRoute

java.lang.String getEditorRoute(java.lang.Object entity,
                                java.lang.Class<? extends Screen> screenClass,
                                java.util.Map<java.lang.String,java.lang.String> urlParams)

Generates route for editor with the given screenClass and entity and urlParams.

Parameters:

entity - entity to edit

screenClass - editor screen class

urlParams - URL params

Returns:

generated route