OptimalTrace
5.2

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

All Superinterfaces:
AssociateIfc, BizObjectIfc, ChildIfc, CustomPropertyDocgenContainerIfc, DynAttributeIfc, MergeObjectIfc, ParentIfc, PersistentIfc, PropertiesContainerIfc, RelationIfc
All Known Subinterfaces:
AlternativeScenarioIfc, ItemListIfc, MainSuccessScenarioIfc

public interface ScenarioIfc
extends BizObjectIfc, CustomPropertyDocgenContainerIfc

Interface ScenarioIfc

Author:
Damian Beresford

Field Summary
 
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 addStep(AbstractStepIfc step)
          Adds the new Step
 boolean addStepAt(AbstractStepIfc step, int index)
          Adds the new Step at the specified position
 void checkStepNameUnique(AbstractStepIfc step, java.lang.String name)
          Checks for uniqueness of step name, ensuring that you're not checking the current step being edited.
 void checkStepNameUniqueForFactory(java.lang.String name)
          Checks for uniqueness of step name, for use by factory classes when you want to add a new step.
 java.util.List getAbstractSteps()
          Gets the list of steps associated with this scenario
 AbstractStepIfc getStep(int stepNumber)
          Gets the step that has the specified step number
 java.util.List getStepRefinements()
          Gets the list of refinements in the Steps associated with this scenario
 boolean moveStep(AbstractStepIfc step, java.lang.Integer numOfPlacesToMove)
          Moves the step a number of places..
 boolean moveStep(AbstractStepIfc step, ScenarioIfc newScenario)
          Moves the step scenario.
 boolean moveStepDown(AbstractStepIfc step)
          Moves the Step down 1 place
 boolean moveStepUp(AbstractStepIfc step)
          Moves the Step up 1 place
 boolean removeStep(AbstractStepIfc step)
          Removes the Step
 void updateName(java.lang.String name)
          Updates the scenario 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
 

Method Detail

getAbstractSteps

java.util.List getAbstractSteps()
Gets the list of steps associated with this scenario

Returns:
List of StepIfc

getStepRefinements

java.util.List getStepRefinements()
Gets the list of refinements in the Steps associated with this scenario

Returns:
List

getStep

AbstractStepIfc getStep(int stepNumber)
Gets the step that has the specified step number

Parameters:
stepNumber -
Returns:
AbstractStepIfc of StepIfc

addStep

boolean addStep(AbstractStepIfc step)
Adds the new Step

Parameters:
step -
Returns:
boolean

addStepAt

boolean addStepAt(AbstractStepIfc step,
                  int index)
Adds the new Step at the specified position

Parameters:
step -
index - position in which to insert the step.
Returns:
boolean

checkStepNameUnique

void checkStepNameUnique(AbstractStepIfc step,
                         java.lang.String name)
                         throws com.compuware.optimaltrace.tools.common.bizobjects.NameNotUniqueException
Checks for uniqueness of step name, ensuring that you're not checking the current step being edited.

Parameters:
step -
name -
Throws:
NameNotUniqueException

checkStepNameUniqueForFactory

void checkStepNameUniqueForFactory(java.lang.String name)
                                   throws com.compuware.optimaltrace.tools.common.bizobjects.NameNotUniqueException
Checks for uniqueness of step name, for use by factory classes when you want to add a new step.

Parameters:
name -
Throws:
NameNotUniqueException

updateName

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

Parameters:
name -
Throws:
NameNotUniqueException

removeStep

boolean removeStep(AbstractStepIfc step)
Removes the Step

Parameters:
step -
Returns:
boolean

moveStepUp

boolean moveStepUp(AbstractStepIfc step)
Moves the Step up 1 place

Parameters:
step -
Returns:
boolean

moveStepDown

boolean moveStepDown(AbstractStepIfc step)
Moves the Step down 1 place

Parameters:
step -
Returns:
boolean

moveStep

boolean moveStep(AbstractStepIfc step,
                 java.lang.Integer numOfPlacesToMove)
Moves the step a number of places..

Parameters:
step - a StepIfc value
numOfPlacesToMove - an int value
Returns:
boolean

moveStep

boolean moveStep(AbstractStepIfc step,
                 ScenarioIfc newScenario)
Moves the step scenario.

Parameters:
step - a StepIfc value
newScenario -
Returns:
boolean

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.