PersistGiftRegistryCmdImpl

java.lang.Object
- MeasuredCacheableCommandImpl
- - com.ibm.commerce.command.AbstractECTargetableCommand
  - - com.ibm.commerce.command.TaskCommandImpl
    - - com.ibm.commerce.command.bod.BusinessObjectDocumentCmdImpl
      - com.ibm.commerce.component.giftregistry.commands.PersistGiftRegistryCmdImpl

All Implemented Interfaces:

BusinessObjectDocumentCmd, com.ibm.commerce.command.CacheableECCommand, ECCommand, ECTargetableCommand, TaskCommand, PersistGiftRegistryCmd, com.ibm.websphere.command.CacheableCommand, com.ibm.websphere.command.Command, com.ibm.websphere.command.CommandCaller, com.ibm.websphere.command.TargetableCommand, java.io.Serializable
```
public class PersistGiftRegistryCmdImpl
extends BusinessObjectDocumentCmdImpl
implements PersistGiftRegistryCmd
```
Default implementation of PersistGiftRegistryCmd. The following protocol will be used to determine if a row has been created for a GiftRegistry:
- If a value object has its corresponding row's unique identifier, the corresponding row has been created in the database. For simplicity, the default implementation assumes primary key will be used as the unique identifier, except for GiftRegistryVO.
- For a GiftRegistryVO, the situation is a little complicated:
  - If a GiftRegistryVO has neither externalId nor giftRegistryId, it is new.
  - If a GiftRegistryVO has giftRegistryId, it is to be updated.
  - If a GiftRegistryVO has only externalId, database will be searched for a record with the externalId. If such record is found, the gift registry is to be updated. Otherwise, it is new and its externalId is as given.
- If a corresponding row of a value object has only compound primary key, a corresponding row is already created. If both the parent node (the containing value object) has its corresponding row created and the value object's primary key can be found in database. This implies that all the containment relations are compositions. That is, a child node does not exist if its parent does not exist.
- Otherwise, a value object does not have a corresponding row in database yet.

How the updates are done:

If no corresponding row is found for a value object, new row(s) will be created. Otherwise, the row(s) will be updated with the values in the value object if the values are not null.
All the fields indicated in the Verb will be written to database regardless of whether the indicated value is null or not.

Here are rules regarding persisting various value object:

Any empty or null value object will be ignored.
If a new registrant doesn't have addresses information at all, the registrant will not be created at all.
The values in database will always be synchronized with value objects.
Adding an existing item to the same gift registry, the quantity of the item will be incremented.
If any UserAuthentication is to be updated, the command makes sure that guest password and registrant password for the same gift registry will be different.

See Also:: PersistGiftRegistryCmd

Field Summary

Fields
Modifier and Type Field and Description

static java.lang.String CLASS_NAME
The class name of this class

static java.lang.String COPYRIGHT
IBM copyright notice field.
- Fields inherited from class com.ibm.commerce.command.AbstractECTargetableCommand
  commandContext
- Fields inherited from interface com.ibm.commerce.component.giftregistry.commands.PersistGiftRegistryCmd
  defaultCommandClassName, NAME
- Fields inherited from interface com.ibm.websphere.command.Command
  serialVersionUID

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`CLASS_NAME` The class name of this class
`static java.lang.String`	`COPYRIGHT` IBM copyright notice field.

Constructor Summary

Constructors
Constructor and Description

PersistGiftRegistryCmdImpl()

Constructors
Constructor and Description
`PersistGiftRegistryCmdImpl()`

Method Summary

Methods
Modifier and Type	Method and Description
`AccessVector`	`getResources()` Returns a vector of `AccessBeans` to check authority against
`protected com.ibm.commerce.component.giftregistry.commands.GenerateGiftRegistrySearchKeyValuesCmd`	`getSearchKeyGenerator()` Returns the instance of `GenerateGiftRegistrySearchKeyValuesCmd` which generates the search key values for `firstname` and `lastname` which will stored in `SEARCHKEYFIRSTNAME` and `SEARCHKEYLASTNAME` columns of GRADDR respectively.
`void`	`performExecute()` Persists all the data in a gift registry value object into database
`protected void`	`validateGiftRegistry(GiftRegistryVO registry)` Validates data in a given gift registry.

Methods inherited from class com.ibm.commerce.command.bod.BusinessObjectDocumentCmdImpl
getRequestBOD, getResultBOD, setRequestBOD, setResultBOD

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.ibm.commerce.command.bod.BusinessObjectDocumentCmd
getResultBOD, setRequestBOD

Methods inherited from interface com.ibm.commerce.command.CacheableECCommand
execute

Methods inherited from interface com.ibm.websphere.command.CacheableCommand
executeFromCache, getCaller, getEntryInfo, getId, getSharingPolicy, postExecute, preExecute, setCaller, updateCache

Methods inherited from interface com.ibm.websphere.command.TargetableCommand
getCommandTarget, getCommandTargetName, hasOutputProperties, setCommandTarget, setCommandTargetName, setOutputProperties

Methods inherited from interface com.ibm.websphere.command.Command
isReadyToCallExecute, reset

Methods inherited from interface com.ibm.websphere.command.CommandCaller
unionDependencies

Methods inherited from interface com.ibm.commerce.command.ECCommand
checkIsAllowed, checkResourcePermission, createCommandExecutionEvent, getAccCheck, getCommandContext, getCommandIfName, getCommandName, getCommandStoreId, getDefaultProperties, getExceptionInvokeParameters, getPostInvokeParameters, getPreInvokeParameters, getStoreId, getUser, getUserId, setAccCheck, setCommandContext, setCommandIfName, setCommandStoreId, setDefaultProperties, validateParameters

- Field Detail
  - COPYRIGHT
```
public static final java.lang.String COPYRIGHT
```
    IBM copyright notice field.
    
    See Also:
    
    Constant Field Values
  - CLASS_NAME
```
public static final java.lang.String CLASS_NAME
```
    The class name of this class
- Constructor Detail
  - PersistGiftRegistryCmdImpl
```
public PersistGiftRegistryCmdImpl()
```
- Method Detail
  - validateGiftRegistry
```
protected void validateGiftRegistry(GiftRegistryVO registry)
                             throws ECException
```
    Validates data in a given gift registry. By default, it makes sure the following rules are enforced:
    1. no gift registry has the same guest password & registrant password
    2. Guest password is required if the gift registry is password protected for guest access
    Parameters:
    
    registry - the gift registry which will be validated
    
    Throws:
    
    An - exception will be thrown with the erroneous data if validation fails
    
    ECException
  - performExecute
```
public void performExecute()
                    throws ECException
```
    Persists all the data in a gift registry value object into database
    
    Specified by:
    
    performExecute in interface ECCommand
    
    Specified by:
    
    performExecute in interface com.ibm.websphere.command.TargetableCommand
    
    Overrides:
    
    performExecute in class AbstractECTargetableCommand
    
    Throws:
    
    ECException - the exception is thrown when the persisting operation fails.
  - getResources
```
public AccessVector getResources()
                          throws ECException
```
    Returns a vector of AccessBeans to check authority against
    
    Specified by:
    
    getResources in interface ECCommand
    
    Overrides:
    
    getResources in class AbstractECTargetableCommand
    
    Returns:
    
    AccessVector the vector contains a list of gift registry access beans that are possibly owned by the caller.
    
    Throws:
    
    ECException - _ERR_USER_AUTHORITY when no gift registry access bean can be found.
  - getSearchKeyGenerator
```
protected com.ibm.commerce.component.giftregistry.commands.GenerateGiftRegistrySearchKeyValuesCmd getSearchKeyGenerator()
```
    Returns the instance of GenerateGiftRegistrySearchKeyValuesCmd which generates the search key values for firstname and lastname which will stored in SEARCHKEYFIRSTNAME and SEARCHKEYLASTNAME columns of GRADDR respectively.
    These search key columns will be used while performing the similar matches search. The search key columns of GRADDR will not be used if the instance returns null values. This method returns the instance provided by the GiftRegistryCmdHelper method.
    
    Returns:
    
    The instance of GenerateGiftRegistrySearchKeyValuesCmd.
    
    See Also:
    
    GiftRegistryCmdHelper.getGiftRegistrySearchKeyValueGenerator(com.ibm.commerce.command.CommandContext), GiftRegistrySearchDataBeanBase.getCommandContext()

Class PersistGiftRegistryCmdImpl

Field Summary

Fields inherited from class com.ibm.commerce.command.AbstractECTargetableCommand

Fields inherited from interface com.ibm.commerce.component.giftregistry.commands.PersistGiftRegistryCmd

Fields inherited from interface com.ibm.websphere.command.Command

Constructor Summary

Method Summary

Methods inherited from class com.ibm.commerce.command.bod.BusinessObjectDocumentCmdImpl

Methods inherited from class com.ibm.commerce.command.AbstractECTargetableCommand

Methods inherited from class java.lang.Object

Methods inherited from interface com.ibm.commerce.command.bod.BusinessObjectDocumentCmd

Methods inherited from interface com.ibm.commerce.command.CacheableECCommand

Methods inherited from interface com.ibm.websphere.command.CacheableCommand

Methods inherited from interface com.ibm.websphere.command.TargetableCommand

Methods inherited from interface com.ibm.websphere.command.Command

Methods inherited from interface com.ibm.websphere.command.CommandCaller

Methods inherited from interface com.ibm.commerce.command.ECCommand

Field Detail

COPYRIGHT

CLASS_NAME

Constructor Detail

PersistGiftRegistryCmdImpl

Method Detail

validateGiftRegistry

performExecute

getResources

getSearchKeyGenerator