Status Class Reference

Inheritance diagram for Status:

Public Member Functions
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	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
	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 foundational Status class. This provides the structure for the return values of many of the API calls.

Definition at line 22 of file Status.java.

Constructor & Destructor Documentation

Status() [1/2]

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

protected

For internal use to generate the initial event.

Definition at line 79 of file Status.java.

Status() [2/2]

Status	(	Parcel	in,
		int	parcelVersion
	)

Reconstruct the object from a parcel.

Definition at line 87 of file Status.java.

Member Function Documentation

getMessage()

String getMessage

(

)

A user-readable message. This message may not be localized, in which case the type field should be used for determining a localized message.

Definition at line 72 of file Status.java.

getSessionId()

String getSessionId

(

)

Get the session ID for the session which triggered this event.

Definition at line 47 of file Status.java.

getStatus()

int getStatus

(

)

Get the status for this particular event. A status of 0 means success, any other status is a failure.

Definition at line 55 of file Status.java.

getType()

String getType

(

)

The type of status. This will generally be SUCCESS for a status of 0, and contain a different type for other errors. For example, in a refund or void, it is possible to receive type TRANSACTION_NOT_FOUND. This may be used for localizing the specific messages as needed

Definition at line 65 of file Status.java.

Member Data Documentation

CREATOR

final Parcelable.Creator<Status> CREATOR

static

Initial value:

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

Definition at line 114 of file Status.java.

STATUS_ERROR

final String STATUS_ERROR = "ERROR"

static

The constant status type for a general error.

Definition at line 26 of file Status.java.

STATUS_SUCCESS

final String STATUS_SUCCESS = "SUCCESS"

static

The constant status type for success.

Definition at line 24 of file Status.java.

---

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

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