Package com.ibm.portal

This package and its subpackages define the portal programming model.

See:
Description

Interface Summary

Countable	Optional interface for collection-like models that want to expose the number of elements stored.
DatabaseDomainConstants	This interface provides constants to identify database domains
Disposable	An object implementing this interface indicates that it is advantageous to signal to the object that it will not longer be accessed.
Identifiable	Interface for any resource in the portal that can be identified by an ObjectID.
IterableListModel<E>	A model representing a list.
ListModel<E>	A model representing a list.
Localized	Interface providing methods to obtain title and description of a portal resource.
ObjectID	Represents a unique identifier for a resource in Portal.
ObjectID.Deserializer	Reads ObjectIDs.
ObjectID.Serializer	Writes ObjectIDs.
ObjectType	This interface models the individual object types used in Portal.
SearchableIterableListModel<E>	A model representing a list.
URL	This interface defines a portal URL.

Enum Summary

ObjectTypeConstants

This class provides static references to well known object type instances. Their type is ObjectType.

Exception Summary

ModelException

Occurs when anything unexpected happened while using model API related functions.

Package com.ibm.portal Description

This package and its subpackages define the portal programming model.

Package Specification

The interfaces and classes contained in this package are the starting points for the programming model.

Models and model access

Portal models are either specializations of ListModel or of TreeModel. These two interfaces describe the generic characteristics of the models. The following specialized models are available:

• com.ibm.portal.content.ContentModel - model of page hierarchy and associated information (including the com.ibm.portal.content.LayoutModel).
• LanguageList - model of portal supported languages.
• MarkupList - model of portal supported markups.
• com.ibm.portal.navigation.NavigationModel - model of the navigation hierarchy (which can reference information of the com.ibm.portal.content.ContentModel).
• com.ibm.portal.navigation.NavigationSelectionModel - model about the current selection (e.g. the currently displayed page).
• SkinList - model of portal supported skins.
• ThemeList - model of the portal supported themes.
• PortletModel - model of the portlet configuration for portlets on pages accessed through a content model.
• AdminPortletModel - model of the global portlet configuration that is available throughout portal.

Models can be searched if they implement the LocatorProvider interface. This is reflected through the interfaces SearchableListModel and SearchableTreeModel on a generic level. The generic Locator returned by the provider interface can look up resources in a model; a model may provide more specialized locators that can be used for further model-specific tasks.

The portal models can be obtained through JNDI lookups. This is described in com.ibm.portal.model. For portlets, models can be obtained through portlet services defined in com.ibm.portal.portlet.service.model (for JSR 168 portlets) and com.ibm.portal.ibmportlet.service.model.

Resources

Most portal resources carry an identifier. This identifier is defined with the interface Identifiable which allows retrieving the ID of a resource. This ID is called object ID and uniquely identifies an element in a portal installation - and beyond (the ID is also called GUID - globally unique ID). An ObjectID can also have a unique name (a name that can only exist once per portal installation) assigned to it.
The interface Identification provides methods to convert object ID objects to strings and vice versa.

A widespread interface on resources is Localized. This interface provides localized information about a resource like title and description. For displaying purposes, the com.ibm.portal.model.LocalizedStringResolver provides convenience methods to obtain title or description from a "localized" resource.