com.ibm.mobileservices.isync
Interface ISyncSubscriptionSet


public interface ISyncSubscriptionSet

This interface represents a subscription set and its containing subscriptions, providing accessors to various information about the subscription set.


Method Summary
 void disable()
          Disables for synchronization.
 void enable()
          Enables for synchronization.
 java.lang.String getId()
          Gets the subscription set ID.
 java.lang.String getName()
          Gets the subscription set name.
 int getStatus()
          Gets the status of the subscription set.
 boolean isEnabled()
          Returns if this subscription set is enabled for synchronization.
 boolean isReset()
          Returns if this subscription set is marked for refresh on the next synchronization.
 void reset()
          Marks this subscription set for refresh on the next synchronization.
 

Method Detail

getName

public java.lang.String getName()
                         throws ISyncException
Gets the subscription set name.

Returns:
a String specifying the subscription set name
Throws:
ISyncException - with code:
  • EXC_ILLEGAL_STATE
  • EXC_NOT_EXIST
  • EXC_CONFIG_ERROR

getId

public java.lang.String getId()
                       throws ISyncException
Gets the subscription set ID.

Returns:
a String specifying the ID name
Throws:
ISyncException - with code:
  • EXC_ILLEGAL_STATE
  • EXC_NOT_EXIST
  • EXC_CONFIG_ERROR

isEnabled

public boolean isEnabled()
                  throws ISyncException
Returns if this subscription set is enabled for synchronization.

Returns:
true if this subscription set is enabled; false otherwise
Throws:
ISyncException - with code:
  • EXC_ILLEGAL_STATE
  • EXC_NOT_EXIST
  • EXC_CONFIG_ERROR

isReset

public boolean isReset()
                throws ISyncException
Returns if this subscription set is marked for refresh on the next synchronization.

Returns:
true if the subscription set is reset; false otherwise.
Throws:
ISyncException - with code:
  • EXC_ILLEGAL_STATE
  • EXC_NOT_EXIST
  • EXC_CONFIG_ERROR

enable

public void enable()
            throws ISyncException
Enables for synchronization.

Throws:
ISyncException - with code:
  • EXC_ILLEGAL_STATE
  • EXC_NOT_EXIST
  • EXC_CONFIG_ERROR

disable

public void disable()
             throws ISyncException
Disables for synchronization.

Throws:
ISyncException - with code:
  • EXC_ILLEGAL_STATE
  • EXC_NOT_EXIST
  • EXC_CONFIG_ERROR

reset

public void reset()
           throws ISyncException
Marks this subscription set for refresh on the next synchronization.

Throws:
ISyncException - with code:
  • EXC_ILLEGAL_STATE
  • EXC_NOT_EXIST
  • EXC_CONFIG_ERROR

getStatus

public int getStatus()
              throws ISyncException
Gets the status of the subscription set.

Returns:
  • ISync.STATUS_READY - the subscription set has been enabled, and synchronization has started, but has not synced the subscription set yet.
  • ISync.STATUS_CANCELED - synchronization of the subscription set has been canceled.
  • ISync.STATUS_FAILED - synchronization of the subscription set has failed.
  • ISync.STATUS_COMPLETED - synchronization of the subscription set has succeeded.
Throws:
ISyncException - with code:
  • EXC_ILLEGAL_STATE
  • EXC_NOT_EXIST
  • EXC_CONFIG_ERROR


(c) Copyright IBM Corp. 2000, 2002 All Rights Reserved.