com.srv4pos.server.api.treasurer

Class TreasurerService

java.lang.Object

com.srv4pos.server.api.treasurer.TreasurerService

public class TreasurerService
extends Object

To work with Treasurer entity.

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
TreasurerService(URL url, Credentials credentials, Transport transport) Constructs the service.

Method Summary

Methods

Modifier and Type	Method and Description
IdentifierInfo	create(int version, TreasurerInfo treasurerInfo) Create treasurer on the server.
void	delete(int version, String identifier) Delete entity from the server.
TreasurerInfo	get(Integer version, String identifier) Returns an treasurer entity.
List<TreasurerInfo>	list(Integer version) Returns list of entities.
List<TreasurerInfo>	list(Integer version, Integer firstResult, Integer maxResults, String like, TreasurerInfo.Fields orderBy, Boolean orderDesc) Returns list of entities.
List<TreasurerInfo>	listDiff(int versionFrom, int versionTo) Returns list of item changes between two versions.
void	put(int version, TreasurerInfo treasurerInfo) Put treasurer to the server.

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

TreasurerService

public TreasurerService(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

get

public TreasurerInfo get(Integer version,
                String identifier)

Returns an treasurer entity.

Parameters:

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

identifier - identifies entity. must match to Constraints.WINDOWS_FILENAME_REGEX

Returns:

null if not modified since version or entity. if version is null then return value can not be null

Throws:

VersionConflictJsonException - if version mismatch

NotFoundJsonException - if entity is not found

put

public void put(int version,
       TreasurerInfo treasurerInfo)

Put treasurer to the server.

Parameters:

version - expected latest version of seller

treasurerInfo - data to put

Throws:

VersionConflictJsonException - if version mismatch

create

public IdentifierInfo create(int version,
                    TreasurerInfo treasurerInfo)

Create treasurer on the server.

Parameters:

version - expected latest version of seller

treasurerInfo - data to put

Returns:

identifier info

Throws:

VersionConflictJsonException - if version mismatch

delete

public void delete(int version,
          String identifier)

Delete entity from the server.

Parameters:

version - current seller version

identifier - identifies entity. must match to Constraints.WINDOWS_FILENAME_REGEX

Throws:

VersionConflictJsonException - if version mismatch

NotFoundJsonException - if entity is not found

listDiff

public List<TreasurerInfo> 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 (com.srv4pos.server.api.treasurer.TreasurerInfo#isDeleted() = true)

list

public List<TreasurerInfo> list(Integer version)

Returns list of entities.

Parameters:

version - version or null if fresh data required

Returns:

list of entities which exists on current seller or null if list of entities is not modified since version

list

public List<TreasurerInfo> list(Integer version,
                       Integer firstResult,
                       Integer maxResults,
                       String like,
                       TreasurerInfo.Fields orderBy,
                       Boolean orderDesc)

Returns list of entities.

Parameters:

firstResult - when pagination starts or null

maxResults - amount of items per page or null

like - search string filter or null

orderBy - field to order by, possible values are TreasurerInfo.Fields

orderDesc - field to direction of ordering

version - version or null if fresh data required

Returns:

list of entities which exists on current seller or null if list of entities is not modified since version