com.kony.sdk.client

Class KNYObj

java.lang.Object

com.kony.sdk.client.KNYObj

All Implemented Interfaces:

IKonyObjectSync

public class KNYObj
extends Object
implements IKonyObjectSync

Created by Chirag Mantri on 27/01/17. Copyright © 2017 Kony. All rights reserved.

Constructor Summary

Constructors

Constructor and Description
KNYObj(String name) Creates Object Level Sync Object.

Method Summary

Modifier and Type	Method and Description
void	cancelSync(Map<String,Object> options, KNYCallback syncCallback) Cancellation of Object level Sync session
void	create(HashMap<String,Object> record, HashMap<String,Object> options, KNYCallback syncCallback) Create method provides ability to create record in local database
void	delete(HashMap<String,Object> options, KNYCallback syncCallback) Deletes a record from the local database
void	deleteByPK(HashMap<String,Object> options, KNYCallback syncCallback) Delete method provides ability to Delete record by primary key(s) from local Database
void	get(HashMap<String,Object> options, KNYCallback syncCallback) Get method provides ability to fetch records from local database
void	getBinary(Map<String,Object> options, KNYBinaryDownloadCallback knyBinaryDownloadCallback) Downloads binary for the specified column name and primary key(s) of the object.
void	getPendingRecordsForUpload(HashMap<String,Object> options, KNYCallback syncCallback) Object Level getPendingRecordsForUpload
void	getUploadDeferredRecordKeys(KNYCallback syncCallback) fetches all the differed record primary keys
void	markForUpload(Map<String,Object> options, KNYCallback syncCallback) Mark for upload method provides ability to mark a record for upload from local Database
void	rollback(Map<String,Object> primaryKeyValueMap, KNYCallback syncCallback) Rollback on Object
void	startSync(Map<String,Object> context, KNYCallback syncCallback, KNYProgressCallback konySyncProgressCallback) Object Level Start Sync Session.
void	update(HashMap<String,Object> record, HashMap<String,Object> options, KNYCallback syncCallback) Updates a record in the local database
void	updateByPK(HashMap<String,Object> record, HashMap<String,Object> options, KNYCallback syncCallback) Update method provides ability to update record by primary key(s) in local database

Methods inherited from class java.lang.Object

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

Constructor Detail

KNYObj

public KNYObj(String name)
       throws Exception

Creates Object Level Sync Object.

Parameters:

name - Object for the specified name.

Throws:

Exception

Method Detail

startSync

public void startSync(Map<String,Object> context,
                      KNYCallback syncCallback,
                      KNYProgressCallback konySyncProgressCallback)
               throws Exception

Object Level Start Sync Session.

Specified by:

startSync in interface IKonyObjectSync

Parameters:

context - the context

syncCallback - sync success and error callbacks

konySyncProgressCallback - sync progress callbacks

Throws:

Exception - exception in case of any errors

getPendingRecordsForUpload

public void getPendingRecordsForUpload(HashMap<String,Object> options,
                                       KNYCallback syncCallback)
                                throws Exception

Object Level getPendingRecordsForUpload

Specified by:

getPendingRecordsForUpload in interface IKonyObjectSync

Parameters:

options - the options

syncCallback - getPendingRecordsForUpload success and error callbacks

Throws:

Exception - exception in case of any errors

create

public void create(HashMap<String,Object> record,
                   HashMap<String,Object> options,
                   KNYCallback syncCallback)
            throws Exception

Description copied from interface: IKonyObjectSync

Create method provides ability to create record in local database

Specified by:

create in interface IKonyObjectSync

Parameters:

record - - list of field to be populated in record during creation

options - - parameter for future extensibility. MarkforUpload parameter should come through this data structure

syncCallback - - success and error callback. Success callback returns a primary key map of record created.

Throws:

Exception

update

public void update(HashMap<String,Object> record,
                   HashMap<String,Object> options,
                   KNYCallback syncCallback)
            throws Exception

Description copied from interface: IKonyObjectSync

Updates a record in the local database

Specified by:

update in interface IKonyObjectSync

Parameters:

record - Map containing the column names and respective values to be updated in the record.

options - User specified options for updating the record. This includes PrimaryKey(s), Disable change tracking options, MarkForUpload, whereCondition and whereConditionAsAString.

syncCallback - contains the success and failure callbacks. On success, returns the count of successfully updated records On failure, returns an error object containing the error code, domain and userinfo. The userInfo will contain the actual reason for failure and the stack trace.

Throws:

Exception - in case of errors

updateByPK

public void updateByPK(HashMap<String,Object> record,
                       HashMap<String,Object> options,
                       KNYCallback syncCallback)
                throws Exception

Description copied from interface: IKonyObjectSync

Update method provides ability to update record by primary key(s) in local database

Specified by:

updateByPK in interface IKonyObjectSync

Parameters:

record - Map containing the column names and respective values to be updated in the record.

options - User specified options for updating the record. This includes PrimaryKey(s), Disable change tracking options and MarkForUpload

syncCallback - contains the success and failure callbacks. On success, returns the count of successfully updated records. On failure, returns an error object containing the error code, domain and userinfo. The userInfo will contain the actual reason for failure and the stack trace.

Throws:

Exception - in case of errors

delete

public void delete(HashMap<String,Object> options,
                   KNYCallback syncCallback)
            throws Exception

Description copied from interface: IKonyObjectSync

Deletes a record from the local database

Specified by:

delete in interface IKonyObjectSync

Parameters:

options - User specified options for deleting a record. This includes PrimaryKey(s), Disable change tracking options, MarkForUpload, whereCondition and whereConditionAsAString.

syncCallback - contains the success and failure callbacks. On success, returns true on successful deletion of the record, else false. On failure, returns an error object containing the error code, domain and userinfo. The userInfo will contain the actual reason for failure and the stack trace.

Throws:

Exception - in case of errors

deleteByPK

public void deleteByPK(HashMap<String,Object> options,
                       KNYCallback syncCallback)
                throws Exception

Description copied from interface: IKonyObjectSync

Delete method provides ability to Delete record by primary key(s) from local Database

Specified by:

deleteByPK in interface IKonyObjectSync

Parameters:

options - User specified options for deleting a record. This includes PrimaryKey(s), Disable change tracking options and MarkForUpload.

syncCallback - contains the success and failure callbacks. On success, rturns true on successful deletion of the record, else false. On failure, returns an error object containing the error code, domain and userinfo. The userInfo will contain the actual reason for failure and the stack trace.

Throws:

Exception - in case of errors

get

public void get(HashMap<String,Object> options,
                KNYCallback syncCallback)
         throws Exception

Description copied from interface: IKonyObjectSync

Get method provides ability to fetch records from local database

Specified by:

get in interface IKonyObjectSync

Parameters:

options - - Where clause, OrderBy map, Limit, Offset, MarkforUpload

syncCallback - - success and error callback. Success callback contains a map of the record retrieved.

Throws:

Exception

rollback

public void rollback(Map<String,Object> primaryKeyValueMap,
                     KNYCallback syncCallback)

Rollback on Object

Specified by:

rollback in interface IKonyObjectSync

Parameters:

primaryKeyValueMap - of record only for which rollback should happen

syncCallback - for success and error callbacks

markForUpload

public void markForUpload(Map<String,Object> options,
                          KNYCallback syncCallback)
                   throws Exception

Description copied from interface: IKonyObjectSync

Mark for upload method provides ability to mark a record for upload from local Database

Specified by:

markForUpload in interface IKonyObjectSync

Parameters:

options - - Primary key of record, markforUpload

syncCallback - - success or error callback. Success call back returns true.

Throws:

Exception

getUploadDeferredRecordKeys

public void getUploadDeferredRecordKeys(KNYCallback syncCallback)
                                 throws Exception

Description copied from interface: IKonyObjectSync

fetches all the differed record primary keys

Specified by:

getUploadDeferredRecordKeys in interface IKonyObjectSync

Parameters:

syncCallback - - success or error callback. Success call back returns true.

Throws:

Exception

cancelSync

public void cancelSync(Map<String,Object> options,
                       KNYCallback syncCallback)

Description copied from interface: IKonyObjectSync

Cancellation of Object level Sync session

Specified by:

cancelSync in interface IKonyObjectSync

Parameters:

options - Options for cancellation

syncCallback - For success and error callbacks

getBinary

public void getBinary(Map<String,Object> options,
                      KNYBinaryDownloadCallback knyBinaryDownloadCallback)

Downloads binary for the specified column name and primary key(s) of the object. If the file is available locally, it will not download from server unless Force Download is enabled.

Specified by:

getBinary in interface IKonyObjectSync

Parameters:

options - - Options specific to the file to be downloaded binaryColumnName: String forceDownload: boolean chunkSize: integer primaryKeys: Map of column name and value fileId: ID which user wants to name the file with. This will be appended with timestamp

knyBinaryDownloadCallback - - callbacks for download status (BinaryDownloadCallback includes onFileDownloadStarted, onFileDownloadCompleted ,onStreamDownloadCompleted, onChunkDownloadCompleted onDownloadFailure )