Class ProfileInput

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

public abstract class ProfileInput extends Object implements IConfigTemplate
This interface represents a input policy which provides information on how to create the end-user enrollment page.
Version:
$Revision$, $Date$
  • Constructor Details

    • ProfileInput

      public ProfileInput()
  • Method Details

    • getConfigStore

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

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

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

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

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

      public abstract IDescriptor getValueDescriptor(Locale locale, String name)
      Retrieves the descriptor of the given value property by name.
      Parameters:
      locale - user locale
      name - property name
      Returns:
      descriptor of the property
    • getValue

      public abstract String getValue(String name, Locale locale, Request request) throws EProfileException
      Retrieves value from the request.
      Parameters:
      name - property name
      locale - user locale
      request - request
      Throws:
      EProfileException - failed to get value
    • setValue

      public abstract void setValue(String name, Locale locale, Request request, String value) throws EPropertyException
      Sets the value of the given property by name.
      Parameters:
      name - property name
      locale - user locale
      request - request
      value - value
      Throws:
      EPropertyException