Package com.priint.pubserver.comet.bridge

Enum Class CometBridgeRemote.SessionMode

java.lang.Object
java.lang.Enum<CometBridgeRemote.SessionMode>
com.priint.pubserver.comet.bridge.CometBridgeRemote.SessionMode
All Implemented Interfaces:
CometBridgeRemote.NamedSessionMode, Serializable, Comparable<CometBridgeRemote.SessionMode>, Constable
Enclosing interface:
CometBridgeRemote
public static enum CometBridgeRemote.SessionMode extends Enum<CometBridgeRemote.SessionMode> implements CometBridgeRemote.NamedSessionMode
The enum Session mode.

  • Nested Class Summary

    Nested classes/interfaces inherited from class java.lang.Enum

    Enum.EnumDesc<E extends Enum<E>>

  • Enum Constant Summary

    Enum Constants
    Enum Constant
    Description
    BULK_IMPORT
    This is the session mode required when importing page items and page templates with InDesign Plug-Ins.
    To activate, send a "soap::call pcs::session-mode bulk-import" request.
    FULL_IMPORT
    IDs will be remapped to new IDs obtained from the server, all references (Comet3Reference annotations) remapped and statements / actions parsed for typical references to other actions.
    This is not guaranteed to work in all circumstances, but should be a good starting point when migrating comet3 projects.
    To activate, send a "soap::call pcs::session-mode full-import" request.
    NORMAL
    In normal session mode configuration items can be read updated and created (provided the new ID has been obtained from the server using a pcs::getNextID SOAP call) Attempts to insert an item with an ID other than obtained from the server will cause an error.
    Items will not be processed upon insert, i.e.: no references will be resolved or remapped.

  • Method Summary

    Modifier and Type
    Method
    Description
    static CometBridgeRemote.SessionMode
    valueOf(String name)
    Returns the enum constant of this class with the specified name.
    static CometBridgeRemote.SessionMode[]
    values()
    Returns an array containing the constants of this enum class, in the order they are declared.

    Methods inherited from class java.lang.Enum

    clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

    Methods inherited from interface com.priint.pubserver.comet.bridge.CometBridgeRemote.NamedSessionMode

    getName

  • Enum Constant Details

    • NORMAL

      public static final CometBridgeRemote.SessionMode NORMAL
      In normal session mode configuration items can be
      • read
      • updated and
      • created (provided the new ID has been obtained from the server using a pcs::getNextID SOAP call)
      Attempts to insert an item with an ID other than obtained from the server will cause an error.
      Items will not be processed upon insert, i.e.: no references will be resolved or remapped.

      Only items of the following classes can be inserted:

      • aliases and global variables (datafiles.xml)
      • find statements (findstatements.xml)
      • frame rules (framerules)
      • actions (actions.xml)
      • page items (pageitems.xml)
      • page templates (pagetemplates.xml)
      • grids (grids.xml)
      • binary data associated to any of the items above

      To activate, send a "soap::call pcs::session-mode normal" request. NORMAL is the default mode if no other mode has been set.

    • BULK_IMPORT

      public static final CometBridgeRemote.SessionMode BULK_IMPORT
      This is the session mode required when importing page items and page templates with InDesign Plug-Ins.
      To activate, send a "soap::call pcs::session-mode bulk-import" request.

    • FULL_IMPORT

      public static final CometBridgeRemote.SessionMode FULL_IMPORT
      IDs will be remapped to new IDs obtained from the server, all references (Comet3Reference annotations) remapped and statements / actions parsed for typical references to other actions.
      This is not guaranteed to work in all circumstances, but should be a good starting point when migrating comet3 projects.
      To activate, send a "soap::call pcs::session-mode full-import" request.

  • Method Details

    • values

      public static CometBridgeRemote.SessionMode[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared

    • valueOf

      public static CometBridgeRemote.SessionMode valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null