Package com.appiancorp.suiteapi.common

Interface SynchronizationService

All Superinterfaces:
com.appiancorp.services.ContextSensitiveService, Service
@Deprecated public interface SynchronizationService extends com.appiancorp.services.ContextSensitiveService
Deprecated.
This interface and all of the methods defined within are obsolete and will be removed in a future release.
This interface contains methods used when running multiple instances of Appian applications and sychronizing some or all data between them. Currently, these methods are only implemented for discussion forums. All of these method take a parameter indicating the type of object that is being queried about or manipulated. The proper value for type can be obtained from ObjectTypeMapping
See Also:

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final boolean
    doesRemoteIDExist$UPDATES
    Deprecated.
     
    static final boolean
    getNextRemoteId$UPDATES
    Deprecated.
     
    static final boolean
    setRemoteId$UPDATES
    Deprecated.
     

    Fields inherited from interface com.appiancorp.services.ContextSensitiveService

    SET_SERVICE_CONTEXT_METHOD_NAME

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    doesRemoteIDExist(Long typeOfObject_, Long remoteId_)
    Deprecated.
    Determine whether a remote id exists.
    RemoteId
    getNextRemoteId(Long typeOfObject_)
    Deprecated.
    Get the next available remote id.
    void
    setRemoteId(Long typeOfObject_, Long localId_, Long newInstanceId_, Long remoteId_)
    Deprecated.
    Set the remote id of a target object.

    Methods inherited from interface com.appiancorp.services.ContextSensitiveService

    setServiceContext

  • Field Details

    • setRemoteId$UPDATES

      static final boolean setRemoteId$UPDATES
      Deprecated.
      See Also:

    • doesRemoteIDExist$UPDATES

      static final boolean doesRemoteIDExist$UPDATES
      Deprecated.
      See Also:

    • getNextRemoteId$UPDATES

      static final boolean getNextRemoteId$UPDATES
      Deprecated.
      See Also:

  • Method Details

    • setRemoteId

      void setRemoteId(Long typeOfObject_, Long localId_, Long newInstanceId_, Long remoteId_)
      Deprecated.
      Set the remote id of a target object. Only succeeds if the object's remote id is currently null.
      Parameters:
      typeOfObject_ - The type of the target object.
      localId_ - The local id of the target object.
      newInstanceId_ - The instance id to be assigned to the target object.
      remoteId_ - The remote id to be assigned to the target object.
      Throws:
      ServiceException - if any system-level error occurs

    • doesRemoteIDExist

      boolean doesRemoteIDExist(Long typeOfObject_, Long remoteId_)
      Deprecated.
      Determine whether a remote id exists. The implied instance id is that of the instance within which this code runs.
      Parameters:
      typeOfObject_ - The type of the object.
      remoteId_ - The remote ID for which to check.
      Returns:
      true if the remote id already exists; false otherwise.
      Throws:
      ServiceException - if any system-level error occurs

    • getNextRemoteId

      RemoteId getNextRemoteId(Long typeOfObject_)
      Deprecated.
      Get the next available remote id. The implied instance id is that of the instance within which this code runs.
      Parameters:
      typeOfObject_ - The type of the object.
      Returns:
      The next available remote ID for the type of object specified.
      Throws:
      ServiceException - if any system-level error occurs