OptimalTrace
5.2

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

All Superinterfaces:
AssociateIfc, BizObjectIfc, ChildIfc, CustomPropertyHolderIfc, DynAttributeIfc, LinkHolderIfc, MergeObjectIfc, ParentIfc, PersistentIfc, PropertiesContainerIfc, RelationIfc, RepositionableChildIfc
All Known Subinterfaces:
ItemIfc, StepIfc
All Known Implementing Classes:
com.compuware.optimaltrace.tools.common.bizobjects.AbstractStep, Step

public interface AbstractStepIfc
extends BizObjectIfc, RepositionableChildIfc, CustomPropertyHolderIfc, LinkHolderIfc

Interface AbstractStepIfc

Author:
Damian Beresford

Field Summary
static java.lang.String ATTR_DESCRIPTION
           
 
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 addBranch(com.compuware.optimaltrace.tools.common.bizobjects.BranchIfc branch)
          Adds the branch.
 boolean addRefinement(RefinementIfc refinement)
          Adds the refinement.
 void checkBranchNameUnique(java.lang.String name)
          Checks if a branch name is unique within a step
 void checkRefinementNameUnique(java.lang.String name)
          Checks if a refinement name is unique within a step
 java.lang.String getAbstractStepReadableTypeName()
          Gets the abstract step readable type name.
 java.util.List getBranches()
          Gets the branches associated with this step.
 java.lang.String getBranchesAsString(java.lang.String separator)
          Gets the branches associated with this step as a string.
 java.lang.String getDescription()
          Gets the description.
 java.util.List getExternalLinks()
          Gets the external links.
 AbstractRequirementIfc getParentUseCase()
          Gets the parent usecase
 java.util.List getRefinements()
          Gets the list of refinements for this Step.
 java.lang.String getRefinementsAsString(java.lang.String separator)
          Gets the refinements associated with this step as a string.
 boolean isAlreadyBranched(BizObjectIfc bizObject)
          Checks if there already exists a branch to this business object in a step.
 boolean isAlreadyRefinedToUseCase(AbstractRequirementIfc useCase)
          Checks if there already exists a refine to use case.
 boolean isCircularBranch(com.compuware.optimaltrace.tools.common.bizobjects.BranchIfc branch)
          Checks for a circular branch as specified in the requirements doc.
 boolean isCircularRefinement(RefinementIfc refinement)
          Checks for a circular refinement as specified in the requirements doc.
 boolean isRefiningToSelf(AbstractRequirementIfc useCase)
          Checks if a refinement is being made to the use case that contains this step.
 boolean moveBranch(com.compuware.optimaltrace.tools.common.bizobjects.BranchIfc branch, AbstractStepIfc newStep)
          Moves the branch
 boolean moveRefinement(RefinementIfc refinement, AbstractStepIfc newStep)
          Moves the refinement.
 boolean removeBranch(com.compuware.optimaltrace.tools.common.bizobjects.BranchIfc branch)
          Removes the branch.
 boolean removeRefinement(RefinementIfc refinement)
          Removes the refinement
 void setDescription(java.lang.String description)
          Sets the description.
 void updateName(java.lang.String name)
          Updates the step 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.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
 
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.LinkHolderIfc
getLinkBucket, setLinkBucket
 

Field Detail

ATTR_DESCRIPTION

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

getAbstractStepReadableTypeName

java.lang.String getAbstractStepReadableTypeName()
Gets the abstract step readable type name.

Returns:
String

getParentUseCase

AbstractRequirementIfc getParentUseCase()
Gets the parent usecase

Returns:
AbstractRequirementIfc

addRefinement

boolean addRefinement(RefinementIfc refinement)
Adds the refinement.

Parameters:
refinement -
Returns:
boolean

removeRefinement

boolean removeRefinement(RefinementIfc refinement)
Removes the refinement

Parameters:
refinement -
Returns:
boolean

getRefinements

java.util.List getRefinements()
Gets the list of refinements for this Step.

Returns:
List of RefinementIfc

addBranch

boolean addBranch(com.compuware.optimaltrace.tools.common.bizobjects.BranchIfc branch)
Adds the branch.

Parameters:
branch - an ScenarioIfc value to be added.
Returns:
a boolean value

removeBranch

boolean removeBranch(com.compuware.optimaltrace.tools.common.bizobjects.BranchIfc branch)
Removes the branch.

Parameters:
branch - an ScenarioIfc value to be removed.
Returns:
a boolean value

moveBranch

boolean moveBranch(com.compuware.optimaltrace.tools.common.bizobjects.BranchIfc branch,
                   AbstractStepIfc newStep)
Moves the branch

Parameters:
branch - an ScenarioIfc value to be removed.
newStep -
Returns:
boolean

moveRefinement

boolean moveRefinement(RefinementIfc refinement,
                       AbstractStepIfc newStep)
Moves the refinement.

Parameters:
refinement -
newStep -
Returns:
boolean

getBranches

java.util.List getBranches()
Gets the branches associated with this step.

Returns:
List of the Step branches.

getBranchesAsString

java.lang.String getBranchesAsString(java.lang.String separator)
Gets the branches associated with this step as a string. A separator is inserted between each two branches.

Parameters:
separator - string acting as a separator between each two branches
Returns:
a String representing the Step branches.

getRefinementsAsString

java.lang.String getRefinementsAsString(java.lang.String separator)
Gets the refinements associated with this step as a string. A separator is inserted between each two branches.

Parameters:
separator - string acting as a separator between each two branches
Returns:
a String representing the Step branches.

checkRefinementNameUnique

void checkRefinementNameUnique(java.lang.String name)
                               throws com.compuware.optimaltrace.tools.common.bizobjects.NameNotUniqueException
Checks if a refinement name is unique within a step

Parameters:
name - the name
Throws:
NameNotUniqueException

checkBranchNameUnique

void checkBranchNameUnique(java.lang.String name)
                           throws com.compuware.optimaltrace.tools.common.bizobjects.NameNotUniqueException
Checks if a branch name is unique within a step

Parameters:
name - the name
Throws:
NameNotUniqueException

updateName

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

Parameters:
name -
Throws:
NameNotUniqueException

isCircularRefinement

boolean isCircularRefinement(RefinementIfc refinement)
Checks for a circular refinement as specified in the requirements doc. Namely, "A 'refined from' step; s1, contained in p-use case; pu1, cannot refine, either directly or via navigation, to a p-use case; pu2 that is a direct ancestor of pu1. This rule is known as 'no circular refinements'.

Parameters:
refinement - RefinementIfc
Returns:
boolean

isCircularBranch

boolean isCircularBranch(com.compuware.optimaltrace.tools.common.bizobjects.BranchIfc branch)
Checks for a circular branch as specified in the requirements doc.

Parameters:
branch -
Returns:
boolean

isRefiningToSelf

boolean isRefiningToSelf(AbstractRequirementIfc useCase)
Checks if a refinement is being made to the use case that contains this step.

Parameters:
useCase - UseCaseIfc
Returns:
boolean

isAlreadyBranched

boolean isAlreadyBranched(BizObjectIfc bizObject)
Checks if there already exists a branch to this business object in a step.

Parameters:
bizObject - BizObjectIfc
Returns:
boolean

isAlreadyRefinedToUseCase

boolean isAlreadyRefinedToUseCase(AbstractRequirementIfc useCase)
Checks if there already exists a refine to use case.

Parameters:
useCase -
Returns:
boolean

getExternalLinks

java.util.List getExternalLinks()
Gets the external links.

Returns:
List

getDescription

java.lang.String getDescription()
Gets the description.

Returns:
String

setDescription

void setDescription(java.lang.String description)
Sets the description.

Parameters:
description -

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.