com.intuit.ipp.services

Class DataService

java.lang.Object

com.intuit.ipp.services.DataService

public class DataService
extends Object

Class which has common methods for CRUD operations

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	DataService() Hiding the default constructor as Context is always required to function properly
	DataService(Context context) Constructor DataService

Method Summary

Modifier and Type	Method and Description
<T extends IEntity> T	add(T entity) Method to add the given entity
<T extends IEntity> void	addAsync(T entity, CallbackHandler callbackHandler) Method to add the given entity in asynchronous fashion
<T extends IEntity> T	delete(T entity) Method to delete record for the given entity
<T extends IEntity> void	deleteAsync(T entity, CallbackHandler callbackHandler) Method to delete record for the given entity in asynchronous fashion
<T extends IEntity> T	donotUpdateAccountOnTxns(T entity)
<T extends IEntity> InputStream	download(T entity) Method to find the record for the given id for the corresponding entity
<T extends IEntity> void	downloadAsync(T entity, CallbackHandler callbackHandler) Method to download the file for the given entity id in asynchronous fashion
<T extends IEntity> InputStream	downloadPDF(T entity)
<T extends IEntity> void	downloadPDFAsync(T entity, CallbackHandler callbackHandler) Method to download the file for the given entity id in asynchronous fashion
protected void	executeAsyncInterceptors(IntuitMessage intuitMessage) Invokes async interceptors, which creates thread and perform networking
void	executeBatch(BatchOperation batchOperation) Method to execute the batch operation
void	executeBatchAsync(BatchOperation batchOperation, CallbackHandler callbackHandler) Method to cancel the operation for the corresponding entity in asynchronous fashion
List<CDCQueryResult>	executeCDCQuery(List<? extends IEntity> entities, String changedSince) Method to retrieve the list of records for the given entities whose last modified date is greater than the given changedSince date
void	executeCDCQueryAsync(List<? extends IEntity> entities, String changedSince, CallbackHandler callbackHandler) Method to retrieve records for the given list of query in asynchronous fashion
protected void	executeInterceptors(IntuitMessage intuitMessage) Invokes interceptors, which perform networking operations (serialization, compression, connection etc)
protected void	executeInterceptors(List<IntuitMessage> intuitMessages) Invokes interceptors, which perform networking operations (serialization, compression, connection etc)
QueryResult	executeQuery(String query) Method to retrieve records for the given list of query
void	executeQueryAsync(String query, CallbackHandler callbackHandler) Method to retrieve records for the given list of query in asynchronous fashion
<T extends IEntity> List<T>	findAll(T entity) Method to retrieve all records for the given entity Note, without pagination this will return only 100 records Use query API to add pagintion and obtain additional records
<T extends IEntity> void	findAllAsync(T entity, CallbackHandler callbackHandler) Method to retrieve all records for the given entity in asynchronous fashion Note, without pagination this will return only 100 records Use query API to add pagintion and obtain additional records
<T extends IEntity> T	findById(T entity) Method to find the record for the given id for the corresponding entity
<T extends IEntity> void	findByIdAsync(T entity, CallbackHandler callbackHandler) Method to find the record for the given id for the corresponding entity in asynchronous fashion
protected CDCQueryResult	getCDCQueryResult(CDCResponse cdcResponse) Method to construct and return the CDCQueryResult object from CDCResponse
protected List<CDCQueryResult>	getCDCQueryResult(List<CDCResponse> cdcResponses) Method to get the list of CDCQueryResult object from list of CDCResponse
protected QueryResult	getQueryResult(QueryResponse queryResponse) Method to read the query response from QueryResponse and set into QueryResult
protected <T extends IEntity> Object	getSerializableObject(T object) Method to get the serializable object for the given entity
protected <T> Object	getSerializableRequestObject(T object) Method to get the JAXBElement, using ObjectFactory, to serialize the request
<T extends IEntity> boolean	isAvailableAsPDF(T entity) Returns true if the entity can be downloaded as PDF
<T extends IEntity> boolean	isAvailableToEmail(T entity) Returns true if the entity can be send as email
<T extends IEntity> T	sendEmail(T entity) Send entity via email using address associated with this entity in the system
<T extends IEntity> T	sendEmail(T entity, String email) Send entity via email using specified address
<T extends IEntity> void	sendEmailAsync(T entity, CallbackHandler callbackHandler) Method to send the entity to default email for the given id in asynchronous fashion
<T extends IEntity> void	sendEmailAsync(T entity, String email, CallbackHandler callbackHandler) Method to send the entity to email for the given id in asynchronous fashion
<T extends IEntity> T	update(T entity) Method to update the record of the corresponding entity
<T extends IEntity> T	updateAccountOnTxns(T entity)
<T extends IEntity> void	updateAsync(T entity, CallbackHandler callbackHandler) Method to update the record of the corresponding entity in asynchronous fashion
<T extends IEntity> List<T>	upload(List<UploadEntry> entries) Method to upload entities with their correspond binary
<T extends IEntity> T	upload(T entity, InputStream docContent) Method to upload the given document content for the corresponding entity
<T extends IEntity> void	uploadAsync(T entity, InputStream docContent, CallbackHandler callbackHandler) Method to upload the file for the given entity in asynchronous fashion
<T extends IEntity> T	voidRequest(T entity) Method to cancel the operation for the corresponding entity
<T extends IEntity> void	voidRequestAsync(T entity, CallbackHandler callbackHandler) Method to cancel the operation for the corresponding entity in asynchronous fashion

Methods inherited from class java.lang.Object

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

Constructor Detail

DataService

protected DataService()

Hiding the default constructor as Context is always required to function properly

DataService

public DataService(Context context)

Constructor DataService

Parameters:

context - the context

Method Detail

findAll

public <T extends IEntity> List<T> findAll(T entity)
                                    throws FMSException

Method to retrieve all records for the given entity Note, without pagination this will return only 100 records Use query API to add pagintion and obtain additional records

Parameters:

entity - the entity

Returns:

returns the queryResult

Throws:

FMSException - throws FMSException

add

public <T extends IEntity> T add(T entity)
                          throws FMSException

Method to add the given entity

Parameters:

entity - the entity

Returns:

returns the added entity

Throws:

FMSException - throws FMSException

executeInterceptors

protected void executeInterceptors(IntuitMessage intuitMessage)
                            throws FMSException

Invokes interceptors, which perform networking operations (serialization, compression, connection etc)

Parameters:

intuitMessage -

Throws:

FMSException

executeInterceptors

protected void executeInterceptors(List<IntuitMessage> intuitMessages)
                            throws FMSException

Invokes interceptors, which perform networking operations (serialization, compression, connection etc)

Parameters:

intuitMessages -

Throws:

FMSException

executeAsyncInterceptors

protected void executeAsyncInterceptors(IntuitMessage intuitMessage)

Invokes async interceptors, which creates thread and perform networking

Parameters:

intuitMessage -

delete

public <T extends IEntity> T delete(T entity)
                             throws FMSException

Method to delete record for the given entity

Parameters:

entity - the entity

Returns:

returns deleted y status

Throws:

FMSException

update

public <T extends IEntity> T update(T entity)
                             throws FMSException

Method to update the record of the corresponding entity

Parameters:

entity - the entity

Returns:

returns upadated status

Throws:

FMSException

updateAccountOnTxns

public <T extends IEntity> T updateAccountOnTxns(T entity)
                                          throws FMSException

Throws:

FMSException

donotUpdateAccountOnTxns

public <T extends IEntity> T donotUpdateAccountOnTxns(T entity)
                                               throws FMSException

Throws:

FMSException

findById

public <T extends IEntity> T findById(T entity)
                               throws FMSException

Method to find the record for the given id for the corresponding entity

Parameters:

entity -

Returns:

returns the entity

Throws:

FMSException

voidRequest

public <T extends IEntity> T voidRequest(T entity)
                                  throws FMSException

Method to cancel the operation for the corresponding entity

Parameters:

entity -

Returns:

entity the entity

Throws:

FMSException

upload

public <T extends IEntity> T upload(T entity,
                                    InputStream docContent)
                             throws FMSException

Method to upload the given document content for the corresponding entity

Parameters:

entity - the entity

Returns:

returns the entity

Throws:

FMSException

upload

public <T extends IEntity> List<T> upload(List<UploadEntry> entries)
                                   throws FMSException

Method to upload entities with their correspond binary

Type Parameters:

T -

Parameters:

entries -

Returns:

Throws:

FMSException

download

public <T extends IEntity> InputStream download(T entity)
                                         throws FMSException

Method to find the record for the given id for the corresponding entity

Parameters:

entity -

Returns:

returns the entity

Throws:

FMSException

downloadPDF

public <T extends IEntity> InputStream downloadPDF(T entity)
                                            throws FMSException

Throws:

FMSException

sendEmail

public <T extends IEntity> T sendEmail(T entity)
                                throws FMSException

Send entity via email using address associated with this entity in the system

Type Parameters:

T -

Parameters:

entity -

Returns:

Throws:

FMSException

sendEmail

public <T extends IEntity> T sendEmail(T entity,
                                       String email)
                                throws FMSException

Send entity via email using specified address

Type Parameters:

T -

Parameters:

entity -

email -

Returns:

Throws:

FMSException

isAvailableAsPDF

public <T extends IEntity> boolean isAvailableAsPDF(T entity)

Returns true if the entity can be downloaded as PDF

Type Parameters:

T -

Parameters:

entity -

Returns:

isAvailableToEmail

public <T extends IEntity> boolean isAvailableToEmail(T entity)

Returns true if the entity can be send as email

Type Parameters:

T -

Parameters:

entity -

Returns:

executeQuery

public QueryResult executeQuery(String query)
                         throws FMSException

Method to retrieve records for the given list of query

Parameters:

query - the query string

Returns:

query result

Throws:

FMSException - throws FMSException

executeCDCQuery

public List<CDCQueryResult> executeCDCQuery(List<? extends IEntity> entities,
                                            String changedSince)
                                     throws FMSException

Method to retrieve the list of records for the given entities whose last modified date is greater than the given changedSince date

Parameters:

entities - the list of entities to be listed in the response

changedSince - the date where the entities should be listed from the last changed date

Returns:

the list of CDCQueryResult object

Throws:

FMSException - throws FMSException

executeBatch

public void executeBatch(BatchOperation batchOperation)
                  throws FMSException

Method to execute the batch operation

Parameters:

batchOperation - the batch operation

Throws:

FMSException - throws FMSException

findAllAsync

public <T extends IEntity> void findAllAsync(T entity,
                                             CallbackHandler callbackHandler)
                                      throws FMSException

Method to retrieve all records for the given entity in asynchronous fashion Note, without pagination this will return only 100 records Use query API to add pagintion and obtain additional records

Parameters:

entity - the entity

callbackHandler - the callback handler

Throws:

FMSException - throws FMSException

addAsync

public <T extends IEntity> void addAsync(T entity,
                                         CallbackHandler callbackHandler)
                                  throws FMSException

Method to add the given entity in asynchronous fashion

Parameters:

entity - the entity

callbackHandler - the callback handler

Throws:

FMSException - throws FMSException

deleteAsync

public <T extends IEntity> void deleteAsync(T entity,
                                            CallbackHandler callbackHandler)
                                     throws FMSException

Method to delete record for the given entity in asynchronous fashion

Parameters:

entity - the entity

callbackHandler - the callback handler

Throws:

FMSException

updateAsync

public <T extends IEntity> void updateAsync(T entity,
                                            CallbackHandler callbackHandler)
                                     throws FMSException

Method to update the record of the corresponding entity in asynchronous fashion

Parameters:

entity - the entity

callbackHandler - the callback handler

Throws:

FMSException

findByIdAsync

public <T extends IEntity> void findByIdAsync(T entity,
                                              CallbackHandler callbackHandler)
                                       throws FMSException

Method to find the record for the given id for the corresponding entity in asynchronous fashion

Parameters:

entity - the entity

callbackHandler - the callback handler

Throws:

FMSException

voidRequestAsync

public <T extends IEntity> void voidRequestAsync(T entity,
                                                 CallbackHandler callbackHandler)
                                          throws FMSException

Method to cancel the operation for the corresponding entity in asynchronous fashion

Parameters:

entity - the entity

callbackHandler - the callback handler

Throws:

FMSException

uploadAsync

public <T extends IEntity> void uploadAsync(T entity,
                                            InputStream docContent,
                                            CallbackHandler callbackHandler)
                                     throws FMSException

Method to upload the file for the given entity in asynchronous fashion

Parameters:

entity - the entity

docContent - the content of the file to upload

callbackHandler - the callback handler

Throws:

FMSException - throws FMSException

downloadAsync

public <T extends IEntity> void downloadAsync(T entity,
                                              CallbackHandler callbackHandler)
                                       throws FMSException

Method to download the file for the given entity id in asynchronous fashion

Parameters:

entity - the entity

callbackHandler - the callback handler

Throws:

FMSException - throws FMSException

downloadPDFAsync

public <T extends IEntity> void downloadPDFAsync(T entity,
                                                 CallbackHandler callbackHandler)
                                          throws FMSException

Method to download the file for the given entity id in asynchronous fashion

Parameters:

entity - the entity

callbackHandler - the callback handler

Throws:

FMSException - throws FMSException

sendEmailAsync

public <T extends IEntity> void sendEmailAsync(T entity,
                                               CallbackHandler callbackHandler)
                                        throws FMSException

Method to send the entity to default email for the given id in asynchronous fashion

Type Parameters:

T -

Parameters:

entity -

callbackHandler -

Throws:

FMSException

sendEmailAsync

public <T extends IEntity> void sendEmailAsync(T entity,
                                               String email,
                                               CallbackHandler callbackHandler)
                                        throws FMSException

Method to send the entity to email for the given id in asynchronous fashion

Parameters:

entity - the entity

email - the mail string

callbackHandler - the callback handler

Throws:

FMSException - throws FMSException

executeQueryAsync

public void executeQueryAsync(String query,
                              CallbackHandler callbackHandler)
                       throws FMSException

Method to retrieve records for the given list of query in asynchronous fashion

Parameters:

query -

callbackHandler - the callback handler

Throws:

FMSException

executeCDCQueryAsync

public void executeCDCQueryAsync(List<? extends IEntity> entities,
                                 String changedSince,
                                 CallbackHandler callbackHandler)
                          throws FMSException

Method to retrieve records for the given list of query in asynchronous fashion

Parameters:

entities - the list of entities to be listed in the response

changedSince - the date where the entities should be listed from the last changed date

callbackHandler - the callback handler

Throws:

FMSException

executeBatchAsync

public void executeBatchAsync(BatchOperation batchOperation,
                              CallbackHandler callbackHandler)
                       throws FMSException

Method to cancel the operation for the corresponding entity in asynchronous fashion

Parameters:

batchOperation - the batch operation

callbackHandler - the callback handler

Throws:

FMSException

getSerializableObject

protected <T extends IEntity> Object getSerializableObject(T object)
                                                    throws FMSException

Method to get the serializable object for the given entity

Parameters:

object - the entity object

Returns:

Object the serializable object

Throws:

FMSException

getSerializableRequestObject

protected <T> Object getSerializableRequestObject(T object)
                                           throws FMSException

Method to get the JAXBElement, using ObjectFactory, to serialize the request

Parameters:

object - the object to be converted to JAXBElement

Returns:

Object the serializable object

Throws:

FMSException

getQueryResult

protected QueryResult getQueryResult(QueryResponse queryResponse)

Method to read the query response from QueryResponse and set into QueryResult

Parameters:

queryResponse - the query response

Returns:

queryResult

getCDCQueryResult

protected List<CDCQueryResult> getCDCQueryResult(List<CDCResponse> cdcResponses)

Method to get the list of CDCQueryResult object from list of CDCResponse

Parameters:

cdcResponses - the cdc responses list

Returns:

list of CDCQueryResult object

getCDCQueryResult

protected CDCQueryResult getCDCQueryResult(CDCResponse cdcResponse)

Method to construct and return the CDCQueryResult object from CDCResponse

Parameters:

cdcResponse - the CDC Response object

Returns:

the CDCQueryResult object