OptimalTrace
5.2

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

All Superinterfaces:
AssociateIfc, BizObjectIfc, ChildIfc, com.compuware.optimaltrace.tools.common.bizobjectslocal.ClearableSuspectLinkIfc, DynAttributeIfc, MergeObjectIfc, ParentIfc, PersistentIfc, PropertiesContainerIfc, RelationIfc

public interface RefinementIfc
extends BizObjectIfc, com.compuware.optimaltrace.tools.common.bizobjectslocal.ClearableSuspectLinkIfc

Interface RefinementIfc

Author:
Damian Beresford

Field Summary
static java.lang.String ATTR_FIRST_CIRCULAR
          Dynamic Attributes for Refinement
static java.lang.String ATTR_JUSTIFICIATION
           
 
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
 java.lang.String getJustification()
          Gets the justification for this refinement
 AbstractStepIfc getRefinedFromStep()
          Gets the Step that this is refined from
 AbstractRequirementIfc getRefinedToUseCase()
          Gets the usecase that this refines to
 boolean isCircularRefinement()
          Checks for a circular refinement as specified in the Requirements doc.
 boolean isFirstCircular()
          Gets the first circular property for this fefinement
 boolean isRefiningToSelf()
          Checks if a refinement is being made to the use case that contains the refined step.
 boolean removeRefineToUseCase(AbstractRequirementIfc useCase)
          Removes the refine to usecase.
 void setFirstCircular(boolean firstCircular)
          Sets the first circular property for this fefinement
 void setJustification(java.lang.String justification)
          Sets the justification for this fefinement
 boolean setRefineToUseCase(AbstractRequirementIfc useCase)
          Sets the refine to usecase.
 void updateName(java.lang.String name)
          Updates the refinement 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.tools.common.bizobjectslocal.ClearableSuspectLinkIfc
clearSuspectLink
 
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_FIRST_CIRCULAR

static final java.lang.String ATTR_FIRST_CIRCULAR
Dynamic Attributes for Refinement

See Also:
Constant Field Values

ATTR_JUSTIFICIATION

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

getRefinedFromStep

AbstractStepIfc getRefinedFromStep()
Gets the Step that this is refined from

Returns:
StepIfc

getRefinedToUseCase

AbstractRequirementIfc getRefinedToUseCase()
Gets the usecase that this refines to

Returns:
AbstractRequirementIfc

setRefineToUseCase

boolean setRefineToUseCase(AbstractRequirementIfc useCase)
                           throws com.compuware.optimaltrace.tools.common.bizobjects.InvalidRefinementException
Sets the refine to usecase.

Parameters:
useCase -
Returns:
boolean
Throws:
InvalidRefinementException

removeRefineToUseCase

boolean removeRefineToUseCase(AbstractRequirementIfc useCase)
Removes the refine to usecase.

Parameters:
useCase -
Returns:
boolean

updateName

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

Parameters:
name -
Throws:
NameNotUniqueException

getJustification

java.lang.String getJustification()
Gets the justification for this refinement

Returns:
String

setJustification

void setJustification(java.lang.String justification)
Sets the justification for this fefinement

Parameters:
justification -

isFirstCircular

boolean isFirstCircular()
Gets the first circular property for this fefinement

Returns:
boolean true if this refinement is the first in a cycle in the graph

setFirstCircular

void setFirstCircular(boolean firstCircular)
Sets the first circular property for this fefinement

Parameters:
firstCircular - indicates if this is the first refinement in the cycle

isRefiningToSelf

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

Returns:
boolean

isCircularRefinement

boolean isCircularRefinement()
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'.

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.