public interface UIResourceLocator
Modifier and Type | Method and Description |
---|---|
UIHttpManagerComponent |
createWebComponentForRootSession()
Returns a factory for creating a URL that, when used, creates a new navigation context in a
separate root user session (namely, a Web Component).
|
UIHttpManagerComponent |
createWebComponentForSubSession()
Returns a factory for creating a URL that, when used, creates a new navigation context in a
separate sub-session (namely, a Web Component).
|
String |
getURLForAjaxComponent(String ajaxComponentName)
Returns the URL for the specified Ajax component.
|
String |
getURLForAjaxComponent(String ajaxComponentName,
Map<String,String> parameters)
Returns the URL for the specified Ajax component.
|
String |
getURLForPerspectiveSelection(String aPerspectiveName)
Returns a URL that, when used, changes the current navigation context to
the specified perspective.
|
String |
getURLForPerspectiveSelection(String aPerspectiveName,
String aPerspectiveActionName)
Returns a URL that, when used, changes the current navigation context to
the specified perspective action.
|
String |
getURLForResource(ResourceType aResourceType,
String aResourceName)
Returns the URL of the specified web resource in the current module (that is, the module of
the current adaptation) for the current session locale.
|
String |
getURLForResource(ResourceType aResourceType,
String aResourceName,
Locale aLocale)
Returns the URL of the specified web resource in the current module (that is, the module of
the current adaptation) for the specified locale.
|
String |
getURLForResource(SchemaNode aSchemaNode,
Object aValue)
Returns the URL of the web resource specified by the value of a resource type node.
|
String |
getURLForResource(String aResourcePath)
Returns the URL string for the specified web resource.
|
String |
getURLForResource(String aModuleName,
ResourceType aResourceType,
String aResourceName,
Locale aLocale)
Returns the URL of the specified web resource.
|
String |
getURLForRest(String aPath,
URLQuery aQuery)
Returns the REST URL string for the specified path and query.
|
String |
getURLForSelection(Adaptation aDataSetOrRecord)
Returns a URL that, when used, changes the current navigation context to
the specified dataset or record.
|
String |
getURLForSelection(AdaptationHome aDataSpaceOrSnapshot)
Returns a URL that, when used, changes the current navigation context to
the specified dataspace or snapshot.
|
String |
getURLForSelection(Adaptation aDataSetOrRecord,
Path aPath)
Returns a URL that, when used, changes the current navigation context to
the specified node and dataset or record.
|
String |
getURLForSelection(WorkflowView aWorkflowView)
Returns a URL that, when used, changes the current navigation context to
the specified data workflows section.
|
String |
getURLForSelection(WorkItemKey aWorkItemKey)
Returns a URL that, when used, changes the current navigation context to
the specified work item.
|
String |
getURLForSelection(WorkItemKey aWorkItemKey,
boolean shouldAllocateAndStart)
Returns a URL that, when used, changes the current navigation context to
the specified work item.
|
String |
getURLForViewSelection(Adaptation instance,
String viewPublication)
Returns a URL that, when used, changes the current navigation context to
the specified custom view in the specified dataset.
|
UIHttpManagerComponent createWebComponentForRootSession()
When the property ebx.servlet.useLocalUrl
in the
EBX® main configuration file is set
to 'true', the URL obtained can be used as a permanent link (permalink) to access the
current EBX® repository.
The authentication must be properly managed by passing adequate parameters or the end user will need to authenticate by logging in.
The Web Component must be invoked within a pop-up or inner pop-up (or iFrame).
A standard inner pop-up can be created by using the method
UIComponentWriter.buildButtonPreview(String)
.
createWebComponentForSubSession()
,
getURLForSelection(Adaptation)
UIHttpManagerComponent createWebComponentForSubSession()
trackingInfo
(these inherited properties are available using the Session
interface).
The Web Component must be invoked within a pop-up, inner pop-up, or iFrame.
A standard inner pop-up can be created by using the method
UIComponentWriter.buildButtonPreview(String)
.
createWebComponentForRootSession()
,
getURLForSelection(Adaptation)
String getURLForSelection(Adaptation aDataSetOrRecord)
It is recommended to keep the link target in the same window.
In the case where the current navigation context must remain unchanged, a
web component
must be invoked within a pop-up,
inner pop-up, or iFrame. A standard inner pop-up can be created by using the method
UIComponentWriter.buildButtonPreview(String)
.
String getURLForViewSelection(Adaptation instance, String viewPublication)
It is recommended to keep the link target in the same window.
In the case where the current navigation context must remain unchanged, a
web component
must be invoked within a pop-up,
inner pop-up, or iFrame. A standard inner pop-up can be created by using the method
UIComponentWriter.buildButtonPreview(String)
.
String getURLForSelection(Adaptation aDataSetOrRecord, Path aPath)
It is recommended to keep the target of the link in the same window.
In the case where the current navigation context must remain unchanged, a
web component
must be invoked within a pop-up,
inner pop-up, or iFrame. A standard inner pop-up can be created by using the method
UIComponentWriter.buildButtonPreview(String)
.
String getURLForSelection(AdaptationHome aDataSpaceOrSnapshot)
It is recommended to keep the target of the link in the same window.
In the case where the current navigation context must remain unchanged, a
web component
must be invoked within a pop-up,
inner pop-up, or iFrame. A standard inner pop-up can be created by using the method
UIComponentWriter.buildButtonPreview(String)
.
String getURLForSelection(WorkItemKey aWorkItemKey)
WorkflowView.INBOX
It is recommended to keep the target of the link in the same window.
aWorkItemKey
- key of the work item to be selectedString getURLForSelection(WorkItemKey aWorkItemKey, boolean shouldAllocateAndStart)
WorkflowView.INBOX
It is recommended to keep the target of the link in the same window.
aWorkItemKey
- key of the work item to be selectedshouldAllocateAndStart
- if true the target work item will be
automatically allocated to and started for the current user; does nothing if this
is already the case.String getURLForSelection(WorkflowView aWorkflowView)
It is recommended to keep the target of the link in the same window.
aWorkflowView
- key of the workflow view to be selectedString getURLForPerspectiveSelection(String aPerspectiveName)
It is recommended to keep the target of the link in the same window.
aPerspectiveName
- name of the perspective to be selectedString getURLForPerspectiveSelection(String aPerspectiveName, String aPerspectiveActionName)
It is recommended to keep the target of the link in the same window.
aPerspectiveName
- name of the perspective to be selectedaPerspectiveActionName
- name of the perspective action to be selectedString getURLForAjaxComponent(String ajaxComponentName)
ajaxComponentName
- name of the Ajax component declared either in the data model or in the module.UIAjaxComponent
String getURLForAjaxComponent(String ajaxComponentName, Map<String,String> parameters)
ajaxComponentName
- name of the Ajax component declared either in the data model or in the module.
If the Ajax component is declared in the module, the name should be prefixed by the
module's name
and '@' for example module_name@ajax_component_name
.parameters
- map defining HTTP parameters that are passed in the Ajax request.
It maps HTTP parameter names with their values.UIAjaxComponent
String getURLForResource(String aResourcePath)
The resource must be in the same web application as the service.
aResourcePath
- must begin with a "/" and is interpreted as relative to the module (web
application) root.String getURLForResource(ResourceType aResourceType, String aResourceName)
String getURLForResource(ResourceType aResourceType, String aResourceName, Locale aLocale)
UnsupportedOperationException
- if the resource type is internal (not accessible from HTTP).String getURLForResource(String aModuleName, ResourceType aResourceType, String aResourceName, Locale aLocale) throws ModuleNotFoundException
UnsupportedOperationException
- if the resource type is internal (not accessible from HTTP).ModuleNotFoundException
- if the specified name does not correspond to a module.String getURLForResource(SchemaNode aSchemaNode, Object aValue) throws IllegalArgumentException
aSchemaNode
- the schema node where the value comes from.
The schema node must be an osd:resource
type.aValue
- the value of the osd:resource
type.IllegalArgumentException
- if the schema node or the value is not an osd:resource
type.UIContext.getNode()
,
UIContext.getValue()
,
UIFormContext.getValueContext()
,
ValueContext.getValue()
,
Adaptation.get(Path)
String getURLForRest(String aPath, URLQuery aQuery) throws IllegalArgumentException
The REST service will be called using the current user's credentials.
aPath
- the path to the REST resource. It must start with a slash
character '/' and not contain the host (sample:
/ebx-dataservices/rest/data/v1/{dataspace}/{dataset}/{pathInDataSet}
)aQuery
- a list of URL query parameters that is added to the resulting
URL. May be null
.IllegalArgumentException
- if the provided REST resource path is null
or its
format is incorrect.RestConstants