CommerceManager Class Reference

Public Member Functions
abstract boolean	startSession (CommerceListener listener)
abstract boolean	startSession (CommerceListener listener, String userID, String password, int shiftNumber)
abstract boolean	resumeSession (CommerceListener listener, String sessionId)
abstract boolean	addSessionListener (CommerceListener listener)
abstract boolean	removeSessionListener (CommerceListener listener)
abstract Set< CommerceListener >	getListeners ()
abstract boolean	endSession ()

Detailed Description

The service handle for any communication using the trigger or payment APIs. While multiple Commerce Managers may be created, only one will be able to maintain a session at a given time.

Definition at line 9 of file CommerceManager.java.

Member Function Documentation

addSessionListener()

abstract boolean addSessionListener ( CommerceListener  listener )

abstract

Allows adding new listeners for session events.

Parameters

listener

A listener for session events. There may be more listeners added, but there must always be at least one registered.

Returns

True if the listener was not already registered.

endSession()

abstract boolean endSession ( )

abstract

Ends a session. This releases the terminal reservation for this application, allowing other applications to open sessions. This sends a stop message to the terminal to exit the terminal application if launched by this app. The internal service may send this on behalf of this Android application if this application crashes or exits without closing the session. This method should be called prior to the release of the final reference to the Commerce Manager. Once the session is ended, references to any registered SessionListeners are removed once the Session End event is properly reported.

Returns

True if the session end message was submitted successfully. The SessionListener will receive the end event if the session is ended properly, or will receive the appropriate message if the session is not able to be ended.

getListeners()

abstract Set<CommerceListener> getListeners ( )

abstract

Get the set of currently registered listeners.

Returns

A set of listeners. This set is independent of the internal set, and should only used as a reference for the current listeners, and not be expected to update with the addition or removal of listeners.

removeSessionListener()

abstract boolean removeSessionListener ( CommerceListener  listener )

abstract

Removes a session listener. The last session listener cannot be removed through this method, as there must always be a listener until the session ends.

Parameters

listener

A registered listener for the session events.

Returns

True if the listener exists.

resumeSession()

abstract boolean resumeSession ( CommerceListener  listener, String  sessionId  )

abstract

Attempts to resume a session in the case of a Session Closed event or an application crash. If it is not possible to resume, this may return immediately or may send a Session Resume Failed event to the listener.

Parameters

listener	The first listener for the session events. There may be more listeners added, but there must always be at least one registered.
sessionId	The id of the session to resume.

Returns

True if the session opening message was submitted successfully. The listener will receive the start event if the session is created, or will receive the appropriate message if the session is not able to be created.

startSession() [1/2]

abstract boolean startSession ( CommerceListener  listener )

abstract

Starts a session. This reserves the terminal for this application, preventing conflicts with other apps. When the Android app starts a session, the service will keep track of the app, allowing the service to handle cases where the app is terminated before endSession() is called.

Parameters

listener

The first listener for the session events. There may be more listeners added, but there must always be at least one registered.

Returns

True if the session opening message was submitted successfully. The SessionListener will receive the start event if the session is created, or will receive the appropriate message if the session is not able to be created.

startSession() [2/2]

abstract boolean startSession ( CommerceListener  listener, String  userID, String  password, int  shiftNumber  )

abstract

Please use com.verifone.commerce.payment.TransactionManager#login(CommerceListener, String, String, String) instead.

---

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

• src/main/java/com/verifone/commerce/CommerceManager.java