public class RegistrationService extends Object
Modifier and Type | Field and Description |
---|---|
private Credentials |
credentials |
private Transport |
transport |
private URL |
url |
Constructor and Description |
---|
RegistrationService(URL url,
Credentials credentials,
Transport transport)
Constructs the service.
|
Modifier and Type | Method and Description |
---|---|
void |
delete(int version,
String identifier)
Delete registration from the server.
|
BalanceInfo |
getBalance(Integer version,
String cashRegisterName)
Get balance of registration.
|
RegistrationDetailedOverviewInfo |
getOverviewInfo(String seller,
String cashRegisterName)
Returns an registration info.
|
RegistrationVersion |
getRegistrationVersion(String cashRegisterName)
Returns latest version of registration.
|
KdReplyInfo |
kd(KdInfo kdInfo,
String sellerId,
String cashRegisterName)
Sends data to control unit.
|
KdReplyInfo |
kd(KdInfo kdInfo,
String sellerId,
String cashRegisterName,
String logId)
The same as
kd(KdInfo, String, String) , but also has param logId for load testing. |
KdReplyInfo |
kdForSV(SVKdInfo kdInfo,
String sellerId,
String cashRegisterName)
Sends data to control unit.
|
List<RegistrationInfo> |
list(Integer version)
Returns list of all registrations.
|
List<RegistrationInfo> |
list(Integer version,
Integer firstResult,
Integer maxResults,
RegistrationInfo.Fields orderBy,
Boolean orderDesc,
Boolean activeOnly)
Returns list of registrations.
|
List<RegistrationInfo> |
listDiff(int versionFrom,
int versionTo)
Returns list of item changes between two versions.
|
List<GeolocationInfo> |
listGeolocations(String sellerId) |
void |
setBalance(int version,
String cashRegisterName,
ChangeBalanceInfo changeBalanceInfo)
Set balance of registration.
|
List<RegistrationStatsInfo> |
stats(String period)
Returns stats by registrations.
|
private URL url
private Credentials credentials
private Transport transport
public RegistrationService(URL url, Credentials credentials, Transport transport)
url
- of the servercredentials
- to work with the servertransport
- to know the method to reach the serverpublic BalanceInfo getBalance(Integer version, String cashRegisterName)
version
- version of seller, may be null (if latest data needed)cashRegisterName
- described in swedish regulations as "cash register designation"ReferenceNotFoundJsonException
- if cashRegisterName is not foundUnprocessableEntityJsonException
- see:
UnprocessableEntityErrorType.DAY_IS_NOT_CLOSED
,
UnprocessableEntityErrorType.REPORT_IS_NOT_PRINTED
public void setBalance(int version, String cashRegisterName, ChangeBalanceInfo changeBalanceInfo)
version
- expected latest version of sellercashRegisterName
- described in swedish regulations as "cash register designation"changeBalanceInfo
- registration balance and actionReferenceNotFoundJsonException
- if cashRegisterName is not foundUnprocessableEntityJsonException
- see:
UnprocessableEntityErrorType.DAY_IS_CLOSED
,
UnprocessableEntityErrorType.DAY_IS_NOT_CLOSED
,
UnprocessableEntityErrorType.REPORT_IS_NOT_PRINTED
public List<RegistrationInfo> list(Integer version)
version
- version of seller, may be null (if latest data needed)public List<RegistrationInfo> list(Integer version, Integer firstResult, Integer maxResults, RegistrationInfo.Fields orderBy, Boolean orderDesc, Boolean activeOnly)
version
- version of seller, may be null (if latest data needed)firstResult
- when pagination starts or nullmaxResults
- amount of items per page or nullorderBy
- field to order by, possible values are "IDENTIFIER", "NAME"orderDesc
- field to direction of orderingactiveOnly
- True if need only active registrations, otherwise all registrationspublic List<RegistrationStatsInfo> stats(String period)
period
- filters by date periodpublic RegistrationDetailedOverviewInfo getOverviewInfo(String seller, String cashRegisterName)
seller
- seller's identifiercashRegisterName
- cash register nameNotFoundJsonException
- if registration wasn't foundForbiddenJsonException
- see:
ForbiddenErrorType.INSUFFICIENT_ACCESS_RIGHTS
public RegistrationVersion getRegistrationVersion(String cashRegisterName)
cashRegisterName
- described in swedish regulations as "cash register designation"RegistrationServiceSample
public List<RegistrationInfo> listDiff(int versionFrom, int versionTo)
versionFrom
- version from includedversionTo
- version to includedRegistrationInfo.deleted
= true)public void delete(int version, String identifier)
version
- current version of the entityidentifier
- identifies entityVersionConflictJsonException
- if version mismatchpublic List<GeolocationInfo> listGeolocations(String sellerId)
public KdReplyInfo kd(KdInfo kdInfo, String sellerId, String cashRegisterName)
kdInfo
- data to sendsellerId
- seller identifiercashRegisterName
- cash register nameControlUnitReceiptJsonException
- when Control Unit decides something is
wrong according to it's internal business logicInconsistentDataJsonException
- see:
InconsistentDataErrorType.WORKING_WITH_CU_IS_NOT_SUPPORTED_BY_APP
ControlUnitUnavailableJsonException
- when server is unable to reach the control
unit device (for instance it's ejected from the server)ControlUnitCommunicationJsonException
- when error has happened during transmission data to the control unit
(for instance, it was ejected from the server during sending the data)
workable yetpublic KdReplyInfo kdForSV(SVKdInfo kdInfo, String sellerId, String cashRegisterName)
kdInfo
- data to sendsellerId
- seller identifiercashRegisterName
- cash register nameControlUnitReceiptJsonException
- when Control Unit decides something is
wrong according to it's internal business logicInconsistentDataJsonException
- see:
InconsistentDataErrorType.WORKING_WITH_CU_IS_NOT_SUPPORTED_BY_APP
ControlUnitUnavailableJsonException
- when server is unable to reach the control
unit device (for instance it's ejected from the server)ControlUnitCommunicationJsonException
- when error has happened during transmission data to the control unit
(for instance, it was ejected from the server during sending the data)
workable yetpublic KdReplyInfo kd(KdInfo kdInfo, String sellerId, String cashRegisterName, String logId)
kd(KdInfo, String, String)
, but also has param logId for load testing.
For logging details, see com.srv4pos.server.core.web.infrastructure.MethodProfiler
and com.srv4pos.server.core.web.infrastructure.ServletTimeMeasurementFilter.kdInfo
- data to sendlogId
- the identifier of logCopyright © 2018. All rights reserved.