Overview Package Class Use Deprecated Help IBM WebSphere PortalTM
V5.1.0.1PREV
Package com.ibm.portal
Interface Summary URL This interface defines a portal URL. Localized Interface providing methods to obtain title and description of a portal resource. ListModel A model representing a list. ObjectType This interface models the individual object types used in Portal. ObjectID Represents a unique identifier for a resource in Portal. ObjectID.Serializer Writes ObjectIDs. ObjectID.Deserializer Reads ObjectIDs. Identifiable Interface for any resource in the portal that can be identified by an .
Class Summary
Exception Summary ModelException Occurs when anything unexpected happened while using model API related functions.
Package 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 {@link com.ibm.portal.ListModel} or of {@link com.ibm.portal.TreeModel}. These two interfaces describe the generic characteristics of the models. The following specialized models are available:
- {@link com.ibm.portal.content.ContentModel} - model of page hierarchy and associated information (including the {@link com.ibm.portal.content.LayoutModel}).
- {@link com.ibm.portal.admin.LanguageList} - model of portal supported languages.
- {@link com.ibm.portal.admin.MarkupList} - model of portal supported markups.
- {@link com.ibm.portal.navigation.NavigationModel} - model of the navigation hierarchy (which can reference information of the {@link com.ibm.portal.content.ContentModel}).
- {@link com.ibm.portal.navigation.NavigationSelectionModel} - model about the current selection (e.g. the currently displayed page).
- {@link com.ibm.portal.admin.SkinList} - model of portal supported skins.
- {@link com.ibm.portal.admin.ThemeList} - model of the portal supported themes.
Models can be searched if they implement the {@link com.ibm.portal.LocatorProvider} interface. This is reflected through the interfaces {@link com.ibm.portal.SearchableListModel} and {@link com.ibm.portal.SearchableTreeModel} on a generic level. The generic {@link com.ibm.portal.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 {@link com.ibm.portal.model}. For portlets, models can be obtained through portlet services defined in {@link com.ibm.portal.portlet.service.model} (for JSR 168 portlets) and {@link com.ibm.portal.ibmportlet.service.model}.
Resources
Most portal resources carry an identifier. This identifier is defined with the interface {@link com.ibm.portal.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 {@link com.ibm.portal.ObjectID} can also have a unique name (a name that can only exist once per portal installation) assigned to it.
The interface {@link com.ibm.portal.identification.Identification} provides methods to convert object ID objects to strings and vice versa.A widespread interface on resources is {@link com.ibm.portal.Localized}. This interface provides localized information about a resource like title and description. For displaying purposes, the {@link com.ibm.portal.model.LocalizedStringResolver} provides convenience methods to obtain title or description from a "localized" resource.
Overview Package Class Use Deprecated Help IBM WebSphere PortalTM
V5.1.0.1PREV
WebSphere is a trademark of the IBM Corporation in the United States, other countries, or both.
IBM is a trademark of the IBM Corporation in the United States, other countries, or both.