com.SecurePlay
Class SPTBlastClass

java.lang.Object
  com.SecurePlay.SPRootTransactionClass
      com.SecurePlay.SPAbstractTransactionClass
          com.SecurePlay.SPTBlastClass

All Implemented Interfaces:

SPAbstractTransactionInterface

public class SPTBlastClass

extends SPAbstractTransactionClass

This class is a single step transaction that includes all members of a specific game.

Author:

IT GlobalSecure

See Also:

SecurePlay License Information

Field Summary

Fields inherited from class com.SecurePlay.SPAbstractTransactionClass

classAPI, configuration, gameblock, gameinstance, transactionstatus, transtype

Fields inherited from class com.SecurePlay.SPRootTransactionClass

EventListenerList, gameID, master, playerIDList, transactionID

Constructor Summary

SPTBlastClass()
Default Constructor.

SPTBlastClass(SPGameInterface gameobj, java.lang.String master, boolean privateflag, java.lang.String[] transinfo, java.lang.String transactionID)
Overloaded Constructor

Method Summary

boolean	APIBcreateSingleStepTransaction(SPGameAPIInterface gameapiobj, java.lang.String master, java.lang.String[] transcontent) This method creates a SPSingleStepTransactionClass.
boolean	APIbeginTransaction(java.lang.String pid) This method is not supported because this is a single step transaction
boolean	APIcompleteTransaction(java.lang.String pid) This method is not supported because this is a single step transaction
boolean	APIconfigureTransaction(java.lang.String pid, java.lang.String[] args) This method is not supported because this is a single step transaction
static SPTBlastClass	APIcreateClass() This is a static default constructor that returns the SPStrobeClass instance.
SPTBlastClass	APIcreateSingleStepTransaction(SPGameAPIInterface gameapiobj, java.lang.String master, java.lang.String[] transcontent) This method creates a SPSingleStepTransactionClass.
java.lang.String[]	APIgetTransactionContent() This method returns the contents of the Single Step Transaction
boolean	APIrequestbeginTransaction(java.lang.String pid) This method is not supported because this is a single step transaction
boolean	APIrequestCompleteTransaction(java.lang.String pid) This method is not supported because this is a single step transaction
boolean	APIrequestconfigureTransaction(java.lang.String pid, java.lang.String[] args) This method is not supported because this is a single step transaction
SPTBlastAPIClass	APITOAcreateSingleStepTransaction(SPGameAPIInterface gameapiobj, java.lang.String master, java.lang.String[] transcontent) This method creates a SPSingleStepTransactionAPIClass.
static SPAbstractTransactionInterface	createTransaction(SPGameAPIInterface gameapiobj, java.lang.String master, boolean privateflag, java.lang.String[] transinfo, java.lang.String transactionID) This method creates a SPTBlast transaction.
SPTBlastAPIClass	getAPI() This method gets the API of this class
java.lang.String[]	getTranscontent() Getter function that returns the property: transcontent
static java.lang.String	gettranstype() This method gets the transaction type.
boolean	onbeginTransaction(SPMessageClass incoming) This method is not supported because this is a single step transaction
boolean	oncompleteTransaction(SPMessageClass incoming) This method is not supported because this is a single step transaction
protected boolean	onconfigureTransaction(SPMessageClass incoming) This method is not supported because this is a single step transaction
boolean	onincomingTransaction(SPMessageClass incoming) This method is not supported because this is a single step transaction
void	onrequestbeginTransaction(SPMessageClass incoming) This method is not supported because this is a single step transaction
void	onrequestcompleteTransaction(SPMessageClass incoming) This method is not supported because this is a single step transaction
void	onrequestconfigureTransaction(SPMessageClass incoming) This method is not supported because this is a single step transaction
SPTBlastAPIClass	SPgetAPI() Gets this class's API

Methods inherited from class com.SecurePlay.SPAbstractTransactionClass

APIgetGameBlock, APIsetGameBlock, APISPawn, buildSPawn, createTransaction, getClassAPI, getConfiguration, getGameinstance, getLasterror, getPrivacyFlag, getTransactionstatus, getTransactionType, isPlayerInternal, isPrivateflag, logError, onbeginTransaction, onconfigureTransaction, onSpawn, pronincomingTransaction, pruniqueinit, sendMessage, setGameBlock, setTransactionID, spawnConfigure, transComplete, transError

Methods inherited from class com.SecurePlay.SPRootTransactionClass

APIAddListener, APIClearListeners, APIGetListenerCount, APIGetListeners, APIRemoveListener, getGameID, getMaster, getPlayerIDList, getTransactionID, isPlayerIncluded, SPnotify

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.SecurePlay.SPAbstractTransactionInterface

getGameID, getMaster, getPlayerIDList, getTransactionID

Constructor Detail

SPTBlastClass

public SPTBlastClass()

Default Constructor.

SPTBlastClass

public SPTBlastClass(SPGameInterface gameobj,
                     java.lang.String master,
                     boolean privateflag,
                     java.lang.String[] transinfo,
                     java.lang.String transactionID)

Overloaded Constructor

Parameters:

gameobj - SPGameInterface - the game object associated with this transaction

master - String - master of this transaction

transinfo - String[] - transaction info

privateflag - boolean - priavate flag

transactionID - String - transaction id

Method Detail

APIgetTransactionContent

public java.lang.String[] APIgetTransactionContent()

This method returns the contents of the Single Step Transaction

Returns:

result - Strin[] - string array containing the transaction content

APIbeginTransaction

public boolean APIbeginTransaction(java.lang.String pid)

This method is not supported because this is a single step transaction

Overrides:

APIbeginTransaction in class SPAbstractTransactionClass

Parameters:

pid - String - id of the transaction beginner, must be the master and internal.

Returns:

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

APIcompleteTransaction

public boolean APIcompleteTransaction(java.lang.String pid)

This method is not supported because this is a single step transaction

Overrides:

APIcompleteTransaction in class SPAbstractTransactionClass

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.

APIrequestCompleteTransaction

public boolean APIrequestCompleteTransaction(java.lang.String pid)

This method is not supported because this is a single step transaction

Overrides:

APIrequestCompleteTransaction in class SPAbstractTransactionClass

Parameters:

pid - String - id of the requestor, can not be the master, must be internal.

Returns:

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

APIconfigureTransaction

public boolean APIconfigureTransaction(java.lang.String pid,
                                       java.lang.String[] args)

This method is not supported because this is a single step transaction

Overrides:

APIconfigureTransaction in class SPAbstractTransactionClass

Parameters:

pid - String - id of the configurer, must be internal.

args - String[] - the configuration array, with configuration details inside.

Returns:

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

APIrequestconfigureTransaction

public boolean APIrequestconfigureTransaction(java.lang.String pid,
                                              java.lang.String[] args)

This method is not supported because this is a single step transaction

Overrides:

APIrequestconfigureTransaction in class SPAbstractTransactionClass

Parameters:

pid - String - the configure requestor, can not be the master, must be internal.

args - String[] - the configuration array, with configuration details.

Returns:

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

APIrequestbeginTransaction

public boolean APIrequestbeginTransaction(java.lang.String pid)

This method is not supported because this is a single step transaction

Overrides:

APIrequestbeginTransaction in class SPAbstractTransactionClass

Parameters:

pid - String - the id of the requestor, can not be master, must be internal

Returns:

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

onconfigureTransaction

protected boolean onconfigureTransaction(SPMessageClass incoming)

This method is not supported because this is a single step transaction

Overrides:

onconfigureTransaction in class SPAbstractTransactionClass

Parameters:

incoming - SPMessageClass - incomng message

Returns:

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

onbeginTransaction

public boolean onbeginTransaction(SPMessageClass incoming)

This method is not supported because this is a single step transaction

oncompleteTransaction

public boolean oncompleteTransaction(SPMessageClass incoming)

This method is not supported because this is a single step transaction

onincomingTransaction

public boolean onincomingTransaction(SPMessageClass incoming)

This method is not supported because this is a single step transaction

Specified by:

onincomingTransaction in interface SPAbstractTransactionInterface

Overrides:

onincomingTransaction in class SPAbstractTransactionClass

onrequestcompleteTransaction

public void onrequestcompleteTransaction(SPMessageClass incoming)

This method is not supported because this is a single step transaction

Overrides:

onrequestcompleteTransaction in class SPAbstractTransactionClass

Parameters:

incoming - SPMessageClass - incomng message

onrequestconfigureTransaction

public void onrequestconfigureTransaction(SPMessageClass incoming)

This method is not supported because this is a single step transaction

Overrides:

onrequestconfigureTransaction in class SPAbstractTransactionClass

Parameters:

incoming - SPMessageClass - incomng message

onrequestbeginTransaction

public void onrequestbeginTransaction(SPMessageClass incoming)

This method is not supported because this is a single step transaction

Overrides:

onrequestbeginTransaction in class SPAbstractTransactionClass

Parameters:

incoming - SPMessageClass - incomng message

getAPI

public SPTBlastAPIClass getAPI()

This method gets the API of this class

Returns:

tranAPI SPSingleStepTransactionAPIClass - the API of this class NOTE: This method may be depreciated in future releases.

SPgetAPI

public SPTBlastAPIClass SPgetAPI()

Gets this class's API

Returns:

classAPI - SPSingleStepTransactionAPIClass

getTranscontent

public java.lang.String[] getTranscontent()

Getter function that returns the property: transcontent

Returns:

transcontent - String[]

APIcreateSingleStepTransaction

public SPTBlastClass APIcreateSingleStepTransaction(SPGameAPIInterface gameapiobj,
                                                    java.lang.String master,
                                                    java.lang.String[] transcontent)

This method creates a SPSingleStepTransactionClass.

Parameters:

gameapiobj -

master -

transcontent -

Returns:

SPSingleStepTransactionClass

APIBcreateSingleStepTransaction

public boolean APIBcreateSingleStepTransaction(SPGameAPIInterface gameapiobj,
                                               java.lang.String master,
                                               java.lang.String[] transcontent)

This method creates a SPSingleStepTransactionClass.

Parameters:

gameapiobj -

master -

transcontent -

Returns:

boolean

APITOAcreateSingleStepTransaction

public SPTBlastAPIClass APITOAcreateSingleStepTransaction(SPGameAPIInterface gameapiobj,
                                                          java.lang.String master,
                                                          java.lang.String[] transcontent)

This method creates a SPSingleStepTransactionAPIClass.

Parameters:

gameapiobj -

master -

transcontent -

Returns:

SPSingleStepTransactionAPIClass

gettranstype

public static java.lang.String gettranstype()

This method gets the transaction type.

Returns:

String

APIcreateClass

public static SPTBlastClass APIcreateClass()

This is a static default constructor that returns the SPStrobeClass instance. NOTE: it is used in registering transactions.

Returns:

SPStrobeClass

createTransaction

public static SPAbstractTransactionInterface createTransaction(SPGameAPIInterface gameapiobj,
                                                               java.lang.String master,
                                                               boolean privateflag,
                                                               java.lang.String[] transinfo,
                                                               java.lang.String transactionID)

This method creates a SPTBlast transaction.

Parameters:

gameapiobj - SPGameAPIInterface - the game that will be associated with this transaction.

master - String - player id of the master of the transaction

privateflag - boolean - This is a flag to describe whether the specific transaction is a private transaction to the non-participating Players.

transinfo - String[] - transaction info.

transactionID - String - transaction id.