com.ibm.commerce.usermanagement.commands
Class AuditOrgEntityCmdImpl

java.lang.Object
  |
  +--CacheableCommandImpl
        |
        +--com.ibm.commerce.command.AbstractECTargetableCommand
              |
              +--com.ibm.commerce.command.TaskCommandImpl
                    |
                    +--com.ibm.commerce.usermanagement.commands.AuditBaseCmdImpl
                          |
                          +--com.ibm.commerce.usermanagement.commands.AuditOrgEntityCmdImpl
All Implemented Interfaces:
AuditBaseCmd, AuditOrgEntityCmd, ECCommand, ECTargetableCommand, TaskCommand

public class AuditOrgEntityCmdImpl
extends AuditBaseCmdImpl
implements AuditOrgEntityCmd

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.

See Also:
Serialized Form

Field Summary
static java.lang.String CLASSNAME
          The name of this command.
static java.lang.String COPYRIGHT
          IBM Copyright notice field.
protected  java.lang.String istrBusinessCategory
          The business category.
protected  java.lang.String istrLegalId
          The legal identifier.
 
Fields inherited from class com.ibm.commerce.usermanagement.commands. AuditBaseCmdImpl
ibResult, ihshProperties, ismpProperties, istrErrorViewName, istrPathSeparator, istrPropertyFileName, istrStoreDirectory, requestProperties
 
Fields inherited from class com.ibm.commerce.command. AbstractECTargetableCommand
commandContext
 
Fields inherited from interface com.ibm.commerce.usermanagement.commands. AuditOrgEntityCmd
defaultCommandClassName, NAME
 
Fields inherited from interface com.ibm.commerce.command. ECCommand
defaultCommandClassName
 
Constructor Summary
AuditOrgEntityCmdImpl()
          Creates an instance of the AUditOrgEntity command.
 
Method Summary
 void performExecute()
          Executes the business function.
 void setBusinessCategory(java.lang.String astrBusinessCategory)
          Sets the first line of the address.
 void setLegalId(java.lang.String astrLegalId)
          Sets the first line of the address.
 void setRequestProperties( TypedProperty aRequestProperties)
          Sets the request properties.
 
Methods inherited from class com.ibm.commerce.usermanagement.commands. AuditBaseCmdImpl
getAuditResult, getPathSeparator, getPropertyFileName, getRequestProperties, getStoreDirectory, setErrorViewName, setPathSeparator, setPropertyFileName, setStoreDirectory
 
Methods inherited from class com.ibm.commerce.command. AbstractECTargetableCommand
accessControlCheck, checkIsAllowed, checkParameters, checkResourcePermission, createCommandExecutionEvent, execute, finalize, getAccCheck, getCommandContext, getCommandIfName, getCommandName, getCommandStoreId, getDefaultProperties, getResources, getStoreId, getUser, getUserId, isReadyToCallExecute, reset, setAccCheck, setCommandContext, setCommandIfName, setCommandStoreId, setDefaultProperties, validateParameters
 
Methods inherited from class java.lang.Object
clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
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

CLASSNAME

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

istrLegalId

protected java.lang.String istrLegalId
The legal identifier.

istrBusinessCategory

protected java.lang.String istrBusinessCategory
The business category.
Constructor Detail

AuditOrgEntityCmdImpl

public AuditOrgEntityCmdImpl()
Creates an instance of the AUditOrgEntity command.
Method Detail

performExecute

public void performExecute()
                    throws ECException
Executes the business function.
Specified by:
performExecute in interface ECCommand
Overrides:
performExecute in class AuditBaseCmdImpl
Throws:
ECException - If there was a problem executing the business function.

setBusinessCategory

public void setBusinessCategory(java.lang.String astrBusinessCategory)
Sets the first line of the address.
Specified by:
setBusinessCategory in interface AuditOrgEntityCmd
Parameters:
astrBusinessCategory - Business category.

setLegalId

public void setLegalId(java.lang.String astrLegalId)
Sets the first line of the address.
Specified by:
setLegalId in interface AuditOrgEntityCmd
Parameters:
astrLegalId - The Legal Identifier.

setRequestProperties

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