com.srv4pos.server.api.customization

Class CustomizationGroupService

java.lang.Object

com.srv4pos.server.api.customization.CustomizationGroupService

public class CustomizationGroupService
extends Object

Field Summary

Fields

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

Constructor Summary

Constructors

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

Method Summary

Methods

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

CustomizationGroupService

public CustomizationGroupService(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 CustomizationGroupInfo 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

put

public void put(Integer version,
       CustomizationGroupInfo customizationGroupInfo)

Put entity to the server.

Parameters:

version - expected latest version of seller

customizationGroupInfo - data to put

Throws:

VersionConflictJsonException - if version mismatch

create

public IdentifierInfo create(Integer version,
                    CustomizationGroupInfo customizationGroupInfo)

Create entity on the server.

Parameters:

version - expected latest version of seller

customizationGroupInfo - data to put

Returns:

generated unique identifier

Throws:

VersionConflictJsonException - if version mismatch

delete

public void delete(Integer version,
          String identifier)

Delete entity from the server.

Parameters:

version - current version of the entity

identifier - identifies entity

Throws:

VersionConflictJsonException - if version mismatch

list

public List<CustomizationGroupInfo> list(Integer version,
                                Integer firstResult,
                                Integer maxResults,
                                String like,
                                CustomizationGroupInfo.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", "VAT"

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

listDiff

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