com.ibm.commerce.attachment.commands

Class UpdateAttachmentTargetCmdImpl

java.lang.Object

com.ibm.websphere.command.TargetableCommandImpl

com.ibm.websphere.command.CacheableCommandImpl

com.ibm.commerce.command.MeasuredCacheableCommandImpl

com.ibm.commerce.command.AbstractECTargetableCommand

com.ibm.commerce.command.TaskCommandImpl

com.ibm.commerce.attachment.commands.UpdateAttachmentTargetCmdImpl

All Implemented Interfaces:

UpdateAttachmentTargetCmd, com.ibm.commerce.command.CacheableECCommand, ECCommand, ECTargetableCommand, TaskCommand, com.ibm.websphere.cache.Sizeable, 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 UpdateAttachmentTargetCmdImpl
extends TaskCommandImpl
implements UpdateAttachmentTargetCmd

Updates an attachment target.
Behaviour:

• Updates the attachment target with the specified attachment target ID.
• If attachment target ID is not given, then the identifier, store entity ID, and member ID must be specified. These parameters will be used to determine the attachment target ID.
  • If the attachment target is found, it will be updated with the specified parameters.
  • If the attachment target is not found,
    • If the option to create missing attachment target is set to true, then it will call AddAttachmentTarget to create the attachment target.
    • If the option to create missing attachment target is set to false, then an exception will be thrown.
    • By default, the create missing attachment target option is set to true.
• Owner of the attachment target cannot be changed.

Access Bean:

• AttachmentTargetAccessBean
• StoreEntityAccessBean

Other Commands:

• AddAttachmentTarget

Helper:

• AttachmentTargetHelper

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CLASSNAME Define the CLASSNAME.

Fields inherited from class com.ibm.websphere.command.TargetableCommandImpl

LOCAL

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

defaultCommandClassName

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

serialVersionUID

Constructor Summary

Constructors

Constructor and Description
UpdateAttachmentTargetCmdImpl()

Method Summary

Modifier and Type	Method and Description
java.lang.Long	getAttachmentTargetId() Gets the Attachment Target ID.
java.lang.String	getAttachmentUsageId() Gets the attachment usage ID of the attachment target.
java.lang.String[]	getCatalogIdsForCacheInvalidations() Gets the list of catalog IDs for cache invalidations.
java.lang.String[]	getCatentryIdsForCacheInvalidations() Gets the list of catalog entry IDs for cache invalidations.
java.lang.String[]	getCatgroupIdsForCacheInvalidations() Gets the list of catalog group IDs for cache invalidations.
java.lang.String[]	getCollateralIdsForCacheInvalidations() Gets the list of collateral IDs for cache invalidations.
java.util.Collection	getEMarketingSpotNamesForCacheInvalidations() Gets the list of e-Marketing Spot names for cache invalidations.
java.lang.Long	getField1() Gets the customizable field 1.
java.lang.Double	getField2() Gets the customizable field 2.
java.lang.String	getField3() Gets the customizable field 3.
java.lang.String	getField4() Gets the customizable field 4.
java.lang.String	getIdentifier() Gets the attachment target identifier.
java.lang.Long	getMemberId() Gets the owner ID of the attachment target.
AccessVector	getResources() Gets the access vector accessed by this command.
java.lang.Integer	getStoreentId() Gets the store entity ID of the attachment target.
void	performExecute() Main execution for UpdateAttachmentTarget.
void	reset() Resets all the parameters
void	setAttachmentTargetId(java.lang.Long anAttachmentTargetId) Sets the attachment target ID.
void	setAttachmentUsageId(java.lang.String astrAttachmentUsageId) Sets the attachment usage ID of the attachment target.
void	setCreateMissing(java.lang.Boolean aboolCreateMissing) Sets the option to create the missing attachment target.
void	setField1(java.lang.Long anField1) Sets the customizable field 1.
void	setField2(java.lang.Double adField2) Sets the customizable field 2.
void	setField3(java.lang.String astrField3) Sets the customizable field 3.
void	setField4(java.lang.String astrField4) Sets the customizable field 4
void	setIdentifier(java.lang.String astrIdentifier) Sets the identifier of the attachment target.
void	setMemberId(java.lang.Long anMemberId) Sets the owner ID of the attachment target.
void	setRequestProperties(TypedProperty reqParms) Sets the request properties.
void	setStoreentId(java.lang.Integer anStoreentId) Sets the store entity ID of the attachment target.
void	validateParameters() Validates the parameters.

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

accessControlCheck, checkIsAllowed, checkResourcePermission, createCommandExecutionEvent, execute, getAccCheck, getCommandContext, getCommandIfName, getCommandName, getCommandStoreId, getDefaultProperties, getExceptionInvokeParameters, getObjectSize, getPostInvokeParameters, getPreInvokeParameters, getStoreId, getUser, getUserId, isReadyToCallExecute, setAccCheck, setCommandContext, setCommandIfName, setCommandStoreId, setDefaultProperties

Methods inherited from class com.ibm.websphere.command.CacheableCommandImpl

executeFromCache, getCaller, getEntryInfo, getId, getSharingPolicy, postExecute, preExecute, setCaller, setObjectSize, unionDependencies, updateCache

Methods inherited from class com.ibm.websphere.command.TargetableCommandImpl

getCommandTarget, getCommandTargetName, getTargetPolicy, hasOutputProperties, setCommandTarget, setCommandTargetName, setHasOutputProperties, setOutputProperties, setTargetPolicy

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

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

Field Detail

CLASSNAME

public static final java.lang.String CLASSNAME

Define the CLASSNAME.

See Also:

Constant Field Values

Constructor Detail

UpdateAttachmentTargetCmdImpl

public UpdateAttachmentTargetCmdImpl()

Method Detail

getAttachmentTargetId

public java.lang.Long getAttachmentTargetId()

Gets the Attachment Target ID.

Specified by:

getAttachmentTargetId in interface UpdateAttachmentTargetCmd

Returns:

The attachment target ID

getMemberId

public java.lang.Long getMemberId()

Gets the owner ID of the attachment target.

Specified by:

getMemberId in interface UpdateAttachmentTargetCmd

Returns:

The owner ID of the attachment target

getStoreentId

public java.lang.Integer getStoreentId()

Gets the store entity ID of the attachment target.

Specified by:

getStoreentId in interface UpdateAttachmentTargetCmd

Returns:

The store entity ID of the attachment target

getAttachmentUsageId

public java.lang.String getAttachmentUsageId()

Gets the attachment usage ID of the attachment target.

Specified by:

getAttachmentUsageId in interface UpdateAttachmentTargetCmd

Returns:

The attachment usage ID

getField1

public java.lang.Long getField1()

Gets the customizable field 1.

Specified by:

getField1 in interface UpdateAttachmentTargetCmd

Returns:

The customizable field 1

getField2

public java.lang.Double getField2()

Gets the customizable field 2.

Specified by:

getField2 in interface UpdateAttachmentTargetCmd

Returns:

Field 2

getField3

public java.lang.String getField3()

Gets the customizable field 3.

Specified by:

getField3 in interface UpdateAttachmentTargetCmd

Returns:

The customizable field 3

getField4

public java.lang.String getField4()

Gets the customizable field 4.

Specified by:

getField4 in interface UpdateAttachmentTargetCmd

Returns:

The customizable field 4

getIdentifier

public java.lang.String getIdentifier()

Gets the attachment target identifier.

Specified by:

getIdentifier in interface UpdateAttachmentTargetCmd

Returns:

The attachment target identifier

getResources

public AccessVector getResources()
                          throws ECException

Gets the access vector accessed by this command. The default implementation returns null indicating that no protectable resource is accessed by this command.

Specified by:

getResources in interface ECCommand

Overrides:

getResources in class AbstractECTargetableCommand

Returns:

AccessVector - a vector of resource action pairs

Throws:

ECException - Any ECException captured

performExecute

public void performExecute()
                    throws ECException

Main execution for UpdateAttachmentTarget. Updates the attachment target.

Specified by:

performExecute in interface ECCommand

Specified by:

performExecute in interface com.ibm.websphere.command.TargetableCommand

Overrides:

performExecute in class AbstractECTargetableCommand

Throws:

ECException

reset

public void reset()

Resets all the parameters

Specified by:

reset in interface UpdateAttachmentTargetCmd

Specified by:

reset in interface com.ibm.websphere.command.Command

Overrides:

reset in class AbstractECTargetableCommand

setAttachmentTargetId

public void setAttachmentTargetId(java.lang.Long anAttachmentTargetId)

Sets the attachment target ID.

Specified by:

setAttachmentTargetId in interface UpdateAttachmentTargetCmd

Parameters:

anAttachmentTargetId - The attachment target ID

setMemberId

public void setMemberId(java.lang.Long anMemberId)

Sets the owner ID of the attachment target.

Specified by:

setMemberId in interface UpdateAttachmentTargetCmd

Parameters:

anMemberId - The owner ID of the attachment target

setStoreentId

public void setStoreentId(java.lang.Integer anStoreentId)

Sets the store entity ID of the attachment target.

Specified by:

setStoreentId in interface UpdateAttachmentTargetCmd

Parameters:

anStoreentId - The store entity ID

setAttachmentUsageId

public void setAttachmentUsageId(java.lang.String astrAttachmentUsageId)

Sets the attachment usage ID of the attachment target.

Specified by:

setAttachmentUsageId in interface UpdateAttachmentTargetCmd

Parameters:

astrAttachmentUsageId -

setField1

public void setField1(java.lang.Long anField1)

Sets the customizable field 1.

Specified by:

setField1 in interface UpdateAttachmentTargetCmd

Parameters:

anField1 -

setField2

public void setField2(java.lang.Double adField2)

Sets the customizable field 2.

Specified by:

setField2 in interface UpdateAttachmentTargetCmd

Parameters:

adField2 - The customizable field 2

setField3

public void setField3(java.lang.String astrField3)

Sets the customizable field 3.

Specified by:

setField3 in interface UpdateAttachmentTargetCmd

Parameters:

astrField3 - The customizable field 3

setField4

public void setField4(java.lang.String astrField4)

Sets the customizable field 4

Specified by:

setField4 in interface UpdateAttachmentTargetCmd

Parameters:

astrField4 - The customizable field 4

setIdentifier

public void setIdentifier(java.lang.String astrIdentifier)

Sets the identifier of the attachment target.

Specified by:

setIdentifier in interface UpdateAttachmentTargetCmd

Parameters:

astrIdentifier - The identifier of the attachment target

setCreateMissing

public void setCreateMissing(java.lang.Boolean aboolCreateMissing)

Sets the option to create the missing attachment target.

• True - create the missing attachment target.
• False - throw exception if the attachment target.

By default, the option is set to True.

Specified by:

setCreateMissing in interface UpdateAttachmentTargetCmd

Parameters:

aboolCreateMissing - The create missing flag

setRequestProperties

public void setRequestProperties(TypedProperty reqParms)
                          throws ECApplicationException

Sets the request properties.

Specified by:

setRequestProperties in interface UpdateAttachmentTargetCmd

Parameters:

reqParms -

Throws:

ECApplicationException

validateParameters

public void validateParameters()
                        throws ECException

Validates the parameters.

Specified by:

validateParameters in interface ECCommand

Overrides:

validateParameters in class AbstractECTargetableCommand

Throws:

ECException

getCatalogIdsForCacheInvalidations

public java.lang.String[] getCatalogIdsForCacheInvalidations()
                                                      throws ECException

Gets the list of catalog IDs for cache invalidations.

Returns:

The string array of catalog IDs

Throws:

ECException

getCatentryIdsForCacheInvalidations

public java.lang.String[] getCatentryIdsForCacheInvalidations()
                                                       throws ECException

Gets the list of catalog entry IDs for cache invalidations.

Returns:

The string array of catalog entry IDs

Throws:

ECException

getCatgroupIdsForCacheInvalidations

public java.lang.String[] getCatgroupIdsForCacheInvalidations()
                                                       throws ECException

Gets the list of catalog group IDs for cache invalidations.

Returns:

The string array of catalog group IDs

Throws:

ECException

getCollateralIdsForCacheInvalidations

public java.lang.String[] getCollateralIdsForCacheInvalidations()
                                                         throws ECException

Gets the list of collateral IDs for cache invalidations.

Returns:

The string array of collateral IDs

Throws:

ECException

getEMarketingSpotNamesForCacheInvalidations

public java.util.Collection getEMarketingSpotNamesForCacheInvalidations()
                                                                 throws ECException

Gets the list of e-Marketing Spot names for cache invalidations.

Returns:

The string array of e-Marketing Spot names

Throws:

ECException