public class CategoryService extends Object
User: Kirill, Date: 05.08.13 18:00
.Modifier and Type | Field and Description |
---|---|
private Credentials |
credentials |
private Transport |
transport |
private URL |
url |
Constructor and Description |
---|
CategoryService(URL url,
Credentials credentials,
Transport transport)
Constructs the service.
|
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.
|
private URL url
private Credentials credentials
private Transport transport
public CategoryService(URL url, Credentials credentials, Transport transport)
url
- of the servercredentials
- to work with the servertransport
- to know the method to reach the serverpublic CategoryInfo get(Integer version, String identifier)
version
- latest version of seller, may be null (if latest data needed)identifier
- identifies entityVersionConflictJsonException
- if version mismatchNotFoundJsonException
- if entity is not foundCategoryServiceSample
public void put(int version, CategoryInfo categoryInfo)
version
- expected latest version of sellercategoryInfo
- data to putVersionConflictJsonException
- if version mismatchpublic IdentifierInfo create(int version, CategoryInfo categoryInfo)
version
- expected latest version of sellercategoryInfo
- data to putVersionConflictJsonException
- if version mismatchpublic void delete(int version, String identifier)
version
- current version of the entityidentifier
- identifies entityVersionConflictJsonException
- if version mismatchpublic List<CategoryInfo> listDiff(int versionFrom, int versionTo)
versionFrom
- version from includedversionTo
- version to includedCategoryInfo.deleted
= true)public List<CategoryInfo> list(Integer version)
version
- version or null if fresh data requiredpublic List<CategoryInfo> list(Integer version, Integer firstResult, Integer maxResults, String like, CategoryInfo.Fields orderBy, Boolean orderDesc)
firstResult
- when pagination starts or nullmaxResults
- amount of items per page or nulllike
- search string filter or nullorderBy
- field to order by, possible values are "IDENTIFIER", "NAME"orderDesc
- field to direction of orderingversion
- version or null if fresh data requiredpublic List<PictureInfo> listDiffPicture(int versionFrom, int versionTo)
versionFrom
- version from includedversionTo
- version to includedCategoryServiceSample
public InputStream getPicture(Integer version, String categoryIdentifier, String pictureFilename)
version
- picture version or null if fresh content neededcategoryIdentifier
- category identifierpictureFilename
- just a normal windows filename according to Constraints.WINDOWS_FILENAME_REGEX
NotFoundJsonException
- if image is not foundReferenceNotFoundJsonException
- if category is not foundCategoryServiceSample
public List<String> getPicturePath(Integer version, String categoryIdentifier)
version
- picture version or null if fresh content neededcategoryIdentifier
- category identifierReferenceNotFoundJsonException
- if seller is not foundCategoryServiceSample
public InputStream getPictureFromHistory(Integer pictureVersion, String categoryIdentifier, String pictureFilename)
pictureVersion
- particular version of picturecategoryIdentifier
- category identifierpictureFilename
- just a normal windows filename according to Constraints.WINDOWS_FILENAME_REGEX
NotFoundJsonException
- if image is not foundReferenceNotFoundJsonException
- if category is not foundCategoryServiceSample
public void putPicture(int version, String categoryIdentifier, String pictureFilename, InputStream picture, String contentType)
version
- expected latest version of sellercategoryIdentifier
- 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 streamcontentType
- content type of the imageReferenceNotFoundJsonException
- if category is not foundVersionConflictJsonException
- if version doesn't match to seller versionCategoryServiceSample
private String formatPictureUrl(String productIdentifier, String pictureFilename, Integer version)
public void deletePicture(int version, String categoryIdentifier, String pictureFilename)
version
- version of seller, if mismatch VersionConflictJsonException
will be throwncategoryIdentifier
- identifier of the category. must match to Constraints.WINDOWS_FILENAME_REGEX
pictureFilename
- picture filename. must match to Constraints.WINDOWS_FILENAME_REGEX
ReferenceNotFoundJsonException
- if category is not foundVersionConflictJsonException
- if version doesn't match to seller versionCategoryServiceSample
public CategoriesStatsInfo stats(String period, String cashRegisterName)
period
- filters by date periodcashRegisterName
- filters by cash register nameCategoriesStatsInfo
with stats.TypeMismatchJsonException
- if period
String
isn't convertible to
Date
.Copyright © 2016. All rights reserved.