com.basecmp.core.usecase
Interface UsecaseMetaData

All Known Implementing Classes:

UsecaseMetaDataImpl

public interface UsecaseMetaData

Datencontainer der XML-Beschreibung eines Usecase (immutable). Die Usecase-Definitionen folgen dem XML-Schema "usecase.xsd", welches im Ant-Ordner des Entwicklungsprojekts BaseCMP-BLT zu finden ist. Die Schemadatei wird von der Implementierungsklasse UsecaseMetaDataImpl nich gebraucht, da die von Castor generierten Marshalling-Klassen das Schema bereits implemntieren. Created on 15.09.2003

Author:

Wolfgang Schröder

Method Summary

UsecaseStep	findNextUsecaseStep(UsecaseContext uc) Findet anhand des UsecaseContext-Attributs "MappingNextStep" den Folge-Step und gibt diesen zurück.
UsecaseStep	findUsecaseDefaultStart() Findet den Folge-Step des Default-Start-Step.
UsecaseStep	findUsecaseStart(java.lang.String startNodeName) Findet den Folge-Step eines namentlichen Start-Step.
java.lang.String	getDescription() Liefert die Beschreibung des Usecase.
java.lang.String	getName() Liefert den Namen des Usecase.
java.util.List	getRoles() Liefert alle Rollen, die Zugriff auf den als "protected" deklarierten Usecase haben dürfen.
long	getTimeout() Liefert den Timeout in Millisekunden, nachdem ein Usecase-Thread abgebrochen wird.
boolean	isPrivate() Liefert true, wenn der Usecase für direkte Aufrufe gesperrt (Deklaration als "private") wurde, sonst false.
boolean	isProtected() Liefert true, wenn der Usecase gegen allgemeinen Zugriff als "protected" oder "private" deklariert wurde, sonst false.
void	load() Lädt die XML-Beschreibung des Usecase und instanziert und initialisiert sämtliche Usecase-Steps.

Method Detail

findNextUsecaseStep

public UsecaseStep findNextUsecaseStep(UsecaseContext uc)

Findet anhand des UsecaseContext-Attributs "MappingNextStep" den Folge-Step und gibt diesen zurück. Existiert kein Mapping-Attribut (z.B. beim Start des Usecase), wird als Default-Mapping "NextStep" benutzt und der entsprechende, konfigurierte Step zurückgegeben.

Throws:

UsecaseStepExecutionException

findUsecaseDefaultStart

public UsecaseStep findUsecaseDefaultStart()

Findet den Folge-Step des Default-Start-Step.

Throws:

UsecaseStepExecutionException

findUsecaseStart

public UsecaseStep findUsecaseStart(java.lang.String startNodeName)

Findet den Folge-Step eines namentlichen Start-Step.

Throws:

UsecaseStepExecutionException

getDescription

public java.lang.String getDescription()

Liefert die Beschreibung des Usecase.

getName

public java.lang.String getName()

Liefert den Namen des Usecase.

getRoles

public java.util.List getRoles()

Liefert alle Rollen, die Zugriff auf den als "protected" deklarierten Usecase haben dürfen.

getTimeout

public long getTimeout()

Liefert den Timeout in Millisekunden, nachdem ein Usecase-Thread abgebrochen wird.

Der Default-Timeout kann über den Config-Wert "usecase.timeout" eingestellt werden. Ist der Wert nicht vorhanden, wird UsecaseConstants.USECASE_DEFAULT_TIMEOUT mit 60 Sekunden benutzt.

isPrivate

public boolean isPrivate()

Liefert true, wenn der Usecase für direkte Aufrufe gesperrt (Deklaration als "private") wurde, sonst false.

isProtected

public boolean isProtected()

Liefert true, wenn der Usecase gegen allgemeinen Zugriff als "protected" oder "private" deklariert wurde, sonst false.

load

public void load()

Lädt die XML-Beschreibung des Usecase und instanziert und initialisiert sämtliche Usecase-Steps.

Throws:

UsecaseStepInitializationException