com.aspc.commander.sql.results

Interface CommandBuildResultsPlugin

All Known Implementing Classes:

AddContactCommand, AddOnlineMemberCommand, AddRemoveContactCategoryCommand, AddWebOrder, AdminLoginResetCommand, ArtworkCommand, BestRowIdentifierCommand, BlankCommand, CacheCommand, CatalogCommand, CheckDirectDebitStatusCommand, CheckWorkHours, ColumnPrivilegesCommand, ColumnsCommand, CommitCommand, ConvertDBEmailToTask, ConvertSmegDBEmailToTask, CopyCommand, CopyTaskTemplate, CreateComponentCommand, CreateEmailCommand, CreateOrderCommand, CreatePurchaseOrderCommand, CreateSalesCycleCommand, CreateTaskCommand, CreditInvoiceCommand, CrossReferenceCommand, DBLogicalLockCommand, DeleteCommand, DeleteQuoteProduct, DeletProduct, DiscoverCommand, DroidCommand, EditionCommand, EmailCheckCommand, EmailScreenCommand, EventRegistrationCommand, EwayCreditProcessingCommand, ExportCommand, ExportedKeysCommand, ExtMyobInitialSync, FileCommand, FileSyncCommand, FileSyncManualCommand, ForgotPasswdCommand, GenerateTaskSeriesCommand, GetConferenceCommand, GetOnlineMemberCommand, HealthCommand, ICalendarCommand, ImportCommand, ImportCommand, ImportedKeysCommand, IndexInfoCommand, InsertCommand, InvoiceCommand, JobCommand, JobDailyReport, JobWeeklyReport, LoadEmployerDeductionCommand, LogCommand, LogLocationErrorCommand, MagicCommand, MapCommand, MemberRenewalCommand, MemberRsvpEventCommand, MembershipAuditCommand, MemoryCommand, MergeCommand, MessageCommand, MoveComponentCommand, MYOBImportCommand, NotifyCommand, OnlineAccountCommand, PasswdCommand, PreferenceCommand, PrimaryKeysCommand, ProcedureColumnsCommand, ProceduresCommand, ProcessCommand, ProcessDirectDebitCommand, ProcessEmailSend, ProductItemRecurringCommand, PullLDArtworks, RaiseEventCommand, RecordNoticeSentCommand, RecordOnlineSub, RecordValidateCommand, ReindexFilesCommand, ReloadCommand, RenewalCommand, ReportCommand, RestCommand, RetrieveLogCommand, ReverseCommand, ReverseCreditEftosBatch, RollbackCommand, RunMembershipAccountingFigures, RunMembershipAccountingFiguresV2, SavePointCommand, ScanRFQTSDocsFolder, SchedulerPreferencesCommand, SchemaCommand, SelectCommand, SendActivityReport, SendEmailPage, SendEmailPageV2, SendNoticeCommand, SendSmsCommand, SequenceCommand, ShutdownCommand, SiteSpiderCommand, SleepCommand, SleepTestCommand, SnapToCommand, SplitBuildPestReport, SQLCommand, SqlPagingCommand, StatsPartCommand, StoredResultCommand, StoreWordsCommand, SuperTablesCommand, SuperTypesCommand, SyncCommand, TablePrivilegesCommand, TablesCommand, TaskCommand, TasksByStatusChart, TaskStatusJournalChart, TasksWinLoseChart, TaskTagsCommand, TeamJobWeeklyReport, TransactionCommand, TransactionLogCommand, UpdateCommand, UpdateCreditCardDetailsCommand, UpdateKeywordCommand, UpdateMembersCommand, UpdateOnlineMemberCommand, UpdatePaymentStatusCommand, ValidateCommand, VCardCommand, VersionColumnsCommand, WordsExtractorCommand

public interface CommandBuildResultsPlugin

Provides methods to allow generation of results in xml for a command
THREAD MODE: SINGLE THREADED command

Since:

May 18 2005

Author:

Jason McGrath

Method Summary

Modifier and Type	Method and Description
java.lang.String	getColumnName(int col) Not mandatory to supply a key for the row as well.
java.lang.String	getColumnType(int col) get the column type
java.lang.String	getCursorName() Returns the name for the current cursor
java.lang.String	getRawTitle() Returns the title of the cursor
java.lang.String	getRecordID(int row) We are at the last row when we return null for the record ID.
java.lang.String	getRecordKey(int row) record key
java.lang.Object	getValue(int row, int col) The value for this column/row
boolean	isExecuteOnly() is this defined ( JDBC spec) to be execute only

Method Detail

getRecordID

java.lang.String getRecordID(@Nonnegative
                             int row)

We are at the last row when we return null for the record ID. All rows must have a unique ID. Nothing else is assumed about a record ID other than it is unique and will return the same value at a later time.

Parameters:

row - The row number ( offset from 1)

Returns:

The record ID

getRecordKey

java.lang.String getRecordKey(int row)

record key

Parameters:

row - The row number ( offset from 1)

Returns:

The record key

getColumnName

java.lang.String getColumnName(int col)

Not mandatory to supply a key for the row as well. If not the ID will be used.

Parameters:

col - The column number ( offset from 1)

Returns:

The column name

getColumnType

java.lang.String getColumnType(int col)
                        throws java.lang.Exception

get the column type

Parameters:

col - The column number ( offset from 1)

Returns:

The column name

Throws:

java.lang.Exception - A serious problem

getValue

java.lang.Object getValue(int row,
                          int col)
                   throws java.lang.Exception

The value for this column/row

Parameters:

row - The row number ( offset from 1)

col - The column number ( offset from 1)

Returns:

The value

Throws:

java.lang.Exception - A serious problem

getCursorName

java.lang.String getCursorName()
                        throws java.lang.Exception

Returns the name for the current cursor

Returns:

The value

Throws:

java.lang.Exception - A serious problem

getRawTitle

java.lang.String getRawTitle()
                      throws java.lang.Exception

Returns the title of the cursor

Returns:

The value

Throws:

java.lang.Exception - A serious problem

isExecuteOnly

boolean isExecuteOnly()

is this defined ( JDBC spec) to be execute only

Returns:

true if execute only