OptimalTrace
5.2

com.compuware.optimaltrace.framework.business
Interface BizObjectIfc

All Superinterfaces:
AssociateIfc, ChildIfc, DynAttributeIfc, MergeObjectIfc, ParentIfc, PersistentIfc, PropertiesContainerIfc, RelationIfc
All Known Subinterfaces:
AbstractRequirementIfc, AbstractStepIfc, AlternativeScenarioIfc, com.compuware.optimaltrace.tools.common.bizobjectslocal.ClearableSuspectLinkIfc, CustomPropertyTemplateIfc, CustomPropertyTemplateListIfc, GoalLevelIfc, GoalLevelsIfc, ItemIfc, ItemListIfc, MainSuccessScenarioIfc, ProjectIfc, RefinementIfc, ScenarioIfc, SimpleRequirementIfc, StepIfc, TableHolderListContainerIfc, ToolSettingsIfc, UseCaseIfc, UseCasePackageIfc
All Known Implementing Classes:
com.compuware.optimaltrace.framework.business.AbstractBizObject, com.compuware.optimaltrace.tools.common.bizobjects.AbstractStep, ProjectContainer, Step

public interface BizObjectIfc
extends ParentIfc, ChildIfc, AssociateIfc, PersistentIfc, PropertiesContainerIfc, DynAttributeIfc, MergeObjectIfc

Interface BizObjectIfc


Field Summary
static java.lang.String ATTR_IS_LOCKED
           
static java.lang.String ATTR_IS_LOCKEDLOCALLY
           
static java.lang.String ATTR_IS_READONLY
           
static java.lang.String ATTR_LOCKOWNER
           
static java.lang.String ATTR_NAME
          Dynamic Attributes for BizObjectIfc
static java.lang.String BO_DB_TIMESTAMP
           
static java.lang.String BO_ID
          Some well used String constants, put here for convience
static java.lang.String BO_ST
           
static java.lang.String BO_TIMESTAMP
           
static java.lang.String 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
 void cloneObjectsAttributes(BizObjectIfc bizObject)
          Clones the objects attributes to this object.
 void disableMergeObjectSupport()
          Disables the merge objects support.
 void enableMergeObjectSupport()
          Enables the merge objects support.
 boolean equals(BizObjectIfc bizObject)
          Checks if this object has the same id as the biz object that its being compared to.
 long getBaselineId()
          Gets the baseline id.
 long getBizObjectId()
          Gets the biz object id.
 BizObjectIfc getFirstChild()
          Gets the first child.
 long getId()
          Gets the unique if of the implementing class..
 java.lang.String getLockOwner()
          Gets the lock owner.
 java.lang.String getName()
          Gets the name property.
 BizObjectIfc getNextChild()
          Gets the next child.
 java.lang.String getReadableName()
          Gets the readable name.
 long getTimeStamp()
          Gets the biz object time stamp.
 java.lang.String getTypeId()
          Gets the type id of the implementing class..
 boolean hasChildren()
          Checks if it has the children.
 boolean isEqual(BizObjectIfc bizObject)
          Checks to see if this BizObject is equal to another one.
 boolean isEqualWithFilter(BizObjectIfc bizObject, java.util.List filteredAttributes)
          Checks to see if this BizObject is equal to another one, But ignores attribute values as specified in the list.
 boolean isLocked()
          Gets the lock flag
 boolean isMergeObjectSupportEnabled()
          Checks if the merge objects support is enabled.
 boolean isReadOnly()
          Gets the read-only flag
 void setBaselineId(long oid)
          Sets the baseline id.
 void setBizObjectId(long oid)
          Sets the biz object id.
 void setId(long oid)
          Sets the id.
 void setIsLocked(boolean locked)
          Sets the lock flag
 void setIsReadOnly(boolean readOnly)
          Sets the read-only flag
 void setLockOwner(java.lang.String lockOwner)
          Sets the lock owner.
 void setName(java.lang.String name)
          Sets the name property
 void setTimeStamp(long timeStamp)
          Sets the biz object time stamp.
 void setTimeStampNoParentUpdate(long timeStamp)
          Sets the biz object time stamp, but doesn't update its parents time stamp.
 
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_NAME

static final java.lang.String ATTR_NAME
Dynamic Attributes for BizObjectIfc

See Also:
Constant Field Values

ATTR_IS_READONLY

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

ATTR_IS_LOCKED

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

ATTR_IS_LOCKEDLOCALLY

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

ATTR_LOCKOWNER

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

BO_ID

static final java.lang.String BO_ID
Some well used String constants, put here for convience

See Also:
Constant Field Values

BO_ST

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

BO_TIMESTAMP

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

BO_DB_TIMESTAMP

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

BO_TYPE

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

getName

java.lang.String getName()
Gets the name property.

Returns:
String

setName

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

Parameters:
name -

getTypeId

java.lang.String getTypeId()
Gets the type id of the implementing class..

Returns:
String

getReadableName

java.lang.String getReadableName()
Gets the readable name.

Returns:
String

getId

long getId()
Gets the unique if of the implementing class..

Returns:
long

setId

void setId(long oid)
Sets the id.

Parameters:
oid -

getBaselineId

long getBaselineId()
Gets the baseline id.

Returns:
long

setBaselineId

void setBaselineId(long oid)
Sets the baseline id.

Parameters:
oid -

getBizObjectId

long getBizObjectId()
Gets the biz object id.

Returns:
long

setBizObjectId

void setBizObjectId(long oid)
Sets the biz object id.

Parameters:
oid -

getTimeStamp

long getTimeStamp()
Gets the biz object time stamp.

Returns:
long

setTimeStamp

void setTimeStamp(long timeStamp)
Sets the biz object time stamp.

Parameters:
timeStamp -

setTimeStampNoParentUpdate

void setTimeStampNoParentUpdate(long timeStamp)
Sets the biz object time stamp, but doesn't update its parents time stamp. This is used in loading from file and cloning.

Parameters:
timeStamp -

setIsReadOnly

void setIsReadOnly(boolean readOnly)
Sets the read-only flag

Parameters:
readOnly -

isReadOnly

boolean isReadOnly()
Gets the read-only flag

Returns:
boolean

setIsLocked

void setIsLocked(boolean locked)
Sets the lock flag

Parameters:
locked -

isLocked

boolean isLocked()
Gets the lock flag

Returns:
boolean

getLockOwner

java.lang.String getLockOwner()
Gets the lock owner.

Returns:
String

setLockOwner

void setLockOwner(java.lang.String lockOwner)
Sets the lock owner.

Parameters:
lockOwner -

cloneObjectsAttributes

void cloneObjectsAttributes(BizObjectIfc bizObject)
Clones the objects attributes to this object.

Parameters:
bizObject -

equals

boolean equals(BizObjectIfc bizObject)
Checks if this object has the same id as the biz object that its being compared to.

Parameters:
bizObject -
Returns:
boolean

isEqual

boolean isEqual(BizObjectIfc bizObject)
                throws com.compuware.optimaltrace.framework.business.ObjectsNotEqualException
Checks to see if this BizObject is equal to another one. 'Equal' means that all the properties are identiacal. Note: returning a boolean here is a bit moot as if they're not equal an exception is thrown! Revisit. Note: we could check all the children/associates and call isEqual recusively. TODO - sort out what we want to do here. Also note, isEqual does not compare timestamps. Also TODO - we should replace 'equals' above..

Parameters:
bizObject -
Returns:
boolean
Throws:
ObjectsNotEqualException

isEqualWithFilter

boolean isEqualWithFilter(BizObjectIfc bizObject,
                          java.util.List filteredAttributes)
                          throws com.compuware.optimaltrace.framework.business.ObjectsNotEqualException
Checks to see if this BizObject is equal to another one, But ignores attribute values as specified in the list.

Parameters:
bizObject -
filteredAttributes -
Returns:
boolean
Throws:
ObjectsNotEqualException

enableMergeObjectSupport

void enableMergeObjectSupport()
Enables the merge objects support.


disableMergeObjectSupport

void disableMergeObjectSupport()
Disables the merge objects support.


isMergeObjectSupportEnabled

boolean isMergeObjectSupportEnabled()
Checks if the merge objects support is enabled.

Returns:
boolean

getFirstChild

BizObjectIfc getFirstChild()
Gets the first child.

Returns:
BizObjectIfc

hasChildren

boolean hasChildren()
Checks if it has the children.

Returns:
boolean

getNextChild

BizObjectIfc getNextChild()
Gets the next child.

Returns:
BizObjectIfc

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.