Skip navigation links
C D E F G H I M N O P R S T U V 

C

close() - Method in class DBCSQLQuery
This function closes the internal resultset.
commit() - Method in class DBCSQLConnection
Commits the transaction.
commitIfInTransaction() - Method in class DBCSQLConnection
Convenience function to commit a transaction safely.

D

DBCDBOutQueuePrimaryValues - Class in <Unnamed>
An instance of this class uniquely identifies a single record of the table from which a message is generated.
DBCDBOutQueuePrimaryValues() - Constructor for class DBCDBOutQueuePrimaryValues
 
DBCDBOutQueuePrimaryValues(I_GemDBOutQueuePrimaryValues) - Constructor for class DBCDBOutQueuePrimaryValues
For internal use.
DBCDBPlugin_3 - Interface in <Unnamed>
This class is the interface to be implemented by database-access plugins.
DBCGenericPlugin_1 - Interface in <Unnamed>
This class is the interface to implement for all non-database-access plugins.
DBCInSMSPacket - Class in <Unnamed>
An instance of this class holds the information for a single received SMS Message.
DBCInSMSPacket() - Constructor for class DBCInSMSPacket
 
DBCInSMSPacket(I_GemInSMSPacket) - Constructor for class DBCInSMSPacket
For internal use.
DBCInStatusReport - Class in <Unnamed>
An instance of this class holds the information for a single received Status Report (aka Delivery Report).
DBCInStatusReport() - Constructor for class DBCInStatusReport
 
DBCInStatusReport(I_GemInStatusReport) - Constructor for class DBCInStatusReport
For internal use.
DBCMessageCategory - Enum in <Unnamed>
The category of the message.
DBCMessageSendStatusType - Class in <Unnamed>
An enumerated type representing the status of a send.
DBCOutSMSPacket - Class in <Unnamed>
This object holds the information for one or a concatenated set of outbound SMS messages.
DBCOutSMSPacket() - Constructor for class DBCOutSMSPacket
 
DBCPluginUtils - Class in <Unnamed>
 
DBCPluginUtils(I_GemGenericPluginAdaptor_1) - Constructor for class DBCPluginUtils
 
DBCSendSMSResult - Class in <Unnamed>
 
DBCSendSMSResult() - Constructor for class DBCSendSMSResult
 
DBCSQLConnection - Class in <Unnamed>
This class is a wrapper for java.sql.Connection.
DBCSQLConnection(I_djSQLConnection) - Constructor for class DBCSQLConnection
This constructor is for internal use, and should not be used by developers.
DBCSQLConnectionTarget - Class in <Unnamed>
This class is used by plugins to indicate a target database to the connection pool.
DBCSQLConnectionTarget(String, String, String, String, String) - Constructor for class DBCSQLConnectionTarget
The constructor for developers to create this object.
DBCSQLQuery - Class in <Unnamed>
This function wraps a java.sql.Connection, java.sql.Statement and java.sql.ResultSet into a single object for convenience.
DBCSQLQuery() - Constructor for class DBCSQLQuery
This constructor creates a DBCSQLQuery object using the default target.
DBCSQLQuery(DBCSQLConnectionTarget) - Constructor for class DBCSQLQuery
This constructor creates a DBCSQLQuery object using the specified target.
DBCSQLQuery(DBCSQLConnection) - Constructor for class DBCSQLQuery
This constructor creates a DBCSQLQuery object using the specified connection.
DBCSQLQuery(I_djSQLQuery) - Constructor for class DBCSQLQuery
This constructor is for internal use and should not be used by developers.

E

ErrorMessage - Variable in class DBCSendSMSResult
A textual message that provides more details.
execSql(String) - Method in class DBCSQLQuery
This function executes an sql statement that does not return a resultset.

F

Failed - Static variable in class DBCMessageSendStatusType
This result means that the message send failed, and should not be retried.
first() - Method in class DBCSQLQuery
Positions the cursor on the first record of the resultset.
free() - Method in class DBCSQLQuery
Relinquishes the database connection, ie, sends the connection back to the connection pool provided it is not being shared with another DBCSQLQuery.

G

getBlob(String) - Method in class DBCSQLQuery
 
getBoolean(String) - Method in class DBCSQLQuery
Gets the data of the specified column/field as a boolean value.
getByte(String) - Method in class DBCSQLQuery
Gets the data of the specified column/field as a byte value.
getClob(String) - Method in class DBCSQLQuery
 
getColumnCount() - Method in class DBCSQLQuery
Gets the number of columns in the resultset.
getColumnName(int) - Method in class DBCSQLQuery
Gets the name of the nth column in the resultset.
getColumnType(int) - Method in class DBCSQLQuery
Gets the type of the nth column in the resultset.
getConcatenationMessageNo() - Method in class DBCInSMSPacket
The number representing which part of the concatenated SMS.
getConcatenationReferenceNo() - Method in class DBCInSMSPacket
A reference number that is the same in all parts of a concatenated SMS.
getConcatenationTotalNoOfMessages() - Method in class DBCInSMSPacket
The total number of SMS parts that make up the whole message.
getConnectionString() - Method in class DBCSQLConnectionTarget
Returns the value provided to the constructor.
getContent() - Method in class DBCInSMSPacket
The text content of the message
getContent() - Method in class DBCOutSMSPacket
The text content of the message to be sent.
getDate(String) - Method in class DBCSQLQuery
Gets the data of the specified column/field as a Date value.
getDBConnection() - Method in class DBCSQLQuery
Gets the internal connection associated with this query.
getDoneDate() - Method in class DBCInStatusReport
The date and time that the specified status was reached.
getDouble(String) - Method in class DBCSQLQuery
Gets the data of the specified column/field as an double value.
getExemptionSqlForOnePendingRequest(DBCDBOutQueuePrimaryValues) - Method in interface DBCDBPlugin_3
This event should return the sql clause part that exempts the record specified by the parameter.
getFloat(String) - Method in class DBCSQLQuery
Gets the data of the specified column/field as a float value.
getFromPhoneNo() - Method in class DBCInSMSPacket
The source phone number (MO)
getFromPhoneNo() - Method in class DBCInStatusReport
The phone number to which the original message was sent to.
getInt(String) - Method in class DBCSQLQuery
Gets the data of the specified column/field as an int value.
getInternalConnection() - Method in class DBCSQLConnection
For internal use.
getInternalData() - Method in class DBCDBOutQueuePrimaryValues
For internal use.
getInternalData() - Method in class DBCInSMSPacket
For internal use.
getInternalData() - Method in class DBCInStatusReport
For internal use.
getInternalData() - Method in class DBCOutSMSPacket
For internal use.
getInternalTarget() - Method in class DBCSQLConnectionTarget
Developers must not call this function.
getIsUnicode() - Method in class DBCInSMSPacket
Boolean parameter indicating true if the text content used the unicode characterset.
getLoggingComment() - Method in class DBCOutSMSPacket
Any comment regarding this message that should be put into the Sent Logs alongwith this message.
getLong(String) - Method in class DBCSQLQuery
Gets the data of the specified column/field as an long value.
getMessageCategory() - Method in class DBCOutSMSPacket
 
getMessageCategoryEnum(String) - Static method in enum DBCMessageCategory
This function converts a string to its corresponding enumerated type.
getMessageID() - Method in class DBCInStatusReport
The MessageID of the original sent message.
getName() - Method in class DBCMessageSendStatusType
Gets the user-friendly name of this type.
getName() - Method in class DBCSQLConnectionTarget
Returns the name provided to the constructor.
getNoOfRecordsAffected() - Method in class DBCSQLQuery
Returns the number of records that were updated or deleted by the last UPDATE or DELETE statement executed through this object's execSql function.
getPacketFromCurrentRecord(DBCSQLQuery) - Method in interface DBCDBPlugin_3
This event is called when the system needs to extract SMS packet information from the current database record.
getPassword() - Method in class DBCSQLConnectionTarget
Returns the value provided to the constructor.
getPhoneNo() - Method in class DBCOutSMSPacket
The destination phone number.
getPluginUserDefinedName() - Method in class DBCOutSMSPacket
The name of the plugin that generated this packet.
getPollSqlStatement(String) - Method in interface DBCDBPlugin_3
This function should return the sql statement that will then be used to query the database.
getPrimaryField1() - Method in class DBCDBOutQueuePrimaryValues
 
getPrimaryField2() - Method in class DBCDBOutQueuePrimaryValues
 
getPrimaryField3() - Method in class DBCDBOutQueuePrimaryValues
 
getPrimaryField4() - Method in class DBCDBOutQueuePrimaryValues
 
getPrimaryField5() - Method in class DBCDBOutQueuePrimaryValues
 
getPrimaryField6() - Method in class DBCDBOutQueuePrimaryValues
 
getPrimaryField7() - Method in class DBCDBOutQueuePrimaryValues
 
getPrimaryField8() - Method in class DBCDBOutQueuePrimaryValues
 
getPrimaryField9() - Method in class DBCDBOutQueuePrimaryValues
 
getPrimaryValuesFromCurrentRecord(DBCSQLQuery) - Method in interface DBCDBPlugin_3
This event is used to extract identifying information from the record.
getRecordCount() - Method in class DBCSQLQuery
Gets the number of records in the resultset.
getRequestReceipt() - Method in class DBCOutSMSPacket
This field should be set to true if you want the remote server to send back a status report
getSendAsFlash() - Method in class DBCOutSMSPacket
This field should be set to true if you want the message to be sent as a 'flash' message
getSenderName() - Method in class DBCOutSMSPacket
The sendername or shortcode to be displayed as the 'From' of the message.
getSenderNameIsAlpha() - Method in class DBCOutSMSPacket
Set this field should be true if an alphanumeric sendername is specified in the DBCOutSMSPacket.setSenderName(java.lang.String) field.
getStatusReportStatus() - Method in class DBCInStatusReport
The status of the message.
getString(String) - Method in class DBCSQLQuery
Gets the data of the specified column/field as a String.
getSubmitDate() - Method in class DBCInStatusReport
The submission date and time of the original message.
getSuppressContentInLog() - Method in class DBCOutSMSPacket
 
getToShortCode() - Method in class DBCInSMSPacket
The shortcode to which this message was originally sent, ie, the 'To' field.
getToShortCode() - Method in class DBCInStatusReport
The shortcode or sendername from which the original message was sent.
getUserName() - Method in class DBCSQLConnectionTarget
Returns the value provided to the constructor.
gotoRecordForRowNo(int) - Method in class DBCSQLQuery
Navigates to the nth record of the resultset.

H

handleReceivedSMS(DBCInSMSPacket) - Method in interface DBCDBPlugin_3
This event is called when the system receives an incoming (MO) SMS message.
handleReceivedSMS(DBCInSMSPacket) - Method in interface DBCGenericPlugin_1
This event is called when the system receives an incoming (MO) SMS message.
handleReceivedStatusReport(DBCInStatusReport) - Method in interface DBCDBPlugin_3
This event is called when the system receives an incoming Status Report (Receipt).
handleReceivedStatusReport(DBCInStatusReport) - Method in interface DBCGenericPlugin_1
This event is called when the system receives an incoming Status Report (Receipt).
handleSendResponse(DBCMessageSendStatusType, DBCDBOutQueuePrimaryValues, String) - Method in interface DBCGenericPlugin_1
This function should be implemented by descendents to know the status of a previous sms send request (that was performed through a call to the DBCPluginUtils.sendSMS(DBCOutSMSPacket, DBCDBOutQueuePrimaryValues) function.
handleShutdown() - Method in interface DBCGenericPlugin_1
This event is fired on a shutdown of the plugin, typically on a system shutdown or restart.

I

init(String, String, String, String, String, String, String, String, String, String) - Method in interface DBCDBPlugin_3
This event is called for the plugin to initialize itself.
init(DBCPluginUtils, String, String, String, String, String, String, String, String, String, String) - Method in interface DBCGenericPlugin_1
This event is called for the plugin to initialize itself.
InQueue - Static variable in class DBCMessageSendStatusType
This result means that the message send failed, but the message should be placed back into the queue.
isEOF() - Method in class DBCSQLQuery
Call this function to determine whether the cursor is on the last record of the resultset.
isInTransaction() - Method in class DBCSQLConnection
Function to determine whether a transaction is in force.
isOutgoingPathAvailable() - Method in class DBCPluginUtils
This function determines the current status of the link to the external server.

M

MessageID - Variable in class DBCSendSMSResult
The ID returned by the server for that message.

N

next() - Method in class DBCSQLQuery
Positions the cursor on the next record of the resultset, unless there are no more records, or the resultset is empty.

O

open(String) - Method in class DBCSQLQuery
This function executes an sql statement that returns a resultset.
open(String, boolean) - Method in class DBCSQLQuery
The same features as the open(String) except the inclusion of the paOldStyle parameter.

P

pluginHasShutdown() - Method in class DBCPluginUtils
This function should be called by plugin developers to signal the system that the plugin has shutdown.

R

RetryQueue - Static variable in class DBCMessageSendStatusType
This result means that the message send failed, but the message should be placed back into the queue.
rollback() - Method in class DBCSQLConnection
Rolls back a transaction.
rollbackIfInTransaction() - Method in class DBCSQLConnection
Convenience function to rollback a transaction safely.

S

sendSMS(DBCOutSMSPacket, DBCDBOutQueuePrimaryValues) - Method in class DBCPluginUtils
This function should be called by the developer when an outbound message needs to be sent by the plugin.
sendSMSAndWaitForResponse(DBCOutSMSPacket, DBCDBOutQueuePrimaryValues, long) - Method in class DBCPluginUtils
This function can be called by the developer when an outbound message needs to be sent by the plugin.
SendStatus - Variable in class DBCSendSMSResult
This enumerated type contains the response from the server.
Sent - Static variable in class DBCMessageSendStatusType
This result means that the message send was successful.
setContent(String) - Method in class DBCOutSMSPacket
The text content of the message to be sent.
setLoggingComment(String) - Method in class DBCOutSMSPacket
Any comment regarding this message that should be put into the Sent Logs alongwith this message.
setMessageCategory(DBCMessageCategory) - Method in class DBCOutSMSPacket
The category of this message.
setPhoneNo(String) - Method in class DBCOutSMSPacket
The destination phone number.
setPluginUserDefinedName(String) - Method in class DBCOutSMSPacket
The name of the plugin that generated this packet.
setPrimaryField1(String) - Method in class DBCDBOutQueuePrimaryValues
 
setPrimaryField2(String) - Method in class DBCDBOutQueuePrimaryValues
 
setPrimaryField3(String) - Method in class DBCDBOutQueuePrimaryValues
 
setPrimaryField4(int) - Method in class DBCDBOutQueuePrimaryValues
 
setPrimaryField5(int) - Method in class DBCDBOutQueuePrimaryValues
 
setPrimaryField6(int) - Method in class DBCDBOutQueuePrimaryValues
 
setPrimaryField7(float) - Method in class DBCDBOutQueuePrimaryValues
 
setPrimaryField8(float) - Method in class DBCDBOutQueuePrimaryValues
 
setPrimaryField9(float) - Method in class DBCDBOutQueuePrimaryValues
 
setRequestReceipt(boolean) - Method in class DBCOutSMSPacket
This field should be set to true if you want the remote server to send back a status report
setSendAsFlash(boolean) - Method in class DBCOutSMSPacket
This field should be set to true if you want the message to be sent as a 'flash' message
setSenderName(String) - Method in class DBCOutSMSPacket
The sendername or shortcode to be displayed as the 'From' of the message.
setSenderNameIsAlpha(boolean) - Method in class DBCOutSMSPacket
Set this field should be true if an alphanumeric sendername is specified in the DBCOutSMSPacket.setSenderName(java.lang.String) field.
setSuppressContentInLog(boolean) - Method in class DBCOutSMSPacket
This field indicates whether the content of this message should be logged to disk.
shouldPluginShutdown() - Method in class DBCPluginUtils
This function returns the current status of the system, ie, whether it is in the process of shutting down.
startTransaction() - Method in class DBCSQLConnection
Starts a transaction on this connection.
startTransactionIfNotStarted() - Method in class DBCSQLConnection
Convenience function to start a transaction.

T

toDBVal() - Method in class DBCMessageSendStatusType
Gets a single-character representation of the type.

U

updateDatabaseOnSendResponse(DBCMessageSendStatusType, DBCDBOutQueuePrimaryValues, String, String[]) - Method in interface DBCDBPlugin_3
This event should update the database regarding the status of the send.

V

valueOf(String) - Static method in enum DBCMessageCategory
Returns the enum constant of this type with the specified name.
values() - Static method in enum DBCMessageCategory
Returns an array containing the constants of this enum type, in the order they are declared.
C D E F G H I M N O P R S T U V 
Skip navigation links