ch.postfinance.sdk.service

Class SpaceService

java.lang.Object

ch.postfinance.sdk.service.SpaceService

public class SpaceService
extends Object

Constructor Summary

Constructors

Constructor and Description
SpaceService(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
Long	count(EntityQueryFilter filter) Count Counts the number of items in the database as restricted by the given filter.
Long	count(EntityQueryFilter filter, Map<String,Object> params) Count Counts the number of items in the database as restricted by the given filter.
com.google.api.client.http.HttpResponse	countForHttpResponse(EntityQueryFilter filter)
com.google.api.client.http.HttpResponse	countForHttpResponse(EntityQueryFilter filter, Map<String,Object> params)
com.google.api.client.http.HttpResponse	countForHttpResponse(InputStream filter, String mediaType)
Space	create(SpaceCreate entity) Create Creates the entity with the given properties.
Space	create(SpaceCreate entity, Map<String,Object> params) Create Creates the entity with the given properties.
com.google.api.client.http.HttpResponse	createForHttpResponse(InputStream entity, String mediaType)
com.google.api.client.http.HttpResponse	createForHttpResponse(SpaceCreate entity)
com.google.api.client.http.HttpResponse	createForHttpResponse(SpaceCreate entity, Map<String,Object> params)
void	delete(Long id) Delete Deletes the entity with the given id.
void	delete(Long id, Map<String,Object> params) Delete Deletes the entity with the given id.
com.google.api.client.http.HttpResponse	deleteForHttpResponse(InputStream id, String mediaType)
com.google.api.client.http.HttpResponse	deleteForHttpResponse(Long id)
com.google.api.client.http.HttpResponse	deleteForHttpResponse(Long id, Map<String,Object> params)
ApiClient	getApiClient()
Space	read(Long id) Read Reads the entity with the given 'id' and returns it.
Space	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)
List<Space>	search(EntityQuery query) Search Searches for the entities as specified by the given query.
List<Space>	search(EntityQuery query, Map<String,Object> params) Search Searches for the entities as specified by the given query.
com.google.api.client.http.HttpResponse	searchForHttpResponse(EntityQuery query)
com.google.api.client.http.HttpResponse	searchForHttpResponse(EntityQuery query, Map<String,Object> params)
com.google.api.client.http.HttpResponse	searchForHttpResponse(InputStream query, String mediaType)
void	setApiClient(ApiClient apiClient)
Space	update(SpaceUpdate entity) Update This updates the entity with the given properties.
Space	update(SpaceUpdate entity, Map<String,Object> params) Update This updates the entity with the given properties.
com.google.api.client.http.HttpResponse	updateForHttpResponse(InputStream entity, String mediaType)
com.google.api.client.http.HttpResponse	updateForHttpResponse(SpaceUpdate entity)
com.google.api.client.http.HttpResponse	updateForHttpResponse(SpaceUpdate entity, Map<String,Object> params)

Methods inherited from class java.lang.Object

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

Constructor Detail

SpaceService

public SpaceService(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

count

public Long count(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:

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,
                  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:

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(EntityQueryFilter filter)
                                                             throws IOException

Throws:

IOException

countForHttpResponse

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

Throws:

IOException

countForHttpResponse

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

Throws:

IOException

create

public Space create(SpaceCreate entity)
             throws IOException

Create Creates the entity with the given properties.

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:

entity - The space object with the properties which should be created.

Returns:

Space

Throws:

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

See Also:

Create Documentation

create

public Space create(SpaceCreate entity,
                    Map<String,Object> params)
             throws IOException

Create Creates the entity with the given properties.

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:

entity - The space object with the properties which should be created.

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

Returns:

Space

Throws:

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

See Also:

Create Documentation

createForHttpResponse

public com.google.api.client.http.HttpResponse createForHttpResponse(SpaceCreate entity)
                                                              throws IOException

Throws:

IOException

createForHttpResponse

public com.google.api.client.http.HttpResponse createForHttpResponse(InputStream entity,
                                                                     String mediaType)
                                                              throws IOException

Throws:

IOException

createForHttpResponse

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

Throws:

IOException

delete

public void delete(Long id)
            throws IOException

Delete Deletes the entity with the given id.

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:

id -

Throws:

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

See Also:

Delete Documentation

delete

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

Delete Deletes the entity with the given id.

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:

id -

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:

Delete Documentation

deleteForHttpResponse

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

Throws:

IOException

deleteForHttpResponse

public com.google.api.client.http.HttpResponse deleteForHttpResponse(InputStream id,
                                                                     String mediaType)
                                                              throws IOException

Throws:

IOException

deleteForHttpResponse

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

Throws:

IOException

read

public Space 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 space which should be returned.

Returns:

Space

Throws:

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

See Also:

Read Documentation

read

public Space 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 space 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:

Space

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

search

public List<Space> search(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:

query - The query restricts the spaces which are returned by the search.

Returns:

List<Space>

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<Space> search(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:

query - The query restricts the spaces 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<Space>

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(EntityQuery query)
                                                              throws IOException

Throws:

IOException

searchForHttpResponse

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

Throws:

IOException

searchForHttpResponse

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

Throws:

IOException

update

public Space update(SpaceUpdate entity)
             throws IOException

Update This updates the entity with the given properties. Only those properties which should be updated can be provided. The 'id' and 'version' are required to identify the entity.

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:

entity - The space object with all the properties which should be updated. The id and the version are required properties.

Returns:

Space

Throws:

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

See Also:

Update Documentation

update

public Space update(SpaceUpdate entity,
                    Map<String,Object> params)
             throws IOException

Update This updates the entity with the given properties. Only those properties which should be updated can be provided. The 'id' and 'version' are required to identify the entity.

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:

entity - The space object with all the properties which should be updated. The id and the version are required properties.

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

Returns:

Space

Throws:

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

See Also:

Update Documentation

updateForHttpResponse

public com.google.api.client.http.HttpResponse updateForHttpResponse(SpaceUpdate entity)
                                                              throws IOException

Throws:

IOException

updateForHttpResponse

public com.google.api.client.http.HttpResponse updateForHttpResponse(InputStream entity,
                                                                     String mediaType)
                                                              throws IOException

Throws:

IOException

updateForHttpResponse

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

Throws:

IOException