com.kony.sdk.services.sync

Class SyncOptions

java.lang.Object

com.kony.sdk.services.sync.SyncOptions

public class SyncOptions
extends Object

This can be used to create various options for sync

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SyncOptions.SchemaUpgradePolicy Represents schema upgrade policies
static class	SyncOptions.UploadErrorPolicy Represents policies for upload

Constructor Summary

Constructors

Constructor and Description
SyncOptions()

Method Summary

Modifier and Type	Method and Description
void	addFilter(String scopeName, SyncFilter syncFilter) Adds filter for scope
void	clearFilter() Adds filter for scope
protected void	finalize()
long	getOptionsPtr()
void	setContextVariable(String contextName, String contextValue) Sets context variable
void	setRemoveAfterUpload(boolean value) This method enables/disables remove after upload policy for all objects in all scopes.
void	setRemoveAfterUploadForObject(String objecName, boolean value) This method enables/disables remove after upload policy for given object in given scope.
void	setRemoveAfterUploadForScope(String scopeName, boolean value) This method enables/disables remove after upload policy for all objects in given scope.
void	setSchemaUpgradePolicy(SyncOptions.SchemaUpgradePolicy policy) Sets schemaUpgrade policy, if there is any schema upgrade from server.
void	setScopeDownload(String scope, boolean download) Sets scope to download or not to download.
void	setScopeUpload(String scope, boolean upload) Sets scope to upload or not to upload.
void	setUploadErrorPolicy(String scope, SyncOptions.UploadErrorPolicy policy) Sets scope to upload or not to upload.

Methods inherited from class java.lang.Object

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

Constructor Detail

SyncOptions

public SyncOptions()
            throws KonyException

Throws:

KonyException

Method Detail

setScopeDownload

public void setScopeDownload(String scope,
                             boolean download)
                      throws KonyException

Sets scope to download or not to download. By default it is true.

Parameters:

scope -

download -

Throws:

KonyException

setScopeUpload

public void setScopeUpload(String scope,
                           boolean upload)
                    throws KonyException

Sets scope to upload or not to upload. By default it is true.

Parameters:

scope -

upload -

Throws:

KonyException

setUploadErrorPolicy

public void setUploadErrorPolicy(String scope,
                                 SyncOptions.UploadErrorPolicy policy)
                          throws KonyException

Sets scope to upload or not to upload. By default it is CONTINUE_ON_ERROR.

Parameters:

scope -

policy -

Throws:

KonyException

getOptionsPtr

public long getOptionsPtr()

addFilter

public void addFilter(String scopeName,
                      SyncFilter syncFilter)
               throws KonyException

Adds filter for scope

Parameters:

scopeName -

syncFilter - SyncFilter object

Throws:

KonyException

clearFilter

public void clearFilter()
                 throws KonyException

Adds filter for scope

Throws:

KonyException

setContextVariable

public void setContextVariable(String contextName,
                               String contextValue)
                        throws KonyException

Sets context variable

Parameters:

contextName - name

contextValue - value

Throws:

KonyException

setRemoveAfterUpload

public void setRemoveAfterUpload(boolean value)
                          throws KonyException

This method enables/disables remove after upload policy for all objects in all scopes. By default it is disabled.

Parameters:

value -

Throws:

KonyException

setRemoveAfterUploadForScope

public void setRemoveAfterUploadForScope(String scopeName,
                                         boolean value)
                                  throws KonyException

This method enables/disables remove after upload policy for all objects in given scope. By default it is disabled.

Parameters:

scopeName -

value -

Throws:

KonyException

setRemoveAfterUploadForObject

public void setRemoveAfterUploadForObject(String objecName,
                                          boolean value)
                                   throws KonyException

This method enables/disables remove after upload policy for given object in given scope. By default it is disabled.

Parameters:

objecName -

value -

Throws:

KonyException

setSchemaUpgradePolicy

public void setSchemaUpgradePolicy(SyncOptions.SchemaUpgradePolicy policy)
                            throws KonyException

Sets schemaUpgrade policy, if there is any schema upgrade from server. Default value is UPLOAD_AND_UPGRADE

Parameters:

policy -

Throws:

KonyException

finalize

protected void finalize()
                 throws Throwable

Overrides:

finalize in class Object

Throws:

Throwable