com.srv4pos.server.api.category

Class CategoryService

java.lang.Object

com.srv4pos.server.api.category.CategoryService

public class CategoryService
extends Object

Service of reaching Category entity.

User: Kirill, Date: 05.08.13 18:00

.

Field Summary

Fields

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

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
IdentifierInfo	create(int version, CategoryInfo categoryInfo) Create category on the server.
void	delete(int version, String identifier) Delete category from the server.
void	deletePicture(int version, String categoryIdentifier, String pictureFilename) Deletes specified picture.
private String	formatPictureUrl(String productIdentifier, String pictureFilename, Integer version)
CategoryInfo	get(Integer version, String identifier) Returns an entity.
InputStream	getPicture(Integer version, String categoryIdentifier, String pictureFilename) Returns body of the picture.
InputStream	getPictureFromHistory(Integer pictureVersion, String categoryIdentifier, String pictureFilename) Returns body of the picture for particular version number.
List<String>	getPicturePath(Integer version, String categoryIdentifier) Returns list of picture relative paths .
List<CategoryInfo>	list(Integer version) Returns list of entities.
List<CategoryInfo>	list(Integer version, Integer firstResult, Integer maxResults, String like, CategoryInfo.Fields orderBy, Boolean orderDesc) Returns list of entities.
List<CategoryInfo>	listDiff(int versionFrom, int versionTo) Returns list of item changes between two versions.
List<PictureInfo>	listDiffPicture(int versionFrom, int versionTo) Returns list of category pictures changes between two versions.
void	put(int version, CategoryInfo categoryInfo) Put category to the server.
void	putPicture(int version, String categoryIdentifier, String pictureFilename, InputStream picture, String contentType) Send picture to the server.
CategoriesStatsInfo	stats(String period, String cashRegisterName) Returns stats by categories.

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

CategoryService

public CategoryService(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 CategoryInfo 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:

CategoryServiceSample

put

public void put(int version,
       CategoryInfo categoryInfo)

Put category to the server.

Parameters:

version - expected latest version of seller

categoryInfo - data to put

Throws:

VersionConflictJsonException - if version mismatch

create

public IdentifierInfo create(int version,
                    CategoryInfo categoryInfo)

Create category on the server.

Parameters:

version - expected latest version of seller

categoryInfo - data to put

Returns:

generated unique identifier

Throws:

VersionConflictJsonException - if version mismatch

delete

public void delete(int version,
          String identifier)

Delete category from the server.

Parameters:

version - current version of the entity

identifier - identifies entity

Throws:

VersionConflictJsonException - if version mismatch

listDiff

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

list

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

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

listDiffPicture

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

Returns list of category 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:

CategoryServiceSample

getPicture

public InputStream getPicture(Integer version,
                     String categoryIdentifier,
                     String pictureFilename)

Returns body of the picture.

Parameters:

version - picture version or null if fresh content needed

categoryIdentifier - category identifier

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 category is not found

See Also:

CategoryServiceSample

getPicturePath

public List<String> getPicturePath(Integer version,
                          String categoryIdentifier)

Returns list of picture relative paths .

Parameters:

version - picture version or null if fresh content needed

categoryIdentifier - category identifier

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:

CategoryServiceSample

getPictureFromHistory

public InputStream getPictureFromHistory(Integer pictureVersion,
                                String categoryIdentifier,
                                String pictureFilename)

Returns body of the picture for particular version number.

Parameters:

pictureVersion - particular version of picture

categoryIdentifier - category identifier

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 category is not found

See Also:

CategoryServiceSample

putPicture

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

Send picture to the server.

Parameters:

version - expected latest version of seller

categoryIdentifier - identifier of the category. must match to Constraints.WINDOWS_FILENAME_REGEX

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 category is not found

VersionConflictJsonException - if version doesn't match to seller version

See Also:

CategoryServiceSample

formatPictureUrl

private String formatPictureUrl(String productIdentifier,
                      String pictureFilename,
                      Integer version)

deletePicture

public void deletePicture(int version,
                 String categoryIdentifier,
                 String pictureFilename)

Deletes specified picture.

Parameters:

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

categoryIdentifier - identifier of the category. must match to Constraints.WINDOWS_FILENAME_REGEX

pictureFilename - picture filename. must match to Constraints.WINDOWS_FILENAME_REGEX

Throws:

ReferenceNotFoundJsonException - if category is not found

VersionConflictJsonException - if version doesn't match to seller version

See Also:

CategoryServiceSample

stats

public CategoriesStatsInfo stats(String period,
                        String cashRegisterName)

Returns stats by categories.

Parameters:

period - filters by date period

cashRegisterName - filters by cash register name

Returns: