com.sapportals.wcm.command

Class Macro

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

public class Macro
extends Command

Describe here.

Copyright 2004 SAP AG

Constructor Summary

Macro()

Method Summary

void	add(Command command) Add a command to the macro
protected boolean	canExecuteImpl() Returns true if at least one sub commands can be executed.
protected void	executeImpl() The macro executes all of it's sub commands.
ArrayList	getCommands()
ArrayList	getFailedCommands()
ArrayList	getForbiddenCommands()
protected boolean	isAccessibleImpl() Returns true only if all sub commands are accessible.
protected boolean	isSupportedImpl() Returns true only if all sub commands are supported.
protected void	validateImpl() nothing to validate

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

Macro

public Macro()

Method Detail

getCommands

public ArrayList getCommands()

getFailedCommands

public ArrayList getFailedCommands()

getForbiddenCommands

public ArrayList getForbiddenCommands()

executeImpl

protected void executeImpl()
                    throws Exception

The macro executes all of it's sub commands. The macro.execute() method is not an transaction! If one command fails, the execution is continued, but the macro will be in error state after execution. The failed commands can be accessed by macro.getFailedCommands() list. The forbidden commands can be accessed by macro.getForbiddenCommands() list.

Specified by:

executeImpl in class Command

Throws:

Exception

canExecuteImpl

protected boolean canExecuteImpl()
                          throws WcmException

Returns true if at least one sub commands can be executed.

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

Returns true only if all sub commands are accessible.

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

Returns true only if all sub commands are supported.

Specified by:

isSupportedImpl in class Command

Throws:

WcmException - Must be handled by caller!

Review-reader Dirk Sabiwalsky

Review-date 2001/11/26

validateImpl

protected void validateImpl()
                     throws ValidationException

nothing to validate

Specified by:

validateImpl in class Command

Throws:

ValidationException -

Review-reader Dirk Sabiwalsky

Review-date 2001/11/26

add

public final void add(Command command)

Add a command to the macro

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