OptimalTrace
5.2

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

All Superinterfaces:
AssociateIfc, BizObjectIfc, ChildIfc, CustomPropertyHolderIfc, DynAttributeIfc, LinkHolderIfc, MergeObjectIfc, NoteHolderIfc, ParentIfc, PersistentIfc, PropertiesContainerIfc, RelationIfc, RepositionableChildIfc
All Known Subinterfaces:
SimpleRequirementIfc, UseCaseIfc

public interface AbstractRequirementIfc
extends BizObjectIfc, NoteHolderIfc, LinkHolderIfc, RepositionableChildIfc, CustomPropertyHolderIfc

Interface AbstractRequirementIfc


Field Summary
static java.lang.String ATTR_BUSINESS_DESC
           
static java.lang.String ATTR_GRAPH_DISPLAY_OPTION
           
static java.lang.String ATTR_ORIGIN
           
static java.lang.String ATTR_USECASE_NUMER
          Dynamic Attributes for UseCaseIfc
static java.lang.String SHOW_ALL
           
static java.lang.String SHOW_MAIN_SUCCESS
           
static java.lang.String 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 addExternalLink(com.compuware.optimaltrace.tools.common.bizobjects.ExternalLinkIfc link)
          Deprecated. Please use getLinkBucket to obtain the project's LinkBucket
 java.util.List getAllAbstractSteps()
          Gets all the Steps in all the scenarios for this usecase.
 java.util.List getBranches()
          Gets the list of Branches pointing to this usecase.
 java.util.List getBranchesToUseCases()
          Returns a list of Branches from Steps in this usecase that branch to other usecases.
 java.lang.String getBusinessDescription()
          Gets the business description.
 java.lang.String getDisplayName()
          Gets the value of this usecase's display name.
 java.util.List getExtendsUseCases()
          Returns a List of usecases that are extended from this usecase.
 java.util.List getExternalLinks()
          Deprecated. Please use getLinkBucket to obtain the project's LinkBucket
 java.lang.String getFullyQualifiedName()
          Gets the fully qualified name of this usecase, i.e.
 java.lang.String getGraphDisplayOption()
          Returns the usecase's graph display option.
 java.util.List getIncludesUseCases()
          Gets the included usecases.
 int getNameLength()
          Gets the name length.
 java.awt.geom.Point2D.Double getOrigin()
          Gets the Point2D value of this usecase's origin
 java.lang.String getOriginAsString()
          Gets the Point2D value of this usecase's origin
 int getOriginX()
          Gets the origin X.
 int getOriginY()
          Gets the origin Y.
 java.util.List getRefinements()
          Gets the refinement if there is one.
 java.util.List getRefinementUseCases()
          Gets the refinement usecases.
 java.util.List getScenarios()
          Gets the scenarios.
 java.lang.String getTag()
          Gets the tag.
 java.lang.String getUseCaseNumber()
          Gets the number associated with this usecase.
 UseCasePackageIfc getUseCasePackage()
          Gets the use case package that this usecase belongs to
 boolean isLeafUseCase()
          A leaf use case is a use case that has no more refinements.
 boolean isRootUseCase()
          A root use case is a top level use case that is not refined from any other use case
 boolean removeExternalLink(com.compuware.optimaltrace.tools.common.bizobjects.ExternalLinkIfc link)
          Deprecated. Please use getLinkBucket to obtain the project's LinkBucket
 boolean removeLinkBucket(com.compuware.optimaltrace.tools.common.bizobjects.LinkBucketIfc linkBucket)
          Removes the link bucket.
 void setBusinessDescription(java.lang.String desc)
          Sets the business description.
 void setGraphDisplayOption(java.lang.String option)
          Sets the usecase's graph display option.
 void setName(java.lang.String name)
          Sets the name.
 void setOrigin(java.awt.geom.Point2D.Double point)
          Sets the Point2D value of this usecase's origin
 void setOrigin(java.lang.String origin)
          Sets the origin from a String, which should be in the format: "x.x,y.y".
 void setUseCaseNumber(java.lang.String number)
          Sets the number associated with this usecase.
 void updateName(java.lang.String name)
          Updates the usecase name ensuring that the name is unique and not reserved by another user if the project resides on the repository.
 void updateNumber(java.lang.String number)
          Updates the usecase number ensuring that the number is unique and not reserved by another user if the project resides on the repository.
 
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
 

Field Detail

ATTR_USECASE_NUMER

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

See Also:
Constant Field Values

ATTR_ORIGIN

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

ATTR_GRAPH_DISPLAY_OPTION

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

SHOW_ALL

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

SHOW_NONE

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

SHOW_MAIN_SUCCESS

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

ATTR_BUSINESS_DESC

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

setName

void setName(java.lang.String name)
Sets the name.

Specified by:
setName in interface BizObjectIfc
Parameters:
name -

updateName

void updateName(java.lang.String name)
                throws com.compuware.optimaltrace.tools.common.bizobjects.NameNotUniqueException,
                       com.compuware.optimaltrace.tools.common.tpn.client.NameAlreadyReservedException
Updates the usecase name ensuring that the name is unique and not reserved by another user if the project resides on the repository.

Parameters:
name -
Throws:
NameNotUniqueException
com.compuware.optimaltrace.tools.common.tpn.client.NameAlreadyReservedException

updateNumber

void updateNumber(java.lang.String number)
                  throws com.compuware.optimaltrace.tools.common.bizobjects.NameNotUniqueException,
                         com.compuware.optimaltrace.tools.common.tpn.client.NameAlreadyReservedException
Updates the usecase number ensuring that the number is unique and not reserved by another user if the project resides on the repository.

Parameters:
number -
Throws:
NameNotUniqueException
com.compuware.optimaltrace.tools.common.tpn.client.NameAlreadyReservedException

getUseCasePackage

UseCasePackageIfc getUseCasePackage()
Gets the use case package that this usecase belongs to

Returns:
UseCasePackageIfc

getOrigin

java.awt.geom.Point2D.Double getOrigin()
Gets the Point2D value of this usecase's origin

Returns:
Point2D.Double

getOriginAsString

java.lang.String getOriginAsString()
Gets the Point2D value of this usecase's origin

Returns:
String

setOrigin

void setOrigin(java.awt.geom.Point2D.Double point)
Sets the Point2D value of this usecase's origin

Parameters:
point -

setOrigin

void setOrigin(java.lang.String origin)
Sets the origin from a String, which should be in the format: "x.x,y.y".

Parameters:
origin -

getDisplayName

java.lang.String getDisplayName()
Gets the value of this usecase's display name.

Returns:
String

getUseCaseNumber

java.lang.String getUseCaseNumber()
Gets the number associated with this usecase. This number is set from the UseCasePackageIfc only. The number is a String, i.e. '1.2.4' or 'UC 1.2' or whatever.

Returns:
String

setUseCaseNumber

void setUseCaseNumber(java.lang.String number)
Sets the number associated with this usecase.

Parameters:
number -

getGraphDisplayOption

java.lang.String getGraphDisplayOption()
Returns the usecase's graph display option. Can be one of: SHOW_ALL SHOW_NONE SHOW_MAIN_SUCCESS

Returns:
String

setGraphDisplayOption

void setGraphDisplayOption(java.lang.String option)
Sets the usecase's graph display option. Can be one of: SHOW_ALL SHOW_NONE SHOW_MAIN_SUCCESS

Parameters:
option -

getNameLength

int getNameLength()
Gets the name length.

Returns:
int

getOriginX

int getOriginX()
Gets the origin X.

Returns:
int

getOriginY

int getOriginY()
Gets the origin Y.

Returns:
int

addExternalLink

boolean addExternalLink(com.compuware.optimaltrace.tools.common.bizobjects.ExternalLinkIfc link)
Deprecated. Please use getLinkBucket to obtain the project's LinkBucket

Adds an external link

Parameters:
link -
Returns:
boolean

removeExternalLink

boolean removeExternalLink(com.compuware.optimaltrace.tools.common.bizobjects.ExternalLinkIfc link)
Deprecated. Please use getLinkBucket to obtain the project's LinkBucket

Removes the external link

Parameters:
link -
Returns:
boolean

getExternalLinks

java.util.List getExternalLinks()
Deprecated. Please use getLinkBucket to obtain the project's LinkBucket

Gets the list of external links..

Returns:
List

isRootUseCase

boolean isRootUseCase()
A root use case is a top level use case that is not refined from any other use case

Returns:
boolean

isLeafUseCase

boolean isLeafUseCase()
A leaf use case is a use case that has no more refinements.

Returns:
boolean

getRefinements

java.util.List getRefinements()
Gets the refinement if there is one.

Returns:
List

getFullyQualifiedName

java.lang.String getFullyQualifiedName()
Gets the fully qualified name of this usecase, i.e. considering all its parent packages.

Returns:
String

removeLinkBucket

boolean removeLinkBucket(com.compuware.optimaltrace.tools.common.bizobjects.LinkBucketIfc linkBucket)
Removes the link bucket.

Returns:
boolean

getBranches

java.util.List getBranches()
Gets the list of Branches pointing to this usecase.

Returns:
List

getIncludesUseCases

java.util.List getIncludesUseCases()
Gets the included usecases.

Returns:
List

getExtendsUseCases

java.util.List getExtendsUseCases()
Returns a List of usecases that are extended from this usecase.

Returns:
List

getRefinementUseCases

java.util.List getRefinementUseCases()
Gets the refinement usecases.

Returns:
List

getBranchesToUseCases

java.util.List getBranchesToUseCases()
Returns a list of Branches from Steps in this usecase that branch to other usecases.

Returns:
List

getScenarios

java.util.List getScenarios()
Gets the scenarios.

Returns:
List

getTag

java.lang.String getTag()
Gets the tag.

Returns:
String

getAllAbstractSteps

java.util.List getAllAbstractSteps()
Gets all the Steps in all the scenarios for this usecase.

Returns:
List

getBusinessDescription

java.lang.String getBusinessDescription()
Gets the business description.

Returns:
String

setBusinessDescription

void setBusinessDescription(java.lang.String desc)
Sets the business description.

Parameters:
desc -

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.