|
AR System Java Plug-in API | |||||||||
| PREV NEXT | FRAMES NO FRAMES | |||||||||
| Uses of ARPluginContext in com.bmc.arsys.pluginsvr.plugins |
|---|
| Methods in com.bmc.arsys.pluginsvr.plugins with parameters of type ARPluginContext | |
|---|---|
boolean |
AREAPluggable.areaNeedSync(ARPluginContext context)
Allows the plug-in to tell the AR Server that the user information in its cache is invalid. |
abstract boolean |
AREAPlugin.areaNeedSync(ARPluginContext context)
|
AREAResponse |
AREAPluggable.areaVerifyLogin(ARPluginContext context,
String user,
String password,
String networkAddress,
String authString)
The plug-in server issues this call when the AR Server makes a request to authenticate a user. |
abstract AREAResponse |
AREAPlugin.areaVerifyLogin(ARPluginContext context,
String user,
String password,
String networkAddress,
String authString)
|
void |
ARDBCPluggable.cancel(ARPluginContext context,
long transId)
Cancel the given transaction |
void |
ARDBCPlugin.cancel(ARPluginContext context,
long transId)
|
void |
ARDBCPluggable.commit(ARPluginContext context,
long transId)
Commit the given transaction in the external datasouce |
void |
ARDBCPlugin.commit(ARPluginContext context,
long transId)
|
String |
ARDBCPluggable.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. |
String |
ARDBCPlugin.createEntry(ARPluginContext context,
String tableName,
List<ARVendorField> fieldsList,
long transId,
com.bmc.arsys.api.Entry entry)
|
void |
ARDBCPluggable.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 |
void |
ARDBCPlugin.deleteEntry(ARPluginContext context,
String tableName,
List<ARVendorField> fieldsList,
long transId,
String entryId)
|
List<com.bmc.arsys.api.Value> |
ARFilterAPIPluggable.filterAPICall(ARPluginContext context,
List<com.bmc.arsys.api.Value> pInValues)
Given a set of input values, process it and return a list of output values. |
abstract List<com.bmc.arsys.api.Value> |
ARFilterAPIPlugin.filterAPICall(ARPluginContext context,
List<com.bmc.arsys.api.Value> pInValues)
|
com.bmc.arsys.api.AttachmentValue |
ARDBCPluggable.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.AttachmentValue |
ARDBCPlugin.getBLOB(ARPluginContext context,
String tableName,
List<ARVendorField> fieldsList,
long transId,
String entryId,
int fieldId)
|
com.bmc.arsys.api.Entry |
ARDBCPluggable.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. |
com.bmc.arsys.api.Entry |
ARDBCPlugin.getEntry(ARPluginContext context,
String tableName,
List<ARVendorField> fieldsList,
long transId,
String entryId,
int[] idList)
|
List<com.bmc.arsys.api.StatisticsResultInfo> |
ARDBCPluggable.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.StatisticsResultInfo> |
ARDBCPlugin.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)
|
List<com.bmc.arsys.api.Entry> |
ARDBCPluggable.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.Entry> |
ARDBCPlugin.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)
|
List<com.bmc.arsys.api.VendorForm> |
ARDBCPluggable.getListForms(ARPluginContext context)
Return the list of forms/tables that needs to be exposed to the AR Server. |
List<com.bmc.arsys.api.VendorForm> |
ARDBCPlugin.getListForms(ARPluginContext context)
|
List<ARVendorField> |
ARDBCPluggable.getMultipleFields(ARPluginContext context,
com.bmc.arsys.api.VendorForm schema)
Given the Vendor form details, return it's list of fields with all their properties |
List<ARVendorField> |
ARDBCPlugin.getMultipleFields(ARPluginContext context,
com.bmc.arsys.api.VendorForm schema)
|
void |
ARPluggable.initialize(ARPluginContext context)
An initialization routine called once at startup load time for each plugin that is loaded. |
void |
ARPlugin.initialize(ARPluginContext context)
|
void |
ARPluggable.onEvent(ARPluginContext context,
int pEventID)
Methods to handle events from the AR Server. |
void |
ARPlugin.onEvent(ARPluginContext context,
int pEventID)
|
void |
ARDBCPluggable.rollback(ARPluginContext context,
long transId)
Rollback the given transaction in the external datasource. |
void |
ARDBCPlugin.rollback(ARPluginContext context,
long transId)
|
void |
ARDBCPluggable.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 |
ARDBCPlugin.setBLOB(ARPluginContext context,
String tableName,
List<ARVendorField> fieldsList,
long transId,
String entryId,
int fieldId,
com.bmc.arsys.api.AttachmentValue info)
|
void |
ARDBCPluggable.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. |
void |
ARDBCPlugin.setEntry(ARPluginContext context,
String tableName,
List<ARVendorField> fieldsList,
long transId,
String entryId,
com.bmc.arsys.api.Entry entry,
com.bmc.arsys.api.Timestamp getTimestamp)
|
void |
ARPluggable.terminate(ARPluginContext context)
A clean up method called on a plugin unload or plugin server termination for the plugin to cleanup after itself. |
void |
ARPlugin.terminate(ARPluginContext context)
|
|
AR System Java Plug-in API | |||||||||
| PREV NEXT | FRAMES NO FRAMES | |||||||||