com.SecurePlay.SPTShip
Class SPTShipAPIClass

java.lang.Object
  com.SecurePlay.SPAbstractTransactionAPIClass
      com.SecurePlay.SPTShip.SPTShipAPIClass

All Implemented Interfaces:

SPAbstractTransactionAPIInterface

public class SPTShipAPIClass

extends SPAbstractTransactionAPIClass

This is the API Class of SPSHipClass.

Author:

IT GlobalSecure

See Also:

SecurePlay License Information

Field Summary

protected SPTShipClass

transactioninstance Instance of SPAbstractTransactionClass (SPSHipClass)

Constructor Summary

SPTShipAPIClass(SPTShipClass ship)
Constructor

Method Summary

boolean	APIconfigureTransaction(java.lang.String sender, boolean AckFlag, boolean ManFlag, int bsize, long tsize, java.lang.String classname, java.lang.String instname, byte[] entireshipment) Configure transaction method.
boolean	APIconfigureTransaction(java.lang.String sender, boolean AckFlag, int bsize, long tsize, java.lang.String classname, java.lang.String instname) Configure transaction method.
boolean	APIrequestConfigureTransaction(java.lang.String sender, boolean AckFlag, boolean ManFlag, int bsize, long tsize, java.lang.String classname, java.lang.String instname, byte[] entireshipment) Configure transaction method.
boolean	APIrequestConfigureTransaction(java.lang.String sender, boolean AckFlag, int bsize, long tsize, java.lang.String classname, java.lang.String instname) Configure transaction method.
boolean	APIrequestsendShipment(java.lang.String sender) This method requests send shipments automatically.
boolean	APIrequestsendShipment(java.lang.String sender, byte[] manualShip) This method requests sends a shipment manually.
boolean	APIresendShipment(java.lang.String sender, int shipcount, java.lang.String[] recieverIdList) This shipment sends the specified shipment, grabbed from the last sent list using the shipment number, to the specified players.
boolean	APIsendShipment(java.lang.String sender) This method send shipments automatically.
boolean	APIsendShipment(java.lang.String sender, byte[] manualShip) This method sends a shipment manually.
boolean	rulesrequestSendshipment(java.lang.String pid, SPAbstractTransactionInterface transobj) This shell method determines if an existing transaction object can be used to send shipments from a remote request.

Methods inherited from class com.SecurePlay.SPAbstractTransactionAPIClass

APIAddListener, APIbeginTransaction, APIClearListeners, APIcompleteTransaction, APIconfigureTransaction, APIGetListenerCount, APIGetListeners, APIRemoveListener, APIrequestbeginTransaction, APIrequestCompleteTransaction, APIrequestconfigureTransaction, APISPawn, getTransactioninstance, rulesbeginTransaction, rulescompleteTransaction, rulesconfigureTransaction

Methods inherited from class java.lang.Object

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

Field Detail

transactioninstance

protected SPTShipClass transactioninstance

Instance of SPAbstractTransactionClass (SPSHipClass)

Constructor Detail

SPTShipAPIClass

public SPTShipAPIClass(SPTShipClass ship)

Constructor

Parameters:

ship - SPSHipClass - the ship class associate with this API.

Method Detail

APIconfigureTransaction

public boolean APIconfigureTransaction(java.lang.String sender,
                                       boolean AckFlag,
                                       int bsize,
                                       long tsize,
                                       java.lang.String classname,
                                       java.lang.String instname)

Configure transaction method. This method configures without the entire shipment set. Because entire shipment is not set manual flag is set to true.

Parameters:

sender - String - player id who is configuring this transaction.

AckFlag - boolean - acknowledgement flag, flag whether or not achknowledgements should be expected before next send of the shipment.

bsize - int - buffer size.

tsize - long - total size. (NOTE: the total size is limited by the size of the int, because array types can only support ints as index.)

classname - String - class name.

instname - String - instance name.

Returns:

boolean

APIconfigureTransaction

public boolean APIconfigureTransaction(java.lang.String sender,
                                       boolean AckFlag,
                                       boolean ManFlag,
                                       int bsize,
                                       long tsize,
                                       java.lang.String classname,
                                       java.lang.String instname,
                                       byte[] entireshipment)

Configure transaction method. This method configures with the entire shipment set. Because entire shipment is set the manual flag can be either true or false.

Parameters:

sender - String - player id who is configuring this transaction.

AckFlag - boolean - acknowledgement flag, flag whether or not achknowledgements should be expected before next send of the shipment.

ManFlag - boolean - manual flag, flag for manual or automatic shipment sending.

bsize - int - buffer size.

tsize - long - total size. (NOTE: the total size is limited by the size of the int, because array types can only support ints as index.)

classname - String - class name.

instname - String - instance name.

entireshipment - byte[] - the entire shipment.

Returns:

boolean

APIrequestConfigureTransaction

public boolean APIrequestConfigureTransaction(java.lang.String sender,
                                              boolean AckFlag,
                                              int bsize,
                                              long tsize,
                                              java.lang.String classname,
                                              java.lang.String instname)

Configure transaction method. This method requests to configures without the entire shipment set. Because entire shipment is not set manual flag is set to true.

Parameters:

sender - String - player id who is configuring this transaction.

AckFlag - boolean - acknowledgement flag, flag whether or not achknowledgements should be expected before next send of the shipment.

bsize - int - buffer size.

tsize - long - total size. (NOTE: the total size is limited by the size of the int, because array types can only support ints as index.)

classname - String - class name.

instname - String - instance name.

Returns:

boolean

APIrequestConfigureTransaction

public boolean APIrequestConfigureTransaction(java.lang.String sender,
                                              boolean AckFlag,
                                              boolean ManFlag,
                                              int bsize,
                                              long tsize,
                                              java.lang.String classname,
                                              java.lang.String instname,
                                              byte[] entireshipment)

Configure transaction method. This method requests to configures with the entire shipment set. Because entire shipment is set the manual flag can be either true or false.

Parameters:

sender - String - player id who is configuring this transaction.

AckFlag - boolean - acknowledgement flag, flag whether or not achknowledgements should be expected before next send of the shipment.

ManFlag - boolean - manual flag, flag for manual or automatic shipment sending.

bsize - int - buffer size.

tsize - long - total size. (NOTE: the total size is limited by the size of the int, because array types can only support ints as index.)

classname - String - class name.

instname - String - instance name.

entireshipment - byte[] - the entire shipment.

Returns:

boolean

APIsendShipment

public boolean APIsendShipment(java.lang.String sender,
                               byte[] manualShip)

This method sends a shipment manually.

Parameters:

sender - String - sender of this shipment (master of the transaction)

manualShip - byte[] - the shipment to be sent.

Returns:

boolean

APIsendShipment

public boolean APIsendShipment(java.lang.String sender)

This method send shipments automatically.

Parameters:

sender - String - sender of this shipment.

Returns:

boolean

APIrequestsendShipment

public boolean APIrequestsendShipment(java.lang.String sender,
                                      byte[] manualShip)

This method requests sends a shipment manually.

Parameters:

sender - String - sender of this shipment (master of the transaction)

manualShip - byte[] - the shipment to be sent.

Returns:

boolean

APIrequestsendShipment

public boolean APIrequestsendShipment(java.lang.String sender)

This method requests send shipments automatically.

Parameters:

sender - String - sender of this shipment.

Returns:

boolean

APIresendShipment

public boolean APIresendShipment(java.lang.String sender,
                                 int shipcount,
                                 java.lang.String[] recieverIdList)

This shipment sends the specified shipment, grabbed from the last sent list using the shipment number, to the specified players. NOTE: This method is most likely to be used to send last sent shipments to players who sent nacks for the shipment.

Parameters:

sender -

shipcount -

recieverIdList -

Returns:

boolean

rulesrequestSendshipment

public boolean rulesrequestSendshipment(java.lang.String pid,
                                        SPAbstractTransactionInterface transobj)

This shell method determines if an existing transaction object can be used to send shipments from a remote request.

Parameters:

pid - String - player id

transobj - - SPAbstractTransationInterface - the transaction

Returns:

boolean