OptimalTrace
5.2

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

All Superinterfaces:
AssociateIfc, BizObjectIfc, BoundPropertyValueHolderIfc, ChildIfc, DynAttributeIfc, MergeObjectIfc, ParentIfc, PersistentIfc, PropertiesContainerIfc, RelationIfc

public interface CustomPropertyTemplateIfc
extends BizObjectIfc, BoundPropertyValueHolderIfc

Interface CustomPropertyTemplateIfc


Field Summary
static java.lang.String ATTR_APPLY_NEW_DEFAULT_VALUE
           
static java.lang.String ATTR_DEFAULT_FREEFORM_VALUE
           
static java.lang.String ATTR_DEFINITION
          Dyn Attributes for CustomPropertyTemplateIfc
static java.lang.String ATTR_IS_AWAITING_ASSOCIATE
           
static java.lang.String ATTR_VALUE_TYPE
           
static java.lang.String BOUND_VALUE
           
static java.lang.String FREEFORM_VALUE
           
 
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.util.List getAllowedBoundPropertyValues()
          Gets the allowed bound property values.
 boolean getApplyNewDefaultValue()
          Gets the apply new default value.
 com.compuware.optimaltrace.tools.common.bizobjects.BoundPropertyValueIfc getDefaultBoundPropertyValue()
          Gets the default bound property value.
 java.lang.String getDefaultFreeformValue()
          Gets the default free form value.
 java.lang.String getDefaultValue()
          Gets the default value.
 java.lang.String getDefinition()
          Gets the definition.
 boolean getIsAwaitingAssociate()
          Special case for merging a cloned CustomPropertyTemplate with an associated bound property The association will not be hooked up until after the onChildAdded event is heard but the UI.
 java.lang.String getValueType()
          Gets the value type.
 boolean isBound()
          Checks the bound.
 boolean removeDefaultBoundPropertyValue(com.compuware.optimaltrace.tools.common.bizobjects.BoundPropertyValueIfc boundValue)
          Removes the default bound property value.
 void setApplyNewDefaultValue(boolean apply)
          Sets the apply new default value, indicates if a new default value needs to be applied to all associated CustomProperty objects.
 void setDefaultBoundPropertyValue(com.compuware.optimaltrace.tools.common.bizobjects.BoundPropertyValueIfc boundValue)
          Sets the default bound property value.
 void setDefaultFreeformValue(java.lang.String value)
          Sets the default free form value.
 void setDefaultValue(com.compuware.optimaltrace.tools.common.bizobjects.BoundPropertyValueIfc boundValue)
          Sets the default value.
 void setDefaultValue(java.lang.String value)
          Sets the default value.
 void setDefinition(java.lang.String definition)
          Sets the definition.
 void setIsAwaitingAssociate(boolean awaiting)
          Special case for merging a cloned CustomPropertyTemplate with an associated bound property The association will not be hooked up until after the onChildAdded event is heard but the UI
 void setIsBound(boolean bound)
          Sets the bound.
 void setValueType(java.lang.String valueType)
          Sets the value type.
 void updateName(java.lang.String name)
          Updates the name of the group.
 
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.customproperty.BoundPropertyValueHolderIfc
getBoundPropertyValueBucket, removeBoundPropertyValueBucket, setBoundPropertyValueBucket
 

Field Detail

FREEFORM_VALUE

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

BOUND_VALUE

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

ATTR_DEFINITION

static final java.lang.String ATTR_DEFINITION
Dyn Attributes for CustomPropertyTemplateIfc

See Also:
Constant Field Values

ATTR_DEFAULT_FREEFORM_VALUE

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

ATTR_VALUE_TYPE

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

ATTR_APPLY_NEW_DEFAULT_VALUE

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

ATTR_IS_AWAITING_ASSOCIATE

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

setDefinition

void setDefinition(java.lang.String definition)
Sets the definition.

Parameters:
definition -

getDefinition

java.lang.String getDefinition()
Gets the definition.

Returns:
String

setDefaultFreeformValue

void setDefaultFreeformValue(java.lang.String value)
Sets the default free form value.

Parameters:
value -

getDefaultFreeformValue

java.lang.String getDefaultFreeformValue()
Gets the default free form value.

Returns:
String

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 name of the group.

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

setDefaultBoundPropertyValue

void setDefaultBoundPropertyValue(com.compuware.optimaltrace.tools.common.bizobjects.BoundPropertyValueIfc boundValue)
Sets the default bound property value.

Parameters:
boundValue -

getDefaultBoundPropertyValue

com.compuware.optimaltrace.tools.common.bizobjects.BoundPropertyValueIfc getDefaultBoundPropertyValue()
Gets the default bound property value.

Returns:
BoundPropertyValueIfc

removeDefaultBoundPropertyValue

boolean removeDefaultBoundPropertyValue(com.compuware.optimaltrace.tools.common.bizobjects.BoundPropertyValueIfc boundValue)
Removes the default bound property value.

Parameters:
boundValue -
Returns:
boolean

getAllowedBoundPropertyValues

java.util.List getAllowedBoundPropertyValues()
Gets the allowed bound property values.

Returns:
List

getValueType

java.lang.String getValueType()
Gets the value type.

Returns:
String

setValueType

void setValueType(java.lang.String valueType)
Sets the value type.

Parameters:
valueType -

isBound

boolean isBound()
Checks the bound.

Returns:
boolean

setIsBound

void setIsBound(boolean bound)
Sets the bound.

Parameters:
bound -

getIsAwaitingAssociate

boolean getIsAwaitingAssociate()
Special case for merging a cloned CustomPropertyTemplate with an associated bound property The association will not be hooked up until after the onChildAdded event is heard but the UI.

Returns:
boolean

setIsAwaitingAssociate

void setIsAwaitingAssociate(boolean awaiting)
Special case for merging a cloned CustomPropertyTemplate with an associated bound property The association will not be hooked up until after the onChildAdded event is heard but the UI

Parameters:
awaiting -

setDefaultValue

void setDefaultValue(java.lang.String value)
Sets the default value.

Parameters:
value -

setDefaultValue

void setDefaultValue(com.compuware.optimaltrace.tools.common.bizobjects.BoundPropertyValueIfc boundValue)
Sets the default value.

Parameters:
boundValue -

getDefaultValue

java.lang.String getDefaultValue()
Gets the default value.

Returns:
String

getApplyNewDefaultValue

boolean getApplyNewDefaultValue()
Gets the apply new default value.

Returns:
boolean

setApplyNewDefaultValue

void setApplyNewDefaultValue(boolean apply)
Sets the apply new default value, indicates if a new default value needs to be applied to all associated CustomProperty objects.

Parameters:
apply -

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.