com.ibm.mashups.enabler.model.url
Interface ModelUrlFactory


public ModelUrlFactory

Interface for a ModelUrl Factory that allows to generate ModelUrl's a comfortable way. This class should not be instantiated directly, but should be used through it's defined singleton (com.ibm.mashups.enabler.model.url.ModelUrlFactory).


Field Summary
 String NAVIGATION_URL
           Constant for creation of a navigation URL
 String LAYOUT_URL
           Constant for creation of a layout URL
 String SHARED_NAVIGATION_URL
           Constant for creation of a shared navigation URL
 String FRAGMENT_URL
           Constant for creation of a fragment URL
 String FRAGMENT_MEDIA_URL
           Constant for creation of a fragment-media URL
 String USER_URL
           Constant for creation of a user URL
 String THEME_URL
           Constant for creation of a theme URL
 String THEME_MEDIA_URL
           Constant for creation of a theme-media URL
 String CATALOG_URL
           Constant for creation of a catalog URL
 String CONFIG_URL
           Constant for creation of a config URL
 String SPACE_URL
           Constant for creation of a space URL
 String SPACE_FAVORITE_URL
           Constant for creation of a space-favorite URL
 String AC_URL
           Constant for creation of a ac URL
 String AI_URL
           Constant for creation of a ac URL
 String TEMPLATE_URL
           Constant for creation of a template URL
 String WIDGET_URL
           Constant for widget model
 String EVENT_URL
           Constant for event model
 String SUBMODEL_MEMBER
           Constant for member sub model
 String SUBMODEL_ROLE
           Constant for role sub model
 String SUBMODEL_ACCESS
           Constant for allowed-access sub model
 String SUBMODEL_RESOURCE
           Constant for resource sub model
 unknown RESOURCE_URL
           
 
Method Summary
 ModelUrl createModelUrl(String urlType, Model model)
          Deprecated.  Use createModelURL instead.
 ModelUrl createModelURL(String urlType, Model model)
           Create a ModelUrl based on the specified urlType.
 ModelUrl getModelUrl(String url, Model model)
          Deprecated.  Use getModelURL instead.
 ModelUrl getModelURL(String url, Model model)
           Create a ModelUrl based on the specified URL.
 

Field Detail

NAVIGATION_URL

String NAVIGATION_URL
Constant for creation of a navigation URL


LAYOUT_URL

String LAYOUT_URL
Constant for creation of a layout URL


SHARED_NAVIGATION_URL

String SHARED_NAVIGATION_URL
Constant for creation of a shared navigation URL


FRAGMENT_URL

String FRAGMENT_URL
Constant for creation of a fragment URL


FRAGMENT_MEDIA_URL

String FRAGMENT_MEDIA_URL
Constant for creation of a fragment-media URL


USER_URL

String USER_URL
Constant for creation of a user URL


THEME_URL

String THEME_URL
Constant for creation of a theme URL


THEME_MEDIA_URL

String THEME_MEDIA_URL
Constant for creation of a theme-media URL


CATALOG_URL

String CATALOG_URL
Constant for creation of a catalog URL


CONFIG_URL

String CONFIG_URL
Constant for creation of a config URL


SPACE_URL

String SPACE_URL
Constant for creation of a space URL


SPACE_FAVORITE_URL

String SPACE_FAVORITE_URL
Constant for creation of a space-favorite URL


AC_URL

String AC_URL
Constant for creation of a ac URL


AI_URL

String AI_URL
Constant for creation of a ac URL


TEMPLATE_URL

String TEMPLATE_URL
Constant for creation of a template URL


WIDGET_URL

String WIDGET_URL
Constant for widget model


EVENT_URL

String EVENT_URL
Constant for event model


SUBMODEL_MEMBER

String SUBMODEL_MEMBER
Constant for member sub model


SUBMODEL_ROLE

String SUBMODEL_ROLE
Constant for role sub model


SUBMODEL_ACCESS

String SUBMODEL_ACCESS
Constant for allowed-access sub model


SUBMODEL_RESOURCE

String SUBMODEL_RESOURCE
Constant for resource sub model


RESOURCE_URL

unknown RESOURCE_URL
Method Detail

createModelUrl

ModelUrl createModelUrl(String urlType,
                        Model model)
Deprecated.  Use createModelURL instead.

Create a ModelUrl based on the specified urlType. Afterwards parameters and scheme specific parts can be changed.
Sample:
var myURL = com.ibm.mashups.enabler.model.url.ModelUrlFactory.createModelURL(com.ibm.mashups.enabler.model.url.ModelUrlFactory.NAVIGATION_URL, this);

Parameters:
urlType - the type of ModelUrl that should be created. You should use the URL constants that are defined in this interface. (Must not be null)
model - the model used to create this ModelUrl object for. (Might be null)
Returns:
the created ModelUrl. Returns null if the specified urlType is not known.

createModelURL

ModelUrl createModelURL(String urlType,
                        Model model)
Create a ModelUrl based on the specified urlType. Afterwards parameters and scheme specific parts can be changed.
Sample:
var myURL = com.ibm.mashups.enabler.model.url.ModelUrlFactory.createModelURL(com.ibm.mashups.enabler.model.url.ModelUrlFactory.NAVIGATION_URL, this);

Parameters:
urlType - the type of ModelUrl that should be created. You should use the URL constants that are defined in this interface. (Must not be null)
model - the model used to create this ModelUrl object for. (Might be null)
Returns:
the created ModelUrl. Returns null if the specified urlType is not known.

getModelUrl

ModelUrl getModelUrl(String url,
                     Model model)
Deprecated.  Use getModelURL instead.

Create a ModelUrl based on the specified URL. Afterwards parameters and scheme specific parts can be changed.

Parameters:
url - the URL that should be used to create a ModelUrl. (Must not be null)
model - the model used to create this ModelUrl object for. (Might be null)
Returns:
the created ModelUrl (Must not be null).

getModelURL

ModelUrl getModelURL(String url,
                     Model model)
Create a ModelUrl based on the specified URL. Afterwards parameters and scheme specific parts can be changed.

Parameters:
url - the URL that should be used to create a ModelUrl. (Must not be null)
model - the model used to create this ModelUrl object for. (Might be null)
Returns:
the created ModelUrl (Must not be null).


Copyright IBM Corp. 2010 All Rights Reserved.