Package com.netscape.cms.profile.output

Class EnrollOutput

    • Field Summary

      Fields 
      Modifier and Type Field Description
      protected java.util.Vector<java.lang.String> mConfigNames  

    • Constructor Summary

      Constructors 
      Constructor Description
      EnrollOutput()  

    • Method Summary

      All Methods Instance Methods Abstract Methods Concrete Methods 
      Modifier and Type Method Description
      void addValueName​(java.lang.String name)  
      java.lang.String getConfig​(java.lang.String name)
      Retrieves configuration parameter by name.
      IDescriptor getConfigDescriptor​(java.util.Locale locale, java.lang.String name)
      Returns the descriptors of configuration parameter.
      java.util.Enumeration<java.lang.String> getConfigNames()
      Returns a list of configuration parameter names.
      IConfigStore getConfigStore()
      Retrieves configuration store.
      java.lang.String getDefaultConfig​(java.lang.String name)  
      abstract java.lang.String getName​(java.util.Locale locale)
      Retrieves the localizable name of this policy.
      abstract java.lang.String getText​(java.util.Locale locale)
      Retrieves the localizable description of this policy.
      java.lang.String getValue​(java.lang.String name, java.util.Locale locale, IRequest request)
      Retrieves the value of the given value parameter by name.
      abstract IDescriptor getValueDescriptor​(java.util.Locale locale, java.lang.String name)
      Retrieves the descriptor of the given value parameter by name.
      java.util.Enumeration<java.lang.String> getValueNames()
      Retrieves a list of names of the value parameter.
      void init​(IConfigStore config)
      Initializes this default policy.
      abstract void populate​(java.util.Map<java.lang.String,​java.lang.String> ctx, IRequest request)
      Populates the request with this policy default.
      void setConfig​(java.lang.String name, java.lang.String value)
      Sets configuration parameter.
      void setValue​(java.lang.String name, java.util.Locale locale, IRequest request, java.lang.String value)
      Sets the value of the given value parameter by name.

      • Methods inherited from class java.lang.Object

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

    • Field Detail

      • mConfigNames

        protected java.util.Vector<java.lang.String> mConfigNames

    • Constructor Detail

      • EnrollOutput

        public EnrollOutput()

    • Method Detail

      • addValueName

        public void addValueName​(java.lang.String name)

      • populate

        public abstract void populate​(java.util.Map<java.lang.String,​java.lang.String> ctx,
                              IRequest request)
                       throws EProfileException
        Populates the request with this policy default.
        Specified by:
        populate in class ProfileOutput
        Parameters:
        ctx - profile context
        request - request
        Throws:
        EProfileException - failed to populate

      • getValueDescriptor

        public abstract IDescriptor getValueDescriptor​(java.util.Locale locale,
                                               java.lang.String name)
        Retrieves the descriptor of the given value parameter by name.
        Specified by:
        getValueDescriptor in class ProfileOutput
        Parameters:
        locale - user locale
        name - property name
        Returns:
        property descriptor

      • getName

        public abstract java.lang.String getName​(java.util.Locale locale)
        Retrieves the localizable name of this policy.
        Specified by:
        getName in class ProfileOutput
        Parameters:
        locale - user locale
        Returns:
        output policy name

      • getText

        public abstract java.lang.String getText​(java.util.Locale locale)
        Retrieves the localizable description of this policy.
        Specified by:
        getText in class ProfileOutput
        Parameters:
        locale - user locale
        Returns:
        output policy description

      • getValueNames

        public java.util.Enumeration<java.lang.String> getValueNames()
        Retrieves a list of names of the value parameter.
        Specified by:
        getValueNames in class ProfileOutput
        Returns:
        a list of property names

      • getValue

        public java.lang.String getValue​(java.lang.String name,
                                 java.util.Locale locale,
                                 IRequest request)
                          throws EProfileException
        Description copied from class: ProfileOutput
        Retrieves the value of the given value parameter by name.
        Specified by:
        getValue in class ProfileOutput
        Parameters:
        name - property name
        locale - user locale
        request - request
        Returns:
        property value
        Throws:
        EProfileException - failed to retrieve value

      • setValue

        public void setValue​(java.lang.String name,
                     java.util.Locale locale,
                     IRequest request,
                     java.lang.String value)
              throws EPropertyException
        Sets the value of the given value parameter by name.
        Specified by:
        setValue in class ProfileOutput
        Parameters:
        name - property name
        locale - user locale
        request - request
        value - property value
        Throws:
        EPropertyException

      • getConfigNames

        public java.util.Enumeration<java.lang.String> getConfigNames()
        Description copied from interface: IConfigTemplate
        Returns a list of configuration parameter names.
        Returns:
        parameter names

      • getConfigDescriptor

        public IDescriptor getConfigDescriptor​(java.util.Locale locale,
                                       java.lang.String name)
        Description copied from interface: IConfigTemplate
        Returns the descriptors of configuration parameter.
        Parameters:
        locale - user locale
        name - configuration parameter name
        Returns:
        descriptor

      • setConfig

        public void setConfig​(java.lang.String name,
                      java.lang.String value)
               throws EPropertyException
        Description copied from interface: IConfigTemplate
        Sets configuration parameter.
        Parameters:
        name - parameter name
        value - parameter value
        Throws:
        EPropertyException - failed to set parameter

      • getConfig

        public java.lang.String getConfig​(java.lang.String name)
        Description copied from interface: IConfigTemplate
        Retrieves configuration parameter by name.
        Returns:
        parameter

      • getDefaultConfig

        public java.lang.String getDefaultConfig​(java.lang.String name)