com.arcway.cockpit.usecasemodule.docgen.provider.interfaces

Interface IGoal

All Superinterfaces:

com.arcway.cockpit.docgen.provider.interfaces.ICockpitData, com.arcway.cockpit.modulelib2.client.docgen.provider.interfaces.IModuleData

public interface IGoal
extends com.arcway.cockpit.modulelib2.client.docgen.provider.interfaces.IModuleData

The IGoal object allows to read attribute values of a goal of a use case from the COCKPIT use case module.

Item type constant: "ucm.goal"

Method Summary

Modifier and Type	Method and Description
java.lang.String	getActor() Returns the name of the actor who pursues the goal.
java.util.List<java.lang.String>	getDescription() Returns the description.
IUseCase	getUseCase() Returns the use case the goal belongs to.
boolean	isMainActorsGoal() Returns whether this is the goal of the main actor.
com.arcway.cockpit.docgen.provider.interfaces.IRecord	toRecord() Converts this generic module data into a record.

Methods inherited from interface com.arcway.cockpit.docgen.provider.interfaces.ICockpitData

getCommitVersion, getCreationDate_MilliSecondsSince_01_01_1970, getCreationDate, getCreator, getDateOfLastModification_MilliSecondsSince_01_01_1970, getDateOfLastModification, getDisplayName, getLastModifier, getModificationCount, getProjectUniqueIdentifier, getTypeID, getTypeName, getUniqueIdentifier, toRecord

Method Detail

getDescription

java.util.List<java.lang.String> getDescription()

Returns the description. If the description consists of multiple paragraphs (ENTER) each paragraph is represented by an element in the String array.

Returns:

the description as array of paragraphs

getActor

java.lang.String getActor()

Returns the name of the actor who pursues the goal.

Returns:

the actor

isMainActorsGoal

boolean isMainActorsGoal()

Returns whether this is the goal of the main actor.

Returns:

true, if this is the main actors goal, false otherwise

getUseCase

IUseCase getUseCase()

Returns the use case the goal belongs to.

Returns:

the use case

toRecord

com.arcway.cockpit.docgen.provider.interfaces.IRecord toRecord()

Converts this generic module data into a record.

In addition to all fields documented at ICockpitData.toRecord(), in the created record, the following fields are filled accoring to the wrapped cockpit data:

• IRecord.DESCRIPTION_KEY

Specified by:

toRecord in interface com.arcway.cockpit.docgen.provider.interfaces.ICockpitData

Returns:

converted cockpit project data