Package com.ibm.commerce.component.giftregistry.commands

  • Interface Summary 
    Interface Description
    CancelGiftRegistryCmd
    Cancels a gift registry by setting the status to expired
    CheckGiftRegistryCancelEligibilityCmd
    Checks to see if the registry is eligible for cancellation.
    CheckGiftRegistryCredentialsCmd
    This class takes an AuthenticationGiftRegistryBOD as an input parameter.
    CheckGiftRegistryItemEligibilityCmd
    Validates the GiftRegistryVO based on business rules.

    Called from Operation: ValidateGiftRegistryValuesCmd
    In Parameter: UpdateGiftRegistryBOD
    Result: Returns ECApplicationException if an error occurs

    The class will validate each of the gift items for the incoming UpdateGiftRegistryBOD.

    A check is done to validate that each item follows the defined business rules stored in the GRREGRULES table.

    If an error occurs when validating a gift registry value object, the GiftRegistryItemVO along with a GiftRegistryMessage will be added to an error hashtable.
    CheckGiftRegistryPurchaseRecordEligibilityCmd
    This command checks if a given gift registry purchase record is eligible to be updated or created.
    GenerateGiftRegistryAccessKeyCmd
    This command generates a universal unique key that can be used to identify a gift registry.
    GenerateGiftRegistryExternalIdCmd
    Used to send generate an external key to be used by an external system to identify this gift registry.
    MarkGiftRegistryExpiredCmd
    Marks the gift registry expired.
    PersistGiftRegistryAnnouncementCmd
    Save the Announcement history of gift registries
    PersistGiftRegistryCmd
    This commands persists a list of GiftRegistryVO in a given request business object document to the database.
    PersistGiftRegistryItemPurchaseRecordCmd
    This commands persists the nouns(represented by value objects) in a given request business object document.
    PostGiftRegistryAnnouncementCmd
    Stores announcement information that the registrant enters and optionally sends out an announcement email
    ProcessGiftRegistryAuthenticationCmd
    This BOD command has two separate paths that are chosen based on the verb action.

    1) On VerbAction.POST - The process calls the CheckGiftRegistryCredentialsCmd to validate the users credentials.

    2) On VerbAction.CANCEL - The process calls the RelinquishGiftRegistryCredentialsCmd to release all the users credentials as in a 'logout' situation.


    On failure to POST or CANCEL, an ECApplicationException is thrown from a delegated command.
    RelinquishGiftRegistryCredentialsCmd
    Releases gift registry credentials for a particular user.
    SendAnnouncementCmd
    Sends a gift registry announcement message to notify the recipients
    SendGiftRegistryConfirmationCmd
    Sends an email message informing the registrants of the registry being created successfully.
    SendGiftRegistryMessageCmd
    Sends a UpdateGiftRegistryBOD to the messaging system to notify an external system of a gift registry being modified.
    SyncGiftRegistryCmd
    Synchronizes gift registry data on multiple systems.
    UpdateGiftRegistryCmd
    Updates, and creates a gift registry or gift registry purchase record object.
    UpdateGiftRegistryItemQuantityBoughtCmd
    This command updates how many items have been bought for a gift item in a gift registry.
    ValidateGiftRegistryValuesCmd
    Validates the gift registry value object based on the business rules.
    The class will validate each of the gift registries in the incoming UpdateGiftRegistryBOD and then validate the gift items.
    ValidateMessageParametersCmd
    Validates the gift registry Announcement value object
  • Class Summary 
    Class Description
    CancelGiftRegistryCmdImpl
    Cancels a gift registry by setting the status to expired
    Behaviour:
    execute CheckGiftRegistryCancelEligibilityCmd, to check for cancel eligibility execute MarkGiftRegistryExpiredCmd, to mark registry with expired status execute SendGiftRegistryMessageCmd, to send a message to another system execute ProcessGiftRegistryAuthenticationCmd, to remove authentication for expired registries
    On error, an ECExceptoin is thrown from descendant classes.
    CheckGiftRegistryCancelEligibilityCmdImpl
    Checks to see if the registry is eligible for cancellation.
    CheckGiftRegistryCredentialsCmdImpl
    This class takes an AuthenticationGiftRegistryBOD as an input parameter.
    CheckGiftRegistryItemEligibilityCmdImpl
    Validates the GiftRegistryVO based on business rules.
    CheckGiftRegistryPurchaseRecordEligibilityCmdImpl
    This command checks if a purchase record is eligible to be updated.
    GenerateGiftRegistryAccessKeyCmdImpl
    Default implementation of GenerateGiftRegistryAccessKeyCmd.
    GenerateGiftRegistryExternalIdCmdImpl
    Generates an external key for a gift registry.
    GiftRegistryCmdHelper
    This helper class provides methods that are shared by various gift registry component commands
    MarkGiftRegistryExpiredCmdImpl
    Marks the registry with expired status using either the external id or the gift registry id.
    PersistGiftRegistryAnnouncementCmdImpl
    Save the Announcement history of gift registries In Parameter: PostGiftRegistryAnnouncementBOD Result Parameter: ConfirmGiftRegistryAnnouncementBOD
    PersistGiftRegistryCmdImpl
    Default implementation of PersistGiftRegistryCmd.
    PersistGiftRegistryItemPurchaseRecordCmdImpl
    Default implementation of PersistGiftRegistryCmd.
    PostGiftRegistryAnnouncementCmdImpl
    Stores announcement information that the registrant enters and optionally sends out an announcement email
    Behaviour:
    execute ValidateGiftRegistryMessageCmd, to validate the inputs execute SendGiftRegistryAnnouncementCmd, to send an announcement email.
    ProcessGiftRegistryAuthenticationCmdImpl
    This BOD command has two separate paths that are chosen based on the verb action.

    1) On VerbAction.POST - The process calls the CheckGiftRegistryCredentialsCmd to validate the users credentials.

    2) On VerbAction.CANCEL - The process calls the RelinquishGiftRegistryCredentialsCmd to release all the users credentials as in a 'logout' situation.


    On failure to POST or CANCEL, an ECApplicationException is thrown from a delegated command.
    RelinquishGiftRegistryCredentialsCmdImpl
    Releases gift registry credentials for a particular user.
    SendAnnouncementCmdImpl
    Sends a gift registry announcement message to notify the recipients
    SendGiftRegistryConfirmationCmdImpl
    Sends an email message informing the registrants of the registry being created successfully.
    SendGiftRegistryMessageCmdImpl
    Sends a UpdateGiftRegistryBOD to the messaging system to notify an external system of a gift registry being modified.
    SyncGiftRegistryCmdImpl
    Synchronizes gift registry data on multiple systems.
    UpdateGiftRegistryCmdImpl
    Creates and updates a gift registry object.

    Behaviour:
    execute ValidateGiftRegistryValuesCmd, to validate the inputs execute GenerateGiftRegistryExternalIdCmd, to generate an ExternalId for the registry execute PersistGiftRegistryCmd, to store the object to the database execute SendGiftRegistryMessageCmd, to send an MQ message to another system execute SendGiftRegistryConfirmationCmd, to send out a confirmation email execute CheckGiftRegistryCredentialsCmd, to authenticate the user on this registry
    On error, an ECException is thrown from descendant classes.
    UpdateGiftRegistryItemQuantityBoughtCmdImpl
    This command updates how many items have been bought for a gift item in a gift registry.
    UpdateGiftRegistryPurchaseRecordCmdImpl
    Create or update the purchase record for the gift item

    Behaviour:
    execute CheckGiftRegistryPurchaseRecordEligibilityCmd, to validate the inputs execute PersistGiftRegistryItemPurchaseRecordCmd, to store the purchase record to the database
    On error, an ECException is thrown from descendant classes.
    ValidateGiftRegistryValuesCmdImpl
    Validates the gift registry value object based on the business rules.
    The class will validate each of the gift registries in the incoming UpdateGiftRegistryBOD and then validate the gift items.
    ValidateMessageParametersCmdImpl
    Validates the gift registry Announcement value object In Parameter: PostGiftRegistryAnnouncementBOD Result Parameter: ConfirmGiftRegistryAnnouncementBOD