ch.postfinance.sdk.service

Class TransactionCommentService

java.lang.Object

ch.postfinance.sdk.service.TransactionCommentService

public class TransactionCommentService
extends Object

Constructor Summary

Constructors

Constructor and Description
TransactionCommentService(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
List<TransactionComment>	all(Long spaceId, Long transactionId) Find by transaction Returns all comments of the transaction.
List<TransactionComment>	all(Long spaceId, Long transactionId, Map<String,Object> params) Find by transaction Returns all comments of the transaction.
com.google.api.client.http.HttpResponse	allForHttpResponse(Long spaceId, Long transactionId)
com.google.api.client.http.HttpResponse	allForHttpResponse(Long spaceId, Long transactionId, Map<String,Object> params)
TransactionComment	create(Long spaceId, TransactionCommentCreate entity) Create Creates the comment with the given properties.
TransactionComment	create(Long spaceId, TransactionCommentCreate entity, Map<String,Object> params) Create Creates the comment with the given properties.
com.google.api.client.http.HttpResponse	createForHttpResponse(Long spaceId, InputStream entity, String mediaType)
com.google.api.client.http.HttpResponse	createForHttpResponse(Long spaceId, TransactionCommentCreate entity)
com.google.api.client.http.HttpResponse	createForHttpResponse(Long spaceId, TransactionCommentCreate entity, Map<String,Object> params)
void	delete(Long spaceId, Long id) Delete Deletes the comment with the given id.
void	delete(Long spaceId, Long id, Map<String,Object> params) Delete Deletes the comment with the given id.
com.google.api.client.http.HttpResponse	deleteForHttpResponse(Long spaceId, Long id)
com.google.api.client.http.HttpResponse	deleteForHttpResponse(Long spaceId, Long id, Map<String,Object> params)
ApiClient	getApiClient()
void	pin(Long spaceId, Long id) Pin Pins the comment to the top.
void	pin(Long spaceId, Long id, Map<String,Object> params) Pin Pins the comment to the top.
com.google.api.client.http.HttpResponse	pinForHttpResponse(Long spaceId, Long id)
com.google.api.client.http.HttpResponse	pinForHttpResponse(Long spaceId, Long id, Map<String,Object> params)
TransactionComment	read(Long spaceId, Long id) Read Reads the comment with the given 'id' and returns it.
TransactionComment	read(Long spaceId, Long id, Map<String,Object> params) Read Reads the comment 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)
void	setApiClient(ApiClient apiClient)
void	unpin(Long spaceId, Long id) Unpin Unpins the comment from the top.
void	unpin(Long spaceId, Long id, Map<String,Object> params) Unpin Unpins the comment from the top.
com.google.api.client.http.HttpResponse	unpinForHttpResponse(Long spaceId, Long id)
com.google.api.client.http.HttpResponse	unpinForHttpResponse(Long spaceId, Long id, Map<String,Object> params)
TransactionComment	update(Long spaceId, TransactionCommentActive entity) Update This updates the comment with the given properties.
TransactionComment	update(Long spaceId, TransactionCommentActive entity, Map<String,Object> params) Update This updates the comment with the given properties.
com.google.api.client.http.HttpResponse	updateForHttpResponse(Long spaceId, InputStream entity, String mediaType)
com.google.api.client.http.HttpResponse	updateForHttpResponse(Long spaceId, TransactionCommentActive entity)
com.google.api.client.http.HttpResponse	updateForHttpResponse(Long spaceId, TransactionCommentActive 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

TransactionCommentService

public TransactionCommentService(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

all

public List<TransactionComment> all(Long spaceId,
                                    Long transactionId)
                             throws IOException

Find by transaction Returns all comments of the transaction.

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 -

transactionId -

Returns:

List<TransactionComment>

Throws:

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

See Also:

Find by transaction Documentation

all

public List<TransactionComment> all(Long spaceId,
                                    Long transactionId,
                                    Map<String,Object> params)
                             throws IOException

Find by transaction Returns all comments of the transaction.

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 -

transactionId -

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

Returns:

List<TransactionComment>

Throws:

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

See Also:

Find by transaction Documentation

allForHttpResponse

public com.google.api.client.http.HttpResponse allForHttpResponse(Long spaceId,
                                                                  Long transactionId)
                                                           throws IOException

Throws:

IOException

allForHttpResponse

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

Throws:

IOException

create

public TransactionComment create(Long spaceId,
                                 TransactionCommentCreate entity)
                          throws IOException

Create Creates the comment 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:

spaceId -

entity -

Returns:

TransactionComment

Throws:

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

See Also:

Create Documentation

create

public TransactionComment create(Long spaceId,
                                 TransactionCommentCreate entity,
                                 Map<String,Object> params)
                          throws IOException

Create Creates the comment 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:

spaceId -

entity -

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

Returns:

TransactionComment

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(Long spaceId,
                                                                     TransactionCommentCreate entity)
                                                              throws IOException

Throws:

IOException

createForHttpResponse

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

Throws:

IOException

createForHttpResponse

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

Throws:

IOException

delete

public void delete(Long spaceId,
                   Long id)
            throws IOException

Delete Deletes the comment 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:

spaceId -

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 spaceId,
                   Long id,
                   Map<String,Object> params)
            throws IOException

Delete Deletes the comment 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:

spaceId -

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

Throws:

IOException

deleteForHttpResponse

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

Throws:

IOException

pin

public void pin(Long spaceId,
                Long id)
         throws IOException

Pin Pins the comment to the top.

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:

spaceId -

id -

Throws:

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

See Also:

Pin Documentation

pin

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

Pin Pins the comment to the top.

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:

spaceId -

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:

Pin Documentation

pinForHttpResponse

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

Throws:

IOException

pinForHttpResponse

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

Throws:

IOException

read

public TransactionComment read(Long spaceId,
                               Long id)
                        throws IOException

Read Reads the comment 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 -

Returns:

TransactionComment

Throws:

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

See Also:

Read Documentation

read

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

Read Reads the comment 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 -

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

Returns:

TransactionComment

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

unpin

public void unpin(Long spaceId,
                  Long id)
           throws IOException

Unpin Unpins the comment from the top.

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:

spaceId -

id -

Throws:

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

See Also:

Unpin Documentation

unpin

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

Unpin Unpins the comment from the top.

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:

spaceId -

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:

Unpin Documentation

unpinForHttpResponse

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

Throws:

IOException

unpinForHttpResponse

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

Throws:

IOException

update

public TransactionComment update(Long spaceId,
                                 TransactionCommentActive entity)
                          throws IOException

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

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:

spaceId -

entity -

Returns:

TransactionComment

Throws:

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

See Also:

Update Documentation

update

public TransactionComment update(Long spaceId,
                                 TransactionCommentActive entity,
                                 Map<String,Object> params)
                          throws IOException

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

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:

spaceId -

entity -

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

Returns:

TransactionComment

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(Long spaceId,
                                                                     TransactionCommentActive entity)
                                                              throws IOException

Throws:

IOException

updateForHttpResponse

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

Throws:

IOException

updateForHttpResponse

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

Throws:

IOException