com.ibm.commerce.usermanagement.commands

Interface AuditOrgEntityCmd

  • All Superinterfaces:
    AuditBaseCmd, 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:
    AuditOrgEntityCmdImpl

    public interface AuditOrgEntityCmd
extends AuditBaseCmd
    Checks parameters that are passed into the OrgEntityAdd and OrgEntityUpdate commands according what is specified in the OrgEntity.properties file. The command will get the store directory from CommandContext and use the store directory to find property files. If the property file is not found, no parameter checking will be performed.
    Following is a sample of the OrgEntity properties file: 
    ...
 legalId.Label=Legal Id
 legalId.Displayed=yes
 legalId.Required=yes

 BusinessCategory.Label=Business Category
 BusinessCategory.Displayed=yes
 BusinessCategory.Required=no
    ... Following is a sample of the OrgEntity property file of new format: 
    ...
 25.Name=legalId
 25.Label=Legal Id
 25.Displayed=yes
 25.Required=yes
 25.Size=40
 25.LineBreak=2
 
 30.Name=businessCategory
 30.Label=Business Category
 30.Displayed=yes
 30.Required=yes
 30.Size=40
 30.LineBreak=2
    ... Legal Id parameter will be checked as the 'Required' attribute for legalId equals 'yes'. If the legalId is missing or its length equals 0, the AuditAddressCmd will throw an exception.
    BusinessCategory parameter will NOT be checked since the 'Required' attribute for BusinessCategory equals 'no'.

    If all parameters checks are passed successfully, the getAuditResult() method will return true; otherwise it will return false.

    • Field Detail

      • COPYRIGHT

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

      • defaultCommandClassName

        static final java.lang.String defaultCommandClassName
        The default implementation of this command.
        See Also:
        Constant Field Values

    • Method Detail

      • setBusinessCategory

        void setBusinessCategory(java.lang.String astrBusinessCategory)
        Sets business category.
        Parameters:
        astrBusinessCategory - Business category.

      • setLegalId

        void setLegalId(java.lang.String astrLegalId)
        Sets the Legal Identifier.
        Parameters:
        astrLegalId - The Legal Identifier.
Skip navigation links