Package com.sun.identity.console.base

Class AMPropertySheet

  • 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.WebActionHandler, com.iplanet.jato.view.WebActions
    public class AMPropertySheet
extends com.sun.web.ui.view.propertysheet.CCPropertySheet
    This class provides convenient methods to get and set attribute values to property sheet view. IMPORTANT: The attribute names that is passed into these convenient methods need to correspond to the property sheet xml.

    • Field Summary

      • 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.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
      AMPropertySheet​(com.iplanet.jato.view.ContainerView parent, com.sun.web.ui.model.CCPropertySheetModelInterface model, String name)  
      AMPropertySheet​(com.iplanet.jato.view.ContainerView parent, String name)  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      Map getAttributeValues​(Collection attrNames)
      Returns a map of attribute name to values.
      Map getAttributeValues​(Map orig, boolean modified, boolean matchPwd, AMModel amModel)
      Returns a map of attribute name to values which have different values from the original values.
      Map getAttributeValues​(Map orig, boolean modified, AMModel model)
      Returns a map of attribute name to values which have different values from the original values.
      Map getAttributeValues​(Map orig, AMModel model)
      Returns a map of attribute name to values.
      Map getMultipleChoiceValues​(AMPropertySheetModel model)  
      void init()  
      void restoreStateData​(Collection participatingChildren)
      Automates the restoring of store data in some children.
      void setAttributeValues​(Map attributeValues, AMModel amModel)
      Set values to model of a CCPropertySheet component.

      • Methods inherited from class com.sun.web.ui.view.propertysheet.CCPropertySheet

        getContainerView, getModel, getShowJumpLinks, setContainerView, setModel, setShowJumpLinks

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

        acceptRequest, afterAllModelsExecute, afterAllWebActionModelsExecute, afterHandleRequestCommandExecution, afterModelExecutes, afterWebActionModelExecutes, appMessage, beforeHandleRequestCommandExecution, beforeModelExecutes, beforeWebActionModelExecutes, beginDisplay, 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, setRequestContext, setWebActionModelOffset

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

        beginChildDisplay, beginChildDisplay, beginComponentDisplay, beginDisplay, childExists, createChild, createChildReserved, endChildDisplay, endChildDisplay, endComponentDisplay, endDisplay, endDisplay, ensureChild, getChild, getChildNames, getChildNames, getChildType, getCommandChildNames, getDefaultModel, getDisplayField, getDisplayFieldBooleanValue, getDisplayFieldDoubleValue, getDisplayFieldIntValue, getDisplayFieldStringValue, getDisplayFieldValue, getNumChildren, getQualifiedCommandChildNames, mapRequestParameter, mapRequestParameters, 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 interface com.iplanet.jato.view.View

        getName, getParent, getQualifiedName, setName, setParent

    • Constructor Detail

      • AMPropertySheet

        public AMPropertySheet​(com.iplanet.jato.view.ContainerView parent,
                       com.sun.web.ui.model.CCPropertySheetModelInterface model,
                       String name)

      • AMPropertySheet

        public AMPropertySheet​(com.iplanet.jato.view.ContainerView parent,
                       String name)

    • Method Detail

      • setAttributeValues

        public void setAttributeValues​(Map attributeValues,
                               AMModel amModel)
        Set values to model of a CCPropertySheet component.
        Parameters:
        attributeValues - Map of attribute name to values.

      • getAttributeValues

        public Map getAttributeValues​(Map orig,
                              AMModel model)
                       throws com.iplanet.jato.model.ModelControlException,
                              AMConsoleException
        Returns a map of attribute name to values.
        Parameters:
        orig - Map of attribute to original values.
        model - AMModel object.
        Returns:
        a map of attribute name to values.
        Throws:
        com.iplanet.jato.model.ModelControlException - if cannot get model of property sheet.
        AMConsoleException - if password and confirm password values do not match.

      • getAttributeValues

        public Map getAttributeValues​(Map orig,
                              boolean modified,
                              AMModel model)
                       throws com.iplanet.jato.model.ModelControlException,
                              AMConsoleException
        Returns a map of attribute name to values which have different values from the original values.
        Parameters:
        orig - Map of attribute to original values.
        modified - true to return map of attribute name to values that have values that is different from values in orig.
        model - AMModel object.
        Returns:
        a map of attribute name to values.
        Throws:
        com.iplanet.jato.model.ModelControlException - if cannot get model of property sheet.
        AMConsoleException - if password and confirm password values do not match.

      • getAttributeValues

        public Map getAttributeValues​(Map orig,
                              boolean modified,
                              boolean matchPwd,
                              AMModel amModel)
                       throws com.iplanet.jato.model.ModelControlException,
                              AMConsoleException
        Returns a map of attribute name to values which have different values from the original values.
        Parameters:
        orig - Map of attribute to original values.
        modified - true to return map of attribute name to values that have values that is different from values in orig.
        matchPwd - true to match password with confirm password value.
        amModel - AMModel object.
        Returns:
        a map of attribute name to values.
        Throws:
        com.iplanet.jato.model.ModelControlException - if cannot get model of property sheet.
        AMConsoleException - if password and confirm password values do not match.

      • getAttributeValues

        public Map getAttributeValues​(Collection attrNames)
                       throws com.iplanet.jato.model.ModelControlException,
                              AMConsoleException
        Returns a map of attribute name to values.
        Parameters:
        attrNames - Set of attribute names to retrieve.
        Returns:
        map of attribute name to values.
        Throws:
        com.iplanet.jato.model.ModelControlException - if cannot get model of property sheet.
        AMConsoleException - if password and confirm password values do not match.

      • restoreStateData

        public void restoreStateData​(Collection participatingChildren)
                      throws com.iplanet.jato.model.ModelControlException
        Automates the restoring of store data in some children. This is required for some special children such as CCAddRemvoe.
        Throws:
        com.iplanet.jato.model.ModelControlException - if cannot get model of property sheet.

      • init

        public void init()