com.ibm.commerce.usermanagement.commands
Class MemberLockCmdImpl

java.lang.Object
  |
  +--CacheableCommandImpl
        |
        +--com.ibm.commerce.command.AbstractECTargetableCommand
              |
              +--com.ibm.commerce.command.ControllerCommandImpl
                    |
                    +--com.ibm.commerce.usermanagement.commands.MemberLockCmdImpl
All Implemented Interfaces:
AccCommand, ControllerCommand, ECCommand, ECTargetableCommand, MemberLockCmd

public class MemberLockCmdImpl
extends ControllerCommandImpl
implements MemberLockCmd

This command is used to set 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

Exception Conditions

See Also:
Serialized Form

Field Summary
static java.lang.String COPYRIGHT
          IBM copyright notice field.
static java.lang.String NAME
          Class name.
 
Fields inherited from class com.ibm.commerce.command. ControllerCommandImpl
requestProperties, responseProperties, retriable, viewReqProperties
 
Fields inherited from class com.ibm.commerce.command. AbstractECTargetableCommand
commandContext
 
Fields inherited from interface com.ibm.commerce.command. ECCommand
defaultCommandClassName
 
Constructor Summary
MemberLockCmdImpl()
          Constructor for MemberLockCmdImpl.
 
Method Summary
  AccessVector getResources()
          Returns the organization for which we are attempting to set the lock state.
 boolean isGeneric()
          Checks if this is a generic command.
 boolean isRetriable()
          Checks if this command is retriable on rollback exception
 void lock()
          Sets the lock state to Locked.
 void performExecute()
          Executes the command.
 void setMemberId(java.lang.String memberId)
          Sets the memberId for the organization to either Locked or Unlocked state.
 void setRequestProperties( TypedProperty reqProperties)
          Sets the properties of the command.
 void unlock()
          Sets the lock state to Unlocked.
 void validateParameters()
          Performs server side parameter checking.
 
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, checkParameters, checkResourcePermission, createCommandExecutionEvent, execute, finalize, getAccCheck, getCommandContext, getCommandIfName, getCommandName, getCommandStoreId, getDefaultProperties, getStoreId, getUser, getUserId, isReadyToCallExecute, reset, setAccCheck, setCommandContext, setCommandIfName, setCommandStoreId, setDefaultProperties
 
Methods inherited from class java.lang.Object
clone, 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.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, getStoreId, getUser, getUserId, setCommandContext, setCommandIfName, setCommandStoreId, setDefaultProperties
 

Field Detail
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()
Constructor for MemberLockCmdImpl.
Method Detail

setMemberId

public void setMemberId(java.lang.String memberId)
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()
Sets the lock state to Locked.
Specified by:
lock in interface MemberLockCmd
See Also:
MemberLockCmd.lock()

unlock

public void unlock()
Sets the lock state to Unlocked.
Specified by:
unlock in interface MemberLockCmd
See Also:
MemberLockCmd.unlock()

performExecute

public void performExecute()
                    throws ECException
Executes the command. Before invoking this method, you must set the memberid and the lock state.
Specified by:
performExecute in interface ECCommand
Overrides:
performExecute in class AbstractECTargetableCommand
Throws:
ECException

isGeneric

public boolean isGeneric()
Description copied from interface: ControllerCommand
Checks if this is a generic command. A generic command is a command that can be invoked by a generic user. The default is false for all controller commands and true for all view commands.
Specified by:
isGeneric in interface ControllerCommand
Overrides:
isGeneric in class ControllerCommandImpl
Returns:
boolean
See Also:
ControllerCommand.isGeneric()

setRequestProperties

public void setRequestProperties(TypedProperty reqProperties)
                          throws ECException
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 - request properties
Throws:
ECException
See Also:
ControllerCommand.setRequestProperties(TypedProperty)

validateParameters

public void validateParameters()
                        throws ECException
Description copied from interface: ECCommand
Performs server side parameter checking. This method replaces the checkParameters() method in a previous version of the code.
Specified by:
validateParameters in interface ECCommand
Overrides:
validateParameters in class AbstractECTargetableCommand
Throws:
ECException
See Also:
ECCommand.validateParameters()

isRetriable

public boolean isRetriable()
Description copied from interface: ControllerCommand
Checks if this command is retriable on rollback exception
Specified by:
isRetriable in interface ControllerCommand
Overrides:
isRetriable in class ControllerCommandImpl
Returns:
boolean
See Also:
ControllerCommand.isRetriable()

getResources

public AccessVector getResources()
                          throws ECException
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()