com.sapportals.wcm.command

Class LockResourceCommand

java.lang.Object
  com.sapportals.wcm.command.Command
      com.sapportals.wcm.command.ResourceCommand
          com.sapportals.wcm.command.LockResourceCommand

public class LockResourceCommand
extends ResourceCommand

Handles locking (lock/undlock) and versioning (checkin/checkout) of resources.

Copyright 2004 SAP AG

Field Summary

Fields inherited from class com.sapportals.wcm.command.ResourceCommand

MSG_ACCESSDENIED, MSG_AUTHORIZATIONFAILED, MSG_AUTHORIZATIONREQUIRED, MSG_CHILDRESOURCELOCKED, MSG_DATEVALIDATIONERROR, MSG_DOUBLENAMEVALIDATIONERROR, MSG_INVALID_CHANGED_TARGET, MSG_INVALID_TARGET, MSG_INVALIDNAME, MSG_INVALIDRECIPIENT, MSG_IOERROR, MSG_IPN, MSG_IPN_2, MSG_NAMEALREADYEXISTS, MSG_NAMETOOLONG, MSG_NOACCESSFORRESOURCE, MSG_NORECIPIENTGIVEN, MSG_OPERATIONNOTSUPPORTED, MSG_PARENTFOLDERLOCKED, MSG_RESOURCECHECKEDOUT, MSG_RESOURCELOCKED, MSG_RESOURCENOTCHECKEDOUT, MSG_RESOURCEREADONLY, MSG_SYSTEMERROR, MSG_UNKNOWNERROR, MSG_VALIDATIONERROR

Constructor Summary

LockResourceCommand()

Method Summary

protected boolean	canExecuteImpl() Default implementation of precondition to execute a command.
boolean	canUnlockForeignLock()
protected void	executeResourceImpl() Re-Implementation of resource command execute method.
protected boolean	isAccessibleImpl() Implementation to check access rights to execute a command.
boolean	isResourceLocked()
boolean	isResourceLockedByMe()
boolean	isResourceReleased()
protected boolean	isSupportedImpl() Implementation to check if a system configuration supports the execution of a command.
void	setUndoCheckout(boolean undo)
protected void	validateResourceImpl() Re-Implementation of resource command validate method.

Methods inherited from class com.sapportals.wcm.command.ResourceCommand

executeImpl, getDuplicateName, getResource, isLockedByMeAndSupported, isNotLockedByOtherUser, isNotVersionedOrCheckedOutByMe, isResourceLockedByOther, setResource, validateImpl

Methods inherited from class com.sapportals.wcm.command.Command

canExecute, canExecuteDefaultImpl, execute, failed, getMessage, getMessageKey, getRootCauseException, isAccessible, isSupported, isSystemError, setMessage, setMessageKey

Methods inherited from class java.lang.Object

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

Constructor Detail

LockResourceCommand

public LockResourceCommand()

Method Detail

setUndoCheckout

public void setUndoCheckout(boolean undo)

isResourceLocked

public boolean isResourceLocked()
                         throws ResourceException

Throws:

ResourceException

isResourceLockedByMe

public boolean isResourceLockedByMe()
                             throws ResourceException

Throws:

ResourceException

canUnlockForeignLock

public boolean canUnlockForeignLock()
                             throws WcmException

Throws:

WcmException

isResourceReleased

public boolean isResourceReleased()
                           throws ResourceException

Throws:

ResourceException

validateResourceImpl

protected void validateResourceImpl()
                             throws ValidationException

Description copied from class: ResourceCommand

Re-Implementation of resource command validate method.

Specified by:

validateResourceImpl in class ResourceCommand

Throws:

ValidationException - Only this kind of exceptions are allowed

executeResourceImpl

protected void executeResourceImpl()
                            throws Exception

Description copied from class: ResourceCommand

Re-Implementation of resource command execute method.

Specified by:

executeResourceImpl in class ResourceCommand

Throws:

Exception

isAccessibleImpl

protected boolean isAccessibleImpl()
                            throws WcmException

Description copied from class: Command

Implementation to check access rights to execute a command.

Example: To rename a file at least read and write access permission have to be set.

Specified by:

isAccessibleImpl in class Command

Throws:

WcmException - Must be handled by caller!

Review-reader Dirk Sabiwalsky

Review-date 2001/11/26

isSupportedImpl

protected boolean isSupportedImpl()
                           throws WcmException

Description copied from class: Command

Implementation to check if a system configuration supports the execution of a command.

Specified by:

isSupportedImpl in class Command

Throws:

WcmException - Must be handled by caller!

Review-reader Dirk Sabiwalsky

Review-date 2001/11/26

canExecuteImpl

protected boolean canExecuteImpl()
                          throws WcmException

Description copied from class: Command

Default implementation of precondition to execute a command. Usually this is a boolean combination of isAccessible() and isSupported() and others. For convenience the implementation can call canExecuteDefaultImpl().

Specified by:

canExecuteImpl in class Command

Throws:

WcmException - Must be handled by caller!

Review-reader Dirk Sabiwalsky

Review-date 2001/11/26

Access Rights

This class can be accessed from:

SC	DC	Public Part	ACH
[sap.com] KMC-CM	[sap.com] tc/km/nonwduideprecated	api	EP-KM-CM
[sap.com] KMC-WPC	[sap.com] tc/kmc/wpc/wpcfacade	api	EP-PIN-WPC-WCM