Package com.netscape.cms.profile.common

Class ProfileOutput

  • All Implemented Interfaces:
    IConfigTemplate
    Direct Known Subclasses:
    EnrollOutput
    public abstract class ProfileOutput
extends java.lang.Object
implements IConfigTemplate
    This interface represents a output policy which provides information on how to build the result page for the enrollment.
    Version:
    $Revision$, $Date$

    • Constructor Summary

      Constructors 
      Constructor Description
      ProfileOutput()  

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      abstract IConfigStore getConfigStore()
      Retrieves configuration store.
      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.
      abstract 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.
      abstract java.util.Enumeration<java.lang.String> getValueNames()
      Retrieves a list of names of the value parameter.
      abstract 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.
      abstract 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

    • Constructor Detail

      • ProfileOutput

        public ProfileOutput()

    • Method Detail

      • getConfigStore

        public abstract IConfigStore getConfigStore()
        Retrieves configuration store.
        Returns:
        configuration store

      • 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.
        Parameters:
        ctx - profile context
        request - request
        Throws:
        EProfileException - failed to populate

      • getName

        public abstract java.lang.String getName​(java.util.Locale locale)
        Retrieves the localizable name of this policy.
        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.
        Parameters:
        locale - user locale
        Returns:
        output policy description

      • getValueNames

        public abstract java.util.Enumeration<java.lang.String> getValueNames()
        Retrieves a list of names of the value parameter.
        Returns:
        a list of property names

      • getValueDescriptor

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

      • getValue

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

      • setValue

        public abstract 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.
        Parameters:
        name - property name
        locale - user locale
        request - request
        value - property value
        Throws:
        EPropertyException