apidocs / com.srv4pos.server.api.category / CategoryService

CategoryService

class CategoryService

Service of reaching Category entity.

User: Kirill, Date: 05.08.13 18:00.

Constructors

CategoryService(url: URL, credentials: Credentials?, transport: Transport)

Service of reaching Category entity.

Functions

create	`fun create(version: Int, categoryInfo: CategoryInfo): IdentifierInfo` Create category on the server.
delete	`fun delete(version: Int, identifier: String): Unit` Delete category from the server.
deletePicture	`fun deletePicture(version: Int, categoryIdentifier: String, pictureFilename: String): Unit` Deletes specified picture.
get	`operator fun get(version: Int?, identifier: String): CategoryInfo?` Returns an entity.
getPicture	`fun getPicture(version: Int?, categoryIdentifier: String, pictureFilename: String): InputStream?` Returns body of the picture.
getPictureFromHistory	`fun getPictureFromHistory(pictureVersion: Int?, categoryIdentifier: String, pictureFilename: String): InputStream?` Returns body of the picture for particular version number.
getPicturePath	`fun getPicturePath(version: Int?, categoryIdentifier: String): List<String>` Returns list of picture relative paths .
list	`fun list(version: Int?, firstResult: Int? = null, maxResults: Int? = null, like: String? = null, orderBy: CategoryInfo.Fields? = null, orderDesc: Boolean? = null): List<CategoryInfo>?` Returns list of entities.
listDiff	`fun listDiff(versionFrom: Int, versionTo: Int): List<CategoryInfo>` Returns list of item changes between two versions.
listDiffPicture	`fun listDiffPicture(versionFrom: Int, versionTo: Int): List<CategoryPictureInfo>` Returns list of category pictures changes between two versions.
put	`fun put(version: Int, categoryInfo: CategoryInfo): Unit` Put category to the server.
putPicture	`fun putPicture(version: Int, categoryIdentifier: String, pictureFilename: String, picture: InputStream, contentType: String): Unit` Send picture to the server.
stats	`fun stats(period: String?, cashRegisterName: String?): CategoriesStatsInfo?` Returns stats by categories.