com.ibm.commerce.catalogattachment.commands

Class CatalogAttachmentAddCmdImpl

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.ControllerCommandImpl

com.ibm.commerce.attachment.commands.AttachmentRelationBaseAddCmdImpl

com.ibm.commerce.catalogattachment.commands.CatalogAttachmentAddCmdImpl

All Implemented Interfaces:

AttachmentRelationBaseAddCmd, CatalogAttachmentAddCmd, AccCommand, ControllerCommand, ECCommand, ECTargetableCommand, Protectable, 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 CatalogAttachmentAddCmdImpl
extends AttachmentRelationBaseAddCmdImpl
implements CatalogAttachmentAddCmd

The CatalogAttachmentAddCmd is a URL and controller command that:

• Adds a new attachment relation for the specified catalog.
• Add the descriptions for the attachment relation.

To obtain the Catalog ID

• Catalog ID can be specified in the parameter
• If Catalog ID is not specified, the catalog identifier should be specified. Identifier is used together with the member ID to obtain the Catalog ID. The member ID is obtained as the owner of the store where this command is called.
• If the catalog identifier is not specified, the attachment relation ID should be provided as input. The attachment relation is then checked to see if it is a catalog attachment relation. The object ID found in the attachment relation is used as the catalog ID.

If the attachment relation ID is specified, then only attachment relation description will be created. If the command is called as URL. Only one description can be created. Otherwise, multiple descriptions can be created by setting the vector of AttachmentRelationDescriptionDataBean.

When creating the vector of AttachmentRelationDescriptionDataBean, the attachment relation ID from the databean will not be used. The attachment relation ID will be obtained from the command itself. Either user specified the attachment relation ID or it is obtained from the attachment relation just created by the command. Parameters:

• Catalog ID or Identifier of the Catalog
• Attachment Relation ID
• Attachment Target ID
• Attachment Relation Usage ID
• Sequence
• Relation Name
• Relation Description Language ID
• Relation Short Description
• Relation Long Description
• Vector of AttachmentRelationDescriptionDataBean

Access Beans and Data Beans:

• CatalogAccessBean
• AttachmentRelationAccessBean
• AttachmentRelationDescriptionAccessBean
• AttachmentRelationDescriptionDataBean

Task Commands:

• AddAttachmentRelationCmd
,

Utilities and Helpers:

• AttachmentRelationHelper

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CLASSNAME Define the CLASSNAME.
static java.lang.String	COPYRIGHT The internal copyright field.

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

LOCAL

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

defaultCommandClassName

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

serialVersionUID

Constructor Summary

Constructors

Constructor and Description
CatalogAttachmentAddCmdImpl()

Method Summary

Modifier and Type	Method and Description
java.lang.Long	getCatalogId() Gets the Catalog ID.
java.lang.String	getCatalogIdentifier() Gets the external catalog identifier.
AccessVector	getResources() Gets the access vector accessed by this command.
void	performExecute() Calls the super class to do the work.
void	reset() Resets the variables used.
void	setCatalogId(java.lang.Long anCatalogId) Sets the Catalog ID.
void	setCatalogIdentifier(java.lang.String astrCatalogIdentifier) Sets the external identifier of the catalog.
void	setRequestProperties(TypedProperty reqParms) Sets the request properties.
void	validateParameters() Validate the parameters.

Methods inherited from class com.ibm.commerce.attachment.commands.AttachmentRelationBaseAddCmdImpl

getAttachmentObjectId, getAttachmentObjectTypeId, getAttachmentRelationDescriptions, getAttachmentRelationId, getAttachmentRelationUsageId, getAttachmentTargetId, getSequence, getURL, setAttachmentObjectId, setAttachmentObjectTypeId, setAttachmentRelationDescriptions, setAttachmentRelationId, setAttachmentRelationUsageId, setAttachmentTargetId, setSequence, setURL

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

checkPermission, fulfills, getForUserId, getGeneric, getOwner, getRequestProperties, getResolvedRequestProperties, getResourceOwners, getResponseProperties, getRetriable, getViewInputProperties, isGeneric, isRetriable, mergeProperties, setForUserId, setGeneric, setOwner, setResponseProperties, setRetriable, setViewInputProperties

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.attachment.commands.AttachmentRelationBaseAddCmd

getAttachmentObjectId, getAttachmentRelationDescriptions, getAttachmentRelationId, getAttachmentRelationUsageId, getAttachmentTargetId, getSequence, getURL, setAttachmentObjectId, setAttachmentRelationDescriptions, setAttachmentRelationId, setAttachmentRelationUsageId, setAttachmentTargetId, setSequence, setURL

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

checkPermission, execute, getGeneric, getRequestProperties, getResolvedRequestProperties, getResponseProperties, getRetriable, getViewInputProperties, isGeneric, isRetriable, mergeProperties, setGeneric, setRetriable, setViewInputProperties

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.CommandCaller

unionDependencies

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

accessControlCheck, getAccCheck, getForUserId, getResourceOwners, setAccCheck, setForUserId, setOwner

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

checkIsAllowed, checkResourcePermission, createCommandExecutionEvent, getCommandContext, getCommandIfName, getCommandName, getCommandStoreId, getDefaultProperties, getExceptionInvokeParameters, getPostInvokeParameters, getPreInvokeParameters, getStoreId, getUser, getUserId, setCommandContext, setCommandIfName, setCommandStoreId, setDefaultProperties

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

isReadyToCallExecute

Methods inherited from interface com.ibm.commerce.security.Protectable

fulfills, getOwner

Field Detail

COPYRIGHT

public static final java.lang.String COPYRIGHT

The internal copyright field.

See Also:

Constant Field Values

CLASSNAME

public static final java.lang.String CLASSNAME

Define the CLASSNAME.

See Also:

Constant Field Values

Constructor Detail

CatalogAttachmentAddCmdImpl

public CatalogAttachmentAddCmdImpl()

Method Detail

getCatalogId

public java.lang.Long getCatalogId()

Gets the Catalog ID.

Specified by:

getCatalogId in interface CatalogAttachmentAddCmd

Returns:

The Catalog ID

getCatalogIdentifier

public java.lang.String getCatalogIdentifier()

Gets the external catalog identifier.

Specified by:

getCatalogIdentifier in interface CatalogAttachmentAddCmd

Returns:

The catalog identifier

getResources

public AccessVector getResources()
                          throws ECException

Gets the access vector accessed by this command. The access vector consists of a CatalogAccessBean. which is the owner of the attachment relation.

Specified by:

getResources in interface ECCommand

Overrides:

getResources in class AbstractECTargetableCommand

Returns:

AccessVector - a vector of a CatalogAccessBean.

Throws:

ECException

performExecute

public void performExecute()
                    throws ECException

Calls the super class to do the work. Assumes that the superclass calls preSetParamters() to load the object

Specified by:

performExecute in interface ECCommand

Specified by:

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

Overrides:

performExecute in class AttachmentRelationBaseAddCmdImpl

Throws:

ECException

reset

public void reset()

Resets the variables used.

Specified by:

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

Overrides:

reset in class AttachmentRelationBaseAddCmdImpl

setCatalogId

public void setCatalogId(java.lang.Long anCatalogId)

Sets the Catalog ID.

Specified by:

setCatalogId in interface CatalogAttachmentAddCmd

Parameters:

anCatalogId - The Catalog ID

setCatalogIdentifier

public void setCatalogIdentifier(java.lang.String astrCatalogIdentifier)

Sets the external identifier of the catalog.

Specified by:

setCatalogIdentifier in interface CatalogAttachmentAddCmd

Parameters:

astrCatalogIdentifier - The identifier of the Catalog

setRequestProperties

public void setRequestProperties(TypedProperty reqParms)
                          throws ECApplicationException

Sets the request properties.

Specified by:

setRequestProperties in interface ControllerCommand

Overrides:

setRequestProperties in class AttachmentRelationBaseAddCmdImpl

Parameters:

reqParms - The request properties

Throws:

ECApplicationException

validateParameters

public void validateParameters()
                        throws ECException

Validate the parameters.

Specified by:

validateParameters in interface ECCommand

Overrides:

validateParameters in class AbstractECTargetableCommand

Throws:

ECException