SecurePlayLibrary::SPAbstractTransactionInterface Class Reference

#include <SPAbstractTransactionInterface.h>

Inheritance diagram for SecurePlayLibrary::SPAbstractTransactionInterface:

List of all members.

---

Detailed Description

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

Public Member Functions
virtual	~SPAbstractTransactionInterface ()
virtual bool	onincomingTransaction (SPMessageClass *incoming)=0
virtual string	getMaster ()=0
virtual string	getTransactionID ()=0
virtual SPAbstractTransactionAPIInterface *	getClassAPI ()=0
virtual string	getGameID ()=0
virtual vector< string >	getPlayerIDList ()=0
virtual bool	getPrivacyFlag ()=0
virtual bool	transComplete ()=0
virtual void	setTransactionID (string tid)=0
virtual bool	sendMessage (string sender, vector< string > receivers, bool encryptflag, bool privateflag, string messagetype, vector< string > messagebody, vector< string > altmessage)=0
virtual bool	isPrivateflag ()=0
virtual string	getTransactionstatus ()=0
virtual vector< string >	getConfiguration ()=0
virtual string	APIgetGameBlock ()=0
virtual bool	APIsetGameBlock (string pid, string newgameblock)=0
virtual string	getTransactionType ()=0
virtual SPAbstractTransactionInterface *	createTransaction (SPGameAPIInterface *gameapiobj, string master, vector< string > playerIDList, bool privateflag, string transactionID)=0

---

Constructor & Destructor Documentation

virtual SecurePlayLibrary::SPAbstractTransactionInterface::~SPAbstractTransactionInterface (   )  [inline, virtual]

Virtual Destructor.

---

Member Function Documentation

virtual string SecurePlayLibrary::SPAbstractTransactionInterface::APIgetGameBlock (   )  [pure virtual]

Gets the gameblock of this transaction. Returns: string - gameblock Implemented in SecurePlayLibrary::SPAbstractTransactionClass.

virtual bool SecurePlayLibrary::SPAbstractTransactionInterface::APIsetGameBlock (  string  pid, string  newgameblock )  [pure virtual]

This method allows the Transaction Master ONLY to set the game block. Parameters: pid  string - id of the player attempting to set the game block, must be internal. newgameblock  string - the game block for this transaction. Returns: bool: TRUE if successful, FALSE, if unsuccessful Implemented in SecurePlayLibrary::SPAbstractTransactionClass.

virtual SPAbstractTransactionInterface* SecurePlayLibrary::SPAbstractTransactionInterface::createTransaction (  SPGameAPIInterface *  gameapiobj, string  master, vector< string >  playerIDList, bool  privateflag, string  transactionID )  [pure virtual]

This method creates a transaction. It is overriden in each individual transaction and it will return the individual transaction Parameters: gameapiobj  SPGameAPIInterface* - game associated with this transaction. master  string - master of this transaction playerIDList  vector<string> - player id list of this transaction. privateflag  bool - private flag transactionID  string - transaction id. Returns: SPAbstractTransactionInterface* - returns the created transaction. Implemented in SecurePlayLibrary::SPAbstractTransactionClass, SecurePlayLibrary::SPTMultiPartSecretClass, SecurePlayLibrary::SPTMultiPartSimultaneousClass, SecurePlayLibrary::SPTMultistepTurnClass, SecurePlayLibrary::SPTRandomClass, SecurePlayLibrary::SPTSecretClass, SecurePlayLibrary::SPTSimultaneousClass, and SecurePlayLibrary::SPTStrobeClass.

virtual SPAbstractTransactionAPIInterface* SecurePlayLibrary::SPAbstractTransactionInterface::getClassAPI (   )  [pure virtual]

Gets this class's API Returns: SPAbstractTransactionAPIInterface* - class api of this class. Implemented in SecurePlayLibrary::SPAbstractTransactionClass.

virtual vector<string> SecurePlayLibrary::SPAbstractTransactionInterface::getConfiguration (   )  [pure virtual]

Getter function that returns the property: configuration Returns: vector<string> - configuration of this transaction. Implemented in SecurePlayLibrary::SPAbstractTransactionClass.

virtual string SecurePlayLibrary::SPAbstractTransactionInterface::getGameID (   )  [pure virtual]

Gets the game id associated with the transaction. Returns: string - game id. Implemented in SecurePlayLibrary::SPAbstractTransactionClass.

virtual string SecurePlayLibrary::SPAbstractTransactionInterface::getMaster (   )  [pure virtual]

Gets the id of the master of the transaction. Returns: string - master of the transaction. Implemented in SecurePlayLibrary::SPAbstractTransactionClass.

virtual vector<string> SecurePlayLibrary::SPAbstractTransactionInterface::getPlayerIDList (   )  [pure virtual]

Gets the player ids associated with the transaction. Returns: vector<string> - players associated with the transaction in a string array. Implemented in SecurePlayLibrary::SPAbstractTransactionClass.

virtual bool SecurePlayLibrary::SPAbstractTransactionInterface::getPrivacyFlag (   )  [pure virtual]

Gets the privacy flag of this class. Returns: bool - privacy flag Implemented in SecurePlayLibrary::SPAbstractTransactionClass.

virtual string SecurePlayLibrary::SPAbstractTransactionInterface::getTransactionID (   )  [pure virtual]

Gets the transaction id. Returns: string - the transaction id Implemented in SecurePlayLibrary::SPAbstractTransactionClass.

virtual string SecurePlayLibrary::SPAbstractTransactionInterface::getTransactionstatus (   )  [pure virtual]

Getter function that returns the property: transactionstatus Returns: string - the status of this transaction. Implemented in SecurePlayLibrary::SPAbstractTransactionClass.

virtual string SecurePlayLibrary::SPAbstractTransactionInterface::getTransactionType (   )  [pure virtual]

This method returns a string of the transactiontype. Returns: string - name of transaction type Implemented in SecurePlayLibrary::SPAbstractTransactionClass.

virtual bool SecurePlayLibrary::SPAbstractTransactionInterface::isPrivateflag (   )  [pure virtual]

Getter function that returns the property: privateflag Returns: bool - private flag. Implemented in SecurePlayLibrary::SPAbstractTransactionClass.

virtual bool SecurePlayLibrary::SPAbstractTransactionInterface::onincomingTransaction (  SPMessageClass *  incoming  )  [pure virtual]

This method handles the various incoming messages and passes them to the appropriate message type handler. Parameters: incoming  SPMessageClass - incomng message Returns: bool: TRUE if successful, FALSE, if unsuccessful Implemented in SecurePlayLibrary::SPAbstractTransactionClass, and SecurePlayLibrary::SPTBlastClass.

virtual bool SecurePlayLibrary::SPAbstractTransactionInterface::sendMessage (  string  sender, vector< string >  receivers, bool  encryptflag, bool  privateflag, string  messagetype, vector< string >  messagebody, vector< string >  altmessage )  [pure virtual]

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  vector<string> - player ids of recievers. encryptflag  bool - enrypted flag privateflag  bool - private flag messagetype  string - message type messagebody  vector<string> - the message body as a string altmessage  vector<string> - alternative message. Returns: bool: TRUE, if successful, FALSE, if not Implemented in SecurePlayLibrary::SPAbstractTransactionClass.

virtual void SecurePlayLibrary::SPAbstractTransactionInterface::setTransactionID (  string  tid  )  [pure virtual]

Sets the transaction id to a specified id. Parameters: string  - the id of the transaction. Implemented in SecurePlayLibrary::SPAbstractTransactionClass.

virtual bool SecurePlayLibrary::SPAbstractTransactionInterface::transComplete (   )  [pure virtual]

This method returns a flag for whether the transaction is currently in the "complete" state. Returns: bool: TRUE, if transaction complete, FALSE, if not. Implemented in SecurePlayLibrary::SPAbstractTransactionClass.

---

The documentation for this class was generated from the following file:

• SPAbstractTransactionInterface.h

2006 Copyright Filed by IT GlobalSecure, Inc. All Rights Reserved. Not to be used without authorization by Author. SecurePlay, IT GlobalSecure, and IT Armor are registered trademarks by IT GlobalSecure, Inc. Software protected by software license, and one or more the following U.S. and International patent numbers: U.S. Patent 6,030,288, U.S. Patent 6,165,072, European Patent Office EP1016049A1,and World Intellectual Property Organization WO9912135C1 and additional filings worldwide.