OptimalTrace
5.2

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

All Superinterfaces:
AssociateIfc, BizObjectIfc, ChildIfc, CustomPropertyHolderIfc, CustomPropertyTemplatesMapHolderIfc, DynAttributeIfc, MergeObjectIfc, ParentIfc, PersistentIfc, PropertiesContainerIfc, RelationIfc, RepositionableChildIfc, TableHolderListContainerIfc

public interface UseCasePackageIfc
extends BizObjectIfc, CustomPropertyHolderIfc, RepositionableChildIfc, CustomPropertyTemplatesMapHolderIfc, TableHolderListContainerIfc

Interface UseCasePackageIfc


Field Summary
static java.lang.String ATTR_GRAPH_DISPLAY_OPTION
           
static java.lang.String ATTR_INHERIT_CP_TEMPLATE_MAP
           
static java.lang.String ATTR_LONG_DESCRIPTION
          Dynamic Attributes for UseCasePackageIfc
static java.lang.String ATTR_ORIGIN
           
static java.lang.String ATTR_PACKAGE_DISPLAY_OPTION
           
static java.lang.String ATTR_SHOW_CROSS_PACKAGE_LINKS
           
static java.lang.String ATTR_TAG
           
static java.lang.String SHOW_ALL
           
static java.lang.String SHOW_ALL_USE_CASES
           
static java.lang.String SHOW_CURRENT_PACKAGE_USE_CASES
           
static java.lang.String SHOW_MAIN_SUCCESS
           
static java.lang.String SHOW_NONE
           
static java.lang.String SHOW_SUB_PACKAGE_USE_CASES
           
 
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 addSimpleRequirement(SimpleRequirementIfc simpleRequirement)
          Adds the simple requirement.
 boolean addUseCase(AbstractRequirementIfc requirement)
          Adds the usecase.
 boolean addUseCasePackage(UseCasePackageIfc packageName)
          Adds the usecase package.
 void checkUseCaseNameUniqueInPackage(java.lang.String useCaseNumber)
          Checks for uniqueness of a Use Case Name on a package level
 void checkUseCaseNumberUniqueInPackageTag(java.lang.String useCaseNumber)
          Checks for uniqueness of a Use Case number in package tag.
 void checkUseCaseNumberUniqueInProject(java.lang.String useCaseNumber)
          Checks for uniqueness of a usecase name on a project level
 void checkUseCasePackageNameUniqueInPackage(java.lang.String name)
          Checks for uniqueness of a Use Case Name in package.
 void checkUseCasePackageNameUniqueInProject(java.lang.String name)
          Checks for uniqueness of a Use Case Name in project.
 java.util.List getAllPackages()
          Gets the list of Packages this package contains and all its subpackages
 java.util.List getAllRequirementsInPackages()
          Gets all requirements in packages.
 java.util.List getAllSimpleRequirementsInPackages()
          Gets all simple requirements in packages.
 java.util.List getAllUseCasePackages()
          Gets the list of UseCasePackages in all sub-packages
 java.util.List getAllUseCasesInPackages()
          Gets the list of usecase in all sub-packages.
 java.lang.String getFullyQualifiedName()
          Gets the fully qualified package name prepended by its package name hierarchy.
 java.lang.String getGraphDisplayOption()
          Gets the usecase package's graph display option.
 boolean getIsDisplayingCrossPackageLinks()
          Gets the attribute ATTR_SHOW_CROSS_PACKAGE_LINKS
 java.lang.String getLongDescription()
          Gets the value of LongDescription.
 java.awt.geom.Point2D.Double getOrigin()
          Gets the Point2D value of the usecase's origin
 java.lang.String getOriginAsString()
          Gets the Point2D value of the usecase's origin
 int getOriginX()
          Gets the origin X.
 int getOriginY()
          Gets the origin Y.
 java.lang.String getPackageDisplayOption()
          Gets the usecase package's package display option.
 java.util.List getPackages()
          Gets the list of Packages this package contains
 java.util.List getRequirements()
          Gets the requirements.
 SimpleRequirementIfc getSimpleRequirement(java.lang.String name)
          Gets the simple requirement.
 java.util.List getSimpleRequirements()
          Gets the simple requirements.
 java.lang.String getTag()
          Gets the tag.
 UseCaseIfc getUseCase(java.lang.String name)
          Gets the specific usecase.
 UseCasePackageIfc getUseCasePackage(java.lang.String name)
          Gets the UseCase package.
 java.util.List getUseCasePackages()
          Gets the list of usecase package's referencing this usecase package.
 java.util.List getUseCases()
          Gets the list of usecase held.
 boolean isUseCaseNumberUnique(AbstractRequirementIfc useCase)
          Checks the unique of UseCase number.
 boolean moveUseCase(AbstractRequirementIfc requirement, java.lang.Integer numOfPlaces)
          Moves the usecase.
 boolean moveUseCase(AbstractRequirementIfc childRequirement, UseCasePackageIfc newPackage)
          Moves the usecase.
 boolean moveUseCaseAtNoValidation(AbstractRequirementIfc childReq, UseCasePackageIfc newPackage, int position)
          Moves the usecase at position without validation.
 boolean moveUseCaseNoValidation(AbstractRequirementIfc childReq, UseCasePackageIfc newPackage)
          Moves the usecase without validation.
 boolean moveUseCasePackage(UseCasePackageIfc usecasePackage, java.lang.Integer numOfPlaces)
          Moves the usecase package.
 boolean moveUseCasePackage(UseCasePackageIfc childPackage, UseCasePackageIfc newPackage)
          Moves the usecase package to another package.
 boolean moveUseCasePackageAtNoValidation(UseCasePackageIfc childPackage, UseCasePackageIfc newPackage, int position)
          Moves the usecase package at the specific position without validation.
 boolean moveUseCasePackageNoValidation(UseCasePackageIfc childPackage, UseCasePackageIfc newPackage)
          Moves the usecase package without validation.
 void numberUseCase(AbstractRequirementIfc useCase)
          Sets the usecase's number within the package.
 boolean removeRequirement(AbstractRequirementIfc requirement)
          Removes the usecase.
 boolean removeSimpleRequirement(SimpleRequirementIfc simpleRequirement)
          Removes the simple requirement.
 boolean removeUseCasePackage(UseCasePackageIfc packageName)
          Removes the usecase package.
 void renumberAllUseCases()
          Renumbers all the usecases depending on their respective refined depth.
 boolean repositionRequirement(AbstractRequirementIfc childRequirement, int numberOfPlaces)
          Moves the usecase to a different position within its current package
 boolean repositionUseCasePackage(UseCasePackageIfc childPackage, int numberOfPlaces)
          Moves the usecase package to a different position within its current package.
 void setGraphDisplayOption(java.lang.String option)
          Sets the usecase package's graph display option.
 void setIsDisplayingCrossPackageLinks(boolean value)
          Sets the attribute ATTR_SHOW_CROSS_PACKAGE_LINKS
 void setLongDescription(java.lang.String description)
          Sets the value of LongDescription.
 void setOrigin(java.awt.geom.Point2D.Double point)
          Sets the Point2D value of the usecase's origin
 void setOrigin(java.lang.String origin)
          Sets the origin from a String.
 void setPackageDisplayOption(java.lang.String option)
          Sets the UseCasePackage's graph package option.
 void setTag(java.lang.String tag)
          Sets the tag.
 void updateName(java.lang.String name)
          Updates the package name ensuring that the name is unique and not reserved by another user if the project resides on the repository.
 
Methods inherited from interface com.compuware.optimaltrace.framework.customproperty.CustomPropertyHolderIfc
getCustomProperty, getCustomPropertyBucket, getCustomPropertyTemplates, removeCustomPropertyBucket, setCustomPropertyBucket
 
Methods inherited from interface com.compuware.optimaltrace.framework.business.RepositionableChildIfc
getPositionNumber
 
Methods inherited from interface com.compuware.optimaltrace.framework.customproperty.CustomPropertyTemplatesMapHolderIfc
getCustomPropertyTemplatesForType, getCustomPropertyTemplatesMap, getInheritCPTemplatesMap, removeCustomPropertyTemplatesMap, setCustomPropertyTemplatesMap, setInheritCPTemplatesMap
 
Methods inherited from interface com.compuware.optimaltrace.framework.ui.table.TableHolderListContainerIfc
getTableHolderList, setTableHolderList
 
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, setName, 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
 

Field Detail

ATTR_GRAPH_DISPLAY_OPTION

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

ATTR_PACKAGE_DISPLAY_OPTION

static final java.lang.String ATTR_PACKAGE_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

SHOW_ALL_USE_CASES

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

SHOW_SUB_PACKAGE_USE_CASES

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

SHOW_CURRENT_PACKAGE_USE_CASES

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

ATTR_ORIGIN

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

ATTR_SHOW_CROSS_PACKAGE_LINKS

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

ATTR_LONG_DESCRIPTION

static final java.lang.String ATTR_LONG_DESCRIPTION
Dynamic Attributes for UseCasePackageIfc

See Also:
Constant Field Values

ATTR_TAG

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

ATTR_INHERIT_CP_TEMPLATE_MAP

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

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 package 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

checkUseCaseNumberUniqueInProject

void checkUseCaseNumberUniqueInProject(java.lang.String useCaseNumber)
                                       throws com.compuware.optimaltrace.tools.common.bizobjects.NameNotUniqueException,
                                              com.compuware.optimaltrace.tools.common.tpn.client.NameAlreadyReservedException
Checks for uniqueness of a usecase name on a project level

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

checkUseCaseNameUniqueInPackage

void checkUseCaseNameUniqueInPackage(java.lang.String useCaseNumber)
                                     throws com.compuware.optimaltrace.tools.common.bizobjects.NameNotUniqueException,
                                            com.compuware.optimaltrace.tools.common.tpn.client.NameAlreadyReservedException
Checks for uniqueness of a Use Case Name on a package level

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

checkUseCasePackageNameUniqueInProject

void checkUseCasePackageNameUniqueInProject(java.lang.String name)
                                            throws com.compuware.optimaltrace.tools.common.bizobjects.NameNotUniqueException,
                                                   com.compuware.optimaltrace.tools.common.tpn.client.NameAlreadyReservedException
Checks for uniqueness of a Use Case Name in project.

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

checkUseCasePackageNameUniqueInPackage

void checkUseCasePackageNameUniqueInPackage(java.lang.String name)
                                            throws com.compuware.optimaltrace.tools.common.bizobjects.NameNotUniqueException,
                                                   com.compuware.optimaltrace.tools.common.tpn.client.NameAlreadyReservedException
Checks for uniqueness of a Use Case Name in package.

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

checkUseCaseNumberUniqueInPackageTag

void checkUseCaseNumberUniqueInPackageTag(java.lang.String useCaseNumber)
                                          throws com.compuware.optimaltrace.tools.common.bizobjects.NameNotUniqueException,
                                                 com.compuware.optimaltrace.tools.common.tpn.client.NameAlreadyReservedException
Checks for uniqueness of a Use Case number in package tag.

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

moveUseCaseNoValidation

boolean moveUseCaseNoValidation(AbstractRequirementIfc childReq,
                                UseCasePackageIfc newPackage)
                                throws com.compuware.optimaltrace.tools.common.bizobjects.NameNotUniqueException,
                                       com.compuware.optimaltrace.tools.common.tpn.client.NameAlreadyReservedException
Moves the usecase without validation.

Parameters:
childReq -
newPackage -
Returns:
boolean
Throws:
NameNotUniqueException
com.compuware.optimaltrace.tools.common.tpn.client.NameAlreadyReservedException

moveUseCaseAtNoValidation

boolean moveUseCaseAtNoValidation(AbstractRequirementIfc childReq,
                                  UseCasePackageIfc newPackage,
                                  int position)
                                  throws com.compuware.optimaltrace.tools.common.bizobjects.NameNotUniqueException,
                                         com.compuware.optimaltrace.tools.common.tpn.client.NameAlreadyReservedException
Moves the usecase at position without validation.

Parameters:
childReq -
newPackage -
position -
Returns:
boolean
Throws:
NameNotUniqueException
com.compuware.optimaltrace.tools.common.tpn.client.NameAlreadyReservedException

moveUseCasePackageNoValidation

boolean moveUseCasePackageNoValidation(UseCasePackageIfc childPackage,
                                       UseCasePackageIfc newPackage)
                                       throws com.compuware.optimaltrace.tools.common.bizobjects.NameNotUniqueException,
                                              com.compuware.optimaltrace.tools.common.tpn.client.NameAlreadyReservedException
Moves the usecase package without validation.

Parameters:
childPackage -
newPackage -
Returns:
boolean
Throws:
NameNotUniqueException
com.compuware.optimaltrace.tools.common.tpn.client.NameAlreadyReservedException

moveUseCasePackageAtNoValidation

boolean moveUseCasePackageAtNoValidation(UseCasePackageIfc childPackage,
                                         UseCasePackageIfc newPackage,
                                         int position)
                                         throws com.compuware.optimaltrace.tools.common.bizobjects.NameNotUniqueException,
                                                com.compuware.optimaltrace.tools.common.tpn.client.NameAlreadyReservedException
Moves the usecase package at the specific position without validation.

Parameters:
childPackage -
newPackage -
position -
Returns:
boolean
Throws:
NameNotUniqueException
com.compuware.optimaltrace.tools.common.tpn.client.NameAlreadyReservedException

renumberAllUseCases

void renumberAllUseCases()
Renumbers all the usecases depending on their respective refined depth.


numberUseCase

void numberUseCase(AbstractRequirementIfc useCase)
Sets the usecase's number within the package.

Parameters:
useCase -

getOrigin

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

Returns:
Point2D.Double

getOriginAsString

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

Returns:
String

setOrigin

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

Parameters:
point -

setOrigin

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

Parameters:
origin -

getOriginX

int getOriginX()
Gets the origin X.

Returns:
int

getOriginY

int getOriginY()
Gets the origin Y.

Returns:
int

getGraphDisplayOption

java.lang.String getGraphDisplayOption()
Gets the usecase package'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 package's graph display option. Can be one of: SHOW_ALL SHOW_NONE SHOW_MAIN_SUCCESS

Parameters:
option -

getPackageDisplayOption

java.lang.String getPackageDisplayOption()
Gets the usecase package's package display option. Can be one of: SHOW_ALL_USE_CASES SHOW_SUB_PACKAGE_USE_CASES SHOW_CURRENT_PACKAGE_USE_CASES

Returns:
String

setIsDisplayingCrossPackageLinks

void setIsDisplayingCrossPackageLinks(boolean value)
Sets the attribute ATTR_SHOW_CROSS_PACKAGE_LINKS

Parameters:
value -

getIsDisplayingCrossPackageLinks

boolean getIsDisplayingCrossPackageLinks()
Gets the attribute ATTR_SHOW_CROSS_PACKAGE_LINKS

Returns:
boolean

setPackageDisplayOption

void setPackageDisplayOption(java.lang.String option)
Sets the UseCasePackage's graph package option. Can be one of: SHOW_ALL_USE_CASES SHOW_SUB_PACKAGE_USE_CASES SHOW_CURRENT_PACKAGE_USE_CASES

Parameters:
option -

getUseCases

java.util.List getUseCases()
Gets the list of usecase held.

Returns:
List of UseCaseInf

getAllUseCasesInPackages

java.util.List getAllUseCasesInPackages()
Gets the list of usecase in all sub-packages.

Returns:
List of UseCaseIfc

getUseCase

UseCaseIfc getUseCase(java.lang.String name)
Gets the specific usecase.

Parameters:
name -
Returns:
UseCaseIfc

getUseCasePackage

UseCasePackageIfc getUseCasePackage(java.lang.String name)
Gets the UseCase package.

Parameters:
name -
Returns:
UseCasePackageIfc

getSimpleRequirement

SimpleRequirementIfc getSimpleRequirement(java.lang.String name)
Gets the simple requirement.

Parameters:
name -
Returns:
SimpleRequirementIfc

addUseCase

boolean addUseCase(AbstractRequirementIfc requirement)
                   throws com.compuware.optimaltrace.tools.common.bizobjects.NameNotUniqueException,
                          com.compuware.optimaltrace.tools.common.tpn.client.NameAlreadyReservedException
Adds the usecase.

Parameters:
requirement -
Returns:
boolean
Throws:
NameNotUniqueException
com.compuware.optimaltrace.tools.common.tpn.client.NameAlreadyReservedException

removeRequirement

boolean removeRequirement(AbstractRequirementIfc requirement)
Removes the usecase.

Parameters:
requirement -
Returns:
boolean

moveUseCase

boolean moveUseCase(AbstractRequirementIfc childRequirement,
                    UseCasePackageIfc newPackage)
                    throws com.compuware.optimaltrace.tools.common.bizobjects.NameNotUniqueException,
                           com.compuware.optimaltrace.tools.common.tpn.client.NameAlreadyReservedException
Moves the usecase.

Parameters:
childRequirement -
newPackage -
Returns:
boolean
Throws:
NameNotUniqueException
com.compuware.optimaltrace.tools.common.tpn.client.NameAlreadyReservedException

repositionRequirement

boolean repositionRequirement(AbstractRequirementIfc childRequirement,
                              int numberOfPlaces)
Moves the usecase to a different position within its current package

Parameters:
childRequirement -
numberOfPlaces -
Returns:
boolean

repositionUseCasePackage

boolean repositionUseCasePackage(UseCasePackageIfc childPackage,
                                 int numberOfPlaces)
Moves the usecase package to a different position within its current package.

Parameters:
childPackage -
numberOfPlaces -
Returns:
boolean

addUseCasePackage

boolean addUseCasePackage(UseCasePackageIfc packageName)
                          throws com.compuware.optimaltrace.tools.common.bizobjects.NameNotUniqueException,
                                 com.compuware.optimaltrace.tools.common.tpn.client.NameAlreadyReservedException
Adds the usecase package. Allows Packages to contain other packages.

Parameters:
packageName -
Returns:
boolean
Throws:
NameNotUniqueException
com.compuware.optimaltrace.tools.common.tpn.client.NameAlreadyReservedException

getAllUseCasePackages

java.util.List getAllUseCasePackages()
Gets the list of UseCasePackages in all sub-packages

Returns:
List of UseCasePackageIfc

removeUseCasePackage

boolean removeUseCasePackage(UseCasePackageIfc packageName)
Removes the usecase package. The package being removed must be empty.

Parameters:
packageName -
Returns:
boolean - if the package was successfully deleted or not

moveUseCasePackage

boolean moveUseCasePackage(UseCasePackageIfc childPackage,
                           UseCasePackageIfc newPackage)
                           throws com.compuware.optimaltrace.tools.common.bizobjects.NameNotUniqueException,
                                  com.compuware.optimaltrace.tools.common.tpn.client.NameAlreadyReservedException
Moves the usecase package to another package.

Parameters:
childPackage -
newPackage -
Returns:
boolean
Throws:
NameNotUniqueException
com.compuware.optimaltrace.tools.common.tpn.client.NameAlreadyReservedException

getPackages

java.util.List getPackages()
Gets the list of Packages this package contains

Returns:
List of UseCasePackageIfc

getAllPackages

java.util.List getAllPackages()
Gets the list of Packages this package contains and all its subpackages

Returns:
List of UseCasePackageIfc

getLongDescription

java.lang.String getLongDescription()
Gets the value of LongDescription.

Returns:
value of LongDescription.

setLongDescription

void setLongDescription(java.lang.String description)
Sets the value of LongDescription.

Parameters:
description -

getUseCasePackages

java.util.List getUseCasePackages()
Gets the list of usecase package's referencing this usecase package.

Returns:
List

moveUseCase

boolean moveUseCase(AbstractRequirementIfc requirement,
                    java.lang.Integer numOfPlaces)
Moves the usecase.

Parameters:
requirement -
numOfPlaces -
Returns:
boolean

moveUseCasePackage

boolean moveUseCasePackage(UseCasePackageIfc usecasePackage,
                           java.lang.Integer numOfPlaces)
Moves the usecase package.

Parameters:
usecasePackage -
numOfPlaces -
Returns:
boolean

setTag

void setTag(java.lang.String tag)
Sets the tag.

Parameters:
tag -

getTag

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

Returns:
String

isUseCaseNumberUnique

boolean isUseCaseNumberUnique(AbstractRequirementIfc useCase)
Checks the unique of UseCase number.

Parameters:
useCase -
Returns:
boolean

getFullyQualifiedName

java.lang.String getFullyQualifiedName()
Gets the fully qualified package name prepended by its package name hierarchy.

Returns:
String

addSimpleRequirement

boolean addSimpleRequirement(SimpleRequirementIfc simpleRequirement)
                             throws com.compuware.optimaltrace.tools.common.bizobjects.NameNotUniqueException,
                                    com.compuware.optimaltrace.tools.common.tpn.client.NameAlreadyReservedException
Adds the simple requirement.

Parameters:
simpleRequirement -
Returns:
boolean
Throws:
NameNotUniqueException
com.compuware.optimaltrace.tools.common.tpn.client.NameAlreadyReservedException

removeSimpleRequirement

boolean removeSimpleRequirement(SimpleRequirementIfc simpleRequirement)
Removes the simple requirement.

Parameters:
simpleRequirement -
Returns:
boolean

getSimpleRequirements

java.util.List getSimpleRequirements()
Gets the simple requirements.

Returns:
List

getRequirements

java.util.List getRequirements()
Gets the requirements.

Returns:
List

getAllRequirementsInPackages

java.util.List getAllRequirementsInPackages()
Gets all requirements in packages.

Returns:
List

getAllSimpleRequirementsInPackages

java.util.List getAllSimpleRequirementsInPackages()
Gets all simple requirements in packages.

Returns:
List

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.