public class JetAPIReturn extends JetAPI implements IJetReturn, IJetAPIReturn
API.REQUEST_TYPE
AUTH_TEST_RESPONSE, config
client, context, lockHost, maxDownloadSize
Constructor and Description |
---|
JetAPIReturn(IAPIHttpClient client,
JetConfig conf)
Create a new API instance
|
JetAPIReturn(IAPIHttpClient client,
JetConfig conf,
boolean lockHost)
Create a new API instance
|
JetAPIReturn(IAPIHttpClient client,
JetConfig conf,
boolean lockHost,
long maxDownloadSize)
Create a new API instance
|
Modifier and Type | Method and Description |
---|---|
boolean |
completeReturn(String jetReturnId,
CompleteReturnRequestRec request)
Send a complete return command to jet
|
ReturnRec |
getReturnDetail(String jetReturnId)
Retrieve detail about a specific return
|
List<String> |
getReturnsStatusTokens(ReturnStatus status)
Poll Jet and retrieve a list of returns id's for doing stuff
with returns.
|
List<String> |
getReturnStatusTokens(ReturnStatus status,
boolean includePath)
Poll Jet and retrieve a list of return id's for doing stuff
with returns.
|
IJetAPIResponse |
putCompleteReturn(String jetReturnId,
CompleteReturnRequestRec request)
Send a complete return command to jet
|
IJetAPIResponse |
sendGetReturnDetail(String jetReturnId)
Retrieve detail about a specific return
|
IJetAPIResponse |
sendPollReturns(ReturnStatus status)
Check for any returns and return a list of returns id's
|
IJetAPIResponse |
sendPutCompleteReturn(String jetReturnId,
String payload)
Send a complete return command to jet
|
executeRequest, get, getHeaderBuilder, getJSONHeaderBuilder, getPlainHeaderBuilder, jsonArrayToTokenList, login, post, post, post, put, put, put, setErrorHandler
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
get, getHeaderBuilder, getJSONHeaderBuilder, getPlainHeaderBuilder, post, post, post, put, put, put, setErrorHandler
public JetAPIReturn(IAPIHttpClient client, JetConfig conf)
client
- The built APIHttpClient instanceconf
- The Jet Configuration objectpublic JetAPIReturn(IAPIHttpClient client, JetConfig conf, boolean lockHost)
client
- The built APIHttpClient instanceconf
- The Jet Configuration objectlockHost
- Toggle locking the host to a domain if http is not present
in the url string.public JetAPIReturn(IAPIHttpClient client, JetConfig conf, boolean lockHost, long maxDownloadSize)
client
- The built APIHttpClient instanceconf
- The Jet Configuration objectlockHost
- Toggle locking the host to a domain if http is not present
in the url string.maxDownloadSize
- Set a maximum download site for the local client.
This is a fixed limit.public IJetAPIResponse sendPollReturns(ReturnStatus status) throws APIException, JetException
sendPollReturns
in interface IJetAPIReturn
status
- APIException
JetException
public List<String> getReturnsStatusTokens(ReturnStatus status) throws APIException, JetException
getReturnsStatusTokens
in interface IJetReturn
status
- status to pollAPIException
JetException
public List<String> getReturnStatusTokens(ReturnStatus status, boolean includePath) throws APIException, JetException
getReturnStatusTokens
in interface IJetReturn
status
- status to pollincludePath
- If this is false, only the rightmost path part
is returned from the uri.APIException
JetException
public IJetAPIResponse sendGetReturnDetail(String jetReturnId) throws APIException, JetException
sendGetReturnDetail
in interface IJetAPIReturn
jetReturnId
- Jet return idAPIException
JetException
public ReturnRec getReturnDetail(String jetReturnId) throws APIException, JetException
getReturnDetail
in interface IJetReturn
jetReturnId
- Jet return idAPIException
JetException
public IJetAPIResponse sendPutCompleteReturn(String jetReturnId, String payload) throws APIException, JetException
sendPutCompleteReturn
in interface IJetAPIReturn
jetReturnId
- payload
- The payloadAPIException
JetException
public IJetAPIResponse putCompleteReturn(String jetReturnId, CompleteReturnRequestRec request) throws APIException, JetException
putCompleteReturn
in interface IJetAPIReturn
jetReturnId
- payload
- The payloadAPIException
JetException
public boolean completeReturn(String jetReturnId, CompleteReturnRequestRec request) throws APIException, JetException
completeReturn
in interface IJetReturn
jetReturnId
- payload
- The payloadAPIException
JetException
Copyright © 2017. All rights reserved.