oracle.apps.fnd.appltest.diagfwk.api.report
Class ReportElementFactory

java.lang.Object
  oracle.apps.fnd.appltest.diagfwk.common.DiagBaseFactory
      oracle.apps.fnd.appltest.diagfwk.api.report.ReportElementFactory

All Implemented Interfaces:

ReportConstants, DiagConstants

public abstract class ReportElementFactory
extends DiagBaseFactory
implements ReportConstants

A factory that provides APIs for creating instances of various report element objects during execution of a test.

Nested Class Summary

Nested classes/interfaces inherited from interface oracle.apps.fnd.appltest.diagfwk.common.DiagConstants

DiagConstants.ExecutionMode, DiagConstants.Format, DiagConstants.LinkType, DiagConstants.Status

Field Summary

static int

BREAK_HEADER_LENGTH Break column headers greater than this length

Fields inherited from interface oracle.apps.fnd.appltest.diagfwk.api.report.ReportConstants

ERROR_TYPE_DIAG, ERROR_TYPE_EXEC, MSG_ATTENTION, MSG_NORMAL, SEVERITY_CRITICAL, SEVERITY_WARNING

Fields inherited from interface oracle.apps.fnd.appltest.diagfwk.common.DiagConstants

APPS_MSG_ID_TAG_NAME, CFG_ADR_PROVIDER_CLASS, CFG_CACHE_PROVIDER_CLASS, CFG_CRED_PROVIDER_CLASS, CFG_DAO_FACTORY_CLASS, CFG_DB_CONN_INFO_PROVIDER_CLASS, CFG_DB_CONN_PROVIDER_CLASS, CFG_NLS_PROVIDER_CLASS, CFG_PLSQL_PROVIDER_CLASS, CFG_PROFILE_PROVIDER_CLASS, CFG_SECURITY_PROVIDER_CLASS, CFG_SESSION_INFO_PROVIDER_CLASS, CFG_URL_PROVIDER_FACTORY_CLASS, CFG_WLS_MBEANSRV_CONNINFO_PROVIDER_CLASS, DATA_SECURITY_PERMISSION_ALLOWED, DATA_SECURITY_PERMISSION_NOT_ALLOWED, DELIM_URL, EXEC_MODE_CLI, EXEC_MODE_ESS, EXEC_MODE_INCIDENT, EXEC_MODE_JAVA, EXEC_MODE_UI, EXECUTABLE_TYPE_JAVA, EXECUTABLE_TYPE_PLSQL, EXECUTABLE_TYPE_TESTREF, FORMAT_HTML, FORMAT_XML, GUID_ORACLE_MINUS1, GUID_ORACLE_ZERO, INPUTS_STATUS_ALL_OPT_INPUTS, INPUTS_STATUS_NO_INPUTS, INPUTS_STATUS_REQ_INPUTS_NO_DEFAULTS, INPUTS_STATUS_REQ_INPUTS_W_DEFAULTS, IO_FLAG_I, IO_FLAG_O, JMX_API_BASE_OBJECT_NAME, LINK_EXTERNAL, LINK_INTERNAL, LINK_METALINK, N, NLS_BUNDLE_JAVA_RES, NLS_BUNDLE_MSG_SVC, NLS_BUNDLE_RES_REF, NLS_BUNDLE_XLIFF, NO, NULL, ODF_MBEAN_DOMAIN_NAME, PARAM_MON_INTERVAL, PLSQL_DEBUG_ENABLED_SYSTEM_PROP, PREREQ_TYPE_TAG_VALUE, PREREQ_TYPE_TEST, SECONDS_IN_ONE_DAY, SECONDS_IN_ONE_HOUR, STATUS_CANCELED, STATUS_EXECERROR, STATUS_FAILURE, STATUS_RUNNING, STATUS_SUCCESS, STATUS_WARNING, SYS_PROP_MAX_MONITOR_INTERNVAL, SYS_PROP_MAX_NUM_THREADS, SYSPROP_APPCONNFILE, SYSPROP_DIAG_CONFIG_FILE, TAG_TYPE_DIAG, TAG_TYPE_TAXONOMY, TEST_TYPE_DECL, TEST_TYPE_JAVA, USER_NAME, WEB_APP_NAME_TAG_NAME, Y, YES

Constructor Summary

ReportElementFactory()

Method Summary

static Message	createAttentionMessage(java.lang.String pNlsKey, java.lang.String pDefault) Create a new Attention Message object with the given NLS Key and default value
static Message	createAttentionMessage(java.lang.String pNlsKey, java.lang.String pDefault, java.lang.String pMetaLinkNoteId) Creates a new Attention Message with the given parameters
static Message	createAttentionMessage(java.lang.String pNlsKey, java.lang.String pDefault, java.lang.String[][] pMsgTokens) Creates a new Messsage with the given parameters
static Message	createAttentionMessage(java.lang.String pNlsKey, java.lang.String pDefault, java.lang.String[][] pMsgTokens, java.lang.String pMetaLinkNoteId) Creates a new Messsage with the given parameters
static DescriptiveHeader	createDescriptiveHeader() Creates an empty descriptive header instance
static DescriptiveHeader	createDescriptiveHeader(Label pHeader, Label pHeaderDescription) Creates an descriptive header instance with the given header and description labels
static DescriptiveHeader	createDescriptiveHeader(java.lang.String pNlsKey, java.lang.String pDefault, java.lang.String[][] pNameValuePairs, java.lang.String pNlsDescKey, java.lang.String pDescription, java.lang.String[][] pDescNameValuePairs) Creates an descriptive header instance with the given parameters
static DescriptiveHeader	createDescriptiveHeader(java.lang.String pNlsKey, java.lang.String pDefault, java.lang.String pNlsDescKey, java.lang.String pDescription) Creates an descriptive header instance with the given parameters
static ErrorInfo	createError(java.lang.String pErrorNlsKey, java.lang.String pErrorDefault, java.lang.String[][] pErrorMsgTokens, java.lang.String pFixNlsKey, java.lang.String pFixDefault) Creates a new instance of an ErrorInfo object with the specified attribuets
static ErrorInfo	createError(java.lang.String pErrorNlsKey, java.lang.String pErrorDefault, java.lang.String[][] pErrorMsgTokens, java.lang.String pErrorMetalinkId, java.lang.String pFixNlsKey, java.lang.String pFixDefault) Creates a new instance of an ErrorInfo object with the specified attribuets
static ErrorInfo	createError(java.lang.String pErrorNlsKey, java.lang.String pErrorDefault, java.lang.String[][] pErrorMsgTokens, java.lang.String pFixNlsKey, java.lang.String pFixDefault, java.lang.String[][] pFixMsgTokens) Creates a new instance of an ErrorInfo object with the specified attribuets
static ErrorInfo	createError(java.lang.String pErrorNlsKey, java.lang.String pErrorDefault, java.lang.String[][] pErrorMsgTokens, java.lang.String pErrorMetalinkId, java.lang.String pFixNlsKey, java.lang.String pFixDefault, java.lang.String[][] pFixMsgTokens, java.lang.String pFixMetalinkId) Creates a new instance of an ErrorInfo object with the specified attribuets
static ErrorInfo	createError(java.lang.String pErrorNlsKey, java.lang.String pErrorDefault, java.lang.String pFixNlsKey, java.lang.String pFixDefault) Creates a new instance of an ErrorInfo object with the specified attribuets
static ErrorInfo	createError(java.lang.String pErrorNlsKey, java.lang.String pErrorDefault, java.lang.String pFixNlsKey, java.lang.String pFixDefault, java.lang.String[][] pFixMsgTokens) Creates a new instance of an ErrorInfo object with the specified attribuets
static ErrorInfo	createError(java.lang.String pErrorNlsKey, java.lang.String pErrorDefault, java.lang.String pFixNlsKey, java.lang.String pFixDefault, java.lang.String[][] pFixMsgTokens, java.lang.String pFixMetalinkId) Creates a new instance of an ErrorInfo object with the specified attribuets
static ErrorInfo	createErrorInfo() Creates a new instance of an ErrorInfo object
static ErrorInfo	createErrorInfo(ErrorInfo.Severity pSeverity, Message pErrMsg, FixInfo pFixInfo) Creates a new instance of an ErrorInfo object with the specified attribuets
static ErrorInfo	createException(java.lang.Throwable pTrace, java.lang.String pErrorNlsKey, java.lang.String pErrorDefault, java.lang.String[][] pErrorMsgTokens, java.lang.String pFixNlsKey, java.lang.String pFixDefault) Creates a new instance of an ErrorInfo object with the specified attribuets
static ErrorInfo	createException(java.lang.Throwable pTrace, java.lang.String pErrorNlsKey, java.lang.String pErrorDefault, java.lang.String[][] pErrorMsgTokens, java.lang.String pFixNlsKey, java.lang.String pFixDefault, java.lang.String[][] pFixMsgTokens) Creates a new instance of an ErrorInfo object with the specified attribuets
static ErrorInfo	createException(java.lang.Throwable pTrace, java.lang.String pErrorNlsKey, java.lang.String pErrorDefault, java.lang.String pFixNlsKey, java.lang.String pFixDefault) Creates a new instance of an ErrorInfo object with the specified attribuets
static ErrorInfo	createException(java.lang.Throwable pTrace, java.lang.String pErrorNlsKey, java.lang.String pErrorDefault, java.lang.String pFixNlsKey, java.lang.String pFixDefault, java.lang.String[][] pFixMsgTokens) Creates a new instance of an ErrorInfo object with the specified attribuets
static FixInfo	createFixInfo() Creates a new instance of FixInfo
static FixInfo	createFixInfo(Message pFixMsg) Creates a new instance of a FixInfo object
static Header	createHeader() Returns a new instance of a Header
static Header	createHeader(java.lang.String pNlsKey, java.lang.String pDefault) Returns a new Header with the given NLS key and the given default value.
static Header	createHeader(java.lang.String pNlsKey, java.lang.String pDefault, java.lang.String[][] pNameValuePairs) Returns a new Header with the given NLS key and the given default value.
static Label	createLabel() Returns a new instance of a Label
static Label	createLabel(java.lang.String pNlsKey, java.lang.String pDefault) Returns a new Label
static Label	createLabel(java.lang.String pNlsKey, java.lang.String pDefault, java.util.List<NameValue> pTokens) Returns a new label
static Label	createLabel(java.lang.String pNlsKey, java.lang.String pDefault, java.lang.String[][] pNameValuePairs) Returns a new label
static LinkToken	createLinkToken() Create a new LinkToken object
static LinkToken	createLinkToken(java.lang.String pTokenName, Message pMessage) Create a LinkToken with given name and Message (link)
static LinkToken	createLinkTokenForMetalinkNote(java.lang.String pTokenName, java.lang.String pMetalinkNoteId) Deprecated. please use createLinkTokenForSupportNote(String pTokenName, String pSupportNoteId)
static LinkToken	createLinkTokenForSupportNote(java.lang.String pTokenName, java.lang.String pSupportNoteId) A convenience API that will internally create a Message with the Note ID with the link to Support defined
static Message	createMessage() Create a new Message object
static Message	createMessage(java.lang.String pNlsKey, java.lang.String pDefault) Create a new Message object with the given NLS Key and default value
static Message	createMessage(java.lang.String pNlsKey, java.lang.String pDefault, java.lang.String pMetaLinkNoteId) Creates a new Message with the given parameters
static Message	createMessage(java.lang.String pNlsKey, java.lang.String pDefault, java.lang.String[][] pMsgTokens) Creates a new Messsage with the given parameters
static Message	createMessage(java.lang.String pNlsKey, java.lang.String pDefault, java.lang.String[][] pMsgTokens, java.lang.String pMetaLinkNoteId) Creates a new Messsage with the given parameters
static MsgList	createMsgList() Creates a new empty list of messages
static MsgList	createMsgList(java.util.List<Message> pListElems) Creates a new MsgList with the given list of elements
static NameValue	createNameValue() Returns a new instance of a NameValue
static NameValue	createNameValue(java.lang.String pName, java.lang.String pValue) Returns a new instance of a NameValue with the given name and value
static RowCell	createRowCell() Creates an empty row cell
static RowCell	createRowCell(Message pData) Creates a row cell with the given data
static Section	createSection() Creates a new Section
static Section	createSection(DescriptiveHeader pHeader) Creates a new Section with the given header
static Section	createSection(java.lang.String pSectionNlsKey, java.lang.String pSectionDefault) Creates a new Section with the given parameters
static Section	createSection(java.lang.String pSectionNlsKey, java.lang.String pSectionDefault, java.lang.String[][] pSectionTokens) Creates a new Section with the given parameters
static Section	createSection(java.lang.String pSectionNlsKey, java.lang.String pSectionDefault, java.lang.String[][] pSectionTokens, java.lang.String pDescrNlsKey, java.lang.String pDescrDefault, java.lang.String[][] pDescrTokens) Creates a new Section with the given parameters
static Section	createSection(java.lang.String pSectionNlsKey, java.lang.String pSectionDefault, java.lang.String pDescrNlsKey, java.lang.String pDescrDefault) Creates a new Section with the given parameters
static SummaryInfo	createSummaryInfo() Creates a new SummaryInfo object
static SummaryInfo	CreateSummaryInfo(Message pSummaryText) Creates a new instnace of summary info with the given label and error list
static Table	createTable() Creates a new empty table.
static Table	createTable(Header pHeader, java.util.List<Header> pColumnHeaders, java.util.List<TableRow> pTableRows) Creates a new table with the specified table header, column headers and table rows.
static Table	createTableFromResultSet(java.lang.String tableHeaderNlsKey, java.lang.String defaultTableHeader, java.sql.ResultSet resultSet, java.lang.String sql, java.math.BigInteger maxDisplayRows, boolean showFooter, boolean showSQL) Displays the data in a result set formatted either in a tabular or portrait form.
static Table	createTableFromResultSet(java.lang.String tableHeaderNlsKey, java.lang.String defaultTableHeader, java.sql.ResultSet resultSet, java.lang.String sql, java.lang.String[][] sqlBindVariables, java.math.BigInteger maxDisplayRows, boolean showFooter, boolean showSQL) Displays the data in a result set formatted either in a tabular or portrait form.
static Table	createTableFromResultSetWithRowCountThreshold(java.lang.String tableHeaderNlsKey, java.lang.String defaultTableHeader, java.sql.ResultSet resultSet, java.lang.String sql, java.lang.String[][] sqlBindVariables, java.math.BigInteger maxDisplayRows, boolean showFooter, boolean showSQL, int nRowsThreshold) Displays the data in a result set formatted either in a tabular or portrait form.
static TableRow	createTableRow() Creates a new TableRow
static TableRow	createTableRow(java.util.List<RowCell> pRowElems) Creates a new TableRow with the given row elements
static ErrorInfo	createWarning(java.lang.String pWarningNlsKey, java.lang.String pWarningDefault, java.lang.String[][] pWarningMsgTokens, java.lang.String pFixNlsKey, java.lang.String pFixDefault) Creates a new instance of an ErrorInfo object with the specified attribuets
static ErrorInfo	createWarning(java.lang.String pWarningNlsKey, java.lang.String pWarningDefault, java.lang.String[][] pWarningMsgTokens, java.lang.String pWarningMetalinkId, java.lang.String pFixNlsKey, java.lang.String pFixDefault) Creates a new instance of an ErrorInfo object with the specified attribuets
static ErrorInfo	createWarning(java.lang.String pWarningNlsKey, java.lang.String pWarningDefault, java.lang.String[][] pWarningMsgTokens, java.lang.String pFixNlsKey, java.lang.String pFixDefault, java.lang.String[][] pFixMsgTokens) Creates a new instance of an ErrorInfo object with the specified attribuets
static ErrorInfo	createWarning(java.lang.String pWarningNlsKey, java.lang.String pWarningDefault, java.lang.String[][] pWarningMsgTokens, java.lang.String pWarningMetalinkId, java.lang.String pFixNlsKey, java.lang.String pFixDefault, java.lang.String[][] pFixMsgTokens, java.lang.String pFixMetalinkId) Creates a new instance of an ErrorInfo object with the specified attribuets
static ErrorInfo	createWarning(java.lang.String pWarningNlsKey, java.lang.String pWarningDefault, java.lang.String pFixNlsKey, java.lang.String pFixDefault) Creates a new instance of an ErrorInfo object with the specified attribuets
static ErrorInfo	createWarning(java.lang.String pWarningNlsKey, java.lang.String pWarningDefault, java.lang.String pFixNlsKey, java.lang.String pFixDefault, java.lang.String[][] pFixMsgTokens) Creates a new instance of an ErrorInfo object with the specified attribuets
static ErrorInfo	createWarning(java.lang.String pWarningNlsKey, java.lang.String pWarningDefault, java.lang.String pFixNlsKey, java.lang.String pFixDefault, java.lang.String[][] pFixMsgTokens, java.lang.String pFixMetalinkId) Creates a new instance of an ErrorInfo object with the specified attribuets
static Table	getResultSetAsTable(java.lang.String tableHeaderNlsKey, java.lang.String defaultTableHeader, java.sql.ResultSet resultSet, java.lang.String sql, java.math.BigInteger maxDisplayRows, boolean showFooter, boolean showSQL) Deprecated. Please use createTableFromResultSet() APIs instead.
static java.lang.String	resolveSqlStatement(java.lang.String sqlStatement, java.lang.String[][] bindValues) Resolve sql statement.
static NameValueList	toNameValueList(java.lang.String[][] pNameValuePairs)

Methods inherited from class oracle.apps.fnd.appltest.diagfwk.common.DiagBaseFactory

createClassLoader, loadClassFor

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

BREAK_HEADER_LENGTH

public static final int BREAK_HEADER_LENGTH

Break column headers greater than this length

See Also:

Constant Field Values

Constructor Detail

ReportElementFactory

public ReportElementFactory()

Method Detail

createNameValue

public static NameValue createNameValue()

Returns a new instance of a NameValue

Returns:

a new instance of a NameValue

createNameValue

public static NameValue createNameValue(java.lang.String pName,
                                        java.lang.String pValue)

Returns a new instance of a NameValue with the given name and value

Returns:

a new instance of a NameValue

createLabel

public static Label createLabel()

Returns a new instance of a Label

Returns:

a new instance of a Label

createLabel

public static Label createLabel(java.lang.String pNlsKey,
                                java.lang.String pDefault)

Returns a new Label

Parameters:

pNlsKey - - the NLS key for the label

pDefault - - the default text for the label

Returns:

the new label

createHeader

public static Header createHeader()

Returns a new instance of a Header

Returns:

a new instance of a Header

createHeader

public static Header createHeader(java.lang.String pNlsKey,
                                  java.lang.String pDefault)

Returns a new Header with the given NLS key and the given default value.

Parameters:

pNlsKey - - the NLS key for the label

pDefault - - the default text for the label

Returns:

the new Header

createLabel

public static Label createLabel(java.lang.String pNlsKey,
                                java.lang.String pDefault,
                                java.util.List<NameValue> pTokens)

Returns a new label

Parameters:

pNlsKey - - the NLS key for the label

pDefault - - the default text for the label

pTokens - - list of tokens to go with the NLS key for getting the translated message

Returns:

the new label

createDescriptiveHeader

public static DescriptiveHeader createDescriptiveHeader()

Creates an empty descriptive header instance

Returns:

an empty descriptive header instance

createDescriptiveHeader

public static DescriptiveHeader createDescriptiveHeader(Label pHeader,
                                                        Label pHeaderDescription)

Creates an descriptive header instance with the given header and description labels

Parameters:

pHeader - header text

pHeaderDescription - header description text

Returns:

an instance of descriptive header with the given header and description labels

createSummaryInfo

public static SummaryInfo createSummaryInfo()

Creates a new SummaryInfo object

Returns:

a new instance of SummaryInfo

CreateSummaryInfo

public static SummaryInfo CreateSummaryInfo(Message pSummaryText)

Creates a new instnace of summary info with the given label and error list

Parameters:

pSummaryText - - summary text for the summary info

Returns:

a new instance of summary info

createMessage

public static Message createMessage()

Create a new Message object

Returns:

a new instance of an empty Message

createMessage

public static Message createMessage(java.lang.String pNlsKey,
                                    java.lang.String pDefault)

Create a new Message object with the given NLS Key and default value

Parameters:

pNlsKey - - NLS Key for the message

pDefault - - Default text for the message

Returns:

a new instance of an Message with the given NLS Key and default value.

createFixInfo

public static FixInfo createFixInfo()

Creates a new instance of FixInfo

Returns:

a new FixInfo object instance

createFixInfo

public static FixInfo createFixInfo(Message pFixMsg)

Creates a new instance of a FixInfo object

Parameters:

pFixMsg - - label for the fix message

Returns:

a new instnace of a FixInfo

createErrorInfo

public static ErrorInfo createErrorInfo()

Creates a new instance of an ErrorInfo object

Returns:

a new instance of an ErrorInfo object

createErrorInfo

public static ErrorInfo createErrorInfo(ErrorInfo.Severity pSeverity,
                                        Message pErrMsg,
                                        FixInfo pFixInfo)

Creates a new instance of an ErrorInfo object with the specified attribuets

Parameters:

pSeverity - - severity of the error

pErrMsg - - the error message

pFixInfo - - a fix info object with a list of fix messages

Returns:

a new instance of an ErrorInfo object

createSection

public static Section createSection()

Creates a new Section

Returns:

a new Section

createSection

public static Section createSection(DescriptiveHeader pHeader)

Creates a new Section with the given header

Parameters:

pHeader - label for the header

Returns:

a new Section with the given header

createMsgList

public static MsgList createMsgList()

Creates a new empty list of messages

Returns:

a new list of messages

createMsgList

public static MsgList createMsgList(java.util.List<Message> pListElems)

Creates a new MsgList with the given list of elements

Parameters:

pListElems - - the list of elements for the MsgList

Returns:

a new MsgList with the given list of elements

createTableRow

public static TableRow createTableRow()

Creates a new TableRow

Returns:

a new TableRow

createTableRow

public static TableRow createTableRow(java.util.List<RowCell> pRowElems)

Creates a new TableRow with the given row elements

Parameters:

pRowElems - list of row elements for the row

Returns:

a new TableRow

createTable

public static Table createTable()

Creates a new empty table.

Returns:

a new empty table.

createTable

public static Table createTable(Header pHeader,
                                java.util.List<Header> pColumnHeaders,
                                java.util.List<TableRow> pTableRows)

Creates a new table with the specified table header, column headers and table rows.

Parameters:

pHeader - - a table header for the table

pColumnHeaders - - headers for the columns of the table

pTableRows - - rows for the table

Returns:

a new table.

createRowCell

public static RowCell createRowCell()

Creates an empty row cell

Returns:

an empty row cell

createRowCell

public static RowCell createRowCell(Message pData)

Creates a row cell with the given data

Returns:

a a row cell with the given data

createSection

public static Section createSection(java.lang.String pSectionNlsKey,
                                    java.lang.String pSectionDefault)

Creates a new Section with the given parameters

Parameters:

pSectionNlsKey - - the NLS key for the label

pSectionDefault - - the default text for the label

Returns:

the new Section

createSection

public static Section createSection(java.lang.String pSectionNlsKey,
                                    java.lang.String pSectionDefault,
                                    java.lang.String pDescrNlsKey,
                                    java.lang.String pDescrDefault)

Creates a new Section with the given parameters

Parameters:

pSectionNlsKey - - the NLS key for the label

pSectionDefault - - the default text for the label

pDescrNlsKey - - the NLS key for the description

pDescrDefault - - the default text for the description

Returns:

the new Section

createSection

public static Section createSection(java.lang.String pSectionNlsKey,
                                    java.lang.String pSectionDefault,
                                    java.lang.String[][] pSectionTokens)

Creates a new Section with the given parameters

Parameters:

pSectionNlsKey - - the NLS key for the label

pSectionDefault - - the default text for the label

pSectionTokens - - the tokens to apply to the nlsKey

Returns:

the new Section

createSection

public static Section createSection(java.lang.String pSectionNlsKey,
                                    java.lang.String pSectionDefault,
                                    java.lang.String[][] pSectionTokens,
                                    java.lang.String pDescrNlsKey,
                                    java.lang.String pDescrDefault,
                                    java.lang.String[][] pDescrTokens)

Creates a new Section with the given parameters

Parameters:

pSectionNlsKey - - the NLS key for the label

pSectionDefault - - the default text for the label

pSectionTokens - - the tokens to apply to the nlsKey

pDescrNlsKey - - the NLS key for the description

pDescrDefault - - the default text for the description

pDescrTokens - - the tokens to apply to the nlsKey

Returns:

the new Section

createMessage

public static Message createMessage(java.lang.String pNlsKey,
                                    java.lang.String pDefault,
                                    java.lang.String[][] pMsgTokens)

Creates a new Messsage with the given parameters

Parameters:

pNlsKey - - the NLS key for the label

pDefault - - the default text for the label

pMsgTokens - - the tokens to apply to the nlsKey

Returns:

the new Messsage

createMessage

public static Message createMessage(java.lang.String pNlsKey,
                                    java.lang.String pDefault,
                                    java.lang.String[][] pMsgTokens,
                                    java.lang.String pMetaLinkNoteId)

Creates a new Messsage with the given parameters

Parameters:

pNlsKey - - the NLS key for the label

pDefault - - the default text for the label

pMetaLinkNoteId - - MetaLink Note Id

pMsgTokens - - the tokens to apply to the nlsKey

Returns:

the new Messsage

createMessage

public static Message createMessage(java.lang.String pNlsKey,
                                    java.lang.String pDefault,
                                    java.lang.String pMetaLinkNoteId)

Creates a new Message with the given parameters

Parameters:

pNlsKey - - the NLS key for the label

pDefault - - the default text for the label

pMetaLinkNoteId - - MetaLink Note Id

Returns:

the new Messsage

createAttentionMessage

public static Message createAttentionMessage(java.lang.String pNlsKey,
                                             java.lang.String pDefault)

Create a new Attention Message object with the given NLS Key and default value

Parameters:

pNlsKey - - NLS Key for the message

pDefault - - Default text for the message

Returns:

a new instance of an Message with the given NLS Key and default value.

createAttentionMessage

public static Message createAttentionMessage(java.lang.String pNlsKey,
                                             java.lang.String pDefault,
                                             java.lang.String pMetaLinkNoteId)

Creates a new Attention Message with the given parameters

Parameters:

pNlsKey - - the NLS key for the label

pDefault - - the default text for the label

pMetaLinkNoteId - - MetaLink Note Id

Returns:

the new Messsage

createAttentionMessage

public static Message createAttentionMessage(java.lang.String pNlsKey,
                                             java.lang.String pDefault,
                                             java.lang.String[][] pMsgTokens)

Creates a new Messsage with the given parameters

Parameters:

pNlsKey - - the NLS key for the label

pDefault - - the default text for the label

pMsgTokens - - the tokens to apply to the nlsKey

Returns:

the new Messsage

createAttentionMessage

public static Message createAttentionMessage(java.lang.String pNlsKey,
                                             java.lang.String pDefault,
                                             java.lang.String[][] pMsgTokens,
                                             java.lang.String pMetaLinkNoteId)

Creates a new Messsage with the given parameters

Parameters:

pNlsKey - - the NLS key for the label

pDefault - - the default text for the label

pMetaLinkNoteId - - MetaLink Note Id

pMsgTokens - - the tokens to apply to the nlsKey

Returns:

the new Messsage

getResultSetAsTable

public static Table getResultSetAsTable(java.lang.String tableHeaderNlsKey,
                                        java.lang.String defaultTableHeader,
                                        java.sql.ResultSet resultSet,
                                        java.lang.String sql,
                                        java.math.BigInteger maxDisplayRows,
                                        boolean showFooter,
                                        boolean showSQL)
                                 throws java.sql.SQLException

Deprecated. Please use createTableFromResultSet() APIs instead.

Displays the data in a result set formatted either in a tabular or portrait form. The column names/aliases are used to automatically determine the headings. summary is required only for printing in tabular form, and is ignored if printing portait. This method has the possibility to chec kfor leading and trailing spaces.

Parameters:

tableHeaderNlsKey - NLS Key for Table Header

defaultTableHeader - Title above table (blue bar, null means no bar)

resultSet - ResultSet with data to be displayed

sql - SQL statement executed

maxDisplayRows - Maximum number of rows to display null means display all

showFooter - Show the 'xx rows retrieved' ?

showSQL - showSQL - which shows the SQL used to create the table, the default is FALSE, don't show.

Returns:

Table containing result set values

Throws:

java.sql.SQLException - When something bad happens fetching data

See Also:

createTableFromResultSet(String,String,ResultSet,String,String[][],BigInteger,boolean,boolean)

createTableFromResultSet

public static Table createTableFromResultSet(java.lang.String tableHeaderNlsKey,
                                             java.lang.String defaultTableHeader,
                                             java.sql.ResultSet resultSet,
                                             java.lang.String sql,
                                             java.lang.String[][] sqlBindVariables,
                                             java.math.BigInteger maxDisplayRows,
                                             boolean showFooter,
                                             boolean showSQL)
                                      throws java.sql.SQLException

Displays the data in a result set formatted either in a tabular or portrait form. The column names/aliases are used to automatically determine the headings. summary is required only for printing in tabular form, and is ignored if printing portait. This method has the possibility to chec kfor leading and trailing spaces.

Parameters:

tableHeaderNlsKey - NLS Key for Table Header

defaultTableHeader - Title above table (blue bar, null means no bar)

resultSet - ResultSet with data to be displayed

sql - SQL statement executed

sqlBindVariables - SQL bind variables

maxDisplayRows - Maximum number of rows to display null means display all

showFooter - Show the 'xx rows retrieved' ?

showSQL - showSQL - which shows the SQL used to create the table, the default is FALSE, don't show.

Returns:

Table containing result set values

Throws:

java.sql.SQLException - When something bad happens fetching data

createTableFromResultSetWithRowCountThreshold

public static Table createTableFromResultSetWithRowCountThreshold(java.lang.String tableHeaderNlsKey,
                                                                  java.lang.String defaultTableHeader,
                                                                  java.sql.ResultSet resultSet,
                                                                  java.lang.String sql,
                                                                  java.lang.String[][] sqlBindVariables,
                                                                  java.math.BigInteger maxDisplayRows,
                                                                  boolean showFooter,
                                                                  boolean showSQL,
                                                                  int nRowsThreshold)
                                                           throws java.sql.SQLException

Displays the data in a result set formatted either in a tabular or portrait form. The column names/aliases are used to automatically determine the headings. summary is required only for printing in tabular form, and is ignored if printing portait. This method has the possibility to chec kfor leading and trailing spaces.

Parameters:

tableHeaderNlsKey - NLS Key for Table Header

defaultTableHeader - Title above table (blue bar, null means no bar)

resultSet - ResultSet with data to be displayed

sql - SQL statement executed

maxDisplayRows - Maximum number of rows to display null means display all

showFooter - Show the 'xx rows retrieved' ?

showSQL - showSQL - which shows the SQL used to create the table, the default is FALSE, don't show.

nRowsThreshold - -1=always show table, 0=don't show table, n = show table if there are n+1 or more rows

Returns:

Table containing result set values

Throws:

java.sql.SQLException - When something bad happens fetching data

createTableFromResultSet

public static Table createTableFromResultSet(java.lang.String tableHeaderNlsKey,
                                             java.lang.String defaultTableHeader,
                                             java.sql.ResultSet resultSet,
                                             java.lang.String sql,
                                             java.math.BigInteger maxDisplayRows,
                                             boolean showFooter,
                                             boolean showSQL)
                                      throws java.sql.SQLException

Displays the data in a result set formatted either in a tabular or portrait form. The column names/aliases are used to automatically determine the headings. summary is required only for printing in tabular form, and is ignored if printing portait. This method has the possibility to chec kfor leading and trailing spaces.

Parameters:

tableHeaderNlsKey - NLS Key for Table Header

defaultTableHeader - Title above table (blue bar, null means no bar)

resultSet - ResultSet with data to be displayed

sql - SQL statement executed

maxDisplayRows - Maximum number of rows to display null means display all

showFooter - Show the 'xx rows retrieved' ?

showSQL - showSQL - which shows the SQL used to create the table, the default is FALSE, don't show.

Returns:

Table containing result set values

Throws:

java.sql.SQLException - When something bad happens fetching data

resolveSqlStatement

public static java.lang.String resolveSqlStatement(java.lang.String sqlStatement,
                                                   java.lang.String[][] bindValues)

Resolve sql statement. Replace binds with actual dynamic values

Parameters:

sqlStatement - SQL Statement

bindValues - Dynamic Values

Returns:

Table containing result set values

toNameValueList

public static NameValueList toNameValueList(java.lang.String[][] pNameValuePairs)

Parameters:

pNameValuePairs - a double String Array of name value pairs

Returns:

a list of NameValue objects

createLabel

public static Label createLabel(java.lang.String pNlsKey,
                                java.lang.String pDefault,
                                java.lang.String[][] pNameValuePairs)

Returns a new label

Parameters:

pNlsKey - - the NLS key for the label

pDefault - - the default text for the label

pNameValuePairs - - String array of name value pairs to go with the NLS key for getting the translated message

Returns:

the new label

createHeader

public static Header createHeader(java.lang.String pNlsKey,
                                  java.lang.String pDefault,
                                  java.lang.String[][] pNameValuePairs)

Returns a new Header with the given NLS key and the given default value.

Parameters:

pNlsKey - - the NLS key for the label

pDefault - - the default text for the label

pNameValuePairs - The name value pairs for NLS

Returns:

the new Header

createDescriptiveHeader

public static DescriptiveHeader createDescriptiveHeader(java.lang.String pNlsKey,
                                                        java.lang.String pDefault,
                                                        java.lang.String pNlsDescKey,
                                                        java.lang.String pDescription)

Creates an descriptive header instance with the given parameters

Parameters:

pNlsKey - - the NLS key for the label

pDefault - - the default text for the label

pNlsDescKey - - the NLS key for the description

pDescription - - the default text for the description

Returns:

the new Descriptive Header

createDescriptiveHeader

public static DescriptiveHeader createDescriptiveHeader(java.lang.String pNlsKey,
                                                        java.lang.String pDefault,
                                                        java.lang.String[][] pNameValuePairs,
                                                        java.lang.String pNlsDescKey,
                                                        java.lang.String pDescription,
                                                        java.lang.String[][] pDescNameValuePairs)

Creates an descriptive header instance with the given parameters

Parameters:

pNlsKey - - the NLS key for the label

pDefault - - the default text for the label

pNameValuePairs - - String array of name value pairs to go with the NLS key for getting the translated message

pDescription - - the default text for the description

pNlsDescKey - - the NLS key for the description

pDescNameValuePairs - - String array of name value pairs to go with the DescNLS key for getting the translated message

Returns:

the new Descriptive Header

createException

public static ErrorInfo createException(java.lang.Throwable pTrace,
                                        java.lang.String pErrorNlsKey,
                                        java.lang.String pErrorDefault,
                                        java.lang.String pFixNlsKey,
                                        java.lang.String pFixDefault)

Creates a new instance of an ErrorInfo object with the specified attribuets

Parameters:

pErrorNlsKey - - NLS Key for Error Message

pErrorDefault - - The default error message

pFixNlsKey - - NLS Key for fix Message

pFixDefault - - The default fix message

Returns:

a new instance of an ErrorInfo object

createException

public static ErrorInfo createException(java.lang.Throwable pTrace,
                                        java.lang.String pErrorNlsKey,
                                        java.lang.String pErrorDefault,
                                        java.lang.String[][] pErrorMsgTokens,
                                        java.lang.String pFixNlsKey,
                                        java.lang.String pFixDefault)

Creates a new instance of an ErrorInfo object with the specified attribuets

Parameters:

pErrorNlsKey - - NLS Key for Error Message

pErrorDefault - - The default error message

pErrorMsgTokens - - NLS Tokens

pFixNlsKey - - NLS Key for fix Message

pFixDefault - - The default fix message

Returns:

a new instance of an ErrorInfo object

createException

public static ErrorInfo createException(java.lang.Throwable pTrace,
                                        java.lang.String pErrorNlsKey,
                                        java.lang.String pErrorDefault,
                                        java.lang.String pFixNlsKey,
                                        java.lang.String pFixDefault,
                                        java.lang.String[][] pFixMsgTokens)

Creates a new instance of an ErrorInfo object with the specified attribuets

Parameters:

pErrorNlsKey - - NLS Key for Error Message

pErrorDefault - - The default error message

pFixNlsKey - - NLS Key for fix Message

pFixDefault - - The default fix message

pFixMsgTokens - - NLS Tokens

Returns:

a new instance of an ErrorInfo object

createException

public static ErrorInfo createException(java.lang.Throwable pTrace,
                                        java.lang.String pErrorNlsKey,
                                        java.lang.String pErrorDefault,
                                        java.lang.String[][] pErrorMsgTokens,
                                        java.lang.String pFixNlsKey,
                                        java.lang.String pFixDefault,
                                        java.lang.String[][] pFixMsgTokens)

Creates a new instance of an ErrorInfo object with the specified attribuets

Parameters:

pErrorNlsKey - - NLS Key for Error Message

pErrorDefault - - The default error message

pErrorMsgTokens - - NLS Tokens

pFixNlsKey - - NLS Key for fix Message

pFixDefault - - The default fix message

pFixMsgTokens - - NLS Tokens

Returns:

a new instance of an ErrorInfo object

createError

public static ErrorInfo createError(java.lang.String pErrorNlsKey,
                                    java.lang.String pErrorDefault,
                                    java.lang.String pFixNlsKey,
                                    java.lang.String pFixDefault)

Creates a new instance of an ErrorInfo object with the specified attribuets

Parameters:

pErrorNlsKey - - NLS Key for Error Message

pErrorDefault - - The default error message

pFixNlsKey - - NLS Key for fix Message

pFixDefault - - The default fix message

Returns:

a new instance of an ErrorInfo object

createError

public static ErrorInfo createError(java.lang.String pErrorNlsKey,
                                    java.lang.String pErrorDefault,
                                    java.lang.String[][] pErrorMsgTokens,
                                    java.lang.String pFixNlsKey,
                                    java.lang.String pFixDefault)

Creates a new instance of an ErrorInfo object with the specified attribuets

Parameters:

pErrorNlsKey - - NLS Key for Error Message

pErrorDefault - - The default error message

pErrorMsgTokens - - Error message tokens for NLS message

pFixNlsKey - - NLS Key for fix Message

pFixDefault - - The default fix message

Returns:

a new instance of an ErrorInfo object

createError

public static ErrorInfo createError(java.lang.String pErrorNlsKey,
                                    java.lang.String pErrorDefault,
                                    java.lang.String[][] pErrorMsgTokens,
                                    java.lang.String pErrorMetalinkId,
                                    java.lang.String pFixNlsKey,
                                    java.lang.String pFixDefault)

Creates a new instance of an ErrorInfo object with the specified attribuets

Parameters:

pErrorNlsKey - - NLS Key for Error Message

pErrorDefault - - The default error message

pErrorMsgTokens - - Error message tokens for NLS message

pErrorMetalinkId - - MetaLink Note Id

pFixNlsKey - - NLS Key for fix Message

pFixDefault - - The default fix message

Returns:

a new instance of an ErrorInfo object

createError

public static ErrorInfo createError(java.lang.String pErrorNlsKey,
                                    java.lang.String pErrorDefault,
                                    java.lang.String pFixNlsKey,
                                    java.lang.String pFixDefault,
                                    java.lang.String[][] pFixMsgTokens)

Creates a new instance of an ErrorInfo object with the specified attribuets

Parameters:

pErrorNlsKey - - NLS Key for Error Message

pErrorDefault - - The default error message

pFixNlsKey - - NLS Key for fix Message

pFixDefault - - The default fix message

pFixMsgTokens - - Fix message tokens for NLS message

Returns:

a new instance of an ErrorInfo object

createError

public static ErrorInfo createError(java.lang.String pErrorNlsKey,
                                    java.lang.String pErrorDefault,
                                    java.lang.String pFixNlsKey,
                                    java.lang.String pFixDefault,
                                    java.lang.String[][] pFixMsgTokens,
                                    java.lang.String pFixMetalinkId)

Creates a new instance of an ErrorInfo object with the specified attribuets

Parameters:

pErrorNlsKey - - NLS Key for Error Message

pErrorDefault - - The default error message

pFixNlsKey - - NLS Key for fix Message

pFixDefault - - The default fix message

pFixMsgTokens - - Fix message tokens for NLS message

pFixMetalinkId - - Fix MetaLink Note Id

Returns:

a new instance of an ErrorInfo object

createError

public static ErrorInfo createError(java.lang.String pErrorNlsKey,
                                    java.lang.String pErrorDefault,
                                    java.lang.String[][] pErrorMsgTokens,
                                    java.lang.String pFixNlsKey,
                                    java.lang.String pFixDefault,
                                    java.lang.String[][] pFixMsgTokens)

Creates a new instance of an ErrorInfo object with the specified attribuets

Parameters:

pErrorNlsKey - - NLS Key for Error Message

pErrorDefault - - The default error message

pErrorMsgTokens - - Error message tokens for NLS message

pFixNlsKey - - NLS Key for fix Message

pFixDefault - - The default fix message

pFixMsgTokens - - Fix message tokens for NLS message

Returns:

a new instance of an ErrorInfo object

createError

public static ErrorInfo createError(java.lang.String pErrorNlsKey,
                                    java.lang.String pErrorDefault,
                                    java.lang.String[][] pErrorMsgTokens,
                                    java.lang.String pErrorMetalinkId,
                                    java.lang.String pFixNlsKey,
                                    java.lang.String pFixDefault,
                                    java.lang.String[][] pFixMsgTokens,
                                    java.lang.String pFixMetalinkId)

Creates a new instance of an ErrorInfo object with the specified attribuets

Parameters:

pErrorNlsKey - - NLS Key for Error Message

pErrorDefault - - The default error message

pErrorMsgTokens - - Error message tokens for NLS message

pErrorMetalinkId - - MetaLink Note Id

pFixNlsKey - - NLS Key for fix Message

pFixDefault - - The default fix message

pFixMsgTokens - - Fix message tokens for NLS message

pFixMetalinkId - - Fix MetaLink Note Id

Returns:

a new instance of an ErrorInfo object

createWarning

public static ErrorInfo createWarning(java.lang.String pWarningNlsKey,
                                      java.lang.String pWarningDefault,
                                      java.lang.String pFixNlsKey,
                                      java.lang.String pFixDefault)

Creates a new instance of an ErrorInfo object with the specified attribuets

Parameters:

pWarningNlsKey - - NLS Key for Warning Message

pWarningDefault - - The default Warning message

pFixNlsKey - - NLS Key for fix Message

pFixDefault - - The default fix message

Returns:

a new instance of an ErrorInfo object

createWarning

public static ErrorInfo createWarning(java.lang.String pWarningNlsKey,
                                      java.lang.String pWarningDefault,
                                      java.lang.String[][] pWarningMsgTokens,
                                      java.lang.String pFixNlsKey,
                                      java.lang.String pFixDefault)

Creates a new instance of an ErrorInfo object with the specified attribuets

Parameters:

pWarningNlsKey - - NLS Key for Warning Message

pWarningDefault - - The default Warning message

pWarningMsgTokens - - Warning message tokens for NLS message

pFixNlsKey - - NLS Key for fix Message

pFixDefault - - The default fix message

Returns:

a new instance of an ErrorInfo object

createWarning

public static ErrorInfo createWarning(java.lang.String pWarningNlsKey,
                                      java.lang.String pWarningDefault,
                                      java.lang.String[][] pWarningMsgTokens,
                                      java.lang.String pWarningMetalinkId,
                                      java.lang.String pFixNlsKey,
                                      java.lang.String pFixDefault)

Creates a new instance of an ErrorInfo object with the specified attribuets

Parameters:

pWarningNlsKey - - NLS Key for Warning Message

pWarningDefault - - The default Warning message

pWarningMsgTokens - - Warning message tokens for NLS message

pWarningMetalinkId - - MetaLink Note Id

pFixNlsKey - - NLS Key for fix Message

pFixDefault - - The default fix message

Returns:

a new instance of an ErrorInfo object

createWarning

public static ErrorInfo createWarning(java.lang.String pWarningNlsKey,
                                      java.lang.String pWarningDefault,
                                      java.lang.String pFixNlsKey,
                                      java.lang.String pFixDefault,
                                      java.lang.String[][] pFixMsgTokens)

Creates a new instance of an ErrorInfo object with the specified attribuets

Parameters:

pWarningNlsKey - - NLS Key for Warning Message

pWarningDefault - - The default Warning message

pFixNlsKey - - NLS Key for fix Message

pFixDefault - - The default fix message

pFixMsgTokens - - Fix message tokens for NLS message

Returns:

a new instance of an ErrorInfo object

createWarning

public static ErrorInfo createWarning(java.lang.String pWarningNlsKey,
                                      java.lang.String pWarningDefault,
                                      java.lang.String pFixNlsKey,
                                      java.lang.String pFixDefault,
                                      java.lang.String[][] pFixMsgTokens,
                                      java.lang.String pFixMetalinkId)

Creates a new instance of an ErrorInfo object with the specified attribuets

Parameters:

pWarningNlsKey - - NLS Key for Warning Message

pWarningDefault - - The default Warning message

pFixNlsKey - - NLS Key for fix Message

pFixDefault - - The default fix message

pFixMsgTokens - - Fix message tokens for NLS message

pFixMetalinkId - - Fix MetaLink Note Id

Returns:

a new instance of an ErrorInfo object

createWarning

public static ErrorInfo createWarning(java.lang.String pWarningNlsKey,
                                      java.lang.String pWarningDefault,
                                      java.lang.String[][] pWarningMsgTokens,
                                      java.lang.String pFixNlsKey,
                                      java.lang.String pFixDefault,
                                      java.lang.String[][] pFixMsgTokens)

Creates a new instance of an ErrorInfo object with the specified attribuets

Parameters:

pWarningNlsKey - - NLS Key for Warning Message

pWarningDefault - - The default Warning message

pWarningMsgTokens - - Warning message tokens for NLS message

pFixNlsKey - - NLS Key for fix Message

pFixDefault - - The default fix message

pFixMsgTokens - - Fix message tokens for NLS message

Returns:

a new instance of an ErrorInfo object

createWarning

public static ErrorInfo createWarning(java.lang.String pWarningNlsKey,
                                      java.lang.String pWarningDefault,
                                      java.lang.String[][] pWarningMsgTokens,
                                      java.lang.String pWarningMetalinkId,
                                      java.lang.String pFixNlsKey,
                                      java.lang.String pFixDefault,
                                      java.lang.String[][] pFixMsgTokens,
                                      java.lang.String pFixMetalinkId)

Creates a new instance of an ErrorInfo object with the specified attribuets

Parameters:

pWarningNlsKey - - NLS Key for Warning Message

pWarningDefault - - The default Warning message

pWarningMsgTokens - - Warning message tokens for NLS message

pWarningMetalinkId - - MetaLink Note Id

pFixNlsKey - - NLS Key for fix Message

pFixDefault - - The default fix message

pFixMsgTokens - - Fix message tokens for NLS message

pFixMetalinkId - - Fix MetaLink Note Id

Returns:

a new instance of an ErrorInfo object

createLinkToken

public static LinkToken createLinkToken()

Create a new LinkToken object

Returns:

a new instance of an empty LinkToken

createLinkToken

public static LinkToken createLinkToken(java.lang.String pTokenName,
                                        Message pMessage)

Create a LinkToken with given name and Message (link)

Parameters:

pTokenName - Name for the LinkToken

pMessage - Message that contains the link

Returns:

New LinkToken

createLinkTokenForSupportNote

public static LinkToken createLinkTokenForSupportNote(java.lang.String pTokenName,
                                                      java.lang.String pSupportNoteId)

A convenience API that will internally create a Message with the Note ID with the link to Support defined

Parameters:

pTokenName - Name for the LinkToken

pSupportNoteId - Message that contains the link

Returns:

New LinkToken

createLinkTokenForMetalinkNote

@Deprecated
public static LinkToken createLinkTokenForMetalinkNote(java.lang.String pTokenName,
                                                                  java.lang.String pMetalinkNoteId)

Deprecated. please use createLinkTokenForSupportNote(String pTokenName, String pSupportNoteId)