org.argouml.model.uml.behavioralelements.usecases
Class UseCasesHelper

java.lang.Object
  |
  +--org.argouml.model.uml.behavioralelements.usecases.UseCasesHelper

public class UseCasesHelper
extends java.lang.Object

Helper class for UML BehavioralElements::UseCases Package. Current implementation is a placeholder.

Since:
ARGO0.11.2

Method Summary
 java.util.Collection getAllActors()
          Returns all actors in the current project model.
 java.util.Collection getAllActors(MNamespace ns)
          Returns all actors in some namespace ns.
 java.util.Collection getAllUseCases()
          Returns all usecases in the current project model.
 java.util.Collection getAllUseCases(MNamespace ns)
          Returns all usecases in some namespace ns.
 java.util.Collection getExtendedUseCases(MUseCase usecase)
          Returns all usecases this usecase extends
 java.util.Collection getExtendingUseCases(MUseCase usecase)
           
 MExtend getExtends(MUseCase base, MUseCase extension)
          Returns the extend relation between two usecases base and extension.
 java.util.Collection getExtensionPoints(MUseCase useCase)
          This method returns all extension points of a given use case.
static UseCasesHelper getHelper()
          Singleton instance access method.
 java.util.Collection getIncludedUseCases(MUseCase usecase)
          Returns all usecases this usecase includes
 MInclude getIncludes(MUseCase base, MUseCase inclusion)
          Returns the include relation between two usecases base and inclusion.
 java.util.Collection getSpecificationPath(MUseCase uc)
          Returns the specificationpath operation of some usecase.
 void setBase(MExtend extend, MUseCase base)
          Sets the base usecase of a given extend.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

getHelper

public static UseCasesHelper getHelper()
Singleton instance access method.


getExtensionPoints

public java.util.Collection getExtensionPoints(MUseCase useCase)

This method returns all extension points of a given use case.

Here for completeness, but actually just a wrapper for the NSUML function.

Parameters:
useCase - The use case for which we want the extension points.
Returns:
A collection of the extension points.

getAllUseCases

public java.util.Collection getAllUseCases()
Returns all usecases in the current project model.

Returns:
Collection

getAllUseCases

public java.util.Collection getAllUseCases(MNamespace ns)
Returns all usecases in some namespace ns.

Returns:
Collection

getAllActors

public java.util.Collection getAllActors()
Returns all actors in the current project model.

Returns:
Collection

getAllActors

public java.util.Collection getAllActors(MNamespace ns)
Returns all actors in some namespace ns.

Returns:
Collection

getExtendedUseCases

public java.util.Collection getExtendedUseCases(MUseCase usecase)
Returns all usecases this usecase extends

Returns:
Collection

getExtendingUseCases

public java.util.Collection getExtendingUseCases(MUseCase usecase)

getExtends

public MExtend getExtends(MUseCase base,
                          MUseCase extension)
Returns the extend relation between two usecases base and extension. If there is none null is returned.

Parameters:
base -
extension -
Returns:
MExtend

getIncludedUseCases

public java.util.Collection getIncludedUseCases(MUseCase usecase)
Returns all usecases this usecase includes

Returns:
Collection

getIncludes

public MInclude getIncludes(MUseCase base,
                            MUseCase inclusion)
Returns the include relation between two usecases base and inclusion. If there is none null is returned.

Parameters:
base -
Returns:
MExtend

getSpecificationPath

public java.util.Collection getSpecificationPath(MUseCase uc)
Returns the specificationpath operation of some usecase. See section 2.11.3.5 of the UML 1.3 spec for a definition

Parameters:
uc -
Returns:
Collection

setBase

public void setBase(MExtend extend,
                    MUseCase base)
Sets the base usecase of a given extend. Updates the extensionpoints of the extend too.

Parameters:
extend -
base -


ArgoUML © 1996-2003 (20040229)ArgoUML Project HomeArgoUML Cookbook