com.bmc.arsys.pluginsvr.plugins
Interface ARDBCPluggable

All Superinterfaces:

ARPluggable

All Known Implementing Classes:

ARDBCPlugin

public interface ARDBCPluggable
extends ARPluggable

Method Summary

void	cancel(ARPluginContext context, long transId) Cancel the given transaction
void	commit(ARPluginContext context, long transId) Commit the given transaction in the external datasouce
String	createEntry(ARPluginContext context, String tableName, List<ARVendorField> fieldsList, long transId, com.bmc.arsys.api.Entry entry) Create an entry in the given table for external data source.
void	deleteEntry(ARPluginContext context, String tableName, List<ARVendorField> fieldsList, long transId, String entryId) Given the table name and entry id, delete the entry from the table in the external data source
com.bmc.arsys.api.AttachmentValue	getBLOB(ARPluginContext context, String tableName, List<ARVendorField> fieldsList, long transId, String entryId, int fieldId) Given the table name, entry id and the blob field id, fetch the blob from that field in that table for that entry
com.bmc.arsys.api.Entry	getEntry(ARPluginContext context, String tableName, List<ARVendorField> fieldsList, long transId, String entryId, int[] idList) Given the table name, list of fields and entry id, fetch the entry from the external data source.
List<com.bmc.arsys.api.StatisticsResultInfo>	getEntryStatistics(ARPluginContext context, String tableName, List<ARVendorField> fieldsList, long transId, com.bmc.arsys.api.QualifierInfo qualifier, com.bmc.arsys.api.ArithmeticOrRelationalOperand target, int statistic, int[] groupByList) Return the entry statistics for the given table and qualification.
List<com.bmc.arsys.api.Entry>	getListEntryWithFields(ARPluginContext context, String tableName, List<ARVendorField> fieldsList, long transId, com.bmc.arsys.api.QualifierInfo qualifier, List<com.bmc.arsys.api.SortInfo> sortList, List<com.bmc.arsys.api.EntryListFieldInfo> getListFields, int startAt, int maxRetrieve, com.bmc.arsys.api.OutputInteger numMatches) Given the table name, a qualification, and list of fields to fetch the values for, return a list of entries with all fields and their values that meet the given qualification.
List<com.bmc.arsys.api.VendorForm>	getListForms(ARPluginContext context) Return the list of forms/tables that needs to be exposed to the AR Server.
List<ARVendorField>	getMultipleFields(ARPluginContext context, com.bmc.arsys.api.VendorForm schema) Given the Vendor form details, return it's list of fields with all their properties
void	rollback(ARPluginContext context, long transId) Rollback the given transaction in the external datasource.
void	setBLOB(ARPluginContext context, String tableName, List<ARVendorField> fieldsList, long transId, String entryId, int fieldId, com.bmc.arsys.api.AttachmentValue info) Given the table, entry and the blob field id, insert the blob into the external datasource table
void	setEntry(ARPluginContext context, String tableName, List<ARVendorField> fieldsList, long transId, String entryId, com.bmc.arsys.api.Entry entry, com.bmc.arsys.api.Timestamp getTimestamp) Given the table name, and entry object, modify the entry recognized by the entry key of the entry object in the external datasource.

Methods inherited from interface com.bmc.arsys.pluginsvr.plugins.ARPluggable

initialize, onEvent, terminate

Method Detail

createEntry

String createEntry(ARPluginContext context,
                   String tableName,
                   List<ARVendorField> fieldsList,
                   long transId,
                   com.bmc.arsys.api.Entry entry)
                   throws com.bmc.arsys.api.ARException

Create an entry in the given table for external data source. Called on a creation of a new entry in the AR Vendor form based on this table from the external datasource.

Parameters:

context - Current context for this plugin call, like username etc.

tableName - table name

fieldsList - list of fields on the form and its datatypes etc.

transId - transaction id

entry - the entry object with all field value pairs

Returns:

String object with the entry id for the newly created entry.

Throws:

com.bmc.arsys.api.ARException - with a list of StatusInfo objects in it that can be passed on to the server

getEntry

com.bmc.arsys.api.Entry getEntry(ARPluginContext context,
                                 String tableName,
                                 List<ARVendorField> fieldsList,
                                 long transId,
                                 String entryId,
                                 int[] idList)
                                 throws com.bmc.arsys.api.ARException

Given the table name, list of fields and entry id, fetch the entry from the external data source.

Parameters:

context - Current context for this plugin call, like username etc.

tableName - table name

fieldsList - list of fields on the form and its datatypes etc.

transId - transaction id

entryId - String object with the id for the entry to fetch

idList - list of field ids to fetch the values for in the entry

Returns:

Entry object with a list of field value pair

Throws:

com.bmc.arsys.api.ARException

setEntry

void setEntry(ARPluginContext context,
              String tableName,
              List<ARVendorField> fieldsList,
              long transId,
              String entryId,
              com.bmc.arsys.api.Entry entry,
              com.bmc.arsys.api.Timestamp getTimestamp)
              throws com.bmc.arsys.api.ARException

Given the table name, and entry object, modify the entry recognized by the entry key of the entry object in the external datasource.

Parameters:

context - Current context for this plugin call, like username etc.

tableName - table name

fieldsList - list of fields on the form and its datatypes etc.

transId - transaction id

entryId - entry id for entry to set

entry - entry object with new field value pairs to modify the entry

getTimestamp - Timestamp for last modified time to recognize entries to modify

Throws:

com.bmc.arsys.api.ARException

deleteEntry

void deleteEntry(ARPluginContext context,
                 String tableName,
                 List<ARVendorField> fieldsList,
                 long transId,
                 String entryId)
                 throws com.bmc.arsys.api.ARException

Given the table name and entry id, delete the entry from the table in the external data source

Parameters:

context - Current context for this plugin call, like username etc.

tableName - table name

fieldsList - list of fields on the form and its datatypes etc.

transId - transaction id

entryId - String object iding the entry in the table

Throws:

com.bmc.arsys.api.ARException

getBLOB

com.bmc.arsys.api.AttachmentValue getBLOB(ARPluginContext context,
                                          String tableName,
                                          List<ARVendorField> fieldsList,
                                          long transId,
                                          String entryId,
                                          int fieldId)
                                          throws com.bmc.arsys.api.ARException

Given the table name, entry id and the blob field id, fetch the blob from that field in that table for that entry

Parameters:

context - Current context for this plugin call, like username etc.

tableName - table name

fieldsList - list of fields on the form and its datatypes etc.

transId - transaction id

entryId - String object iding the entry in the table

fieldId - Fieldid to fetch the blob object from

Returns:

An AttachmentValue object with the blob in it.

Throws:

com.bmc.arsys.api.ARException

setBLOB

void setBLOB(ARPluginContext context,
             String tableName,
             List<ARVendorField> fieldsList,
             long transId,
             String entryId,
             int fieldId,
             com.bmc.arsys.api.AttachmentValue info)
             throws com.bmc.arsys.api.ARException

Given the table, entry and the blob field id, insert the blob into the external datasource table

Parameters:

context - Current context for this plugin call, like username etc.

tableName - table name

fieldsList - list of fields on the form and its datatypes etc.

transId - transaction id

entryId - String object iding the entry in the table

fieldId - Fieldid to fetch the blob object from

info - AttachmentValue object with the blob to set.

Throws:

com.bmc.arsys.api.ARException

getListEntryWithFields

List<com.bmc.arsys.api.Entry> getListEntryWithFields(ARPluginContext context,
                                                     String tableName,
                                                     List<ARVendorField> fieldsList,
                                                     long transId,
                                                     com.bmc.arsys.api.QualifierInfo qualifier,
                                                     List<com.bmc.arsys.api.SortInfo> sortList,
                                                     List<com.bmc.arsys.api.EntryListFieldInfo> getListFields,
                                                     int startAt,
                                                     int maxRetrieve,
                                                     com.bmc.arsys.api.OutputInteger numMatches)
                                                     throws com.bmc.arsys.api.ARException

Given the table name, a qualification, and list of fields to fetch the values for, return a list of entries with all fields and their values that meet the given qualification.

Parameters:

context - Current context for this plugin call, like username etc.

tableName - table name

fieldsList - list of fields on the form and its datatypes etc.

transId - transaction id

qualifier - QualifierInfo for the qualification

sortList - SortInfo for the sort orders

getListFields - list of fields to fetch values for

startAt - starting record

maxRetrieve - max number of records to fetch

numMatches - OutputInteger to be returned with number of records that actually matched the qual

Returns:

list of Entry objects that satisfy the qualification

Throws:

com.bmc.arsys.api.ARException

commit

void commit(ARPluginContext context,
            long transId)
            throws com.bmc.arsys.api.ARException

Commit the given transaction in the external datasouce

Parameters:

context - Current context for this plugin call, like username etc.

transId - transaction id

Throws:

com.bmc.arsys.api.ARException

rollback

void rollback(ARPluginContext context,
              long transId)
              throws com.bmc.arsys.api.ARException

Rollback the given transaction in the external datasource.

Parameters:

context - Current context for this plugin call, like username etc.

transId - transaction id

Throws:

com.bmc.arsys.api.ARException

cancel

void cancel(ARPluginContext context,
            long transId)
            throws com.bmc.arsys.api.ARException

Cancel the given transaction

Parameters:

context - Current context for this plugin call, like username etc.

transId - transaction id

Throws:

com.bmc.arsys.api.ARException

getListForms

List<com.bmc.arsys.api.VendorForm> getListForms(ARPluginContext context)
                                                throws com.bmc.arsys.api.ARException

Return the list of forms/tables that needs to be exposed to the AR Server. The forms are represented by the VendorForm objects.

Parameters:

context - Current context for this plugin call, like username etc.

Returns:

List of VenforForm objects to expose

Throws:

com.bmc.arsys.api.ARException

getMultipleFields

List<ARVendorField> getMultipleFields(ARPluginContext context,
                                      com.bmc.arsys.api.VendorForm schema)
                                      throws com.bmc.arsys.api.ARException

Given the Vendor form details, return it's list of fields with all their properties

Parameters:

context - Current context for this plugin call, like username etc.

schema - VendorForm object with details about the form

Returns:

List of fields for the table with details for each field

Throws:

com.bmc.arsys.api.ARException

getEntryStatistics

List<com.bmc.arsys.api.StatisticsResultInfo> getEntryStatistics(ARPluginContext context,
                                                                String tableName,
                                                                List<ARVendorField> fieldsList,
                                                                long transId,
                                                                com.bmc.arsys.api.QualifierInfo qualifier,
                                                                com.bmc.arsys.api.ArithmeticOrRelationalOperand target,
                                                                int statistic,
                                                                int[] groupByList)
                                                                throws com.bmc.arsys.api.ARException

Return the entry statistics for the given table and qualification.

Parameters:

context - Current context for this plugin call, like username etc.

tableName - table name

fieldsList - list of fields on the form and its datatypes etc.

transId - transaction id

qualifier - QualifierInfo for the qualification

target - Operation for the statistics

statistic - the type of statistic

groupByList - list of fields to group by

Returns:

StatisticsResultInfo that has the statistics

Throws:

com.bmc.arsys.api.ARException