Portlet Registry Javascript Component

Component Overview

The PortletBrowser javascript component is a Fluid-based uPortal component designed to provide support for retrieving portlet and portlet category information via JavaScript. This component is factored as a stand-alone Fluid component but will typically be used as a subcomponent within a parent. This component does not provide any sort of user interface.

All information provided by this component is limited by the portal permissions of the user executing the JavaScript. The registry information is furthermore limited by the purpose for which the listing was retrieved; for example, a list of portlets produced from a request for subscribeable portlets will differ from one produced from a request for manageable portlets.

Component Options

Configuration Options

Name

Description

portletListUrl

URL of the portlet registry AJAX target

Public Methods

Method Name

Description

Parameters

Parameter Description

getPortlet

Return the portlet with the specified id

id

integer-based unique ID of the portlet to be retrieved

getCategory

Return the category with the specified key

key

String-based unique key of the category to be retrieved. This key should include the service string (e.g. "local.1")

getMemberPortlets

Return an array of portlets that are members of the specified category

id
deepMembers

id is the integer-based unique ID of the portlet for which to retrieve members
deepMembers indicates whether deep members of the category should be retrieved. This property should be set to true to recursively retrieve all deep members, and false for only direct members

getMemberCategories

Return an array of categories that are members of the specified category

key
deepMembers

key is the String-based unique key of the category for which to retrieve members. This key should include the service string (e.g. "local.1")
deepMembers indicates whether deep members of the category should be retrieved. This property should be set to true to recursively retrieve all deep members, and false for only direct members

getAllPortlets

Return an array of all portlets retrieved for the current portlet registry request.

 

 

getAllCategories

Return an array of all categories retrieved for the current portlet registry request.

 

 

refreshRegistry

Refresh the cached category and portlet information by making a fresh request to the backend portlet registry service.

 

Â