portlet

Contains information that defines a relationship with a Web services for Remote Portlets (WSRP) producer.

A portlet instance represents a WSRP portlet that can be embedded in a bibus » pagelet class object.

A WSRP producer is a presentation Web service that serves as a container of portlets.

The portlets that are available to pagelet authors are determined by the user's access rights to the portlet object.

We recommend that you represent instances of this type as leaf nodes in a tree structure. These objects can be manipulated independent of their containing object.

This class

inherits properties from the bibus » uiClass class

References

Used by the following properties:

bibus » portletInstance » portlet

Container Information

Contained by instances of the following classes

bibus » portletProducer

Properties

This class has the following properties.

canCustomize

Specifies whether this portlet can be customized in a bibus » portletInstance.

This property

is of type boolean

is encoded as type tns:booleanProp
has a default value of true

contact

Refers to a person or group of people who are responsible for the object.

This property

is an array of type bibus » baseClass

has items that must be of class bibus » account, bibus » contact, bibus » distributionList, bibus » group, or bibus » role

is encoded as type tns:baseClassArrayProp
refers to other objects in the content store using an id-based search path
must have at most 1 item

contactEMail

Specifies the email address of the person or group of people who are responsible for the object.

This property

is of type string

is encoded as type tns:stringProp

context

Specifies customization information for this portlet. When this property is nil, the portlet represents a producer offered portlet.

This property contains data to be used only by IBM® Cognos®software. The structure of this data is subject to change without notice. Client applications should not attempt to interpret or modify this data.

This property

is of type bibus » xmlEncodedXML

is encoded as type tns:xmlEncodedXMLProp

deploymentReferences

Contains the deployable object references for this object.

This property

is an array of type bibus » deploymentReference

is encoded as type tns:deploymentReferenceArrayProp

New in Version 8.3 — Package Hierarchies: This property was added.

handle

Specifies the portlet handle returned by the bibus » portletProducer class object. The portlet handle is used to retrieve the portlet description from the containing portlet producer serviceDescription property.

This property contains data to be used only by IBM Cognossoftware. The structure of this data is subject to change without notice. Client applications should not attempt to interpret or modify this data.

This property

is of type bibus » xmlEncodedXML

is encoded as type tns:xmlEncodedXMLProp