Class ProfileOutput

java.lang.Object
com.netscape.cms.profile.common.ProfileOutput
All Implemented Interfaces:
IConfigTemplate
Direct Known Subclasses:
EnrollOutput

public abstract class ProfileOutput extends 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 Details

    • ProfileOutput

      public ProfileOutput()
  • Method Details

    • init

      public abstract void init(ConfigStore config) throws EProfileException
      Initializes this default policy.
      Parameters:
      config - configuration store
      Throws:
      EProfileException - failed to initialize
    • getConfigStore

      public abstract ConfigStore getConfigStore()
      Retrieves configuration store.
      Returns:
      configuration store
    • populate

      public abstract void populate(Map<String,String> ctx, Request request) throws EProfileException
      Populates the request with this policy default.
      Parameters:
      ctx - profile context
      request - request
      Throws:
      EProfileException - failed to populate
    • getName

      public abstract String getName(Locale locale)
      Retrieves the localizable name of this policy.
      Parameters:
      locale - user locale
      Returns:
      output policy name
    • getText

      public abstract String getText(Locale locale)
      Retrieves the localizable description of this policy.
      Parameters:
      locale - user locale
      Returns:
      output policy description
    • getValueNames

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

      public abstract IDescriptor getValueDescriptor(Locale locale, 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 String getValue(String name, Locale locale, Request 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(String name, Locale locale, Request request, 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