com.ibm.mashups.enabler.persistence
Interface NavigationModelPersistenceProvider

All Superinterfaces:

ModelPersistenceProvider

public NavigationModelPersistenceProvider
extends ModelPersistenceProvider

Method Summary

void	find(ModelUrl url, Object callback, Object parameters) Returns the specified object(s).
void	findBySelection(ModelUrl url, Object selection, Object callback, Object parameters) Returns the specified object(s).
Object	create(Object context) Creates a navigation object based on a given context.

Methods inherited from interface com.ibm.mashups.enabler.persistence.ModelPersistenceProvider

findBySelection, create, remove, store, getModifiable

Method Detail

find

void find(ModelUrl url,
          Object callback,
          Object parameters)

Returns the specified object(s).

Parameters:

url - url that specifies the object(s) to find

selection - selection criteria

callback - callback function, which is called with the following arguments: function(result, status, parameters), where

• result is an array containing the selected objects; may contain zero or more objects
• status status code of the operation
• parameters are the parameters as passed into findBySelection

parameters - parameters to pass to the callback function; optional

See Also:

ModelUrl

findBySelection

void findBySelection(ModelUrl url,
                     Object selection,
                     Object callback,
                     Object parameters)

Returns the specified object(s).
selection = {
sections: SECTIONS,
pages: {
select: PAGE_SELECTION,
},
spaces: {
select: SPACE_SELECTION,
},
widgets: {
params: {
includeDefaultLocale: "true" | "false"
}
}
}

where

• SECTIONS is an array containing or one or more of the following keywords:
  • "pages",
  • "spaces",
  • "widgets", or
  the keyword "all" to include all of the above information.
• PAGE_SELECTION is an array with one or more of the following keywords:
  • "children",
  • "trail", or
  • "topLevel"
• SPACE_SELECTION is an array with one or more of the following keywords:
  • "current" or
  • "favorite"
• includeDefaultLocale if set to "true", widgets contain titles in the browser default locale. Otherwise the widgets will not contain titles, but the widgets in the page markup will contain titles in the server fall back locale.
  • "current" or
  • "favorite"

Example (select the children of a page):
findBySelection( { sections:["pages"], pages: { select: ["children"]}}, function(result) {
dojo.forEach(result, function(o) {
console.log("page ID: ", o.getID());
})
});

Parameters:

url - url that specifies the object(s) to find

selection - selection criteria

callback - callback function, which is called with the following arguments: function(result, status, parameters), where

• result is an array containing the selected objects; may contain zero or more objects;
• status status code of the operation
• parameters are the parameters as passed into findBySelection

parameters - parameters to pass to the callback function; optional

See Also:

ModelUrl

create

Object create(Object context)

Creates a navigation object based on a given context.
context = { type: TYPE }

where

• TYPE is the type of the navigation object, i.e. one of the following
  • "page"
  • "label"
  • "url"

Parameters:

context - context defining properties for the object to create

Returns:

new navigation object