Class JDPAlphaSender

java.lang.Object
   |
   +----JDPAlphaSender

public class JDPAlphaSender
extends Object
Class JDPAlphaSender represents an interface the the JaggServer alpha paging mechanism.


Constructor Index

 o JDPAlphaSender(JDPUser)
Creates a Alpha Paging sender.
 o JDPAlphaSender(JDPUser, JDPJagg)
Creates a Alpha Paging sender.

Method Index

 o addMessage(String, String, String)
Add a message to the message pool.
 o getServiceProviderNumber(String)
Get the service provider number.
 o getServiceProviders()
Get the names of the service providers that are known to this class.
 o sendLoadedMessages()
Send loaded messages.
 o sendMultipleMessage()
Send multiple messages.
 o sendSingleMessage()
Send a single message.
 o setBaudRate(int)
Set the baud rate for this service provider.
 o setCommPort(int)
Set the comm port that the modem is set up on.
 o setCSTR(String)
Set the database connection string for doing a merge.
 o setDSN(String)
Set the datasource/database name for doing a merge.
 o setFromWhereClause(String)
Set the where clause string for doing a merge.
 o setJdbcDriver(String)
Set the fully qualified class name of the JDBC driver.
 o setJdbcPrefix(String)
Set the prefix to use for connecting to the JDBC driver.
 o setJdbcSuffix(String)
Set the suffix to use for connecting to the JDBC driver.
 o setMergeColumns(String[])
Set the merge column names for doing a merge.
 o setMessage(String)
Set the message.
 o setPagerPINNumber(String)
Set the pager PIN number.
 o setPWD(String)
Set the password string for doing a merge.
 o setServiceProvider(String)
Set the service provider.
 o setSQL(String)
Set the SQL string for doing a merge.
 o setUID(String)
Set the userid string for doing a merge.

Constructors

 o JDPAlphaSender
 public JDPAlphaSender(JDPUser user)
Creates a Alpha Paging sender.

Parameters:
JDPUser - the global user parameter used to pass handles in JDP.
 o JDPAlphaSender
 public JDPAlphaSender(JDPUser user,
                       JDPJagg jaggSQL)
Creates a Alpha Paging sender.

Parameters:
JDPUser - the global user parameter used to pass handles in JDP.
JDPJagg - instance for alpha paging merge with a database.

Methods

 o setCommPort
 public void setCommPort(int commPort)
Set the comm port that the modem is set up on.

Parameters:
commPort - the port on the server that the modem is set up on.
 o setBaudRate
 public void setBaudRate(int baudRate)
Set the baud rate for this service provider.

Parameters:
baudRate - the maximum baud rate that this service provider will accept.
 o addMessage
 public void addMessage(String serviceProvider,
                        String pagerPINNumber,
                        String message)
Add a message to the message pool. If sending multiple messages you can batch them using this method before sending them.

Parameters:
serviceProvider - the service provider to dial to send this message.
pagerPINNumber - the pager PIN number for the recipient.
message - the message to send.
 o setMessage
 public void setMessage(String message)
Set the message. This is used for single messages or for message merging.

Parameters:
message - the message to send.
 o setServiceProvider
 public void setServiceProvider(String serviceProvider)
Set the service provider. This can be the phone number or the name. If it is a name it must come from the list provided in the getServiceProviders() method.

Parameters:
serviceProvider - the service provider to dial to send this message.
 o getServiceProviders
 public String[] getServiceProviders()
Get the names of the service providers that are known to this class.

Returns:
the list of service providers.
 o setPagerPINNumber
 public void setPagerPINNumber(String pagerPINNumber)
Set the pager PIN number.

Parameters:
pagerPINNumber - the pager PIN number for the recipient.
 o getServiceProviderNumber
 public String getServiceProviderNumber(String provider)
Get the service provider number.

Returns:
the phone number for the requested provider name.
 o setDSN
 public void setDSN(String DSN)
Set the datasource/database name for doing a merge.

Parameters:
DSN - the datasource/database name for JDPJagg to use.
 o setJdbcDriver
 public void setJdbcDriver(String jdbcDriver)
Set the fully qualified class name of the JDBC driver.

Parameters:
jcbdDriver - the fully qualified class name of the JDBC driver.
 o setJdbcPrefix
 public void setJdbcPrefix(String jdbcPrefix)
Set the prefix to use for connecting to the JDBC driver.

Parameters:
jcbdPrefix - the prefix to use for connecting to the JDBC driver.
 o setJdbcSuffix
 public void setJdbcSuffix(String jdbcSuffix)
Set the suffix to use for connecting to the JDBC driver.

Parameters:
jcbdSuffix - the suffix to use for connecting to the JDBC driver.
 o setUID
 public void setUID(String UID)
Set the userid string for doing a merge.

Parameters:
UID - the userid for JDPJagg to use.
 o setPWD
 public void setPWD(String PWD)
Set the password string for doing a merge.

Parameters:
PWD - the password for JDPJagg to use.
 o setCSTR
 public void setCSTR(String CSTR)
Set the database connection string for doing a merge.

Parameters:
CSTR - the connection string for JDPJagg to use. This will typically be of the form DSN=MyDatabase;UID=myuser;PWD=mypassword;
 o setSQL
 public void setSQL(String SQL)
Set the SQL string for doing a merge. See the generated code for the alpha merge data bound component for an example of a valid SQL.

Parameters:
SQL - the SQL for JDPJagg to use.
 o setFromWhereClause
 public void setFromWhereClause(String whereClause)
Set the where clause string for doing a merge. See the generated code for the alpha merge data bound component for an example of a valid where clause.

Parameters:
whereClause - the where clause for JDPJagg to use.
 o setMergeColumns
 public void setMergeColumns(String columns[])
Set the merge column names for doing a merge. See the generated code for the alpha merge data bound component for an example of a valid where clause.

Parameters:
columns - the names of the columns from the selected SQL that will be used for the merge.
 o sendSingleMessage
 public void sendSingleMessage()
Send a single message. If the commPort, baudRate, serviceProvider, PIN number and message have all been set then this method is used to send the message.

 o sendLoadedMessages
 public void sendLoadedMessages()
Send loaded messages. This method is used in conjunction with addMessage to send the messages that have been batched.

 o sendMultipleMessage
 public void sendMultipleMessage()
Send multiple messages. This method is used in conjunction with the database merging methods to tell JaggServer to run the SQL, do the merge with the resulting rows and send the messages that are created as a result of the merge.