com.srv4pos.server.api.keyboard

Class KeyboardService

java.lang.Object

com.srv4pos.server.api.keyboard.KeyboardService

public class KeyboardService
extends Object

Service for reaching Keyboard entity.

User: Sergey, Date: 18.03.14 18:14

.

Field Summary

Fields

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

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
IdentifierInfo	create(int version, KeyboardInfo keyboardInfo) Create keyboard on the server.
void	delete(int version, String identifier) Delete keyboard from the server.
KeyboardInfo	get(Integer version, String identifier) Returns an entity.
List<KeyboardInfo>	list(Integer version) Returns list of entities.
List<KeyboardInfo>	list(Integer version, Integer firstResult, Integer maxResults, String like, KeyboardInfo.Fields orderBy, Boolean orderDesc) Returns list of entities.
List<KeyboardInfo>	listDiff(int versionFrom, int versionTo) Returns list of item changes between two versions.
void	put(int version, KeyboardInfo keyboardInfo) Put keyboard 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

KeyboardService

public KeyboardService(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 KeyboardInfo get(Integer version,
               String identifier)

Returns an entity.

Parameters:

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

identifier - identifies entity

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

See Also:

KeyboardServiceSample

put

public void put(int version,
       KeyboardInfo keyboardInfo)

Put keyboard to the server.

Parameters:

version - expected latest version of seller

keyboardInfo - data to put

Throws:

VersionConflictJsonException - if version mismatch

create

public IdentifierInfo create(int version,
                    KeyboardInfo keyboardInfo)

Create keyboard on the server.

Parameters:

version - expected latest version of seller

keyboardInfo - data to put

Returns:

generated unique identifier

Throws:

VersionConflictJsonException - if version mismatch

delete

public void delete(int version,
          String identifier)

Delete keyboard from the server.

Parameters:

version - current version of the entity

identifier - identifies entity

Throws:

VersionConflictJsonException - if version mismatch

listDiff

public List<KeyboardInfo> 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 (KeyboardInfo.deleted = true)

list

public List<KeyboardInfo> 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<KeyboardInfo> list(Integer version,
                      Integer firstResult,
                      Integer maxResults,
                      String like,
                      KeyboardInfo.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 "IDENTIFIER", "NAME", "WIDTH", "HEIGHT", "DEVICE_FORM_FACTOR"

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