CommerceResponse Class Reference

Inheritance diagram for CommerceResponse:

Public Member Functions
String	getSessionId ()
String	getType ()
String	getEventId ()
int	getStatus ()
void	setStatus (int status)
void	setSuccessful ()
void	setFailed ()
String	getMessage ()
void	setMessage (String message)
	CommerceResponse (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 Parcelable.Creator< CommerceResponse >	CREATOR
Static Public Attributes inherited from BaseParcel
static final Parcelable.Creator< BaseParcel >	CREATOR

Protected Member Functions
	CommerceResponse (String sessionId, String type, String eventId)

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 main factory for all commerce responses. Please refer to the individual events that generate the response for specific information.

Definition at line 21 of file CommerceResponse.java.

Member Function Documentation

getEventId()

String getEventId

(

)

Returns an optional event ID as copied from the originating event.

Definition at line 46 of file CommerceResponse.java.

getMessage()

String getMessage

(

)

Returns the message associated with the response, if it is conveying an error.

Definition at line 81 of file CommerceResponse.java.

getSessionId()

String getSessionId

(

)

Returns the session ID associated with this event, or null if detached from a session.

Definition at line 31 of file CommerceResponse.java.

getStatus()

int getStatus

(

)

Returns the status of the response, non-zero if it encountered an error during handling.

Definition at line 53 of file CommerceResponse.java.

getType()

String getType

(

)

Returns the response type, generally a copy of the event type, or otherwise linked to the type of event that generated this response.

Definition at line 39 of file CommerceResponse.java.

setFailed()

void setFailed

(

)

Sets the status to a general failed value.

Definition at line 74 of file CommerceResponse.java.

setMessage()

void setMessage

(

String

message

)

Refer to getMessage().

Definition at line 88 of file CommerceResponse.java.

setStatus()

void setStatus

(

int

status

)

Refer to getStatus().

Definition at line 60 of file CommerceResponse.java.

setSuccessful()

void setSuccessful

(

)

Sets the status to the successful value, namely, 0.

Definition at line 67 of file CommerceResponse.java.

Member Data Documentation

CREATOR

final Parcelable.Creator<CommerceResponse> CREATOR

static

Initial value:

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

Definition at line 128 of file CommerceResponse.java.

---

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

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