com.srv4pos.server.api.registration

Class RegistrationService

java.lang.Object

com.srv4pos.server.api.registration.RegistrationService

public class RegistrationService
extends Object

Service to reach registrations.

Author:

Ruslan Kashapov.

Field Summary

Fields

Modifier and Type	Field and Description
private Credentials	credentials
private Transport	transport
private URL	url

Constructor Summary

Constructors

Constructor and Description
RegistrationService(URL url, Credentials credentials, Transport transport) Constructs the service.

Method Summary

Modifier and Type	Method and Description
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.

Methods inherited from class java.lang.Object

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

Field Detail

url

private URL url

credentials

private Credentials credentials

transport

private Transport transport

Constructor Detail

RegistrationService

public RegistrationService(URL url,
                           Credentials credentials,
                           Transport transport)

Constructs the service.

Parameters:

url - of the server

credentials - to work with the server

transport - to know the method to reach the server

Method Detail

getBalance

public BalanceInfo getBalance(Integer version,
                              String cashRegisterName)

Get balance of registration.

Parameters:

version - version of seller, may be null (if latest data needed)

cashRegisterName - described in swedish regulations as "cash register designation"

Returns:

balance of registration

Throws:

ReferenceNotFoundJsonException - if cashRegisterName is not found

UnprocessableEntityJsonException - see: UnprocessableEntityErrorType.DAY_IS_NOT_CLOSED, UnprocessableEntityErrorType.REPORT_IS_NOT_PRINTED

setBalance

public void setBalance(int version,
                       String cashRegisterName,
                       ChangeBalanceInfo changeBalanceInfo)

Set balance of registration.

Parameters:

version - expected latest version of seller

cashRegisterName - described in swedish regulations as "cash register designation"

changeBalanceInfo - registration balance and action

Throws:

ReferenceNotFoundJsonException - if cashRegisterName is not found

UnprocessableEntityJsonException - see: UnprocessableEntityErrorType.DAY_IS_CLOSED, UnprocessableEntityErrorType.DAY_IS_NOT_CLOSED, UnprocessableEntityErrorType.REPORT_IS_NOT_PRINTED

list

public List<RegistrationInfo> list(Integer version)

Returns list of all registrations.

Parameters:

version - version of seller, may be null (if latest data needed)

Returns:

list of all registrations

list

public List<RegistrationInfo> list(Integer version,
                                   Integer firstResult,
                                   Integer maxResults,
                                   RegistrationInfo.Fields orderBy,
                                   Boolean orderDesc,
                                   Boolean activeOnly)

Returns list of registrations.

Parameters:

version - version of seller, may be null (if latest data needed)

firstResult - when pagination starts or null

maxResults - amount of items per page or null

orderBy - field to order by, possible values are "IDENTIFIER", "NAME"

orderDesc - field to direction of ordering

activeOnly - True if need only active registrations, otherwise all registrations

Returns:

list of registrations

stats

public List<RegistrationStatsInfo> stats(String period)

Returns stats by registrations.

Parameters:

period - filters by date period

Returns:

getOverviewInfo

public RegistrationDetailedOverviewInfo getOverviewInfo(String seller,
                                                        String cashRegisterName)

Returns an registration info.

Parameters:

seller - seller's identifier

cashRegisterName - cash register name

Returns:

the entity

Throws:

NotFoundJsonException - if registration wasn't found

ForbiddenJsonException - see: ForbiddenErrorType.INSUFFICIENT_ACCESS_RIGHTS

getRegistrationVersion

public RegistrationVersion getRegistrationVersion(String cashRegisterName)

Returns latest version of registration.

Parameters:

cashRegisterName - described in swedish regulations as "cash register designation"

Returns:

version number

See Also:

RegistrationServiceSample

listDiff

public List<RegistrationInfo> listDiff(int versionFrom,
                                       int versionTo)

Returns list of item changes between two versions.

Parameters:

versionFrom - version from included

versionTo - version to included

Returns:

list of items to be added, edited or deleted (RegistrationInfo.deleted = true)

listGeolocations

public List<GeolocationInfo> listGeolocations(String sellerId)

kd

public KdReplyInfo kd(KdInfo kdInfo,
                      String sellerId,
                      String cashRegisterName)

Sends data to control unit.

Parameters:

kdInfo - data to send

sellerId - seller identifier

cashRegisterName - cash register name

Returns:

result of sending

Throws:

ControlUnitReceiptJsonException - when Control Unit decides something is wrong according to it's internal business logic

InconsistentDataJsonException - 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 yet

kdForSV

public KdReplyInfo kdForSV(SVKdInfo kdInfo,
                           String sellerId,
                           String cashRegisterName)

Sends data to control unit.

Parameters:

kdInfo - data to send

sellerId - seller identifier

cashRegisterName - cash register name

Returns:

result of sending

Throws:

ControlUnitReceiptJsonException - when Control Unit decides something is wrong according to it's internal business logic

InconsistentDataJsonException - 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 yet

kd

public 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. For logging details, see com.srv4pos.server.core.web.infrastructure.MethodProfiler and com.srv4pos.server.core.web.infrastructure.ServletTimeMeasurementFilter.

Parameters:

kdInfo - data to send

logId - the identifier of log

Returns:

result of sending