org.argouml.model
Interface UseCasesHelper

All Known Implementing Classes:

AbstractUseCasesHelperDecorator

public interface UseCasesHelper

The interface for the helper for UseCases.

Created from the old UseCasesHelper.

getAllUseCases

java.util.Collection getAllUseCases(java.lang.Object ns)

Returns all usecases in some namespace ns.

Parameters:

ns - is the namespace

Returns:

Collection

getAllActors

java.util.Collection getAllActors(java.lang.Object ns)

Returns all actors in some namespace ns.

Parameters:

ns - is the namespace

Returns:

Collection

getExtendedUseCases

java.util.Collection getExtendedUseCases(java.lang.Object ausecase)

Returns all usecases this given usecase extends.

Parameters:

ausecase - the given usecase

Returns:

Collection all usecases this given usecase extends

getExtendingUseCases

@Deprecated
java.util.Collection getExtendingUseCases(java.lang.Object usecase)

Deprecated. for 0.25.4 by tfmorris

Find all UseCases that extend this UseCase.

NOTE: The association is not navigable in this direction, so a brute force search will be used and it will only include models which are accessable, not any models which are potentially linked to this one.

Parameters:

usecase - the given usecase

Returns:

Collection all usecases that extend the given usecase

getExtends

java.lang.Object getExtends(java.lang.Object abase,
                            java.lang.Object anextension)

Returns the extend relation between two usecases base and extension. If there is none null is returned.

Parameters:

abase - the given base usecase

anextension - the given extension usecase

Returns:

MExtend the extend relation

getIncludedUseCases

java.util.Collection getIncludedUseCases(java.lang.Object ausecase)

Returns all usecases this usecase includes.

Parameters:

ausecase - the given usecase

Returns:

Collection all usecases the given usecase includes

getIncludes

java.lang.Object getIncludes(java.lang.Object abase,
                             java.lang.Object aninclusion)

Returns the include relation between two usecases base and inclusion. If there is none null is returned.

Parameters:

abase - the given base usecase

aninclusion - the given inclusion usecase

Returns:

The include relation.

getSpecificationPath

java.util.Collection getSpecificationPath(java.lang.Object ausecase)

Returns the specificationpath operation of some usecase. See section 2.11.3.5 of the UML 1.3 spec for a definition.

Parameters:

ausecase - the given usecase

Returns:

Collection the specificationpath operation of the given usecase

setBase

void setBase(java.lang.Object extend,
             java.lang.Object base)

Sets the base usecase of a given extend. Updates the extensionpoints of the extend too.

Parameters:

extend - the given extend

base - the base usecase

removeExtend

void removeExtend(java.lang.Object elem,
                  java.lang.Object extend)

Remove an extend to a Use Case or Extension Point.

Parameters:

elem - The Use Case or Extension Point.

extend - The Extend to add.

removeExtensionPoint

void removeExtensionPoint(java.lang.Object elem,
                          java.lang.Object ep)

This method removes an Extension Point from a Use Case or an Extend.

Parameters:

elem - is The Use Case or Extend.

ep - is the extension point

removeInclude

void removeInclude(java.lang.Object usecase,
                   java.lang.Object include)

Remove an include from a Use Case.

Parameters:

usecase - The Use Case.

include - The Include.

addExtend

void addExtend(java.lang.Object elem,
               java.lang.Object extend)

Add an extend to a Use Case or Extension Point.

Parameters:

elem - The Use Case or Extension Point.

extend - The Extend to add.

addExtensionPoint

void addExtensionPoint(java.lang.Object handle,
                       java.lang.Object extensionPoint)

Adds an extension point to some Use Case or Extend.

Parameters:

handle - is the Use Case or Extend

extensionPoint - is the Extension Point

addExtensionPoint

void addExtensionPoint(java.lang.Object handle,
                       int position,
                       java.lang.Object extensionPoint)

Adds an extension point to some Extend.

Parameters:

handle - is the Extend

position - the 0-based position at which to insert the Extension Point

extensionPoint - is the Extension Point

addInclude

void addInclude(java.lang.Object usecase,
                java.lang.Object include)

Add an include to a Use Case.

Parameters:

usecase - The Use Case.

include - The Include.

setAddition

void setAddition(java.lang.Object handle,
                 java.lang.Object useCase)

Sets the addition to an include.

Parameters:

handle - Include

useCase - UseCase

setCondition

void setCondition(java.lang.Object handle,
                  java.lang.Object booleanExpression)

Set the condition of an extend.

Parameters:

handle - is the extend

booleanExpression - is the condition

setExtension

void setExtension(java.lang.Object handle,
                  java.lang.Object ext)

Set the extension of a usecase.

Parameters:

handle - Extend

ext - UseCase or null

setExtensionPoints

void setExtensionPoints(java.lang.Object handle,
                        java.util.Collection extensionPoints)

Sets the extension points of some use cases.

Parameters:

handle - the use case

extensionPoints - is the extension points

setIncludes

void setIncludes(java.lang.Object handle,
                 java.util.Collection includes)

Set the collection of Include relationships for a usecase.

Parameters:

handle - UseCase

includes - the collection of Include relationships

setLocation

void setLocation(java.lang.Object handle,
                 java.lang.String loc)

Sets a location of some extension point.

Parameters:

handle - is the extension point

loc - is the location

setUseCase

void setUseCase(java.lang.Object elem,
                java.lang.Object usecase)

Set a Use Case for an Extension Point.

Parameters:

elem - The Extension Point.

usecase - The Use Case.