CommerceEvent Class Reference

Inheritance diagram for CommerceEvent:

Public Member Functions
String	getType ()
Response	generateResponse ()
	CommerceEvent (Parcel in, int parcelVersion)
void	writeToParcel (Parcel dest, int flags)
Public Member Functions inherited from Status
String	getSessionId ()
int	getStatus ()
String	getType ()
String	getMessage ()
	Status (Parcel in, int parcelVersion)
void	writeToParcel (Parcel dest, int flags)
int	describeContents ()
Public Member Functions inherited from BaseParcel
	BaseParcel (Parcel in, int parcelVersion)
void	setParcelVersion (int targetParcelVersion)
final int	getParcelVersion ()
String	getClassName ()
void	writeToParcel (Parcel dest, int flags)
int	describeContents ()

Static Public Attributes
static final String	SESSION_STARTED = "SESSION_STARTED"
static final String	SESSION_RESUMED = "SESSION_RESUMED"
static final String	SESSION_ENDED = "SESSION_ENDED"
static final String	SESSION_CLOSED = "SESSION_CLOSED"
static final String	SESSION_ERROR = "SESSION_ERROR"
static final String	SESSION_START_FAILED = "SESSION_START_FAILED"
static final String	SESSION_RESUME_FAILED = "SESSION_RESUME_FAILED"
static final String	SESSION_END_FAILED = "SESSION_END_FAILED"
static final Parcelable.Creator< CommerceEvent >	CREATOR
Static Public Attributes inherited from Status
static final String	STATUS_SUCCESS = "SUCCESS"
static final String	STATUS_ERROR = "ERROR"
static final Parcelable.Creator< Status >	CREATOR
Static Public Attributes inherited from BaseParcel
static final Parcelable.Creator< BaseParcel >	CREATOR

Protected Member Functions
	CommerceEvent (String sessionId, int status, String type, String message)
String	getEventId ()
void	setEventId (String eventId)
Protected Member Functions inherited from Status
	Status (String sessionId, int status, String type, String message)

Additional Inherited Members
Static Protected Member Functions inherited from BaseParcel
static void	safelySetParcelVersion (final int targetParcelVersion, @Nullable BaseParcel item)
static void	safelySetParcelVersion (final int targetParcelVersion, @Nullable List<? extends BaseParcel > items)
static< T extends BaseParcel > void	safelySetParcelVersion (final int targetParcelVersion, @Nullable T[] items)

Detailed Description

The session-specific extension of status. This object is returned to the CommerceListener, and should never be constructed directly.

Definition at line 19 of file CommerceEvent.java.

Constructor & Destructor Documentation

CommerceEvent() [1/2]

CommerceEvent ( String  sessionId, int  status, String  type, String  message  )

protected

For internal use to generate the initial event.

Definition at line 72 of file CommerceEvent.java.

CommerceEvent() [2/2]

CommerceEvent	(	Parcel	in,
		int	parcelVersion
	)

Reconstruct the object from a parcel. This should only be used by the system.

Definition at line 85 of file CommerceEvent.java.

Member Function Documentation

generateResponse()

Response generateResponse

(

)

The generator method for generating the appropriate response for the current event. This will always return a concrete subclass of Response.

Definition at line 63 of file CommerceEvent.java.

getType()

String getType

(

)

Returns the Commerce Event constants in addition to the Status constants. Overridden here only to provide the appropriate documentation.

Definition at line 57 of file CommerceEvent.java.

Member Data Documentation

CREATOR

final Parcelable.Creator<CommerceEvent> CREATOR

static

Initial value:

=
              new CommerceEvent.ParcelCreator<CommerceEvent>() {
                  @Override
                  public CommerceEvent[] newArray(int size) { return new CommerceEvent[size]; }
                  @Override
                  public CommerceEvent createFromParcel(Parcel source) {
                      Status createdObject = super.createFromParcel(source);
                      if (createdObject == null || !CommerceEvent.class.isInstance(createdObject)) {
                          return new CommerceEvent(source, getRecommendedParcelVersion());
                      } else {
                          return (CommerceEvent) createdObject;
                      }
                  }
              }

Definition at line 102 of file CommerceEvent.java.

SESSION_CLOSED

final String SESSION_CLOSED = "SESSION_CLOSED"

static

The type returned when a session is closed, but not by a request to endSession.

Definition at line 29 of file CommerceEvent.java.

SESSION_END_FAILED

final String SESSION_END_FAILED = "SESSION_END_FAILED"

static

Replaced by a SESSION_ENDED event with a non-zero status to indicate the specific problem.

Definition at line 48 of file CommerceEvent.java.

SESSION_ENDED

final String SESSION_ENDED = "SESSION_ENDED"

static

The type returned for an endSession request.

Definition at line 27 of file CommerceEvent.java.

SESSION_ERROR

final String SESSION_ERROR = "SESSION_ERROR"

static

A general error has occurred in the session that has stopped an unspecified method from being performed.

Definition at line 31 of file CommerceEvent.java.

SESSION_RESUME_FAILED

final String SESSION_RESUME_FAILED = "SESSION_RESUME_FAILED"

static

Replaced by a SESSION_RESUMED event with a non-zero status to indicate the specific problem.

Definition at line 42 of file CommerceEvent.java.

SESSION_RESUMED

final String SESSION_RESUMED = "SESSION_RESUMED"

static

The type returned for a resumeSession request.

Definition at line 25 of file CommerceEvent.java.

SESSION_START_FAILED

final String SESSION_START_FAILED = "SESSION_START_FAILED"

static

Replaced by a SESSION_STARTED event with a non-zero status to indicate the specific problem.

Definition at line 36 of file CommerceEvent.java.

SESSION_STARTED

final String SESSION_STARTED = "SESSION_STARTED"

static

The type returned for a startSession request.

Definition at line 23 of file CommerceEvent.java.

---

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

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