public interface UserServiceResourceLocator extends UIResourceLocator
Modifier and Type | Method and Description |
---|---|
String |
getURLForAction(UserServiceEvent aCallback)
Returns a URL that will trigger an action event when clicked by a user.
|
String |
getURLForAction(UserServiceEvent aCallback,
URLQuery aQuery)
Returns a URL that will trigger an action event when clicked by a user.
|
String |
getURLForAjaxRequest(UserServiceAjaxRequest aCallback)
Returns a URL that will invoke an Ajax request callback.
|
String |
getURLForAjaxRequest(UserServiceAjaxRequest aCallback,
URLQuery aQuery)
Returns a URL that will invoke an Ajax request callback.
|
String |
getURLForEndingService()
Returns a user interface URL indicating that the execution of this
service is finished.
|
String |
getURLForGetRequest(UserServiceGetRequest aCallback)
Returns a URL that will invoke a GET request callback.
|
String |
getURLForGetRequest(UserServiceGetRequest aCallback,
URLQuery aQuery)
Returns a URL that will invoke a GET request callback.
|
String |
getURLForResource(String aModuleName,
String aResourcePath)
Returns the URL string for the specified web resource.
|
String |
getURLForResource(String aModuleName,
String aResourcePath,
URLQuery aQuery)
Returns the URL string for the specified web resource.
|
String |
getURLForServiceSelection(Adaptation aRecordOrInstance,
SchemaNode aNode,
ServiceKey aServiceKey)
Deprecated.
|
String |
getURLForServiceSelection(ServiceKey aServiceKey)
Returns a user interface URL to start the specified service.
|
String |
getURLForServiceSelection(ServiceKey aServiceKey,
Adaptation aRecordOrDataSet)
Returns a user interface URL which selects the specified record or
dataset and starts the specified service on it.
|
String |
getURLForServiceSelection(ServiceKey aServiceKey,
AdaptationHome aDataSpaceOrSnapshot)
Returns a user interface URL that selects the specified dataspace or
snapshot and starts the specified service on it.
|
String |
getURLForServiceSelection(ServiceKey aServiceKey,
AdaptationHome aDataSpaceOrSnapshot,
URLQuery aQuery)
Returns a user interface URL that selects the specified dataspace or
snapshot and starts the specified service on it.
|
String |
getURLForServiceSelection(ServiceKey aServiceKey,
Adaptation aRecordOrInstance,
SchemaNode aNode)
Returns a user interface URL which selects the specified node of the
given record or dataset and starts the specified service on it.
|
String |
getURLForServiceSelection(ServiceKey aServiceKey,
Adaptation aRecordOrInstance,
SchemaNode aNode,
URLQuery aQuery)
Returns a user interface URL which selects the specified node of the
given record or dataset and starts the specified service on it.
|
String |
getURLForServiceSelection(ServiceKey aServiceKey,
Adaptation aRecordOrDataSet,
URLQuery aQuery)
Returns a user interface URL which selects the specified record or
dataset and starts the specified service on it.
|
String |
getURLForServiceSelection(ServiceKey aServiceKey,
URLQuery aQuery)
Returns a user interface URL to start the specified service.
|
createWebComponentForRootSession, createWebComponentForSubSession, getURLForAjaxComponent, getURLForAjaxComponent, getURLForPerspectiveSelection, getURLForPerspectiveSelection, getURLForResource, getURLForResource, getURLForResource, getURLForResource, getURLForResource, getURLForRest, getURLForSelection, getURLForSelection, getURLForSelection, getURLForSelection, getURLForSelection, getURLForSelection, getURLForViewSelection
String getURLForAction(UserServiceEvent aCallback)
Calling this method has the same result as calling
getURLForAction(aCallback, null)
.
aCallback
- the callback that will be called when receiving the action event.String getURLForAction(UserServiceEvent aCallback, URLQuery aQuery)
aCallback
- the callback that will be called when receiving the action event.aQuery
- query that is added to the URL. May be null
.String getURLForAjaxRequest(UserServiceAjaxRequest aCallback)
Calling this method has the same result as calling
getURLForAjaxRequest(aCallback, null)
.
aCallback
- the callback that will be called when receiving the action event.String getURLForAjaxRequest(UserServiceAjaxRequest aCallback, URLQuery aQuery)
aCallback
- the callback that will be called when receiving the action event.aQuery
- query that is added to the URL. May be null
.String getURLForGetRequest(UserServiceGetRequest aCallback)
Calling this method has the same result as calling
getURLForGetRequest(aCallback, null)
.
aCallback
- the callback that will be called when receiving the action event.String getURLForGetRequest(UserServiceGetRequest aCallback, URLQuery aQuery)
aCallback
- the callback that will be called when receiving the action event.aQuery
- query that is added to the URL. May be null
.String getURLForEndingService()
If the service was displayed in a pop-up window, the latter is closed automatically.
For a user service form, the action is the same as clicking on a default close button.
String getURLForServiceSelection(ServiceKey aServiceKey)
ServiceKey.WORKFLOW
).aServiceKey
- the service key.String getURLForServiceSelection(ServiceKey aServiceKey, URLQuery aQuery)
ServiceKey.WORKFLOW
).aServiceKey
- the service key.aQuery
- query that is added to the URL. May be null
.String getURLForServiceSelection(ServiceKey aServiceKey, AdaptationHome aDataSpaceOrSnapshot)
aServiceKey
- the service key.aDataSpaceOrSnapshot
- the dataspace or snapshot.String getURLForServiceSelection(ServiceKey aServiceKey, AdaptationHome aDataSpaceOrSnapshot, URLQuery aQuery)
aServiceKey
- the service key.aDataSpaceOrSnapshot
- the dataspace or snapshot.aQuery
- query that is added to the URL. May be null
.String getURLForServiceSelection(ServiceKey aServiceKey, Adaptation aRecordOrDataSet)
Calling this method has the same result as calling
getURLForServiceSelection(aServiceKey, aRecordOrInstance, aNode, URLQuery)
.
aServiceKey
- the service key.aRecordOrDataSet
- the record or dataset.String getURLForServiceSelection(ServiceKey aServiceKey, Adaptation aRecordOrDataSet, URLQuery aQuery)
aServiceKey
- the service key.aRecordOrDataSet
- the record or dataset.aQuery
- query that is added to the URL. May be null
.String getURLForServiceSelection(Adaptation aRecordOrInstance, SchemaNode aNode, ServiceKey aServiceKey)
getURLForServiceSelection(ServiceKey, Adaptation, SchemaNode, URLQuery)
.String getURLForServiceSelection(ServiceKey aServiceKey, Adaptation aRecordOrInstance, SchemaNode aNode)
aServiceKey
- the service key.aRecordOrInstance
- the dataspace or snapshot.aNode
- the node.String getURLForServiceSelection(ServiceKey aServiceKey, Adaptation aRecordOrInstance, SchemaNode aNode, URLQuery aQuery)
aServiceKey
- the service key.aRecordOrInstance
- the dataspace or snapshot.aNode
- the node.aQuery
- query that is added to the URL. May be null
.String getURLForResource(String aModuleName, String aResourcePath)
Calling this method has the same result as calling
getURLForResource(aModuleName, aResourcePath, URLQuery)
.
aModuleName
- the name of the module containing the resource.aResourcePath
- must begin with a "/" and is interpreted as relative to the
specified module (web
application) root.String getURLForResource(String aModuleName, String aResourcePath, URLQuery aQuery)
aModuleName
- the name of the module containing the resource.aResourcePath
- must begin with a "/" and is interpreted as relative to the
specified module (web
application) root.aQuery
- query that is added to the URL. May be null
.