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.
|
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.
|
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 mismatchCopyright © 2016. All rights reserved.