com.srv4pos.server.api.seller

Class UserService

java.lang.Object

com.srv4pos.server.api.seller.UserService

public class UserService
extends Object

Field Summary

Fields

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
String	create(UserRegistrationInfo userRegistrationInfo) Creates an user.
UserInfo	get(String id) Returns an user.
Collection<UserShortInfo>	list(Integer firstResult, Integer maxResults, String like) Returns list of users.
void	put(String id, UserInfo userInfo) Modifies an user.

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

UserService

public UserService(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

put

public void put(String id,
                UserInfo userInfo)

Modifies an user.

Parameters:

id - identifies entity

userInfo - the entity content to put

Throws:

NotFoundJsonException - if user wasn't found

UnprocessableEntityJsonException - see: UnprocessableEntityErrorType.SOFTWARE_VENDOR_IS_MISSING

ForbiddenJsonException - see: ForbiddenErrorType.INSUFFICIENT_ACCESS_RIGHTS

get

public UserInfo get(String id)

Returns an user.

Parameters:

id - identifies entity

Returns:

the entity

Throws:

NotFoundJsonException - if user wasn't found

ForbiddenJsonException - see: ForbiddenErrorType.INSUFFICIENT_ACCESS_RIGHTS

create

public String create(UserRegistrationInfo userRegistrationInfo)

Creates an user.

Parameters:

userRegistrationInfo - the entity

Returns:

generated id of the entity * @throws com.srv4pos.server.api.exceptions.VersionConflictJsonException if version mismatch

Throws:

UnprocessableEntityJsonException - see: UnprocessableEntityErrorType.SOFTWARE_VENDOR_IS_MISSING

ForbiddenJsonException - see: ForbiddenErrorType.INSUFFICIENT_ACCESS_RIGHTS

list

public Collection<UserShortInfo> list(Integer firstResult,
                                      Integer maxResults,
                                      String like)

Returns list of users.

Parameters:

firstResult - when pagination starts or null

maxResults - amount of items per page or null

like - search string filter or null

Returns:

list of entities