com.srv4pos.server.api.seller

Class SellerService

java.lang.Object

com.srv4pos.server.api.seller.SellerService

public class SellerService
extends Object

Exchange information for Seller entity. User: Kirill Date: 25.07.13 11: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
SellerService(URL url, Credentials credentials, Transport transport) Constructs the service.

Method Summary

Modifier and Type	Method and Description
void	deletePicture(int version, String pictureFilename) Deletes specified picture.
private String	formatPictureUrl(String pictureFilename, Integer version)
SellerInfo	get(Integer version) Get latest information about seller from the server.
List<SellerModificationInfo>	getModifications(int versionFrom, int versionTo) Gets list of seller modifications.
InputStream	getPicture(Integer version, String pictureFilename) Returns body of the picture.
InputStream	getPictureFromHistory(Integer pictureVersion, String pictureFilename) Returns body of the picture for particular version number.
List<String>	getPicturePath(Integer version) Returns list of picture relative paths .
SellerStatsInfo	getStats() Gets an information about availability of local control units, expiration of activation.
SellerVersion	getThisVersion() Returns latest version of this seller.
SellerVersion	getThisVersionPublic(String sellerId) Returns latest version of this public seller.
List<PublicSellerInfo>	list(Integer firstResult, Integer maxResults, String like, PublicSellerInfo.Fields orderBy, Boolean orderDesc) Returns list of entities which have publicAccess == true.
List<PictureInfo>	listDiffPicture(int versionFrom, int versionTo) Returns list of seller pictures changes between two versions.
void	put(int version, SellerInfo sellerInfo) Send information about seller to the server to store it.
void	putPicture(int version, String pictureFilename, InputStream picture, String contentType) Send picture to the server.
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

SellerService

public SellerService(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 SellerInfo get(Integer version)

Get latest information about seller from the server.

Parameters:

version - put value from 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,
                SellerInfo sellerInfo)

Send information about seller to the server to store it.

Parameters:

sellerInfo - the data

version - put value from getThisVersion()

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<PublicSellerInfo> list(Integer firstResult,
                                   Integer maxResults,
                                   String like,
                                   PublicSellerInfo.Fields orderBy,
                                   Boolean orderDesc)

Returns list of entities which have publicAccess == true.

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

getThisVersion

public SellerVersion getThisVersion()

Returns latest version of this seller.

Returns:

version number

See Also:

SellerServiceSample

getThisVersionPublic

public SellerVersion getThisVersionPublic(String sellerId)

Returns latest version of this public seller.

Parameters:

sellerId - id of the seller

Returns:

version number

Throws:

ForbiddenJsonException - see: ForbiddenErrorType.INSUFFICIENT_ACCESS_RIGHTS

See Also:

SellerServiceSample

getStats

public SellerStatsInfo getStats()

Gets an information about availability of local control units, expiration of activation.

Returns:

seller stats

listDiffPicture

public List<PictureInfo> listDiffPicture(int versionFrom,
                                         int versionTo)

Returns list of seller pictures changes between two versions.

Parameters:

versionFrom - version from included

versionTo - version to included

Returns:

list of items to be added, edited or deleted

See Also:

SellerServiceSample

getPicture

public InputStream getPicture(Integer version,
                              String pictureFilename)

Returns body of the picture.

Parameters:

version - picture version or null if fresh content needed

pictureFilename - just a normal windows filename according to Constraints.WINDOWS_FILENAME_REGEX

Returns:

body in bytes or null if not modified (if version parameter is not null and seller has the same version as specified)

Throws:

NotFoundJsonException - if image is not found

ReferenceNotFoundJsonException - if seller is not found

See Also:

SellerServiceSample

getPicturePath

public List<String> getPicturePath(Integer version)

Returns list of picture relative paths .

Parameters:

version - picture version or null if fresh content needed

Returns:

list of paths or null if not modified (if version parameter is not null and seller has the same version as specified)

Throws:

ReferenceNotFoundJsonException - if seller is not found

See Also:

SellerServiceSample

getPictureFromHistory

public InputStream getPictureFromHistory(Integer pictureVersion,
                                         String pictureFilename)

Returns body of the picture for particular version number.

Parameters:

pictureVersion - particular version of picture

pictureFilename - just a normal windows filename according to Constraints.WINDOWS_FILENAME_REGEX

Returns:

body of the picture

Throws:

NotFoundJsonException - if image is not found

ReferenceNotFoundJsonException - if seller is not found

See Also:

SellerServiceSample

putPicture

public void putPicture(int version,
                       String pictureFilename,
                       InputStream picture,
                       String contentType)

Send picture to the server.

Parameters:

version - expected latest version of seller

pictureFilename - picture filename. must match to Constraints.WINDOWS_FILENAME_REGEX

picture - body of the picture. method doesn't close the stream

contentType - content type of the image

Throws:

ReferenceNotFoundJsonException - if seller is not found

VersionConflictJsonException - if version doesn't match to seller version

See Also:

SellerServiceSample

formatPictureUrl

private String formatPictureUrl(String pictureFilename,
                                Integer version)

deletePicture

public void deletePicture(int version,
                          String pictureFilename)

Deletes specified picture.

Parameters:

version - version of seller, if mismatch VersionConflictJsonException will be thrown

pictureFilename - picture filename. must match to Constraints.WINDOWS_FILENAME_REGEX

Throws:

ReferenceNotFoundJsonException - if seller is not found

VersionConflictJsonException - if version doesn't match to seller version

See Also:

SellerServiceSample

getModifications

public List<SellerModificationInfo> getModifications(int versionFrom,
                                                     int versionTo)

Gets list of seller modifications.

Parameters:

versionFrom - version from included

versionTo - version to included

Returns:

list of items to be added, edited or deleted