com.SecurePlay
Interface SPAbstractTransactionInterface

All Known Implementing Classes:

SPAbstractTransactionClass

public interface SPAbstractTransactionInterface

The Abstract Transaction Interface is the required interface that all transactions that work with the SecurePlay library must support. This provides an alternate construction method for new transactions that does not require inheritance from the Abstract Transaction Class.

Author:

IT GlobalSecure

See Also:

SecurePlay License Information

Method Summary

boolean	APIcompleteTransaction(java.lang.String pid) This method allows the Transaction Master ONLY to complete the transaction.
SPAbstractTransactionInterface	APIcreateTransaction(SPGameInterface gameapiobj, SPMessageClass message) Creates a new instance of an Abstract Transaction class.
java.lang.String	APIgetAGE() Gets the abstract game engine of this transaction.
java.lang.String[]	APIgetConfiguration() Getter function that returns the property: configuration
java.lang.String	APIgetGameID() Gets the game id associated with the transaction.
java.lang.String	APIgetMaster() Gets the id of the master of the transaction.
java.lang.String[]	APIgetPlayerIDList() Gets the player ids associated with the transaction.
boolean	APIgetPrivacyFlag() Gets the privacy flag of this class.
java.lang.String	APIgetTransactionID() Gets the transaction id.
java.lang.String	APIgetTransactionstatus() Getter function that returns the property: transactionstatus
java.lang.String	APIgetTransactionType() This method returns a String of the transactiontype.
void	APIsetTransactionID(java.lang.String tid) Sets the transaction id to a specified id.
void	onincomingTransaction(SPMessageClass incoming) This method handles the various incoming messages and passes them to the appropriate message type handler.
void	sendMessage(java.lang.String sender, java.lang.String[] receivers, boolean encryptflag, boolean privateflag, java.lang.String messagetype, java.lang.String[] messagebody, java.lang.String[] altmessage) This method sends a message.

Method Detail

onincomingTransaction

public void onincomingTransaction(SPMessageClass incoming)

This method handles the various incoming messages and passes them to the appropriate message type handler.

Parameters:

incoming - SPMessageClass - incomng message

Returns:

result - Boolean: TRUE if successful, FALSE, if unsuccessful

APIgetMaster

public java.lang.String APIgetMaster()

Gets the id of the master of the transaction.

Returns:

master - String - master of the transaction.

APIgetTransactionID

public java.lang.String APIgetTransactionID()

Gets the transaction id.

Returns:

tid - String - the transaction id

APIgetGameID

public java.lang.String APIgetGameID()

Gets the game id associated with the transaction.

Returns:

gid - String - game id

APIgetPlayerIDList

public java.lang.String[] APIgetPlayerIDList()

Gets the player ids associated with the transaction.

Returns:

players - String[] - players associated with the transaction in a String array.

APIgetPrivacyFlag

public boolean APIgetPrivacyFlag()

Gets the privacy flag of this class.

Returns:

privateflag - boolean

APIsetTransactionID

public void APIsetTransactionID(java.lang.String tid)

Sets the transaction id to a specified id.

Parameters:

tid - String - the id of the transaction.

sendMessage

public void sendMessage(java.lang.String sender,
                        java.lang.String[] receivers,
                        boolean encryptflag,
                        boolean privateflag,
                        java.lang.String messagetype,
                        java.lang.String[] messagebody,
                        java.lang.String[] altmessage)

This method sends a message. It hands the configured message off to the appropriate comms service. Also, for private messages, it sends an alternate message to the parties not recieving the main message.

Parameters:

sender - String - player id of the sender.

receivers - String[] - player ids of recievers.

encryptflag - boolean - enrypted flag

privateflag - boolean - private flag

messagetype - String - message type

messagebody - String[] - the message body as a string

altmessage - String[] - alternative message.

Returns:

void

APIgetTransactionstatus

public java.lang.String APIgetTransactionstatus()

Getter function that returns the property: transactionstatus

Returns:

transactionstatus - String

APIgetConfiguration

public java.lang.String[] APIgetConfiguration()

Getter function that returns the property: configuration

Returns:

configuration - String[]

APIgetAGE

public java.lang.String APIgetAGE()

Gets the abstract game engine of this transaction.

Returns:

gameblock - String

APIgetTransactionType

public java.lang.String APIgetTransactionType()

This method returns a String of the transactiontype.

Returns:

this.transtype - String - name of transaction type

APIcreateTransaction

public SPAbstractTransactionInterface APIcreateTransaction(SPGameInterface gameapiobj,
                                                           SPMessageClass message)

Creates a new instance of an Abstract Transaction class.

Parameters:

gameapiobj - SPGameInterface - game associated with this transaction.

message - SPMessageClass - message that has all the config information.

Returns:

SPAbstractTransactionInterface

APIcompleteTransaction

public boolean APIcompleteTransaction(java.lang.String pid)

This method allows the Transaction Master ONLY to complete the transaction. Transactions that are in an error state cannot be cleared by completion.

Parameters:

pid - String - id of the player who is completing the transaction, must be the master and internal.

Returns:

result - Boolean: TRUE, if successful, FALSE, if not.