com.kontakt.sdk.android.http.interfaces

Interface ManagersApiAccessor

All Known Subinterfaces:

IKontaktApiClient

All Known Implementing Classes:

KontaktApiClient

public interface ManagersApiAccessor

Managers API Accessor provides interface for Managers hierarchy management.

Method Summary

Modifier and Type	Method and Description
int	assignManagersToSupervisor(java.util.UUID supervisorId, java.util.Set<java.util.UUID> managerIdSet) Assigns managers to supervisor.
void	assignManagersToSupervisor(java.util.UUID supervisorId, java.util.Set<java.util.UUID> managerIdSet, UpdateApiCallback apiCallback) Assign managers to supervisor.
HttpResult<IManager>	createManager(ManagerData manager) Creates manager.
void	createManager(ManagerData managerData, ResultApiCallback<IManager> apiCallback) Create manager.
int	deleteManager(java.util.UUID managerId) Deletes manager.
void	deleteManager(java.util.UUID managerId, UpdateApiCallback apiCallback) Delete manager.
HttpResult<IManager>	getManager(java.util.UUID managerId) Gets manager.
void	getManager(java.util.UUID managerId, ResultApiCallback<IManager> apiCallback) Gets manager.
HttpResult<IManager>	getManager(java.util.UUID managerId, SDKOptional<ETag> eTagOptional) Gets manager.
void	getManager(java.util.UUID managerId, SDKOptional<ETag> etag, ResultApiCallback<IManager> apiCallback) Gets manager.
HttpResult<java.util.List<IManager>>	listManagers() List managers.
HttpResult<java.util.List<IManager>>	listManagers(RequestDescription requestDescription) Provides the list of managers.
void	listManagers(RequestDescription requestDescription, ResultApiCallback<java.util.List<IManager>> apiCallback) List managers.
void	listManagers(ResultApiCallback<java.util.List<IManager>> apiCallback) List managers.
HttpResult<java.util.List<IManager>>	listSubordinatesForManager(java.util.UUID managerId) List subordinates for manager.
HttpResult<java.util.List<IManager>>	listSubordinatesForManager(java.util.UUID managerId, RequestDescription requestDescription) Gets subordinates for manager by specified Manager Id.
void	listSubordinatesForManager(java.util.UUID managerId, RequestDescription requestDescription, ResultApiCallback<java.util.List<IManager>> resultApiCallback) List subordinates for manager.
void	listSubordinatesForManager(java.util.UUID managerId, ResultApiCallback<java.util.List<IManager>> resultApiCallback) List subordinates for manager.
int	updateManager(ManagerData managerData) Updates manager.
void	updateManager(ManagerData managerData, UpdateApiCallback updateApiCallback) Update manager.

Methods inherited from interface java.io.Closeable

close

Method Detail

listSubordinatesForManager

HttpResult<java.util.List<IManager>> listSubordinatesForManager(java.util.UUID managerId,
                                                                RequestDescription requestDescription)
                                                         throws ClientException

Gets subordinates for manager by specified Manager Id. If the ETag's value matches the latest one the code 304 (NOT MODIFIED) is returned.

Parameters:

managerId - the manager id

requestDescription - the request description

Returns:

the subordinates for manager

Throws:

ClientException - is thrown if unexpected error has occured

listSubordinatesForManager

HttpResult<java.util.List<IManager>> listSubordinatesForManager(java.util.UUID managerId)
                                                         throws ClientException

List subordinates for manager.

Parameters:

managerId - the manager id

Returns:

the http result

Throws:

ClientException - the client exception

listSubordinatesForManager

void listSubordinatesForManager(java.util.UUID managerId,
                                RequestDescription requestDescription,
                                ResultApiCallback<java.util.List<IManager>> resultApiCallback)

List subordinates for manager.

Parameters:

managerId - the manager id

requestDescription - the request description

resultApiCallback - the result api callback

listSubordinatesForManager

void listSubordinatesForManager(java.util.UUID managerId,
                                ResultApiCallback<java.util.List<IManager>> resultApiCallback)

List subordinates for manager.

Parameters:

managerId - the manager id

resultApiCallback - the result api callback

deleteManager

int deleteManager(java.util.UUID managerId)
           throws ClientException

Deletes manager.

Parameters:

managerId - the manager id

Returns:

the Http Status. Successful deletion should return Http Status: 200.

Throws:

ClientException - is thrown if unexpected error has occured

deleteManager

void deleteManager(java.util.UUID managerId,
                   UpdateApiCallback apiCallback)

Delete manager.

Parameters:

managerId - the manager id

apiCallback - the api callback

updateManager

int updateManager(ManagerData managerData)
           throws ClientException

Updates manager.

Required parameter: manager Id. The optional parameters: firstName, lastName, role(one of: ADMIN, OPERATOR), e-mail.If any of the optional parameters is null, it will not be updated.

Parameters:

managerData - the manager update data

Returns:

the Http Status. Successful update should return HttpStauts: 200.

Throws:

ClientException - is thrown if unexpected error has occured

updateManager

void updateManager(ManagerData managerData,
                   UpdateApiCallback updateApiCallback)

Update manager.

Parameters:

managerData - the manager data

updateApiCallback - the update api callback

createManager

HttpResult<IManager> createManager(ManagerData manager)
                            throws ClientException

Creates manager.

Required parameters: firstName, lastName, e-mail, role(one of: SUPERUSER, ADMIN, OPERATOR).

Parameters:

manager - the manager data

Returns:

the result

Throws:

ClientException - is thrown if unexpected error has occured

createManager

void createManager(ManagerData managerData,
                   ResultApiCallback<IManager> apiCallback)

Create manager.

Parameters:

managerData - the manager data

apiCallback - the api callback

getManager

HttpResult<IManager> getManager(java.util.UUID managerId,
                                SDKOptional<ETag> eTagOptional)
                         throws ClientException

Gets manager.

Parameters:

managerId - the manager id

eTagOptional - the e tag optional

Returns:

the manager

Throws:

ClientException - the client exception

getManager

HttpResult<IManager> getManager(java.util.UUID managerId)
                         throws ClientException

Gets manager.

Parameters:

managerId - the manager id

Returns:

the manager

Throws:

ClientException - the client exception

getManager

void getManager(java.util.UUID managerId,
                SDKOptional<ETag> etag,
                ResultApiCallback<IManager> apiCallback)

Gets manager.

Parameters:

managerId - the manager id

etag - the etag

apiCallback - the api callback

getManager

void getManager(java.util.UUID managerId,
                ResultApiCallback<IManager> apiCallback)

Gets manager.

Parameters:

managerId - the manager id

apiCallback - the api callback

assignManagersToSupervisor

int assignManagersToSupervisor(java.util.UUID supervisorId,
                               java.util.Set<java.util.UUID> managerIdSet)
                        throws ClientException

Assigns managers to supervisor.

Parameters:

supervisorId - the supervisor id

managerIdSet - the manager ids set

Returns:

the Http Status. Successful assign returns Http Status: 200.

Throws:

ClientException - is thrown if unexpected error has occured

assignManagersToSupervisor

void assignManagersToSupervisor(java.util.UUID supervisorId,
                                java.util.Set<java.util.UUID> managerIdSet,
                                UpdateApiCallback apiCallback)

Assign managers to supervisor.

Parameters:

supervisorId - the supervisor id

managerIdSet - the manager id set

apiCallback - the api callback

listManagers

HttpResult<java.util.List<IManager>> listManagers(RequestDescription requestDescription)
                                           throws ClientException

Provides the list of managers. According to request description the response:

• may contain sorted list items
• may contain empty body for conditional requests with ETag value included in headers
• may contain list items in ascending or descending order
• may contain ranged list items by specifying start index and offset

Parameters:

requestDescription - the request description

Returns:

the devices

Throws:

ClientException - the client exception

listManagers

HttpResult<java.util.List<IManager>> listManagers()
                                           throws ClientException

List managers.

Returns:

the http result

Throws:

ClientException - the client exception

listManagers

void listManagers(RequestDescription requestDescription,
                  ResultApiCallback<java.util.List<IManager>> apiCallback)

List managers.

Parameters:

requestDescription - the request description

apiCallback - the api callback

listManagers

void listManagers(ResultApiCallback<java.util.List<IManager>> apiCallback)

List managers.

Parameters:

apiCallback - the api callback