OptimalTrace
5.2

com.compuware.optimaltrace.tools.common.bizobjects
Interface UseCaseIfc

All Superinterfaces:
AbstractRequirementIfc, AssociateIfc, BizObjectIfc, ChildIfc, CustomPropertyHolderIfc, DynAttributeIfc, LinkHolderIfc, MergeObjectIfc, NFRHolderIfc, NoteHolderIfc, ParentIfc, PersistentIfc, PropertiesContainerIfc, RelationIfc, RepositionableChildIfc

public interface UseCaseIfc
extends AbstractRequirementIfc, NFRHolderIfc

Interface UseCaseIfc


Field Summary
static java.lang.String ATTR_MINIMAL_GUARANTEE
           
static java.lang.String ATTR_POSTCONDITION
           
static java.lang.String ATTR_PRECONDITION
          Dynamic Attributes for UseCaseIfc
static java.lang.String ATTR_PRIORITY
           
static java.lang.String ATTR_TRIGGER
          Dynamic Attributes for UseCaseIfc
 
Fields inherited from interface com.compuware.optimaltrace.tools.common.bizobjects.AbstractRequirementIfc
ATTR_BUSINESS_DESC, ATTR_GRAPH_DISPLAY_OPTION, ATTR_ORIGIN, ATTR_USECASE_NUMER, SHOW_ALL, SHOW_MAIN_SUCCESS, SHOW_NONE
 
Fields inherited from interface com.compuware.optimaltrace.framework.business.BizObjectIfc
ATTR_IS_LOCKED, ATTR_IS_LOCKEDLOCALLY, ATTR_IS_READONLY, ATTR_LOCKOWNER, ATTR_NAME, BO_DB_TIMESTAMP, BO_ID, BO_ST, BO_TIMESTAMP, BO_TYPE
 
Fields inherited from interface com.compuware.optimaltrace.framework.merge.MergeObjectIfc
ATTR_IS_ASSOCIATECHANGEDNEWER, ATTR_IS_ASSOCIATECHANGEDOLDER, ATTR_IS_ATTRIBUTESCHANGED_NEWER, ATTR_IS_ATTRIBUTESCHANGED_OLDER, ATTR_IS_CHILDCONFLICT, ATTR_IS_CHILDWASADDED, ATTR_IS_CHILDWASREMOVED, ATTR_IS_CUSTOMPROPERTYCHANGED, ATTR_IS_CUSTOMPROPERTYCHANGEDADDED, ATTR_IS_CUSTOMPROPERTYCHANGEDREMOVED, ATTR_IS_CUSTOMPROPERTYVALUECHANGEDNEWER, ATTR_IS_CUSTOMPROPERTYVALUECHANGEDOLDER, ATTR_IS_MERGEACCEPTED, ATTR_IS_MERGECHANGED, ATTR_IS_MERGEREJECTED, ATTR_IS_NEWPARENTAFTERMOVE, ATTR_IS_OLDPARENTAFTERMOVE, ATTR_IS_PARENTCHANGED, ATTR_IS_POSITIONCHANGEDNEWER, ATTR_IS_POSITIONCHANGEDOLDER, ATTR_IS_WASADDED, ATTR_IS_WASREMOVED
 
Method Summary
 boolean addAlternativeScenario(AlternativeScenarioIfc alternativeScenario)
          Adds the alternative scenario.
 boolean addNonFunctionalRequirement(com.compuware.optimaltrace.tools.common.bizobjects.NonFunctionalRequirementIfc nfr)
          Deprecated. Please use getNFRBucket to obtain the project's NFRBucket
 void checkAlternativeScenarioNameUnique(java.lang.String name)
          Determines if the alternative scenario already exists in the usecase.
 java.lang.String getActors()
          Gets the actors associated with this UseCase in a comma delimited string.
 java.util.List getAllActors()
          Gets all actors, return the ActorIfc's associated with this usecase.
 java.util.List getAlternativeScenarios()
          Gets the list of alternative scenarios.
 GoalLevelIfc getGoalLevel()
          Gets the use case process view level
 MainSuccessScenarioIfc getMainSuccessScenario()
          Gets the main success scenario.
 java.util.List getMainSuccessScenarioRefinements()
          Returns a list of refinements contained in the main success scenario of this use case.
 java.lang.String getMinimalGuarantee()
          Gets the notes category
 java.util.List getNonFunctionalRequirements()
          Deprecated. Please use getNFRBucket to obtain the project's NFRBucket
 java.lang.String getPostCondition()
          Gets the postcondition.
 java.lang.String getPreCondition()
          Gets the precondition.
 java.lang.String getPriority()
          Gets the use case priority
 java.lang.String getTag()
          Returns the parent package tag.
 java.lang.String getTrigger()
          Gets the trigger for this usecase.
 boolean moveAlternativeScenario(AlternativeScenarioIfc scenario, java.lang.Integer numOfPlaces)
          Moves the alternative scenario.
 boolean removeAlternativeScenario(AlternativeScenarioIfc alternativeScenario)
          Removes the alternative scenario.
 boolean removeGoalLevel(GoalLevelIfc level)
          Removes the use case process view level
 boolean removeMainSuccessScenario(MainSuccessScenarioIfc mainSuccessScenario)
          Removes the main success scenario.
 boolean removeNFRBucket(com.compuware.optimaltrace.tools.common.bizobjects.NFRBucketIfc nfrBucket)
          Removes the NFR bucket.
 boolean removeNonFunctionalRequirement(com.compuware.optimaltrace.tools.common.bizobjects.NonFunctionalRequirementIfc nfr)
          Deprecated. Please use getNFRBucket to obtain the project's NFRBucket
 void repositionScenario(AlternativeScenarioIfc scenario, int numberOfPlaces)
          Gets the main success scenario.
 void setAlternativeScenarioDisplayName(AlternativeScenarioIfc altScen, java.lang.String displayNumber, java.lang.String name)
          Sets the alternative scenario display number.
 void setAlternativeScenarioDisplayNumber(AlternativeScenarioIfc altScen, int number)
          Sets the alternative scenario display number.
 boolean setGoalLevel(GoalLevelIfc level)
          Sets the use case process view level
 boolean setMainSuccessScenario(MainSuccessScenarioIfc mainSuccessScenario)
          Sets the main success scenario.
 void setMinGuarantee(java.lang.String minimalGuarantee)
          Leaving setMinimalGuarantee here for backward compatability reasons
 void setMinimalGuarantee(java.lang.String minimalGuarantee)
          Sets the minimal guarantee.
 void setPostCondition(java.lang.String cond)
          Sets the postcondition.
 void setPreCondition(java.lang.String cond)
          Sets the precondition.
 void setPriority(java.lang.String priority)
          Sets the use case priority
 void setTrigger(java.lang.String trigger)
          Sets the trigger for this usecase.
 
Methods inherited from interface com.compuware.optimaltrace.tools.common.bizobjects.AbstractRequirementIfc
addExternalLink, getAllAbstractSteps, getBranches, getBranchesToUseCases, getBusinessDescription, getDisplayName, getExtendsUseCases, getExternalLinks, getFullyQualifiedName, getGraphDisplayOption, getIncludesUseCases, getNameLength, getOrigin, getOriginAsString, getOriginX, getOriginY, getRefinements, getRefinementUseCases, getScenarios, getUseCaseNumber, getUseCasePackage, isLeafUseCase, isRootUseCase, removeExternalLink, removeLinkBucket, setBusinessDescription, setGraphDisplayOption, setName, setOrigin, setOrigin, setUseCaseNumber, updateName, updateNumber
 
Methods inherited from interface com.compuware.optimaltrace.framework.business.BizObjectIfc
cloneObjectsAttributes, disableMergeObjectSupport, enableMergeObjectSupport, equals, getBaselineId, getBizObjectId, getFirstChild, getId, getLockOwner, getName, getNextChild, getReadableName, getTimeStamp, getTypeId, hasChildren, isEqual, isEqualWithFilter, isLocked, isMergeObjectSupportEnabled, isReadOnly, setBaselineId, setBizObjectId, setId, setIsLocked, setIsReadOnly, setLockOwner, setTimeStamp, setTimeStampNoParentUpdate
 
Methods inherited from interface com.compuware.optimaltrace.framework.relations.ParentIfc
addChild, addChildAt, addParentListener, decrementChildPosition, fireChildEvent, fireChildEvent, getChild, getChild, getChildById, getChildren, getChildren, getChildren, getNextChild, getParentListeners, getPreviousChild, hasChild, hasChildById, incrementChildPosition, moveChild, numChildren, reInitialiseListeners, removeChild, removeParentListener, silentlyAddChild, silentlyAddChildAt, silentlyRemoveChild
 
Methods inherited from interface com.compuware.optimaltrace.framework.relations.ChildIfc
addChildListener, getChildListeners, getParent, getParent, moveChild, moveChildAt, removeChildListener, setParent
 
Methods inherited from interface com.compuware.optimaltrace.framework.relations.AssociateIfc
addAssociate, addAssociateListener, addInwardAssociate, fireAssociateEvent, getAssociate, getAssociateListeners, getAssociates, getAssociates, getInwardAssociates, getInwardAssociates, getOutwardAssociates, getOutwardAssociates, hasAssociate, hasInwardAssociate, hasOutwardAssociate, numAssociates, numInwardAssociates, numOutwardAssociates, removeAssociate, removeAssociateListener, removeInwardAssociate
 
Methods inherited from interface com.compuware.optimaltrace.framework.business.PersistentIfc
customPropertiesToDocArray, getChildDocPersistObjects, toDocArray, toSQL
 
Methods inherited from interface com.compuware.optimaltrace.framework.business.PropertiesContainerIfc
addPropertyChangeListener, addPropertyChangeListener, firePropertyChange, getPropertyChangeListeners, removePropertyChangeListener, removePropertyChangeListener
 
Methods inherited from interface com.compuware.optimaltrace.framework.dynattribute.DynAttributeIfc
getAttributeTable, getAttributeTimeStamp, getBooleanAttribute, getIntAttribute, getLongAttribute, getObjectAttribute, getShortAttribute, getStringAttribute, getTimeStamp, getTimeStampTable, hasAttribute, removeAttribute, renameAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttributeNoTimeStampUpdate, setAttributeNoTimeStampUpdate, setAttributeTable, setAttributeTimeStamp, setObjectAttribute, setTimeStampTable
 
Methods inherited from interface com.compuware.optimaltrace.framework.merge.MergeObjectIfc
isAssociateChangedNewer, isAssociateChangedOlder, isAttributesChangedNewer, isAttributesChangedOlder, isChildConflict, isChildWasAdded, isChildWasRemoved, isMergeAccepted, isMergeChanged, isMergeRejected, isNewParentAfterMove, isOldParentAfterMove, isParentChanged, isPositionChangedNewer, isPositionChangedOlder, isWasAdded, isWasRemoved, setIsAssociateChangedNewer, setIsAssociateChangedOlder, setIsAttributesChangedNewer, setIsAttributesChangedOlder, setIsChildConflict, setIsChildWasAdded, setIsChildWasRemoved, setIsMergeAccepted, setIsMergeChanged, setIsMergeRejected, setIsNewParentAfterMove, setIsOldParentAfterMove, setIsParentChanged, setIsPositionChangedNewer, setIsPositionChangedOlder, setIsWasAdded, setIsWasRemoved
 
Methods inherited from interface com.compuware.optimaltrace.tools.common.bizobjects.NoteHolderIfc
getNoteBucket, removeNoteBucket, setNoteBucket
 
Methods inherited from interface com.compuware.optimaltrace.tools.common.bizobjects.LinkHolderIfc
getLinkBucket, setLinkBucket
 
Methods inherited from interface com.compuware.optimaltrace.framework.business.RepositionableChildIfc
getPositionNumber
 
Methods inherited from interface com.compuware.optimaltrace.framework.customproperty.CustomPropertyHolderIfc
getCustomProperty, getCustomPropertyBucket, getCustomPropertyTemplates, removeCustomPropertyBucket, setCustomPropertyBucket
 
Methods inherited from interface com.compuware.optimaltrace.tools.common.bizobjects.NFRHolderIfc
getNFRBucket, setNFRBucket
 

Field Detail

ATTR_PRECONDITION

static final java.lang.String ATTR_PRECONDITION
Dynamic Attributes for UseCaseIfc

See Also:
Constant Field Values

ATTR_POSTCONDITION

static final java.lang.String ATTR_POSTCONDITION
See Also:
Constant Field Values

ATTR_TRIGGER

static final java.lang.String ATTR_TRIGGER
Dynamic Attributes for UseCaseIfc

See Also:
Constant Field Values

ATTR_MINIMAL_GUARANTEE

static final java.lang.String ATTR_MINIMAL_GUARANTEE
See Also:
Constant Field Values

ATTR_PRIORITY

static final java.lang.String ATTR_PRIORITY
See Also:
Constant Field Values
Method Detail

checkAlternativeScenarioNameUnique

void checkAlternativeScenarioNameUnique(java.lang.String name)
                                        throws com.compuware.optimaltrace.tools.common.bizobjects.NameNotUniqueException
Determines if the alternative scenario already exists in the usecase.

Parameters:
name - The new scenario name to check for uniqueness
Throws:
NameNotUniqueException

setAlternativeScenarioDisplayNumber

void setAlternativeScenarioDisplayNumber(AlternativeScenarioIfc altScen,
                                         int number)
Sets the alternative scenario display number.

Parameters:
altScen -
number -

setAlternativeScenarioDisplayName

void setAlternativeScenarioDisplayName(AlternativeScenarioIfc altScen,
                                       java.lang.String displayNumber,
                                       java.lang.String name)
Sets the alternative scenario display number.

Parameters:
altScen -
displayNumber -
name -

getGoalLevel

GoalLevelIfc getGoalLevel()
Gets the use case process view level

Returns:
GoalLevelIfc

setGoalLevel

boolean setGoalLevel(GoalLevelIfc level)
Sets the use case process view level

Parameters:
level -
Returns:
boolean

removeGoalLevel

boolean removeGoalLevel(GoalLevelIfc level)
Removes the use case process view level

Parameters:
level -
Returns:
boolean

getActors

java.lang.String getActors()
Gets the actors associated with this UseCase in a comma delimited string.

Returns:
String

getMainSuccessScenario

MainSuccessScenarioIfc getMainSuccessScenario()
Gets the main success scenario.

Returns:
MainSuccessScenarioIfc

repositionScenario

void repositionScenario(AlternativeScenarioIfc scenario,
                        int numberOfPlaces)
Gets the main success scenario.

Parameters:
scenario -
numberOfPlaces -

getMainSuccessScenarioRefinements

java.util.List getMainSuccessScenarioRefinements()
Returns a list of refinements contained in the main success scenario of this use case.

Returns:
List

setMainSuccessScenario

boolean setMainSuccessScenario(MainSuccessScenarioIfc mainSuccessScenario)
Sets the main success scenario.

Parameters:
mainSuccessScenario -
Returns:
boolean

removeMainSuccessScenario

boolean removeMainSuccessScenario(MainSuccessScenarioIfc mainSuccessScenario)
Removes the main success scenario.

Parameters:
mainSuccessScenario -
Returns:
boolean

getAlternativeScenarios

java.util.List getAlternativeScenarios()
Gets the list of alternative scenarios.

Returns:
List of AlternativeScenarioIfc

addAlternativeScenario

boolean addAlternativeScenario(AlternativeScenarioIfc alternativeScenario)
                               throws com.compuware.optimaltrace.tools.common.bizobjects.NameNotUniqueException
Adds the alternative scenario.

Parameters:
alternativeScenario -
Returns:
boolean
Throws:
NameNotUniqueException

removeAlternativeScenario

boolean removeAlternativeScenario(AlternativeScenarioIfc alternativeScenario)
Removes the alternative scenario.

Parameters:
alternativeScenario -
Returns:
boolean

getNonFunctionalRequirements

java.util.List getNonFunctionalRequirements()
Deprecated. Please use getNFRBucket to obtain the project's NFRBucket

Gets the list of NonFunctionalRequirements for this UseCase.

Returns:
List

addNonFunctionalRequirement

boolean addNonFunctionalRequirement(com.compuware.optimaltrace.tools.common.bizobjects.NonFunctionalRequirementIfc nfr)
Deprecated. Please use getNFRBucket to obtain the project's NFRBucket

Adds a NonFunctionalRequirement for this UseCase.

Parameters:
nfr -
Returns:
boolean

removeNonFunctionalRequirement

boolean removeNonFunctionalRequirement(com.compuware.optimaltrace.tools.common.bizobjects.NonFunctionalRequirementIfc nfr)
Deprecated. Please use getNFRBucket to obtain the project's NFRBucket

Removes a NonFunctionalRequirement for this UseCase.

Parameters:
nfr -
Returns:
boolean

getTrigger

java.lang.String getTrigger()
Gets the trigger for this usecase.

Returns:
String

setTrigger

void setTrigger(java.lang.String trigger)
Sets the trigger for this usecase.

Parameters:
trigger -

removeNFRBucket

boolean removeNFRBucket(com.compuware.optimaltrace.tools.common.bizobjects.NFRBucketIfc nfrBucket)
Removes the NFR bucket.

Returns:
boolean

getAllActors

java.util.List getAllActors()
Gets all actors, return the ActorIfc's associated with this usecase.

Returns:
List of ActorIfc

setMinGuarantee

void setMinGuarantee(java.lang.String minimalGuarantee)
Leaving setMinimalGuarantee here for backward compatability reasons


setMinimalGuarantee

void setMinimalGuarantee(java.lang.String minimalGuarantee)
Sets the minimal guarantee.

Parameters:
minimalGuarantee - a String

getMinimalGuarantee

java.lang.String getMinimalGuarantee()
Gets the notes category

Returns:
String

getPreCondition

java.lang.String getPreCondition()
Gets the precondition.

Returns:
String

getPostCondition

java.lang.String getPostCondition()
Gets the postcondition.

Returns:
String

setPreCondition

void setPreCondition(java.lang.String cond)
Sets the precondition.

Parameters:
cond -

setPostCondition

void setPostCondition(java.lang.String cond)
Sets the postcondition.

Parameters:
cond -

moveAlternativeScenario

boolean moveAlternativeScenario(AlternativeScenarioIfc scenario,
                                java.lang.Integer numOfPlaces)
Moves the alternative scenario.

Parameters:
scenario -
numOfPlaces -
Returns:
boolean

getTag

java.lang.String getTag()
Returns the parent package tag.

Specified by:
getTag in interface AbstractRequirementIfc
Returns:
boolean

getPriority

java.lang.String getPriority()
Gets the use case priority

Returns:
String

setPriority

void setPriority(java.lang.String priority)
Sets the use case priority

Parameters:
priority -

OptimalTrace
5.2

Compuware Corporation

OptimalTrace is a trademark or registered trademark of Compuware Corporation in the US and other countries.
Copyright 2008-2009 Compuware Corporation. One Campus Martius,
Detroit, Michigan, 48226, U.S.A. All Rights Reserved.