ch.postfinance.sdk.service

Class DeliveryIndicationService

java.lang.Object

ch.postfinance.sdk.service.DeliveryIndicationService

public class DeliveryIndicationService
extends Object

Constructor Summary

Constructors

Constructor and Description
DeliveryIndicationService(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
Long	count(EntityQueryFilter filter, Long spaceId, Map<String,Object> params) Count Counts the number of items in the database as restricted by the given filter.
Long	count(Long spaceId, EntityQueryFilter filter) Count Counts the number of items in the database as restricted by the given filter.
com.google.api.client.http.HttpResponse	countForHttpResponse(EntityQueryFilter filter, Long spaceId, Map<String,Object> params)
com.google.api.client.http.HttpResponse	countForHttpResponse(Long spaceId, EntityQueryFilter filter)
com.google.api.client.http.HttpResponse	countForHttpResponse(Long spaceId, InputStream filter, String mediaType)
ApiClient	getApiClient()
DeliveryIndication	markAsNotSuitable(Long spaceId, Long deliveryIndicationId) markAsNotSuitable This operation marks the delivery indication as not suitable.
DeliveryIndication	markAsNotSuitable(Long spaceId, Long deliveryIndicationId, Map<String,Object> params) markAsNotSuitable This operation marks the delivery indication as not suitable.
com.google.api.client.http.HttpResponse	markAsNotSuitableForHttpResponse(Long spaceId, InputStream deliveryIndicationId, String mediaType)
com.google.api.client.http.HttpResponse	markAsNotSuitableForHttpResponse(Long spaceId, Long deliveryIndicationId)
com.google.api.client.http.HttpResponse	markAsNotSuitableForHttpResponse(Long spaceId, Long deliveryIndicationId, Map<String,Object> params)
DeliveryIndication	markAsSuitable(Long spaceId, Long deliveryIndicationId) markAsSuitable This operation marks the delivery indication as suitable.
DeliveryIndication	markAsSuitable(Long spaceId, Long deliveryIndicationId, Map<String,Object> params) markAsSuitable This operation marks the delivery indication as suitable.
com.google.api.client.http.HttpResponse	markAsSuitableForHttpResponse(Long spaceId, InputStream deliveryIndicationId, String mediaType)
com.google.api.client.http.HttpResponse	markAsSuitableForHttpResponse(Long spaceId, Long deliveryIndicationId)
com.google.api.client.http.HttpResponse	markAsSuitableForHttpResponse(Long spaceId, Long deliveryIndicationId, Map<String,Object> params)
DeliveryIndication	read(Long spaceId, Long id) Read Reads the entity with the given 'id' and returns it.
DeliveryIndication	read(Long spaceId, 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 spaceId, Long id)
com.google.api.client.http.HttpResponse	readForHttpResponse(Long spaceId, Long id, Map<String,Object> params)
List<DeliveryIndication>	search(Long spaceId, EntityQuery query) Search Searches for the entities as specified by the given query.
List<DeliveryIndication>	search(Long spaceId, EntityQuery query, Map<String,Object> params) Search Searches for the entities as specified by the given query.
com.google.api.client.http.HttpResponse	searchForHttpResponse(Long spaceId, EntityQuery query)
com.google.api.client.http.HttpResponse	searchForHttpResponse(Long spaceId, EntityQuery query, Map<String,Object> params)
com.google.api.client.http.HttpResponse	searchForHttpResponse(Long spaceId, InputStream query, String mediaType)
void	setApiClient(ApiClient apiClient)

Methods inherited from class java.lang.Object

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

Constructor Detail

DeliveryIndicationService

public DeliveryIndicationService(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

count

public Long count(Long spaceId,
                  EntityQueryFilter filter)
           throws IOException

Count Counts the number of items in the database as restricted by the given filter.

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:

spaceId -

filter - The filter which restricts the entities which are used to calculate the count.

Returns:

Long

Throws:

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

See Also:

Count Documentation

count

public Long count(EntityQueryFilter filter,
                  Long spaceId,
                  Map<String,Object> params)
           throws IOException

Count Counts the number of items in the database as restricted by the given filter.

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:

spaceId -

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

Returns:

Long

Throws:

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

See Also:

Count Documentation

countForHttpResponse

public com.google.api.client.http.HttpResponse countForHttpResponse(Long spaceId,
                                                                    EntityQueryFilter filter)
                                                             throws IOException

Throws:

IOException

countForHttpResponse

public com.google.api.client.http.HttpResponse countForHttpResponse(Long spaceId,
                                                                    InputStream filter,
                                                                    String mediaType)
                                                             throws IOException

Throws:

IOException

countForHttpResponse

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

Throws:

IOException

markAsNotSuitable

public DeliveryIndication markAsNotSuitable(Long spaceId,
                                            Long deliveryIndicationId)
                                     throws IOException

markAsNotSuitable This operation marks the delivery indication as not suitable.

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:

spaceId -

deliveryIndicationId - The delivery indication id which should be marked as not suitable.

Returns:

DeliveryIndication

Throws:

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

See Also:

markAsNotSuitable Documentation

markAsNotSuitable

public DeliveryIndication markAsNotSuitable(Long spaceId,
                                            Long deliveryIndicationId,
                                            Map<String,Object> params)
                                     throws IOException

markAsNotSuitable This operation marks the delivery indication as not suitable.

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:

spaceId -

deliveryIndicationId - The delivery indication id which should be marked as not suitable.

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

Returns:

DeliveryIndication

Throws:

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

See Also:

markAsNotSuitable Documentation

markAsNotSuitableForHttpResponse

public com.google.api.client.http.HttpResponse markAsNotSuitableForHttpResponse(Long spaceId,
                                                                                Long deliveryIndicationId)
                                                                         throws IOException

Throws:

IOException

markAsNotSuitableForHttpResponse

public com.google.api.client.http.HttpResponse markAsNotSuitableForHttpResponse(Long spaceId,
                                                                                InputStream deliveryIndicationId,
                                                                                String mediaType)
                                                                         throws IOException

Throws:

IOException

markAsNotSuitableForHttpResponse

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

Throws:

IOException

markAsSuitable

public DeliveryIndication markAsSuitable(Long spaceId,
                                         Long deliveryIndicationId)
                                  throws IOException

markAsSuitable This operation marks the delivery indication as suitable.

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:

spaceId -

deliveryIndicationId - The delivery indication id which should be marked as suitable.

Returns:

DeliveryIndication

Throws:

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

See Also:

markAsSuitable Documentation

markAsSuitable

public DeliveryIndication markAsSuitable(Long spaceId,
                                         Long deliveryIndicationId,
                                         Map<String,Object> params)
                                  throws IOException

markAsSuitable This operation marks the delivery indication as suitable.

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:

spaceId -

deliveryIndicationId - The delivery indication id which should be marked as suitable.

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

Returns:

DeliveryIndication

Throws:

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

See Also:

markAsSuitable Documentation

markAsSuitableForHttpResponse

public com.google.api.client.http.HttpResponse markAsSuitableForHttpResponse(Long spaceId,
                                                                             Long deliveryIndicationId)
                                                                      throws IOException

Throws:

IOException

markAsSuitableForHttpResponse

public com.google.api.client.http.HttpResponse markAsSuitableForHttpResponse(Long spaceId,
                                                                             InputStream deliveryIndicationId,
                                                                             String mediaType)
                                                                      throws IOException

Throws:

IOException

markAsSuitableForHttpResponse

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

Throws:

IOException

read

public DeliveryIndication read(Long spaceId,
                               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:

spaceId -

id - The id of the delivery indication which should be returned.

Returns:

DeliveryIndication

Throws:

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

See Also:

Read Documentation

read

public DeliveryIndication read(Long spaceId,
                               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:

spaceId -

id - The id of the delivery indication 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:

DeliveryIndication

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 spaceId,
                                                                   Long id)
                                                            throws IOException

Throws:

IOException

readForHttpResponse

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

Throws:

IOException

search

public List<DeliveryIndication> search(Long spaceId,
                                       EntityQuery query)
                                throws IOException

Search Searches for the entities as specified by the given query.

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:

spaceId -

query - The query restricts the delivery indications which are returned by the search.

Returns:

List<DeliveryIndication>

Throws:

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

See Also:

Search Documentation

search

public List<DeliveryIndication> search(Long spaceId,
                                       EntityQuery query,
                                       Map<String,Object> params)
                                throws IOException

Search Searches for the entities as specified by the given query.

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:

spaceId -

query - The query restricts the delivery indications which are returned by the search.

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

Returns:

List<DeliveryIndication>

Throws:

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

See Also:

Search Documentation

searchForHttpResponse

public com.google.api.client.http.HttpResponse searchForHttpResponse(Long spaceId,
                                                                     EntityQuery query)
                                                              throws IOException

Throws:

IOException

searchForHttpResponse

public com.google.api.client.http.HttpResponse searchForHttpResponse(Long spaceId,
                                                                     InputStream query,
                                                                     String mediaType)
                                                              throws IOException

Throws:

IOException

searchForHttpResponse

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

Throws:

IOException