com.ibm.commerce.usermanagement.commands

Class MemberLockCmdImpl

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.usermanagement.commands.MemberLockCmdImpl

All Implemented Interfaces:

AccCommand, ControllerCommand, ECCommand, ECTargetableCommand, Protectable, MemberLockCmd, 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 MemberLockCmdImpl
extends ControllerCommandImpl
implements MemberLockCmd

This command sets the lock state of a given organization.

Use this command with SSL (Secure Sockets Layer) to ensure that the information is encrypted. To do so type the command with the HTTPS secure protocol.

Behavior

• Sets the lock state for the organization with the given memberID to the lock value specified.

Exception Conditions

• memberID is null (_ERR_MISSING_PARMS).
• state is null (_ERR_MISSING_PARMS).

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	COPYRIGHT IBM copyright notice field.
static java.lang.String	NAME Class name.

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
MemberLockCmdImpl() The constructor for MemberLockCmdImpl calls its parents constructor.

Method Summary

Modifier and Type	Method and Description
AccessVector	getResources() This method returns the organization for which we are attempting to set the lock state.
boolean	isGeneric() This method checks if the command is generic.
boolean	isRetriable() This method calls its parents isRetriable() method.
void	lock() This method sets the lock state to Locked.
void	performExecute() This method executes the command.
void	setMemberId(java.lang.String memberId) This method sets the memberID for the organization to either Locked or Unlocked state.
void	setRequestProperties(TypedProperty reqProperties) This method sets the properties of the command.
void	unlock() This method sets the lock state to Unlocked.
void	validateParameters() This method calls its parents validateParamters() method.

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

checkPermission, fulfills, getForUserId, getGeneric, getOwner, getRequestProperties, getResolvedRequestProperties, getResourceOwners, getResponseProperties, getRetriable, getViewInputProperties, 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, reset, 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.ControllerCommand

checkPermission, execute, getGeneric, getRequestProperties, getResolvedRequestProperties, getResponseProperties, getRetriable, getViewInputProperties, 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, reset

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

fulfills, getOwner

Field Detail

COPYRIGHT

public static final java.lang.String COPYRIGHT

IBM copyright notice field.

See Also:

Constant Field Values

NAME

public static final java.lang.String NAME

Class name.

See Also:

Constant Field Values

Constructor Detail

MemberLockCmdImpl

public MemberLockCmdImpl()

The constructor for MemberLockCmdImpl calls its parents constructor.

Method Detail

setMemberId

public void setMemberId(java.lang.String memberId)

This method sets the memberID for the organization to either Locked or Unlocked state.

Specified by:

setMemberId in interface MemberLockCmd

Parameters:

memberId - The memberID of the organization to lock/unlock.

lock

public void lock()

This method sets the lock state to Locked.

Specified by:

lock in interface MemberLockCmd

See Also:

MemberLockCmd.lock()

unlock

public void unlock()

This method sets the lock state to Unlocked.

Specified by:

unlock in interface MemberLockCmd

See Also:

MemberLockCmd.unlock()

performExecute

public void performExecute()
                    throws ECException

This method executes the command. Before invoking this method, you must set the memberID and the lock state.

Specified by:

performExecute in interface ECCommand

Specified by:

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

Overrides:

performExecute in class AbstractECTargetableCommand

Throws:

ECException

isGeneric

public boolean isGeneric()

This method checks if the command is generic. This implementation always returns false.

Specified by:

isGeneric in interface ControllerCommand

Overrides:

isGeneric in class ControllerCommandImpl

Returns:

The current implementation always returns false.

See Also:

ControllerCommand.isGeneric()

setRequestProperties

public void setRequestProperties(TypedProperty reqProperties)
                          throws ECException

This method sets the properties of the command. This is done by executing the ProcessRequestPropertiesCmd.

Specified by:

setRequestProperties in interface ControllerCommand

Overrides:

setRequestProperties in class ControllerCommandImpl

Parameters:

reqProperties - The requestProperties.

Throws:

ECException

See Also:

ControllerCommand.setRequestProperties(TypedProperty)

validateParameters

public void validateParameters()
                        throws ECException

This method calls its parents validateParamters() method.

Specified by:

validateParameters in interface ECCommand

Overrides:

validateParameters in class AbstractECTargetableCommand

Throws:

ECException

See Also:

ECCommand.validateParameters()

isRetriable

public boolean isRetriable()

This method calls its parents isRetriable() method.

Specified by:

isRetriable in interface ControllerCommand

Overrides:

isRetriable in class ControllerCommandImpl

Returns:

boolean

See Also:

ControllerCommand.isRetriable()

getResources

public AccessVector getResources()
                          throws ECException

This method returns the organization for which we are attempting to set the lock state.

Specified by:

getResources in interface ECCommand

Overrides:

getResources in class AbstractECTargetableCommand

Returns:

AccessVector

Throws:

ECException

See Also:

ECCommand.getResources()