com.crystaldecisions.sdk.occa.report.data
Interface IDBField

All Superinterfaces:
IClone, IField
All Known Implementing Classes:
DBField

public interface IDBField
extends IField

This interface represents a database field.


Method Summary
 SummaryMetadata getDefaultSummaryMetadata()
          For internal use only
 java.lang.String getHeadingText()
          Returns the text used as a heading when the field is added to the report.
 java.lang.String getTableAlias()
          Returns the alias that is used to identify the table.
 java.lang.String getUniqueID()
          For internal use only
 boolean isServerAggregatable()
          For internal use only
 void setHeadingText(java.lang.String headingText)
          Sets the text used as a heading when the field is added to the report.
 void setServerAggregatable(boolean serverAggregatable)
          For internal use only
 void setTableAlias(java.lang.String tableAlias)
          Sets the alias that is used to identify the table.
 void setUniqueID(java.lang.String uniqueID)
          For internal use only Sets the Unique ID of database field which is used to identify the field across different PVL.
 
Methods inherited from interface com.crystaldecisions.sdk.occa.report.data.IField
getDescription, getDisplayName, getFormulaForm, getIsRecurring, getKind, getLength, getLongName, getName, getShortName, getType, getValueTypeForFormatOption, setDescription, setLength, setName, setType
 

Method Detail

getHeadingText

java.lang.String getHeadingText()

Returns the text used as a heading when the field is added to the report. The heading text is the text that is used to identify the content of the field.

Specified by:
getHeadingText in interface IField
Returns:
The heading text as a String.

getTableAlias

java.lang.String getTableAlias()

Returns the alias that is used to identify the table.

Returns:
The table alias as a String.

getUniqueID

java.lang.String getUniqueID()
For internal use only

Returns:
Unique ID of database field

isServerAggregatable

boolean isServerAggregatable()
For internal use only


setHeadingText

void setHeadingText(java.lang.String headingText)

Sets the text used as a heading when the field is added to the report. The heading text is the text that is used to identify the content of the field.

Specified by:
setHeadingText in interface IField
Parameters:
headingText - The heading text as a String.

setTableAlias

void setTableAlias(java.lang.String tableAlias)

Sets the alias that is used to identify the table.

Parameters:
tableAlias - The table alias as a String.

setUniqueID

void setUniqueID(java.lang.String uniqueID)
For internal use only

Sets the Unique ID of database field which is used to identify the field across different PVL.

Parameters:
uniqueID - Unique ID of field

setServerAggregatable

void setServerAggregatable(boolean serverAggregatable)
For internal use only


getDefaultSummaryMetadata

SummaryMetadata getDefaultSummaryMetadata()
For internal use only