ch.postfinance.sdk.service

Class TokenVersionService

java.lang.Object

ch.postfinance.sdk.service.TokenVersionService

public class TokenVersionService
extends Object

Constructor Summary

Constructors

Constructor and Description
TokenVersionService(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
TokenVersion	activeVersion(Long spaceId, Long id) Active Version Returns the token version which is currently active given by the token id.
TokenVersion	activeVersion(Long spaceId, Long id, Map<String,Object> params) Active Version Returns the token version which is currently active given by the token id.
com.google.api.client.http.HttpResponse	activeVersionForHttpResponse(Long spaceId, Long id)
com.google.api.client.http.HttpResponse	activeVersionForHttpResponse(Long spaceId, Long id, Map<String,Object> params)
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()
TokenVersion	read(Long spaceId, Long id) Read Reads the entity with the given 'id' and returns it.
TokenVersion	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<TokenVersion>	search(Long spaceId, EntityQuery query) Search Searches for the entities as specified by the given query.
List<TokenVersion>	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

TokenVersionService

public TokenVersionService(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

activeVersion

public TokenVersion activeVersion(Long spaceId,
                                  Long id)
                           throws IOException

Active Version Returns the token version which is currently active given by the token id. In case no token version is active the method will return null.

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 a token for which you want to look up the current active token version.

Returns:

TokenVersion

Throws:

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

See Also:

Active Version Documentation

activeVersion

public TokenVersion activeVersion(Long spaceId,
                                  Long id,
                                  Map<String,Object> params)
                           throws IOException

Active Version Returns the token version which is currently active given by the token id. In case no token version is active the method will return null.

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 a token for which you want to look up the current active token version.

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

Returns:

TokenVersion

Throws:

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

See Also:

Active Version Documentation

activeVersionForHttpResponse

public com.google.api.client.http.HttpResponse activeVersionForHttpResponse(Long spaceId,
                                                                            Long id)
                                                                     throws IOException

Throws:

IOException

activeVersionForHttpResponse

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

Throws:

IOException

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

read

public TokenVersion 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 token version which should be returned.

Returns:

TokenVersion

Throws:

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

See Also:

Read Documentation

read

public TokenVersion 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 token version 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:

TokenVersion

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<TokenVersion> 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 token versions which are returned by the search.

Returns:

List<TokenVersion>

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<TokenVersion> 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 token versions 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<TokenVersion>

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