com.ibm.mashups.enabler.model.state
Interface UrlGenerator


public UrlGenerator

Interface representing an UrlGenerator.


Method Summary
 String getUrl(NavigationStateModel navStateModel, Function callback, JSON params)
          Deprecated.  Use getURL instead.
 String getURL(NavigationStateModel navStateModel, Function callback, JSON params)
           Returns the URL based on navigation state model and additional parameters.
 

Method Detail

getUrl

String getUrl(NavigationStateModel navStateModel,
              Function callback,
              JSON params)
Deprecated.  Use getURL instead.

Returns the URL based on navigation state model and additional parameters. Sample parameter: { nohash:"true"} if "nohash" is set to "true",the returned URL will not contain state in hash.

Parameters:
navStateModel - NavigationStateModel to generate URL
callback - callback funtion is invoked when URL is generated, URL will be passed into callback
params - additional parameter in json format
Returns:
The URL that's generated based on navigationStateModel

getURL

String getURL(NavigationStateModel navStateModel,
              Function callback,
              JSON params)
Returns the URL based on navigation state model and additional parameters. Sample parameter: { nohash:"true"} if "nohash" is set to "true",the returned URL will not contain state in hash.

Parameters:
navStateModel - NavigationStateModel to generate URL
callback - callback funtion is invoked when URL is generated, URL will be passed into callback
params - additional parameter in json format
Returns:
The URL that's generated based on navigationStateModel


Copyright IBM Corp. 2010 All Rights Reserved.