Package com.centralnicreseller.apiconnector

Class Response

java.lang.Object

com.centralnicreseller.apiconnector.Response

public final class Response
extends Object

Response covers all functionality to wrap a Backend API Response like accessing data

Since:

2.0

Version:

%I%, %G%

Author:

Kai Schwarz

Constructor Summary

Constructors

Constructor	Description
Response(String raw)	Constructor
Response(String raw, Map<String,String> cmd)	Constructor
Response(String raw, Map<String,String> cmd, Map<String,String> ph)	Constructor

Method Summary

Modifier and Type	Method	Description
Response	addColumn(String key, ArrayList<String> data)	Add a column to the column list.
Response	addRecord(Map<String,String> h)	Add a record to the record list.
int	getCode()	Get API response code
Column	getColumn(String key)	Get column by column name.
String	getColumnIndex(String colkey, int index)	Get Data by Column Name and Index.
ArrayList<String>	getColumnKeys()	Get Column Names.
ArrayList<Column>	getColumns()	Get List of Columns.
Map<String,String>	getCommand()	Get Command used in this request.
String	getCommandPlain()	Get Command used in this request in plain text.
int	getCurrentPageNumber()	Get Page Number of current List Query.
Record	getCurrentRecord()	Get Record of current record index.
String	getDescription()	Get API response description
int	getFirstRecordIndex()	Get Index of first row in this response.
Map<String,Object>	getHash()	Get API response as Hash
int	getLastRecordIndex()	Get last record index of the current list query.
Map<String,Object>	getListHash()	Get Response as List Hash including useful meta data for tables.
int	getNextPageNumber()	Get Page Number of next list query.
Record	getNextRecord()	Get next record in record list.
int	getNumberOfPages()	Get the number of pages available for this list query.
Map<String,Object>	getPagination()	Get object containing all paging data.
String	getPlain()	Get Plain API response
int	getPreviousPageNumber()	Get Page Number of previous list query.
Record	getPreviousRecord()	Get previous record in record list.
double	getQueuetime()	Get Queuetime of API response
Record	getRecord(int idx)	Get Record at given index.
ArrayList<Record>	getRecords()	Get all Records.
int	getRecordsCount()	Get count of rows in this response
int	getRecordsLimitation()	Get limit(ation) setting of the current list query This is the count of requested rows
int	getRecordsTotalCount()	Get total count of records available for the list query.
double	getRuntime()	Get Runtime of API response
boolean	hasNextPage()	Check if this list query has a next page
boolean	hasPreviousPage()	Check if this list query has a previous page
boolean	isError()	Check if current API response represents an error case API response code is an 5xx code
boolean	isPending()	Check if current operation is returned as pending.
boolean	isSuccess()	Check if current API response represents a success case API response code is an 2xx code
boolean	isTmpError()	Check if current API response represents a temporary error case API response code is an 4xx code
Response	rewindRecordList()	Reset index in record list back to zero

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Response

public Response(String raw)

Constructor

Parameters:

raw - API plain response

Response

public Response(String raw,
 Map<String,String> cmd)

Constructor

Parameters:

raw - API plain response

cmd - API command used within this request

Response

public Response(String raw,
 Map<String,String> cmd,
 Map<String,String> ph)

Constructor

Parameters:

raw - API plain response

cmd - API command used within this request

ph - place holder variables replacements

Method Details

getCode

public int getCode()

Get API response code

Returns:

API response code

getDescription

public String getDescription()

Get API response description

Returns:

API response description

getPlain

public String getPlain()

Get Plain API response

Returns:

Plain API response

getQueuetime

public double getQueuetime()

Get Queuetime of API response

Returns:

Queuetime of API response

getHash

public Map<String,Object> getHash()

Get API response as Hash

Returns:

API response hash

getRuntime

public double getRuntime()

Get Runtime of API response

Returns:

Runtime of API response

isError

public boolean isError()

Check if current API response represents an error case API response code is an 5xx code

Returns:

boolean result

isSuccess

public boolean isSuccess()

Check if current API response represents a success case API response code is an 2xx code

Returns:

boolean result

isTmpError

public boolean isTmpError()

Check if current API response represents a temporary error case API response code is an 4xx code

Returns:

boolean result

isPending

public boolean isPending()

Check if current operation is returned as pending.

Returns:

boolean result

addColumn

public Response addColumn(String key,
 ArrayList<String> data)

Add a column to the column list.

Parameters:

key - column name

data - array of column data

Returns:

Current Response Instance for method chaining

addRecord

public Response addRecord(Map<String,String> h)

Add a record to the record list.

Parameters:

h - row data

Returns:

Current Response Instance for method chaining

getColumn

public Column getColumn(String key)

Get column by column name.

Parameters:

key - column name

Returns:

column instance or null if column does not exist

getColumnIndex

public String getColumnIndex(String colkey,
 int index)

Get Data by Column Name and Index.

Parameters:

colkey - column name

index - column data index

Returns:

column data at index or null if not found

getColumnKeys

public ArrayList<String> getColumnKeys()

Get Column Names.

Returns:

Array of Column Names

getColumns

public ArrayList<Column> getColumns()

Get List of Columns.

Returns:

Array of Columns

getCommand

public Map<String,String> getCommand()

Get Command used in this request.

Returns:

command

getCommandPlain

public String getCommandPlain()

Get Command used in this request in plain text.

Returns:

plain text command

getCurrentPageNumber

public int getCurrentPageNumber()

Get Page Number of current List Query.

Returns:

page number or -1 in case of a non-list response

getCurrentRecord

public Record getCurrentRecord()

Get Record of current record index.

Returns:

Record or null in case of a non-list response

getFirstRecordIndex

public int getFirstRecordIndex()

Get Index of first row in this response.

Returns:

first row index; -1 if record list is empty

getLastRecordIndex

public int getLastRecordIndex()

Get last record index of the current list query.

Returns:

record index or -1 for a non-list response

getListHash

public Map<String,Object> getListHash()

Get Response as List Hash including useful meta data for tables.

Returns:

hash including list meta data and array of rows in hash notation

getNextRecord

public Record getNextRecord()

Get next record in record list.

Returns:

Record or null in case there's no further record

getNextPageNumber

public int getNextPageNumber()

Get Page Number of next list query.

Returns:

page number or -1 if there's no next page

getNumberOfPages

public int getNumberOfPages()

Get the number of pages available for this list query.

Returns:

number of pages

getPagination

public Map<String,Object> getPagination()

Get object containing all paging data.

Returns:

paginator data

getPreviousPageNumber

public int getPreviousPageNumber()

Get Page Number of previous list query.

Returns:

page number or -1 if there's no previous page

getPreviousRecord

public Record getPreviousRecord()

Get previous record in record list.

Returns:

Record or null if there's no previous record

getRecord

public Record getRecord(int idx)

Get Record at given index.

Parameters:

idx - record index

Returns:

Record or null if index does not exist

getRecords

public ArrayList<Record> getRecords()

Get all Records.

Returns:

list of records

getRecordsCount

public int getRecordsCount()

Get count of rows in this response

Returns:

count of rows

getRecordsTotalCount

public int getRecordsTotalCount()

Get total count of records available for the list query.

Returns:

total count of records or count of records for a non-list response

getRecordsLimitation

public int getRecordsLimitation()

Get limit(ation) setting of the current list query This is the count of requested rows

Returns:

limit setting or count requested rows

hasNextPage

public boolean hasNextPage()

Check if this list query has a next page

Returns:

boolean result

hasPreviousPage

public boolean hasPreviousPage()

Check if this list query has a previous page

Returns:

boolean result

rewindRecordList

public Response rewindRecordList()

Reset index in record list back to zero

Returns:

Current Response Instance for method chaining