com.sapportals.wcm.command

Class DeleteResourceCommand

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

Direct Known Subclasses:

DeleteResourceToWastebasketCommand

public class DeleteResourceCommand
extends ResourceCommand

Deletes a resource from repository. Changes between major releases 7.0 and 7.X Added methods: com.sapportals.wcm.command.DeleteResourceCommand newInstance(), com.sapportals.wcm.command.DeleteResourceCommand newInstance(boolean), void setParameters(java.util.Hashtable)

Copyright 2004 SAP AG

Field Summary

protected Hashtable

params

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

protected

DeleteResourceCommand()

Method Summary

protected boolean	canExecuteImpl() Default implementation of precondition to execute a command.
protected void	executeResourceImpl() Re-Implementation of resource command execute method.
protected boolean	isAccessibleImpl() Implementation to check access rights to execute a command.
protected boolean	isSupportedImpl() Implementation to check if a system configuration supports the execution of a command.
static DeleteResourceCommand	newInstance() Creates a new command instance.
static DeleteResourceCommand	newInstance(boolean useWastebasket) Creates a new command instance.
void	setParameters(Hashtable params)
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

Field Detail

params

protected Hashtable params

Constructor Detail

DeleteResourceCommand

protected DeleteResourceCommand()

Method Detail

newInstance

public static DeleteResourceCommand newInstance()

Creates a new command instance. This instance will use the wastebasket service in the following way:
Lookup if the wastebasket service is present. If so, let it delete the resource.

newInstance

public static DeleteResourceCommand newInstance(boolean useWastebasket)

Creates a new command instance.

Parameters:

useWastebasket - If true, the command uses the wastebasket service. If false, just calls IResource.delete() on the given resource.

setParameters

public void setParameters(Hashtable params)

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 com.sapportals.wcm.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:

com.sapportals.wcm.WcmException - Must be handled by caller!

isAccessibleImpl

protected boolean isAccessibleImpl()
                            throws com.sapportals.wcm.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:

com.sapportals.wcm.WcmException - Must be handled by caller!

isSupportedImpl

protected boolean isSupportedImpl()
                           throws com.sapportals.wcm.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:

com.sapportals.wcm.WcmException - Must be handled by caller!

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-WPC	[sap.com] tc/kmc/wpc/wpcfacade	api	EP-PIN-WPC-WCM
[sap.com] KMC-CM	[sap.com] tc/km/nonwduideprecated	api	EP-KM-CM