com.ibm.commerce.giftregistry.struts

Class GiftRegistryAuthenticationBaseActionForm

  • All Implemented Interfaces:
    java.io.Serializable, org.apache.commons.beanutils.DynaBean

    public class GiftRegistryAuthenticationBaseActionForm
extends GiftRegistryBaseValidatorActionForm
    This action form handles request data that authenticates a user
    See Also:
    Serialized Form

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method and Description
      java.lang.String getErrorViewName()
      Gets the error view name
      java.lang.String getExternalId()
      Gets the external ID
      java.lang.String getGuestAccessKey()
      Gets the guest access key
      java.lang.String getPassword()
      Get the gift registry password
      java.lang.String getRegAccessKey()
      Gets the registrant access key
      MappingResult getServiceMappingResult(org.apache.struts.action.ActionMapping mapping, java.util.Map inMap, javax.servlet.http.HttpServletRequest request)
      Returns a MappingResult object that is corresponding to the given name value pairs.
      java.lang.String getURL()
      Gets URL
      void setErrorViewName(java.lang.String string)
      Sets the errorViewName view
      void setExternalId(java.lang.String string)
      Sets the externalId
      void setGuestAccessKey(java.lang.String string)
      Sets the guest access key
      void setPassword(java.lang.String string)
      Sets the registry password
      void setRegAccessKey(java.lang.String string)
      Sets the registrant access key
      void setURL(java.lang.String string)
      Sets the success URL view
      org.apache.struts.action.ActionErrors validate(org.apache.struts.action.ActionMapping mapping, javax.servlet.http.HttpServletRequest request)
      Validates the input of the GiftRegistryAuthenticationBaseActionForm.

      • Methods inherited from class org.apache.struts.validator.DynaValidatorForm

        getPage, getResultValueMap, getValidationKey, getValidatorResults, reset, setPage, setValidatorResults

      • Methods inherited from class org.apache.struts.action.DynaActionForm

        contains, get, get, get, getDynaClass, getMap, getString, getStrings, initialize, initialize, remove, reset, set, set, set, toString

      • Methods inherited from class org.apache.struts.action.ActionForm

        getMultipartRequestHandler, getServletWrapper, setMultipartRequestHandler, setServlet, validate

      • Methods inherited from class java.lang.Object

        equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

      • Methods inherited from interface org.apache.commons.beanutils.DynaBean

        contains, get, get, get, getDynaClass, remove, set, set, set

    • Field Detail

      • COPYRIGHT

        public static final java.lang.String COPYRIGHT
        IBM Copyright
        See Also:
        Constant Field Values

    • Constructor Detail

      • GiftRegistryAuthenticationBaseActionForm

        public GiftRegistryAuthenticationBaseActionForm()

    • Method Detail

      • setErrorViewName

        public void setErrorViewName(java.lang.String string)
        Sets the errorViewName view
        Parameters:
        string - - the error view name

      • setURL

        public void setURL(java.lang.String string)
        Sets the success URL view
        Parameters:
        string - - the success URL view

      • setGuestAccessKey

        public void setGuestAccessKey(java.lang.String string)
        Sets the guest access key
        Parameters:
        guestAccessKey - - guest access key

      • setRegAccessKey

        public void setRegAccessKey(java.lang.String string)
        Sets the registrant access key
        Parameters:
        regAccessKey - - registrant access key

      • setExternalId

        public void setExternalId(java.lang.String string)
        Sets the externalId
        Parameters:
        string - - external ID

      • setPassword

        public void setPassword(java.lang.String string)
        Sets the registry password
        Parameters:
        string - - registry password

      • getGuestAccessKey

        public java.lang.String getGuestAccessKey()
        Gets the guest access key
        Returns:
        guestAccessKey - guest access key

      • getRegAccessKey

        public java.lang.String getRegAccessKey()
        Gets the registrant access key
        Returns:
        regAccessKey - registrant access key

      • getExternalId

        public java.lang.String getExternalId()
        Gets the external ID
        Returns:
        externalId - external ID

      • getPassword

        public java.lang.String getPassword()
        Get the gift registry password
        Returns:
        password - gift registry password

      • getURL

        public java.lang.String getURL()
        Gets URL
        Returns:
        URL

      • getErrorViewName

        public java.lang.String getErrorViewName()
        Gets the error view name
        Returns:
        errorViewName - error view name

      • getServiceMappingResult

        public MappingResult getServiceMappingResult(org.apache.struts.action.ActionMapping mapping,
                                             java.util.Map inMap,
                                             javax.servlet.http.HttpServletRequest request)
                                      throws ECException
        Returns a MappingResult object that is corresponding to the given name value pairs. The MappingResult will contain the name of an IBM Gift Center service, and the service input document, which is instance of BusinessObjectDocument.
        Overrides:
        getServiceMappingResult in class GiftRegistryBaseValidatorActionForm
        Parameters:
        mapping - the ActionMapping used by this action
        map - the input data of a request. Each entry in the map is of the form key: Object[]. For example, if a name-value pair in a request query is lastName = Smith, then the corresponding entry in the inMap is lastName->[Smith]. If the query is orderItemId=1&orderItemId=2&orderItemId=3, then the query is orderItemId->[1, 2, 3]
        request - the request object that represents the current request for which this action is called
        Returns:
        The service request information that is mapped from the given request. If there is no corresponding request found, an empty MappingResult will be returned.
        Throws:
        ECException - if the conversion from the map to the BOD fails

      • validate

        public org.apache.struts.action.ActionErrors validate(org.apache.struts.action.ActionMapping mapping,
                                                      javax.servlet.http.HttpServletRequest request)
        Validates the input of the GiftRegistryAuthenticationBaseActionForm. Errors will be stored in the returned ActionErrors. Guest access key and registrant access key will be validated. If both guest access key and registrant access are not available, an error will be returned.
        Overrides:
        validate in class GiftRegistryBaseValidatorActionForm
        Parameters:
        mapping - - action mapping
        request - - Http servlet request
        Returns:
        ActionErrors
Skip navigation links