B Portal API Documentation

This chapter provides an overview of the available API documentation on adaptive tags, portal UI packages, IDK, and scripting framework API. All documentation is available on the Oracle Technology Network in the Oracle WebCenter Interaction 10g Release 4 (10.3.3.0.0) documentation set: http://download.oracle.com/docs/cd/E23010_01/index.htm.

Adaptive Tags

The tagdocs provide details on tags used for Adaptive Page Layouts. For details, see Chapter 3, "Using Adaptive Page Layouts". The tagdocs can be viewed in the following location: tagdocs.

You can also create custom adaptive tags. The API documentation for the Adaptive Tag Framework can be viewed in the following locations:

• Custom Tags - Java

• Custom Tags - .NET

Portal UI Packages

The following packages provide selected libraries from the portal UI API package for customizing specific functionality.

• PEIs (portalpages.pei, portaluiinfrastructure.pei, portaluiinfrastructure.tags.pei and uiinfrastructure.pei): These libraries are focused on the portal's Programmable Event Interfaces API. For details on implementing custom code using PEIs, see Chapter 12, "Using PEIs". The PEI API documentation can be found in the following locations:

  • PEI - Java

  • PEI - .NET

• Pluggable Navigation (nullnavigation.*, portalnavigation.*, portalpages.common.mediator, portalpages.common.plugnav, portalpages.common.uiparts, portaluiinfrastructure.application.varpacks, portaluiinfrastructure.compoundlist, and portaluiinfrastructure.navtype): These libraries are focused on the Pluggable Navigation API. Note: Most navigation customizations can be implemented without writing custom code against the portal UI. For details, see Chapter 9, "Customizing Portal Navigation". The Pluggable Navigation API documentation can be found in the following locations:

  • Pluggable Navigation - Java

  • Pluggable Navigation - .NET

• UI Infrastructure: The uiinfrastructure library represents the layer of the portal UI that defines the core architectural classes for the portal UI. This layer has no dependencies on the plumtree.server layer. It addresses generic problems like how to store state across pages in a consistent, reusable fashion. The UI Infrastructure API documentation can be found in the following location:

  • UI Infrastructure - Java

  • UI Infrastructure - .NET

• Open Foundation: This section contains the cross-platform (Java) development library underneath all portal UI layers. The Open Foundation API documentation can be found in the following location:

  • Open Foundation - Java

IDK API

The Oracle WebCenter Interaction Development Kit (IDK) enables Java and .NET developers to rapidly build and deliver user-centric composite applications through Oracle WebCenter Interaction. The IDK provides interfaces for pagelets, portlets and integration web services - authentication and profile services, crawlers, and search services.

The IDK API documentation can be found in the following locations:

• IDK API - Java

• IDK API - .NET

For details on using the IDK API, see the Oracle WebCenter Interaction Web Service Development Guide.

Scripting Framework API

The scripting framework API documentation can be found in the following locations:

• CommonOpener

• JSPortlet

• JSXML