Package com.sun.identity.console.service

Class SMDiscoveryDescriptionViewBeanBase

java.lang.Object

com.iplanet.jato.view.ViewBase

com.iplanet.jato.view.ContainerViewBase

com.iplanet.jato.view.RequestHandlingViewBase

com.iplanet.jato.view.ViewBeanBase

org.forgerock.openam.console.base.ConsoleViewBeanBase

com.sun.identity.console.base.AMViewBeanBase

com.sun.identity.console.base.AMPrimaryMastHeadViewBean

com.sun.identity.console.service.SMDiscoveryDescriptionViewBeanBase

All Implemented Interfaces:

com.iplanet.jato.RequestCompletionListener, com.iplanet.jato.RequestHandler, com.iplanet.jato.RequestParticipant, com.iplanet.jato.view.ContainerView, com.iplanet.jato.view.View, com.iplanet.jato.view.ViewBean, com.iplanet.jato.view.WebActionHandler, com.iplanet.jato.view.WebActions, com.sun.web.ui.view.tabs.CCNodeEventHandlerInterface

Direct Known Subclasses:

EntityDiscoveryDescriptionViewBeanBase, RealmDiscoveryDescriptionViewBeanBase, SMDiscoveryDescriptionAddViewBean, SMDiscoveryDescriptionEditViewBean, UMUserDiscoveryDescriptionViewBeanBase

public abstract class SMDiscoveryDescriptionViewBeanBase
extends AMPrimaryMastHeadViewBean

Field Summary

Fields

Modifier and Type	Field	Description
static String	PG_SESSION_DISCO_ENTRY_DATA
static String	PG_SESSION_RETURN_VIEW_BEAN_CLASSNAME
protected static String	PROPERTY_ATTRIBUTE
protected AMPropertySheetModel	propertySheetModel
protected com.sun.web.ui.model.CCPageTitleModel	ptModel

Fields inherited from class com.sun.identity.console.base.AMPrimaryMastHeadViewBean

HDR_COMMON, MH_COMMON, PG_SESSION_PAGE_TRAIL_ID, PG_SESSION_TAB_ID, retainPageSessionsBtwTabs, TAB_COMMON, tabModel

Fields inherited from class com.sun.identity.console.base.AMViewBeanBase

BTN_GHOST, debug, initialized, PG_SESSION_ATTR, PG_SESSION_ATTR_ID, PG_SESSION_SSO_ID, SZ_CACHE

Fields inherited from class com.iplanet.jato.view.ViewBeanBase

DEFAULT_COMMAND_CHILD_NVP_NAME, DISPLAY_EVENT_COMPLETED_REQUEST_ATTRIBUTE_NAME, OPTION_USE_PAGE_SESSION_FOR_DEFAULT_COMMAND_CHILD

Fields inherited from class com.iplanet.jato.view.RequestHandlingViewBase

HANDLE_REQUEST_METHOD_PREFIX, HANDLE_REQUEST_METHOD_SUFFIX

Fields inherited from class com.iplanet.jato.view.ContainerViewBase

BEGIN_DISPLAY_EVENT_METHOD_PREFIX, BEGIN_DISPLAY_EVENT_METHOD_SUFFIX, END_DISPLAY_EVENT_METHOD_PREFIX, END_DISPLAY_EVENT_METHOD_SUFFIX, eventMethodRegistry, OPTION_ENABLE_QUALIFIELD_CHILD_NAME_LOOKUPS, OPTION_USE_LEGACY_DISPLAY_EVENT_SIGNATURES

Fields inherited from interface com.iplanet.jato.view.View

QUALIFIED_VIEW_NAME_SEPARATOR

Fields inherited from interface com.iplanet.jato.view.ViewBean

PAGE_SESSION_ATTRIBUTE_NVP_NAME, VIEW_BEAN_NAME_SUFFIX

Fields inherited from interface com.iplanet.jato.view.WebActionHandler

DELETE_CONTEXT, EXECUTE_CONTEXT, INSERT_CONTEXT, MODEL_TYPE_DELETE, MODEL_TYPE_EXECUTE, MODEL_TYPE_INSERT, MODEL_TYPE_RETRIEVE, MODEL_TYPE_UPDATE, RETRIEVE_CONTEXT, UPDATE_CONTEXT

Fields inherited from interface com.iplanet.jato.view.WebActions

ACTION_CLEAR, ACTION_DELETE, ACTION_EXECUTE, ACTION_FIRST, ACTION_INSERT, ACTION_LAST, ACTION_NEXT, ACTION_PREV, ACTION_PREVIOUS, ACTION_REFRESH, ACTION_SELECT, ACTION_UPDATE

Constructor Summary

Constructors

Constructor	Description
SMDiscoveryDescriptionViewBeanBase(String pageName, String defaultDisplayURL)

Method Summary

Modifier and Type	Method	Description
protected void	create3ButtonPageTitle()
protected com.iplanet.jato.view.View	createChild(String name)	Creates user interface components used by this view bean.
protected void	createPageTitleModel()
protected void	createPropertyModel()
protected abstract SMDescriptionData	getCurrentData()
protected AMModel	getModelInternal()	Returns model for this view bean.
protected abstract String	getPageTitleText()
protected AMViewBeanBase	getReturnToViewBean()
void	handleButton1Request(com.iplanet.jato.view.event.RequestInvocationEvent event)
protected abstract void	handleButton1Request(SMDescriptionData smData)
void	handleButton2Request(com.iplanet.jato.view.event.RequestInvocationEvent event)	Handles cancel request.
void	handleButton3Request(com.iplanet.jato.view.event.RequestInvocationEvent event)	Handles the "Back to" page request.
protected void	initialize()
protected void	registerChildren()	Registers user interface components used by this view bean.
protected void	repopulateMechID()
protected String	setBackButton()	Creates the label used to take the user back to the previous page they were viewing.
protected void	setValues(SMDescriptionData smData)

Methods inherited from class com.sun.identity.console.base.AMPrimaryMastHeadViewBean

addPageTrail, backTrail, beginDisplay, beginDisplay, createTabModel, forwardTo, getBreadCrumbDisplayName, getDefaultTabId, getTabNodeAssociatedViewBean, getTrackingTabIDName, handleBreadCrumbHrefRequest, handleRealmNameInTabSwitch, initPageTrail, isRootRealm, lockPageTrail, nodeClicked, passPgSessionMapEx, setPageTrail, setRequestContext, setSelectedTabNode, startPageTrail, unlockPageTrail, unlockPageTrailForSwapping

Methods inherited from class com.sun.identity.console.base.AMViewBeanBase

addBlankTextField, appendPgSession, beginChildDisplay, bypassForwardTo, charToHex, createOptionList, createOptionList, createOptionList, createOptionList, createOptionList, deserializePageAttributes, disableButton, getBackButtonLabel, getBlankTextFields, getCallingView, getCharset, getCharset, getContentType, getCurrentLocation, getCurrentLocationDN, getCurrentRealm, getCurrentRealmEncoded, getList, getModel, getPageSessionAttributes, getPageSessionAttributeString, getPath, getRequestURL, getServiceNameForAccessControl, getUserLocale, getValues, handleGRequest, hexToString, hideTableSelectionIcons, isInlineAlertMessageSet, mapRequestParameter, passPgSessionMap, passPgSessionMap, performDelegationTasks, redirectToStartURL, resetButtonState, resetView, setCurrentLocation, setInlineAlertMessage, setInlineAlertMessage, setPageSessionAttributes, setRequestContentInitialize, stringToHex

Methods inherited from class com.iplanet.jato.view.ViewBeanBase

clearPageSessionAttributes, forward, forwardTo, getDefaultCommandDescriptor, getDefaultDisplayURL, getDisplayURL, getLogicalName, getModuleURL, getPageSessionAttribute, getPageSessionAttributeString, getRequestInvocationName, getRequestInvocationName, handleDeserializePageAttributesException, include, include, include, invokeRequestHandler, invokeRequestHandlerInternal, mapRequestParameters, removePageSessionAttribute, securityCheck, setDefaultCommandDescriptor, setDefaultDisplayURL, setPageSessionAttribute

Methods inherited from class com.iplanet.jato.view.RequestHandlingViewBase

acceptRequest, afterAllModelsExecute, afterAllWebActionModelsExecute, afterHandleRequestCommandExecution, afterModelExecutes, afterWebActionModelExecutes, appMessage, beforeHandleRequestCommandExecution, beforeModelExecutes, beforeWebActionModelExecutes, createDefaultExecutionContext, executeAutoDeletingModel, executeAutoDeletingModels, executeAutoExecutingModel, executeAutoExecutingModels, executeAutoInsertingModel, executeAutoInsertingModels, executeAutoRetrievingModel, executeAutoRetrievingModels, executeAutoRetrievingModels, executeAutoUpdatingModel, executeAutoUpdatingModels, getAutoDeletingModels, getAutoExecutingModels, getAutoInsertingModels, getAutoRetrieveExecutionContext, getAutoRetrievingModels, getAutoUpdatingModels, getFirstActionExecutionContext, getLastActionExecutionContext, getModel, getNextActionExecutionContext, getPreviousActionExecutionContext, getRefreshActionExecutionContext, getRequestCompletionListenerChildNames, getRequestContext, getRequestParticipantChildNames, getSession, getViewBean, getWebActionModelOffset, getWebActionModels, getWebActionRowOffsetSessionKey, handleRequest, handleWebAction, isAutoRetrieveEnabled, onHandleRequestCommandExecutionError, onModelError, onNoModelDataAvailable, onWebActionExecutionError, requestComplete, setAutoDeletingModels, setAutoExecutingModels, setAutoInsertingModels, setAutoRetrieveEnabled, setAutoRetrieveExecutionContext, setAutoRetrievingModels, setAutoUpdatingModels, setWebActionModelOffset

Methods inherited from class com.iplanet.jato.view.ContainerViewBase

beginChildDisplay, beginComponentDisplay, beginDisplay, childExists, createChildReserved, endChildDisplay, endChildDisplay, endComponentDisplay, endDisplay, endDisplay, ensureChild, getChild, getChildNames, getChildNames, getChildType, getCommandChildNames, getDefaultModel, getDisplayField, getDisplayFieldBooleanValue, getDisplayFieldDoubleValue, getDisplayFieldIntValue, getDisplayFieldStringValue, getDisplayFieldValue, getNumChildren, getQualifiedCommandChildNames, onValidationException, registerChild, registerDisplayEventHandlers, removeAllChildren, removeChild, removeQualifiedNameIndices, resetChildren, setDefaultModel, setDisplayFieldValue, setDisplayFieldValue, setDisplayFieldValue, setDisplayFieldValue, unregisterChild

Methods inherited from class com.iplanet.jato.view.ViewBase

getName, getParent, getParentViewBean, getQualifiedName, getQualifiedViewNameSeparator, getRootView, getRootView, getSimpleQualifiedName, isVisible, setName, setParent, setQualifiedViewNameSeparator, setVisible

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.iplanet.jato.view.ContainerView

endChildDisplay, endDisplay, getChild, getChildNames, getChildType, getDefaultModel, getDisplayField, getDisplayFieldValue, getNumChildren, resetChildren, setDisplayFieldValue

Methods inherited from interface com.iplanet.jato.RequestHandler

acceptRequest, getRequestContext, handleRequest

Methods inherited from interface com.iplanet.jato.view.View

getName, getParent, getQualifiedName, setName, setParent

Methods inherited from interface com.iplanet.jato.view.ViewBean

getModel, getSession, getViewBean

Methods inherited from interface com.iplanet.jato.view.WebActionHandler

getWebActionModels, handleWebAction, isAutoRetrieveEnabled, setAutoRetrieveEnabled

Field Detail

PG_SESSION_RETURN_VIEW_BEAN_CLASSNAME

public static final String PG_SESSION_RETURN_VIEW_BEAN_CLASSNAME

See Also:

Constant Field Values

PG_SESSION_DISCO_ENTRY_DATA

public static final String PG_SESSION_DISCO_ENTRY_DATA

See Also:

Constant Field Values

PROPERTY_ATTRIBUTE

protected static final String PROPERTY_ATTRIBUTE

See Also:

Constant Field Values

ptModel

protected com.sun.web.ui.model.CCPageTitleModel ptModel

propertySheetModel

protected AMPropertySheetModel propertySheetModel

Constructor Detail

SMDiscoveryDescriptionViewBeanBase

public SMDiscoveryDescriptionViewBeanBase(String pageName,
                                          String defaultDisplayURL)

Method Detail

initialize

protected void initialize()

Overrides:

initialize in class AMViewBeanBase

registerChildren

protected void registerChildren()

Description copied from class: AMPrimaryMastHeadViewBean

Registers user interface components used by this view bean.

Overrides:

registerChildren in class AMPrimaryMastHeadViewBean

createChild

protected com.iplanet.jato.view.View createChild(String name)

Description copied from class: AMPrimaryMastHeadViewBean

Creates user interface components used by this view bean.

Overrides:

createChild in class AMPrimaryMastHeadViewBean

Parameters:

name - of component

Returns:

child component

createPageTitleModel

protected void createPageTitleModel()

create3ButtonPageTitle

protected void create3ButtonPageTitle()

setBackButton

protected String setBackButton()

Creates the label used to take the user back to the previous page they were viewing. The label is defined in the property file as "Back to {0}" which lets us control the format of the label in different locales.

createPropertyModel

protected void createPropertyModel()

getModelInternal

protected AMModel getModelInternal()

Description copied from class: AMViewBeanBase

Returns model for this view bean. Dervived class need to implement this method.

Specified by:

getModelInternal in class AMViewBeanBase

Returns:

model for this view bean.

repopulateMechID

protected void repopulateMechID()

handleButton2Request

public void handleButton2Request(com.iplanet.jato.view.event.RequestInvocationEvent event)

Handles cancel request.

Parameters:

event - Request Invocation Event.

handleButton3Request

public void handleButton3Request(com.iplanet.jato.view.event.RequestInvocationEvent event)

Handles the "Back to" page request. Essentially this is just canceling the page and returning to the previous page. Same as a cancel request from the create page.

Parameters:

event - Request Invocation Event.

getReturnToViewBean

protected AMViewBeanBase getReturnToViewBean()

setValues

protected void setValues(SMDescriptionData smData)

handleButton1Request

public void handleButton1Request(com.iplanet.jato.view.event.RequestInvocationEvent event)
                          throws com.iplanet.jato.model.ModelControlException

Throws:

com.iplanet.jato.model.ModelControlException

getCurrentData

protected abstract SMDescriptionData getCurrentData()

getPageTitleText

protected abstract String getPageTitleText()

handleButton1Request

protected abstract void handleButton1Request(SMDescriptionData smData)
                                      throws AMConsoleException

Throws:

AMConsoleException