com.ibm.portal.dynamicui.service
Interface DynamicUIManagementFactoryServiceHome

public interface DynamicUIManagementFactoryServiceHome

The DynamicUIManagementFactoryService provides access to instances of DynamicUIInfo and DynamicUICtrl . NOTE: This API may only be used in the scope of an HTTP request in WebSphere Portal, i.e. within a theme. The API can not be invoked directly by a custom servlet.

Since:

8.0.0.1

Field Summary

static java.lang.String

JNDI_NAME JNDI name of this service

Method Summary

ExtendedDynamicUICtrl	getDynamicUICtrl(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, java.lang.String configurationName) Returns the DynamicUICtrl for a given configuration.
DynamicUIInfo	getDynamicUIInfo(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, java.lang.String configurationName) Returns the DynamicUIInfo for a given configuration.
void	setDefaultRedirectPage(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, java.lang.String configurationName, ObjectID pageID) Sets the default redirect page for this DynamicUIManagement instance that should be used in the case that the currently selected page is closed and there are no other dynamic pages.

Field Detail

JNDI_NAME

static final java.lang.String JNDI_NAME

JNDI name of this service

See Also:

Constant Field Values

Method Detail

getDynamicUIInfo

DynamicUIInfo getDynamicUIInfo(javax.servlet.http.HttpServletRequest request,
                               javax.servlet.http.HttpServletResponse response,
                               java.lang.String configurationName)
                               throws DynamicUIManagementException

Returns the DynamicUIInfo for a given configuration.

Parameters:

configurationName - The name of the configuration. It is not allowed to pass null for this parameter.

request - The servlet request. It is not allowed to pass null for this parameter.

response - The servlet response. It is not allowed to pass null for this parameter.

Returns:

DynamicUIInfo The DynamicUIInfo.

Throws:

FactoryException - The DynamicUIInfo cannot be created.

DynamicUIManagementException

getDynamicUICtrl

ExtendedDynamicUICtrl getDynamicUICtrl(javax.servlet.http.HttpServletRequest request,
                                       javax.servlet.http.HttpServletResponse response,
                                       java.lang.String configurationName)
                                       throws DynamicUIManagementException

Returns the DynamicUICtrl for a given configuration.

Parameters:

request - The servlet request. It is not allowed to pass null for this parameter.

response - The servlet response. It is not allowed to pass null for this parameter.

configurationName - The name of the configuration. It is not allowed to pass null for this parameter.

Returns:

DynamicUICtrl The DynamicUIController.

Throws:

FactoryException - The DynamicUIController cannot be created.

DynamicUIManagementException

setDefaultRedirectPage

void setDefaultRedirectPage(javax.servlet.http.HttpServletRequest request,
                            javax.servlet.http.HttpServletResponse response,
                            java.lang.String configurationName,
                            ObjectID pageID)
                            throws DynamicUIManagementException

Sets the default redirect page for this DynamicUIManagement instance that should be used in the case that the currently selected page is closed and there are no other dynamic pages.

This method overwrites any other settings.

The redirect page can only be set when no dynamic pages exist.

Parameters:

request - The servlet request. It is not allowed to pass null for this parameter.

response - The servlet response. It is not allowed to pass null for this parameter.

configurationName - The name of the configuration. It is not allowed to pass null for this parameter.

pageID - The object id of the default redirect page. If null null is passed, the default settings are used again.

Throws:

FactoryException - Thrown when the redirect page cannot be set.

DynamicUIManagementException