org.argouml.model
Interface UseCasesFactory

All Superinterfaces:
Factory

public interface UseCasesFactory
extends Factory

The interface for the factory for UseCases.


Method Summary
 java.lang.Object buildActor(java.lang.Object actor, java.lang.Object model)
          Builds an actor in the same namespace as the given actor.
 java.lang.Object buildExtend(java.lang.Object abase, java.lang.Object anextension)
          Build an extend relationship with a newly created extension point.
 java.lang.Object buildExtend(java.lang.Object abase, java.lang.Object anextension, java.lang.Object apoint)
          Build an extend relationship.
 java.lang.Object buildExtensionPoint(java.lang.Object modelElement)
          Builds an extension point for a use case.
 java.lang.Object buildInclude(java.lang.Object abase, java.lang.Object anaddition)
          Build an include relationship.
 java.lang.Object createActor()
          Create an empty but initialized instance of a Actor.
 java.lang.Object createExtend()
          Create an empty but initialized instance of a Extend.
 java.lang.Object createExtensionPoint()
          Create an empty but initialized instance of a ExtensionPoint.
 java.lang.Object createInclude()
          Create an empty but initialized instance of a Include.
 java.lang.Object createUseCase()
          Create an empty but initialized instance of a UseCase.
 

Method Detail

createExtend

java.lang.Object createExtend()
Create an empty but initialized instance of a Extend.

Returns:
an initialized Extend instance.

createExtensionPoint

java.lang.Object createExtensionPoint()
Create an empty but initialized instance of a ExtensionPoint.

Returns:
an initialized ExtensionPoint instance.

createActor

java.lang.Object createActor()
Create an empty but initialized instance of a Actor.

Returns:
an initialized Actor instance.

createInclude

java.lang.Object createInclude()
Create an empty but initialized instance of a Include.

Returns:
an initialized Include instance.

createUseCase

java.lang.Object createUseCase()
Create an empty but initialized instance of a UseCase.

Returns:
an initialized UseCase instance.

buildExtend

java.lang.Object buildExtend(java.lang.Object abase,
                             java.lang.Object anextension)
Build an extend relationship with a newly created extension point. Equivalent to calling 3 argument form with null as 3rd argument.

Parameters:
abase - The base use case for the relationship
anextension - The extension use case for the relationship
Returns:
The new extend relationship or null if it can't be created.

buildExtend

java.lang.Object buildExtend(java.lang.Object abase,
                             java.lang.Object anextension,
                             java.lang.Object apoint)
Build an extend relationship.

Parameters:
abase - The base use case for the relationship
anextension - The extension use case for the relationship
apoint - The extension point in the base for the extension. If null, one is created.
Returns:
The new extend relationship or null if it can't be created.

buildExtensionPoint

java.lang.Object buildExtensionPoint(java.lang.Object modelElement)
Builds an extension point for a use case.

Parameters:
modelElement - The owning use case for the extension point.
Returns:
The new extension point.
Throws:
java.lang.IllegalArgumentException - if modelElement isn't a use-case.

buildInclude

java.lang.Object buildInclude(java.lang.Object abase,
                              java.lang.Object anaddition)
Build an include relationship.

Set the namespace to the base (preferred) or else extension's namespace. We don't do any checking on base and extension. They should be different, but that is someone else's problem.

Parameters:
abase - The base use case for the relationship
anaddition - The extension use case for the relationship
Returns:
The new include relationship or null if it can't be created.

buildActor

java.lang.Object buildActor(java.lang.Object actor,
                            java.lang.Object model)
Builds an actor in the same namespace as the given actor. If the object is not and actor nothing is built.

TODO: This shouldn't just silently fail if it is passed a bad argument. This contract will change. - tfm 20070607

Parameters:
model - The namespace.
actor - the given actor
Returns:
Actor the newly built actor


ArgoUML © 1996-2006ArgoUML HomepageArgoUML Cookbook