com.basecmp.core.usecase
Class BaseCmpUsecaseStep

java.lang.Object
  com.basecmp.core.usecase.UsecaseStep
      com.basecmp.core.usecase.BaseCmpUsecaseStep

Direct Known Subclasses:

DecisionNode, DynamicCallNode2, RuntimeCallNode, RuntimeJumpNode

public abstract class BaseCmpUsecaseStep

extends UsecaseStep

Erweiterte Basis-Implementierung eines UsecaseStep.

Alle im BaseCMP-Framework vorhandenen UsecaseSteps mit erben von dieser Klasse. Die Methoden isCallNode(), isEndNode(), is JumpNode() und isStartNode() werden alle mit dem Defaultwert false implementiert, was für die meisten Steps ausreicht, da das Framework selbst bereits die Implementierung der ControlNodes bzw Steps liefert.

BaseCmpUsecaseStep stellt den davon abgeleiteten Steps diverse Hilfsmethoden zu Verfügung und definiert den Logger-Namen in der Instanz-Variablen loggername. Created on 15.09.2003

Author:

Wolfgang Schröder

Field Summary

Fields inherited from class com.basecmp.core.usecase.UsecaseStep

stepId

Constructor Summary

BaseCmpUsecaseStep()

Method Summary

static void	addErrorMessage(UsecaseContext uc, java.lang.String msg)
protected java.lang.String	checkMandatoryConfigKey(java.lang.String configKey) Prüft, ob der angegeben Config-Key gesetzt wurde und wirft eine UsecaseStepInitializationException, wenn der Wert nicht gesetzt wurde.
protected java.lang.String	checkNotEmptyConfigKey(java.lang.String configKey) Prüft, ob der angegeben Config-Key gesetzt wurde und wirft eine UsecaseStepInitializationException, wenn der Wert zwar gesetzt wurde aber leer ist.
protected boolean	containsParameter(UsecaseContext uc, java.lang.String name)
protected void	dumpRequestAttributes(UsecaseContext uc) Noch nicht implementiert!
protected long	getCid(UsecaseContext uc) Liefert die Content-Id des Requests aus dem UsecaseContext als int-Wert.
protected long	getCid(UsecaseContext uc, int defaultCid) Liefert die Content-Id des Requests aus dem UsecaseContext als int-Wert.
protected java.lang.String	getCidAsString(UsecaseContext uc) Liefert die Content-Id des Requests aus dem UsecaseContext als String.
protected java.lang.String	getCidAsString(UsecaseContext uc, int defaultCid) Liefert die Content-Id des Requests aus dem UsecaseContext als String-Wert.
protected java.lang.String	getCidAsString(UsecaseContext uc, java.lang.String defaultCid) Liefert die Content-Id des Requests aus dem UsecaseContext als String-Wert.
protected long	getParameter(UsecaseContext uc, java.lang.String name, int defaultValue) Liefert das Usecase-Argument "name" als int-Wert.
protected java.lang.String	getParameterAsString(UsecaseContext uc, java.lang.String name) Liefert das Usecase-Argument "name" als String.
protected java.lang.String	getParameterAsString(UsecaseContext uc, java.lang.String name, int defaultValue) Liefert das Usecase-Argument "name" als String.
protected java.lang.String	getParameterAsString(UsecaseContext uc, java.lang.String name, java.lang.String defaultValue) Liefert das Usecase-Argument "name" als String.
boolean	isCallNode() Liefert false
boolean	isEndNode() Liefert false
boolean	isJumpNode() Liefert false
boolean	isStartNode() Liefert false

Methods inherited from class com.basecmp.core.usecase.UsecaseStep

getConfigKeys, getConfigValue, initStep, isInitialized, setConfigValue

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

BaseCmpUsecaseStep

public BaseCmpUsecaseStep()

Method Detail

addErrorMessage

public static void addErrorMessage(UsecaseContext uc,
                                   java.lang.String msg)

checkMandatoryConfigKey

protected java.lang.String checkMandatoryConfigKey(java.lang.String configKey)

Prüft, ob der angegeben Config-Key gesetzt wurde und wirft eine UsecaseStepInitializationException, wenn der Wert nicht gesetzt wurde.

Returns:

Liefert den konfigurierten Wert, wenn vorhanden

checkNotEmptyConfigKey

protected java.lang.String checkNotEmptyConfigKey(java.lang.String configKey)

Prüft, ob der angegeben Config-Key gesetzt wurde und wirft eine UsecaseStepInitializationException, wenn der Wert zwar gesetzt wurde aber leer ist.

Returns:

Liefert den konfigurierten Wert, wenn vorhanden

containsParameter

protected boolean containsParameter(UsecaseContext uc,
                                    java.lang.String name)

Returns:

True, wenn im UsecaseContext ein Argument unter dem angegebenen Namen vorhande ist, sonst false.

dumpRequestAttributes

protected void dumpRequestAttributes(UsecaseContext uc)

Noch nicht implementiert!

getCid

protected long getCid(UsecaseContext uc)

Liefert die Content-Id des Requests aus dem UsecaseContext als int-Wert. Liefert 0, wenn keine Content-Id vorhanden ist.

getCid

protected long getCid(UsecaseContext uc,
                      int defaultCid)

Liefert die Content-Id des Requests aus dem UsecaseContext als int-Wert. Liefert defaultCid, wenn keine Content-Id vorhanden ist.

getCidAsString

protected java.lang.String getCidAsString(UsecaseContext uc)

Liefert die Content-Id des Requests aus dem UsecaseContext als String. Liefert 0, wenn keine Content-Id vorhanden ist.

getCidAsString

protected java.lang.String getCidAsString(UsecaseContext uc,
                                          int defaultCid)

Liefert die Content-Id des Requests aus dem UsecaseContext als String-Wert. Liefert defaultCid, wenn keine Content-Id vorhanden ist.

getCidAsString

protected java.lang.String getCidAsString(UsecaseContext uc,
                                          java.lang.String defaultCid)

Liefert die Content-Id des Requests aus dem UsecaseContext als String-Wert. Liefert defaultCid, wenn keine Content-Id vorhanden ist.

getParameter

protected long getParameter(UsecaseContext uc,
                            java.lang.String name,
                            int defaultValue)

Liefert das Usecase-Argument "name" als int-Wert. Liefert defaultValue, wenn das Argument nicht vorhanden ist.

getParameterAsString

protected java.lang.String getParameterAsString(UsecaseContext uc,
                                                java.lang.String name)

Liefert das Usecase-Argument "name" als String. Liefert einen leeren String, wenn das Argument nicht vorhanden ist.

getParameterAsString

protected java.lang.String getParameterAsString(UsecaseContext uc,
                                                java.lang.String name,
                                                int defaultValue)

Liefert das Usecase-Argument "name" als String. Liefert defaultValue als String, wenn das Argument nicht vorhanden ist.

getParameterAsString

protected java.lang.String getParameterAsString(UsecaseContext uc,
                                                java.lang.String name,
                                                java.lang.String defaultValue)

Liefert das Usecase-Argument "name" als String. Liefert defaultValue als String, wenn das Argument nicht vorhanden ist.

isCallNode

public boolean isCallNode()

Liefert false

Specified by:

isCallNode in class UsecaseStep

Returns:

True, wenn der Step als CallNode fungieren darf.

isEndNode

public boolean isEndNode()

Liefert false

Specified by:

isEndNode in class UsecaseStep

Returns:

True, wenn der Step als EndNode fungieren darf.

isJumpNode

public boolean isJumpNode()

Liefert false

Specified by:

isJumpNode in class UsecaseStep

Returns:

True, wenn der Step als JumpNode fungieren darf.

isStartNode

public boolean isStartNode()

Liefert false

Specified by:

isStartNode in class UsecaseStep

Returns:

True, wenn der Step als StartNode fungieren darf.