com.ibm.portal.dynamicui

Interface DynamicUICtrl

All Superinterfaces:

DynamicUIInfo, java.io.Serializable

Deprecated.

@Deprecated
public interface DynamicUICtrl
extends DynamicUIInfo

The DynamicUICtrl provides access to those functions of dynamic ui management that alter the current state.
Portlets can get access to the DynamicUICtrl via the DynamicUIManagerFactoryService .
The DynamicUICtrl must be obtained once per action phase of the portlet and should not be stored.
Currently only static portlets/pages are supported. (addPortlet & removePortlet will throw a DynamicUIManagementException .

See Also:

DynamicUIManagerFactoryService

Method Summary

Methods

Modifier and Type	Method and Description
ObjectID	addPage(ObjectID pageDefinitionID, Localized localeInformation, PropertyValue[] properties) Deprecated. Passes context to a new page.
ObjectID	addPage(ObjectID pageDefinitionID, ObjectID pageID, Localized localeInformation, PropertyValue[] properties) Deprecated. Passes context to an existing page if it exists.
ObjectID	addPortlet(ObjectID portletDefinitionID, Localized localeInformation, PropertyValue[] properties) Deprecated. Passes context and launches a new portlet.
ObjectID	addPortlet(ObjectID portletDefinitionID, ObjectID portletID, Localized localeInformation, PropertyValue[] properties) Deprecated. Passes context and launches a new portlet if the portlet ID doesn't exist.
ObjectID	addSharedPage(ObjectID pageDefinitionID, Localized localeInformation, PropertyValue[] properties) Deprecated. Passes context to a shared page.
ObjectID	addSharedPortlet(ObjectID portletDefinitionID, Localized localeInformation, PropertyValue[] properties) Deprecated. Passes context to an existing portlet.
ObjectID	getCurrentPage() Deprecated. The getCurrentPage method returns objectid for the current page, so that removePage can be used to close self.
ObjectID	removePage(ObjectID pageID) Deprecated. The removePage method removes pages added via addPage method.
void	removePortlet(ObjectID portletWindowID) Deprecated. The removePortlet method removes portlets added via addPortlet method.

Methods inherited from interface com.ibm.portal.dynamicui.DynamicUIInfo

canPageBeClosed, canPortletBeClosed

Method Detail

addPage

ObjectID addPage(ObjectID pageDefinitionID,
               Localized localeInformation,
               PropertyValue[] properties)
                 throws DynamicUIManagementException

Deprecated.

Passes context to a new page.

The pageDefinitionID parameter must be set and is retrieved using JNDI. The properties can be null if no context needs to be passed and the page only needs to be launched. Example of getting the pageDefinitionID via JNDI:

 pageDefinitionID =(ObjectID)ctx.lookup("portal:uniquename/com.ibm.isclite.launchtarget.navigationElement.B");
 

The page is not displayed by default. If the page should be displayed, the portlet should generate a url to the page using its object id and set it as an redirect on the response.

Parameters:

pageDefinitionID - The object id of the page definition. It is not allowed to pass null for this parameter.

localeInformation - Currently not used, this parameter should be null .

properties - The properties that should be delivered to all portlets on the launched page. This parameter can be null .

Returns:

ObjectID The object id of the launched page.

Throws:

DynamicUIManagementException - if pageDefinitionID is null.

See Also:

RedirectURLGenerator

addPage

ObjectID addPage(ObjectID pageDefinitionID,
               ObjectID pageID,
               Localized localeInformation,
               PropertyValue[] properties)
                 throws DynamicUIManagementException

Deprecated.

Passes context to an existing page if it exists.

The page is not displayed by default. If the page should be displayed, the portlet should generate a url to the page using its object id and set it as an redirect on the response.

Parameters:

pageDefinitionID - The object id of the page definition. It is not allowed to pass null for this parameter.

pageID - If this page exists, it will return this page.

localeInformation - Currently not used, this parameter should be null .

properties - The properties that should be delivered to all portlets on the launched page. This parameter can be null .

Returns:

ObjectID The object id of the launched page.

Throws:

DynamicUIManagementException - if pageDefinitionID is null.

See Also:

RedirectURLGenerator

addSharedPage

ObjectID addSharedPage(ObjectID pageDefinitionID,
                     Localized localeInformation,
                     PropertyValue[] properties)
                       throws DynamicUIManagementException

Deprecated.

Passes context to a shared page. If page doesn't exist it will be created.

The pageDefinitionID parameter must be set and is retrieved using JNDI. The properties can be null if no context needs to be passed and the page only needs to be launched. Example of getting the pageDefinitionID via JNDI:

 pageDefinitionID =(ObjectID)ctx.lookup("portal:uniquename/com.ibm.isclite.launchtarget.navigationElement.B");
 

The page is not displayed by default. If the page should be displayed, the portlet should generate a url to the page using its object id and set it as an redirect on the response.

Parameters:

pageDefinitionID - The object id of the page definition. It is not allowed to pass null for this parameter.

localeInformation - Currently not used, this parameter should be null .

properties - The properties that should be delivered to all portlets on the launched page. This parameter can be null .

Returns:

ObjectID The object id of the launched page.

Throws:

DynamicUIManagementException - if pageDefinitionID is null.

See Also:

RedirectURLGenerator

addSharedPortlet

ObjectID addSharedPortlet(ObjectID portletDefinitionID,
                        Localized localeInformation,
                        PropertyValue[] properties)
                          throws DynamicUIManagementException

Deprecated.

Passes context to an existing portlet.

The portletID parameter must be set and is retrieved using JNDI.

Parameters:

portletDefinitionID - The object id of the portlet definition. It is not allowed to pass null for this parameter.

localeInformation - Currently not used, this parameter should be null .

properties - The properties that should be delivered to the portlet. This parameter can be null , which results in nothing being done.

Returns:

ObjectID The object id of the portlet window of the added portlet.

Throws:

DynamicUIManagementException - if the portletDefinitionID is null.

See Also:

RedirectURLGenerator

addPortlet

ObjectID addPortlet(ObjectID portletDefinitionID,
                  Localized localeInformation,
                  PropertyValue[] properties)
                    throws DynamicUIManagementException

Deprecated.

Passes context and launches a new portlet.

The portletDefinitionID parameter must be set and is retrieved using JNDI.

Parameters:

portletDefinitionID - The object id of the portlet definition. It is not allowed to pass null for this parameter.

localeInformation - Currently not used, this parameter should be null .

properties - The properties that should be delivered to the portlet. This parameter can be null , which results in nothing being done.

Returns:

ObjectID The object id of the portlet window of the added portlet.

Throws:

DynamicUIManagementException - because this method is not supported.

See Also:

RedirectURLGenerator

addPortlet

ObjectID addPortlet(ObjectID portletDefinitionID,
                  ObjectID portletID,
                  Localized localeInformation,
                  PropertyValue[] properties)
                    throws DynamicUIManagementException

Deprecated.

Passes context and launches a new portlet if the portlet ID doesn't exist.

The portletDefinitionID parameter must be set and is retrieved using JNDI.

Parameters:

portletDefinitionID - The object id of the portlet definition. It is not allowed to pass null for this parameter.

portletID - The object id of a previously launched portlet, if found, context will be passed to existing portlet, otherwise it will be launched.

localeInformation - Currently not used, this parameter should be null .

properties - The properties that should be delivered to the portlet. This parameter can be null , which results in nothing being done.

Returns:

ObjectID The object id of the portlet window of the added portlet.

Throws:

DynamicUIManagementException - because this method is not supported.

See Also:

RedirectURLGenerator

removePortlet

void removePortlet(ObjectID portletWindowID)
                   throws DynamicUIManagementException

Deprecated.

The removePortlet method removes portlets added via addPortlet method.

Parameters:

portletWindowID - The ObjectID of the portlet to that was previously added.

Throws:

DynamicUIManagementException - if portletDefinitionID is not valid

removePage

ObjectID removePage(ObjectID pageID)
                    throws DynamicUIManagementException

Deprecated.

The removePage method removes pages added via addPage method.

Parameters:

pageID - The ObjectID of the page to that was previously added.

Throws:

DynamicUIManagementException - if pageID is not valid

getCurrentPage

ObjectID getCurrentPage()

Deprecated.

The getCurrentPage method returns objectid for the current page, so that removePage can be used to close self.

Returns:

an ObjectID value