com.ibm.commerce.giftregistry.commands

Interface GiftRegistryAddressAuditCmd

  • All Superinterfaces:
    com.ibm.websphere.command.CacheableCommand, com.ibm.commerce.command.CacheableECCommand, com.ibm.websphere.command.Command, com.ibm.websphere.command.CommandCaller, ECCommand, java.io.Serializable, com.ibm.websphere.command.TargetableCommand, TaskCommand
    All Known Implementing Classes:
    GiftRegistryAddressAuditCmdImpl, GiftRegistryValuesAuditCmdImpl

    public interface GiftRegistryAddressAuditCmd
extends TaskCommand
    This commands audits the addresses used in gift registries. The address auditing rules can be specified in a store properties file. The default file name is GiftRegistryAddress.properties. To specify whether or not an address field is required, three criteria are required: the name of the fields, whether or not the field is required, and the type of field. The full grammar is as follows: 
      Name=
  Required=
  [AddressType=]
    The AddressType is only needed when the field is required. A value of R means the address is for a registrant. A value of C means the address is for a co-registrant. A value of PreEventShipping means the address is for pre-event shipping. A value of PostEventShippingAddress is for post-event shipping.

    • Field Detail

      • COPYRIGHT

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

      • NAME

        static final java.lang.String NAME
        The full qualified class name.
        See Also:
        Constant Field Values

    • Method Detail

      • getAuditResult

        boolean getAuditResult()
        Returns the audit result.
        Returns:
        True if passes the audit; false otherwise.

      • getPathSeparator

        java.lang.String getPathSeparator()
        Gets the path separator. A path separator is used to separate the store directory and the property file name. For example: 
         "store1/UserRegistration"
        "/" is the path separator.
        Returns:
        The path separator.

      • getPropertyFileName

        java.lang.String getPropertyFileName()
        Gets the name of property file
        Returns:
        The name of the property file.

      • getStoreDirectory

        java.lang.String getStoreDirectory()
        Gets the name of the store directory, which is used for finding property files belonging to this store.
        Returns:
        The name of the store directory.

      • performExecute

        void performExecute()
             throws ECException
        Executes the task command.
        Specified by:
        performExecute in interface ECCommand
        Specified by:
        performExecute in interface com.ibm.websphere.command.TargetableCommand
        Throws:
        ECException - any ECException throws.

      • setErrorViewName

        void setErrorViewName(java.lang.String astrErrorViewName)
        Sets the name of the error view.
        Parameters:
        astrErrorViewName - The name of the error view.

      • setPathSeparator

        void setPathSeparator(java.lang.String astrPathSeparator)
        Sets the path separator. A path separator is used to separate the store directory and the property file name. For example: 
         "store1/UserRegistration"
        "/" is the path separator.
        If path separator is not set, the data bean will use the default one: "/" (working under Windows platform).
        Parameters:
        astrPathSeparator - The path separator.

      • setPropertyFileName

        void setPropertyFileName(java.lang.String astrPropertyFileName)
        Sets the name of the property file.
        Parameters:
        The - name of the property file.

      • getRequestProperties

        TypedProperty getRequestProperties()
        Gets the request properties.
        Returns:
        The request properties.

      • setStoreDirectory

        void setStoreDirectory(java.lang.String astrStoreDirectory)
        Sets the name of store directory. Store directory is used as the path to find the property file. For example, you can store the property files for a store under a directory called /store31 directory. * the parent directory is included in the class path, This method should be called to set StoreDirectory to store31. If the store directory is not set, ResourceBundleDataBean will try to get it from commandContext.
        Parameters:
        astrStoreDirectory - The name of store directory.
Skip navigation links