ch.postfinance.sdk.service

Class LabelDescriptionService

java.lang.Object

ch.postfinance.sdk.service.LabelDescriptionService

public class LabelDescriptionService
extends Object

Constructor Summary

Constructors

Constructor and Description
LabelDescriptionService(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
List<LabelDescriptor>	all() All This operation returns all entities which are available.
List<LabelDescriptor>	all(Map<String,Object> params) All This operation returns all entities which are available.
com.google.api.client.http.HttpResponse	allForHttpResponse()
com.google.api.client.http.HttpResponse	allForHttpResponse(Map<String,Object> params)
ApiClient	getApiClient()
LabelDescriptor	read(Long id) Read Reads the entity with the given 'id' and returns it.
LabelDescriptor	read(Long id, Map<String,Object> params) Read Reads the entity with the given 'id' and returns it.
com.google.api.client.http.HttpResponse	readForHttpResponse(Long id)
com.google.api.client.http.HttpResponse	readForHttpResponse(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

LabelDescriptionService

public LabelDescriptionService(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

all

public List<LabelDescriptor> all()
                          throws IOException

All This operation returns all entities which are available.

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.

Returns:

List<LabelDescriptor>

Throws:

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

See Also:

All Documentation

all

public List<LabelDescriptor> all(Map<String,Object> params)
                          throws IOException

All This operation returns all entities which are available.

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:

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

Returns:

List<LabelDescriptor>

Throws:

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

See Also:

All Documentation

allForHttpResponse

public com.google.api.client.http.HttpResponse allForHttpResponse()
                                                           throws IOException

Throws:

IOException

allForHttpResponse

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

Throws:

IOException

read

public LabelDescriptor read(Long id)
                     throws IOException

Read Reads the entity with the given 'id' and returns it.

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:

id - The id of the label descriptor which should be returned.

Returns:

LabelDescriptor

Throws:

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

See Also:

Read Documentation

read

public LabelDescriptor read(Long id,
                            Map<String,Object> params)
                     throws IOException

Read Reads the entity with the given 'id' and returns it.

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:

id - The id of the label descriptor which should be returned.

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

Returns:

LabelDescriptor

Throws:

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

See Also:

Read Documentation

readForHttpResponse

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

Throws:

IOException

readForHttpResponse

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

Throws:

IOException