ch.postfinance.sdk.service

Class UserSpaceRoleService

java.lang.Object

ch.postfinance.sdk.service.UserSpaceRoleService

public class UserSpaceRoleService
extends Object

Constructor Summary

Constructors

Constructor and Description
UserSpaceRoleService(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
UserSpaceRole	addRole(Long userId, Long spaceId, Long roleId) Add Role This operation grants the given role to the user in the given space.
UserSpaceRole	addRole(Long userId, Long spaceId, Long roleId, Map<String,Object> params) Add Role This operation grants the given role to the user in the given space.
com.google.api.client.http.HttpResponse	addRoleForHttpResponse(Long userId, Long spaceId, Long roleId)
com.google.api.client.http.HttpResponse	addRoleForHttpResponse(Long userId, Long spaceId, Long roleId, Map<String,Object> params)
ApiClient	getApiClient()
List<UserSpaceRole>	list(Long userId, Long spaceId) List Roles List all the roles that are assigned to the given user in the given space.
List<UserSpaceRole>	list(Long userId, Long spaceId, Map<String,Object> params) List Roles List all the roles that are assigned to the given user in the given space.
com.google.api.client.http.HttpResponse	listForHttpResponse(Long userId, Long spaceId)
com.google.api.client.http.HttpResponse	listForHttpResponse(Long userId, Long spaceId, Map<String,Object> params)
void	removeRole(Long id) Remove Role This operation removes the specified user space role.
void	removeRole(Long id, Map<String,Object> params) Remove Role This operation removes the specified user space role.
com.google.api.client.http.HttpResponse	removeRoleForHttpResponse(Long id)
com.google.api.client.http.HttpResponse	removeRoleForHttpResponse(Long id, Map<String,Object> params)
void	setApiClient(ApiClient apiClient)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

UserSpaceRoleService

public UserSpaceRoleService(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

addRole

public UserSpaceRole addRole(Long userId,
                             Long spaceId,
                             Long roleId)
                      throws IOException

Add Role This operation grants the given role to the user in the given space.

200 - This status code indicates that a client request was successfully received, understood, and accepted.

442 - This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.

542 - This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

Parameters:

userId - The id of the user to whom the role is assigned.

spaceId - The space to which the role is mapped.

roleId - The role which is mapped to the user and space.

Returns:

UserSpaceRole

Throws:

IOException - if an error occurs while attempting to invoke the API For more information visit this link.

See Also:

Add Role Documentation

addRole

public UserSpaceRole addRole(Long userId,
                             Long spaceId,
                             Long roleId,
                             Map<String,Object> params)
                      throws IOException

Add Role This operation grants the given role to the user in the given space.

200 - This status code indicates that a client request was successfully received, understood, and accepted.

442 - This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.

542 - This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

Parameters:

userId - The id of the user to whom the role is assigned.

spaceId - The space to which the role is mapped.

roleId - The role which is mapped to the user and space.

params - Map of query params. A collection will be interpreted as passing in multiple instances of the same query param.

Returns:

UserSpaceRole

Throws:

IOException - if an error occurs while attempting to invoke the API For more information visit this link.

See Also:

Add Role Documentation

addRoleForHttpResponse

public com.google.api.client.http.HttpResponse addRoleForHttpResponse(Long userId,
                                                                      Long spaceId,
                                                                      Long roleId)
                                                               throws IOException

Throws:

IOException

addRoleForHttpResponse

public com.google.api.client.http.HttpResponse addRoleForHttpResponse(Long userId,
                                                                      Long spaceId,
                                                                      Long roleId,
                                                                      Map<String,Object> params)
                                                               throws IOException

Throws:

IOException

list

public List<UserSpaceRole> list(Long userId,
                                Long spaceId)
                         throws IOException

List Roles List all the roles that are assigned to the given user in the given space.

200 - This status code indicates that a client request was successfully received, understood, and accepted.

409 - This status code indicates that there was a conflict with the current version of the data in the database and the provided data in the request.

442 - This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.

542 - This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

Parameters:

userId - The id of the user to whom the role is assigned.

spaceId - The space to which the role is mapped.

Returns:

List<UserSpaceRole>

Throws:

IOException - if an error occurs while attempting to invoke the API For more information visit this link.

See Also:

List Roles Documentation

list

public List<UserSpaceRole> list(Long userId,
                                Long spaceId,
                                Map<String,Object> params)
                         throws IOException

List Roles List all the roles that are assigned to the given user in the given space.

200 - This status code indicates that a client request was successfully received, understood, and accepted.

409 - This status code indicates that there was a conflict with the current version of the data in the database and the provided data in the request.

442 - This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.

542 - This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

Parameters:

userId - The id of the user to whom the role is assigned.

spaceId - The space to which the role is mapped.

params - Map of query params. A collection will be interpreted as passing in multiple instances of the same query param.

Returns:

List<UserSpaceRole>

Throws:

IOException - if an error occurs while attempting to invoke the API For more information visit this link.

See Also:

List Roles Documentation

listForHttpResponse

public com.google.api.client.http.HttpResponse listForHttpResponse(Long userId,
                                                                   Long spaceId)
                                                            throws IOException

Throws:

IOException

listForHttpResponse

public com.google.api.client.http.HttpResponse listForHttpResponse(Long userId,
                                                                   Long spaceId,
                                                                   Map<String,Object> params)
                                                            throws IOException

Throws:

IOException

removeRole

public void removeRole(Long id)
                throws IOException

Remove Role This operation removes the specified user space role.

442 - This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.

542 - This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

Parameters:

id - The id of user space role which should be removed

Throws:

IOException - if an error occurs while attempting to invoke the API For more information visit this link.

See Also:

Remove Role Documentation

removeRole

public void removeRole(Long id,
                       Map<String,Object> params)
                throws IOException

Remove Role This operation removes the specified user space role.

442 - This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.

542 - This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

Parameters:

id - The id of user space role which should be removed

params - Map of query params. A collection will be interpreted as passing in multiple instances of the same query param.

Throws:

IOException - if an error occurs while attempting to invoke the API For more information visit this link.

See Also:

Remove Role Documentation

removeRoleForHttpResponse

public com.google.api.client.http.HttpResponse removeRoleForHttpResponse(Long id)
                                                                  throws IOException

Throws:

IOException

removeRoleForHttpResponse

public com.google.api.client.http.HttpResponse removeRoleForHttpResponse(Long id,
                                                                         Map<String,Object> params)
                                                                  throws IOException

Throws:

IOException