com.sapportals.wcm.command

Class AddToFavoritesCommand

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

public class AddToFavoritesCommand
extends ResourceCommand

Describe here.

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

AddToFavoritesCommand()

Method Summary

protected boolean	canExecuteImpl() Default implementation of precondition to execute a command.
protected void	executeResourceImpl() Re-Implementation of resource command execute method.
protected String	getDuplicateName()
String	getID() Get the id of the favourites
String	getName() Get the name of the favourites
String	getSubfolder()
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.
void	setID(String id) Set the id of the favourite
void	setName(String name) Set the name of the favourite
void	setSubfolder(String subfolder)
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

AddToFavoritesCommand

public AddToFavoritesCommand()

Method Detail

getName

public String getName()

Get the name of the favourites

Returns:

The name of the favourite

setName

public void setName(String name)

Set the name of the favourite

Parameters:

name - The name of the favourite

getID

public String getID()

Get the id of the favourites

Returns:

The id of the favourite

setID

public void setID(String id)

Set the id of the favourite

Parameters:

id - The id of the favourite

getSubfolder

public String getSubfolder()

Returns:

subfolder

setSubfolder

public void setSubfolder(String subfolder)

Parameters:

subfolder -

executeResourceImpl

protected void executeResourceImpl()
                            throws AuthorizationRequiredException,
                                   AccessDeniedException,
                                   ResourceException,
                                   WcmException

Description copied from class: ResourceCommand

Re-Implementation of resource command execute method.

Specified by:

executeResourceImpl in class ResourceCommand

Throws:

Exception - Description of the Exception

AuthorizationRequiredException

AccessDeniedException

ResourceException

WcmException

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

Returns:

Description of the Return Value

Throws:

WcmException - Description of the 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

Returns:

The accessibleImpl value

Throws:

WcmException - Description of the Exception

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

Returns:

The supportedImpl value

Throws:

WcmException - Description of the Exception

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

getDuplicateName

protected String getDuplicateName()

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