Project: stp

com.ibm.rational.wvcm.stp.cq
Interface CqHistoryFieldValue

All Superinterfaces:
CqFieldValue<String[]>, StpProperty<String[]>

public interface CqHistoryFieldValue
extends CqFieldValue<String[]>

An extension of the CqFieldValue StpProperty interface representing the value of a ClearQuest record history field. The VALUE of this property is an array of strings, each representing a single event in the lifetime of the record. Each event has several sub-fields indicating the time of the event, the user that caused the event, initial and final states, etc. The sub-fields are separated by "\t" characters.


Nested Class Summary
 
Nested classes/interfaces inherited from interface CqFieldValue
CqFieldValue.ValidationStatus, CqFieldValue.ValueStatus, CqFieldValue.ValueType
 
Nested classes/interfaces inherited from interface com.ibm.rational.wvcm.stp.StpProperty
StpProperty.List<S extends StpProperty>, StpProperty.MetaPropertyName<V>, StpProperty.Type
 
Field Summary
static StpProperty.MetaPropertyName<String[]> DISPLAY_NAME_HEADER
          An array of labels for the sub-fields of an event in the VALUE array.
static StpProperty.MetaPropertyName<String[]> DISPLAY_NAME_HEADER_FOR_EXPORT
          An array of labels for the sub-fields of an event in the HISTORIES_FOR_EXPORT array.
static StpProperty.MetaPropertyName<String[]> HISTORIES_FOR_EXPORT
          An array of the history events in a format suitable for export
 
Fields inherited from interface CqFieldValue
CHOICE_LIST, FIELD_DEFINITION, FIELD_TYPE, MESSAGE_TEXT, NULL_VALUE_IMAGE, ORIGINAL_VALUE, ORIGINAL_VALUE_STATUS, RECORD, REQUIREDNESS, VALIDATION_STATUS, VALIDITY_CHANGED_THIS_ACTION, VALIDITY_CHANGED_THIS_GROUP, VALIDITY_CHANGED_THIS_SET_VALUE, VALUE_CHANGED_THIS_ACTION, VALUE_CHANGED_THIS_GROUP, VALUE_CHANGED_THIS_SET_VALUE, VALUE_STATUS
 
Fields inherited from interface com.ibm.rational.wvcm.stp.StpProperty
IS_EMPTY, META_PROPERTY_NAMES, NAME, NAMESPACE, PROPERTY_NAME, RESOURCE, SIZE, TYPE, VALUE
 
Method Summary
 String[] getDisplayNameHeader()
          Returns the value of the DISPLAY_NAME_HEADER property as defined by this proxy.
 String[] getDisplayNameHeaderForExport()
          Returns the value of the DISPLAY_NAME_HEADER_FOR_EXPORT property as defined by this proxy.
 String[] getHistoriesForExport()
          Returns the value of the HISTORIES_FOR_EXPORT property as defined by this proxy.
 
Methods inherited from interface CqFieldValue
characterImage, characterImage, getChoiceList, getFieldDefinition, getFieldName, getFieldType, getMessageText, getOriginalValue, getOriginalValueStatus, getRecord, getRequiredness, getValidationStatus, getValidityChangedThisAction, getValidityChangedThisGroup, getValidityChangedThisSetValue, getValueChangedThisAction, getValueChangedThisGroup, getValueChangedThisSetValue, getValueStatus, initialize, initialize, initialize, valueCount
 
Methods inherited from interface com.ibm.rational.wvcm.stp.StpProperty
getIsEmpty, getMetaProperty, getMetaPropertyNames, getName, getNamespace, getPropertyName, getResource, getSize, getType, getValue, metaPropertyException, metaPropertyExceptions, metaPropertyNames
 

Field Detail

DISPLAY_NAME_HEADER

static final StpProperty.MetaPropertyName<String[]> DISPLAY_NAME_HEADER
An array of labels for the sub-fields of an event in the VALUE array.


DISPLAY_NAME_HEADER_FOR_EXPORT

static final StpProperty.MetaPropertyName<String[]> DISPLAY_NAME_HEADER_FOR_EXPORT
An array of labels for the sub-fields of an event in the HISTORIES_FOR_EXPORT array.


HISTORIES_FOR_EXPORT

static final StpProperty.MetaPropertyName<String[]> HISTORIES_FOR_EXPORT
An array of the history events in a format suitable for export

Method Detail

getDisplayNameHeader

String[] getDisplayNameHeader()
                              throws WvcmException
Returns the value of the DISPLAY_NAME_HEADER property as defined by this proxy.

Returns:
A String[], each element of which contains a label for one sub-field of a history event. The length of this array defines the number of sub-fields in each String of the VALUE array.
Throws:
WvcmException - if this proxy does not define a value for the DISPLAY_NAME_HEADER property.

getDisplayNameHeaderForExport

String[] getDisplayNameHeaderForExport()
                                       throws WvcmException
Returns the value of the DISPLAY_NAME_HEADER_FOR_EXPORT property as defined by this proxy.

Returns:
A String[], each element of which contains a label for one sub-field of a history event in the HISTORIES_FOR_EXPORT array. The length of this array defines the number of sub-fields in each String of the HISTORIES_FOR_EXPORT array.
Throws:
WvcmException - if this proxy does not define a value for the DISPLAY_NAME_HEADER_FOR_EXPORT property.

getHistoriesForExport

String[] getHistoriesForExport()
                               throws WvcmException
Returns the value of the HISTORIES_FOR_EXPORT property as defined by this proxy.

Returns:
A String[], each element of which describes an event in the history of this field's record. Each event String contains sub-fields appropriate for export of the the event information.
Throws:
WvcmException - if this proxy does not define a value for the HISTORIES_FOR_EXPORT property.

Generated Thu 15-Aug-2013 02:30 AM

Copyright © IBM 2013. All rights reserved.