com.ibm.commerce.component.giftregistry.commands

Interface CheckGiftRegistryCredentialsCmd

All Superinterfaces:

BusinessObjectDocumentCmd, 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:

CheckGiftRegistryCredentialsCmdImpl

public interface CheckGiftRegistryCredentialsCmd
extends BusinessObjectDocumentCmd

This class takes an AuthenticationGiftRegistryBOD as an input parameter. The AuthenticationGiftRegistryBOD must contain a gift registry ExternalId. A password is optional. If no password is supplied, the user is validated on the basis that:

• They have already been authenticated (and we have history of it in the GiftRegistryContext).
• they are a Registrant/Co-Registrant on this registry (The GiftRegistryRegistrantDataBean.getUserId(). value is checked against the users Id in the GiftRegistryContext

Logic:
If the AuthenticationGiftRegistryBOD has a password, then

• 1) The password is validated against the gift registry

If the AuthenticationGiftRegistryBOD has no password, then

• 1) we check to see if this registry exists inside the users Context already
• 2) we check to see if this registry is owned by this user

Result: ConfirmAuthenticationGiftRegistryBOD
On Success: It only contains a success message: getConfirmation().equals(Confirmation.SUCCESS)
On Failure: an ECApplicationException is thrown. Possible messages include:

• GiftRegistryMessage._ERR_EC_AUTHENTICATION_PASSWORD_FAILED
• GiftRegistryMessage._ERR_EC_AUTHENTICATION_PASSWORD_REQUIRED

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	COPYRIGHT The internal copyright field.
static java.lang.String	defaultCommandClassName The default implementation class
static java.lang.String	NAME The name of this interface

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

serialVersionUID

Method Summary

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, performExecute, 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, getResources, getStoreId, getUser, getUserId, performExecute, setAccCheck, setCommandContext, setCommandIfName, setCommandStoreId, setDefaultProperties, validateParameters

Field Detail

COPYRIGHT

static final java.lang.String COPYRIGHT

The internal copyright field.

See Also:

Constant Field Values

NAME

static final java.lang.String NAME

The name of this interface

See Also:

Constant Field Values

defaultCommandClassName

static final java.lang.String defaultCommandClassName

The default implementation class

See Also:

Constant Field Values