com.ibm.mashups.enabler.model
Interface ServiceDocumentModel


public ServiceDocumentModel

An singleton that represents the Service Document


Field Summary
 String SERVICE_NAVIGATION
           Constant representing the navigation service
 String SERVICE_SPACE_NAVIGATION
           Constant representing the space navigation service
 String SERVICE_SHARED_NAVIGATION
           Constant representing the shared navigation service
 String SERVICE_CONTENT
           Constant representing the content service
 String SERVICE_CATALOG
           Constant representing the catalog service
 String SERVICE_RESOURCE
           Constant representing the resource service
 String SERVICE_WIDGET
           Constant representing the widget service
 String SERVICE_THEME
           Constant representing the theme service
 String SERVICE_USER
           Constant representing the user service
 String SERVICE_MODEL
           Constant representing generic model services
 String SERVICE_MULTIPART
           Constant representing multipart services
 String SERVICE_HUFFMAN
           Constant representing the huffman encoding of multipart services
 String SERVICE_SITEMAP
           Constant representing the sitemap encoding of multipart services
 String SERVICE_SITEMAP_COMMITHANDLER
           Constant representing the commit handler sitemap encoding of multipart services
 String SERVICE_COMPOSITE
           Constant representing the composite application service
 String SERVICE_SPACE
           Constant representing the space service
 String SERVICE_SPACE_FAVORITE
           Constant representing the space favorites service
 String SERVICE_TEMPLATE
           Constant representing the template service
 String SERVICE_CONFIG
           Constant representing the config service
 String SERVICE_FILESTORE
           Constant representing the webdav filestore
 String SERVICE_WEBDAV
           Constant representing generic webdav services
 
Method Summary
 void invalidate()
           Invalidates the Service Document Model in order for it to be re-initialized again.
 unknown getModelCollections()
           Returns a two-dimensional array of IDs representing services which are attached to a specific endpoint namespace.
 String[][] getMashupsCollections()
           Returns a two-dimensional array of IDs representing services which are attached to mashups specifically.
 Object getCollectionData(String[] idArray)
           Returns a JSON object for a given collection link in the service document.
 

Field Detail

SERVICE_NAVIGATION

String SERVICE_NAVIGATION
Constant representing the navigation service


SERVICE_SPACE_NAVIGATION

String SERVICE_SPACE_NAVIGATION
Constant representing the space navigation service


SERVICE_SHARED_NAVIGATION

String SERVICE_SHARED_NAVIGATION
Constant representing the shared navigation service


SERVICE_CONTENT

String SERVICE_CONTENT
Constant representing the content service


SERVICE_CATALOG

String SERVICE_CATALOG
Constant representing the catalog service


SERVICE_RESOURCE

String SERVICE_RESOURCE
Constant representing the resource service


SERVICE_WIDGET

String SERVICE_WIDGET
Constant representing the widget service


SERVICE_THEME

String SERVICE_THEME
Constant representing the theme service


SERVICE_USER

String SERVICE_USER
Constant representing the user service


SERVICE_MODEL

String SERVICE_MODEL
Constant representing generic model services


SERVICE_MULTIPART

String SERVICE_MULTIPART
Constant representing multipart services


SERVICE_HUFFMAN

String SERVICE_HUFFMAN
Constant representing the huffman encoding of multipart services


SERVICE_SITEMAP

String SERVICE_SITEMAP
Constant representing the sitemap encoding of multipart services


SERVICE_SITEMAP_COMMITHANDLER

String SERVICE_SITEMAP_COMMITHANDLER
Constant representing the commit handler sitemap encoding of multipart services


SERVICE_COMPOSITE

String SERVICE_COMPOSITE
Constant representing the composite application service


SERVICE_SPACE

String SERVICE_SPACE
Constant representing the space service


SERVICE_SPACE_FAVORITE

String SERVICE_SPACE_FAVORITE
Constant representing the space favorites service


SERVICE_TEMPLATE

String SERVICE_TEMPLATE
Constant representing the template service


SERVICE_CONFIG

String SERVICE_CONFIG
Constant representing the config service


SERVICE_FILESTORE

String SERVICE_FILESTORE
Constant representing the webdav filestore


SERVICE_WEBDAV

String SERVICE_WEBDAV
Constant representing generic webdav services

Method Detail

invalidate

void invalidate()
Invalidates the Service Document Model in order for it to be re-initialized again.


getModelCollections

unknown getModelCollections()
Returns a two-dimensional array of IDs representing services which are attached to a specific endpoint namespace. The IDs in the second dimension are required to lookup the service data.
Example: [["webdav"],["filestore"]]
Only the combination of both IDs make the service unique and must be used to lookup the service data @Returns { String[][]} A two-dimensional array with the second dimension being a list of IDs which represent the service.


getMashupsCollections

String[][] getMashupsCollections()
Returns a two-dimensional array of IDs representing services which are attached to mashups specifically. The IDs in the second dimension are required to lookup the service data.
Example: [["webdav"],["filestore"]]
Only the combination of both IDs make the service unique and must be used to lookup the service data

Returns:
A two-dimensional array with the second dimension being a list of IDs which represent the service.

getCollectionData

Object getCollectionData(String[] idArray)
Returns a JSON object for a given collection link in the service document. Not all elements are mandatory.
JSON format
{ id: "the id array",
url :"the url",
template :"the template",
idprefix: "id|oid",
namespaces : { "base" : "base-url", "model" : "model-url", "ext" : "ext-url", "creation-context" : "creation-context-url" },
accept: "accept MIME type",
version: "major.minor"
}

Parameters:
idArray - The ID Array to lookup the service for.
Returns:
Returns a JSON object for a given collection link in the service document


Copyright IBM Corp. 2010 All Rights Reserved.