com.sapportals.wcm.command

Class AttachIndexToFolderCommand

java.lang.Object
  com.sapportals.wcm.command.Command
      com.sapportals.wcm.command.AttachIndexToFolderCommand

public class AttachIndexToFolderCommand
extends Command

Attaches an index to a folder.

Copyright 2004 SAP AG

Constructor Summary

AttachIndexToFolderCommand(IIndex index)

Method Summary

protected boolean	canExecuteImpl() Default implementation of precondition to execute a command.
String	checkValidation() It returns a bundle string for an expected error.
protected void	executeImpl() Implementation to execute a command.
IIndex	getIndex()
IIndexFolder	getIndexFolder()
IResource	getResource()
IResourceContext	getResourceContext()
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	setIndexFolder(IIndexFolder indexFolder, IResourceContext context)
void	setResource(IResource resource)
protected void	validateImpl() checks if the command will execute properly.

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

AttachIndexToFolderCommand

public AttachIndexToFolderCommand(IIndex index)

Method Detail

getResource

public IResource getResource()

setResource

public void setResource(IResource resource)

getIndex

public IIndex getIndex()

setIndexFolder

public void setIndexFolder(IIndexFolder indexFolder,
                           IResourceContext context)

getResourceContext

public IResourceContext getResourceContext()

getIndexFolder

public IIndexFolder getIndexFolder()

executeImpl

protected void executeImpl()
                    throws Exception

Description copied from class: Command

Implementation to execute a command.

Specified by:

executeImpl in class Command

Throws:

Exception - Exceptions are handled generally by the execute() method.

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

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

checkValidation

public String checkValidation()

It returns a bundle string for an expected error. if the command is valid the string is null

validateImpl

protected void validateImpl()
                     throws ValidationException

checks if the command will execute properly.

Specified by:

validateImpl in class Command

Throws:

ValidationException -

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