com.sapportals.wcm.command

Class RenameCommand

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

Direct Known Subclasses:

RenameWithDisplaynameCommand

public class RenameCommand
extends ResourceCommand

Renames a resource.

Copyright (c) SAP Portals Europe GmbH 2001

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

RenameCommand()

Method Summary

protected boolean	canExecuteImpl() Default implementation of precondition to execute a command.
protected void	executeResourceImpl() Re-Implementation of resource command execute method.
String	getNewFileName() Gets the newFileName attribute of the RenameCommand object
String	getOldFileName() Gets the oldFileName attribute of the RenameCommand object
boolean	getRenameDisplayName() Gets the renameDisplayName attribute of the RenameCommand object
protected boolean	isAccessibleImpl() Implementation to check access rights to execute a command.
boolean	isReadonly() Gets the readonly attribute of the RenameCommand object
protected boolean	isReadonlyImpl()
protected boolean	isSupportedImpl() Implementation to check if a system configuration supports the execution of a command.
void	setNewFileName(String newFileName) Sets the newFileName attribute of the RenameCommand object
void	setOldFileName(String oldFileName) Sets the oldFileName attribute of the RenameCommand object
void	setRenameDisplayName(boolean changeDisplayName) Sets the renameDisplayName attribute of the RenameCommand object
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

RenameCommand

public RenameCommand()

Method Detail

getNewFileName

public String getNewFileName()

Gets the newFileName attribute of the RenameCommand object

Returns:

The newFileName value

setNewFileName

public void setNewFileName(String newFileName)

Sets the newFileName attribute of the RenameCommand object

Parameters:

newFileName - The new newFileName value

getOldFileName

public String getOldFileName()

Gets the oldFileName attribute of the RenameCommand object

Returns:

The oldFileName value

setOldFileName

public void setOldFileName(String oldFileName)

Sets the oldFileName attribute of the RenameCommand object

Parameters:

oldFileName - The new oldFileName value

getRenameDisplayName

public boolean getRenameDisplayName()

Gets the renameDisplayName attribute of the RenameCommand object

Returns:

The renameDisplayName value

setRenameDisplayName

public void setRenameDisplayName(boolean changeDisplayName)

Sets the renameDisplayName attribute of the RenameCommand object

Parameters:

changeDisplayName - The new renameDisplayName value

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

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

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

isReadonlyImpl

protected boolean isReadonlyImpl()

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

isReadonly

public final boolean isReadonly()

Gets the readonly attribute of the RenameCommand object

Returns:

The readonly value

Throws:

WcmException - Exception raised in failure situation

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

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