com.srv4pos.server.api.restaurant

Class RestaurantService

java.lang.Object

com.srv4pos.server.api.restaurant.RestaurantService

public class RestaurantService
extends Object

Exchange information for Restaurant entity.

Author:

pavel.tsarev

Field Summary

Fields

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
RestaurantOverviewInfo	get(String sellerId, Integer version) Get latest information about seller from the server.
List<RestaurantListInfo>	list() Returns list of entities.
List<RestaurantListInfo>	list(Integer firstResult, Integer maxResults, String like, PublicSellerInfo.Fields orderBy, Boolean orderDesc) Returns list of entities.
void	put(int version, String sellerId, RestaurantInfo restaurantInfo) Send information about restaurant to the server to store it.
void	remove(String sellerId) Remove seller and all information that concerns seller.

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

RestaurantService

public RestaurantService(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 RestaurantOverviewInfo get(String sellerId,
                                  Integer version)

Get latest information about seller from the server.

Parameters:

sellerId - of the seller

version - put value from SellerService.getThisVersion(). if you don't have any SellerInfo instance, then pass null to return the data anyway

Returns:

null if not modified or fresh version of info

See Also:

SellerServiceSample

put

public void put(int version,
                String sellerId,
                RestaurantInfo restaurantInfo)

Send information about restaurant to the server to store it.

Parameters:

restaurantInfo - the data

sellerId - seller-restaurant id

Throws:

VersionConflictJsonException - if server has newer data sent from other client before

See Also:

SellerServiceSample

remove

public void remove(String sellerId)

Remove seller and all information that concerns seller.

Parameters:

sellerId - identifier of seller

list

public List<RestaurantListInfo> list()

Returns list of entities. Only for admins.

Returns:

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

Throws:

ForbiddenJsonException - see: ForbiddenErrorType.INSUFFICIENT_ACCESS_RIGHTS

list

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

Returns list of entities. Only for admins.

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

Returns:

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

Throws:

ForbiddenJsonException - see: ForbiddenErrorType.INSUFFICIENT_ACCESS_RIGHTS