com.ibm.commerce.usermanagement.commands
Interface AuditOrgEntityCmd

All Superinterfaces:
AuditBaseCmd, TaskCommand
All Known Implementing Classes:
AuditOrgEntityCmdImpl

public interface AuditOrgEntityCmd
extends AuditBaseCmd

The AuditOrgEntityCmd task command checks parameters that are passed into the OrgEntityAdd and OrgEntityUpdate commands according what is specified in the OrgEntity.properties file. The command will get store directory from CommandContex and uses store directory to find property files. If property file is not found, the command will not check any parameters
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
... Because the 'Required' attribute for legalId equals 'yes', the command will check the legalId parameter. If the legalId is missing or its length equals 0, the AuditAddressCmd will throw a excepiton. Because the 'Required' attribute for BusinessCategory equals 'no', the command will not check the BusinessCategory parameter.

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


Field Summary
static java.lang.String COPYRIGHT
          IBM Copyright notice field.
static java.lang.String defaultCommandClassName
          The default implementation of this command.
static java.lang.String NAME
          The name of this command.
 
Method Summary
 void setBusinessCategory(java.lang.String astrBusinessCategory)
          Sets business category.
 void setLegalId(java.lang.String astrLegalId)
          Sets the Legal Identifier.
 void setRequestProperties( TypedProperty requestProperties)
          Sets the request properties.
 
Methods inherited from interface com.ibm.commerce.usermanagement.commands. AuditBaseCmd
getRequestProperties, setErrorViewName, setPropertyFileName
 

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

NAME

public static final java.lang.String NAME
The name of this command.
See Also:
Constant Field Values

defaultCommandClassName

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

setBusinessCategory

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

setLegalId

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

setRequestProperties

public void setRequestProperties(TypedProperty requestProperties)
                          throws ECApplicationException
Sets the request properties.
Specified by:
setRequestProperties in interface AuditBaseCmd
Parameters:
requestProperties - the parameters passed to the command.
Throws:
ECApplicationException - If there is a problem with the parameters passed to the command.