Package de.elo.ix.client

Class EventBusC

java.lang.Object
de.elo.ix.client.EventBusC
All Implemented Interfaces:
Serializable
public class EventBusC extends Object implements Serializable
Constants related to the event bus API.
See Also:

  • Field Details

    • BUSID_BROADCAST

      public static final long BUSID_BROADCAST
      Broadcast bus ID. The EventBusC.BUSID_BROADCAST refers to a public communication channel that can used by all applications and users. Any user can send events to this bus and is allowed to listen to it.
      See Also:

    • BUSID_USER

      public static final long BUSID_USER
      User related bus ID. For each user, an event bus exists with the bus ID EventBusC.BUSID_USER + user-ID. Any user can send events to this bus but only the owning user can listen to it.
      See Also:

    • BUSID_MAX_SYSTEM

      public static final long BUSID_MAX_SYSTEM
      Reserved.
      See Also:

    • EVENT_TYPE_OPEN_CHAT

      public static final long EVENT_TYPE_OPEN_CHAT
      Open chat event type. Events of this type are used to invite subscribers to open a public final static chat channel.
      See Also:

    • EVENT_TYPE_CHAT

      public static final long EVENT_TYPE_CHAT
      Chat event type. Events of this type contain chat text.
      See Also:

    • EVENT_TYPE_CLOSE_CHAT

      public static final long EVENT_TYPE_CLOSE_CHAT
      Close chat event type. An event of this type is sent to notify the subscribers that the chat channel (resp. event bus) will be closed shortly.
      See Also:

    • EVENT_TYPE_WATCH_FOLDER

      public static final long EVENT_TYPE_WATCH_FOLDER
      Watch folder event. An event of this type is sent, if the contents of a given folder have been changed.

      In order to register a listener for such events, the folder to be watched has to be specified with an object ID expression in EventFilter.param2(see checkoutSord): 

       
 IXConnection conn = ...
 
 // Folder to be watched
 int folderId = ...
 
 // Register listener  
 conn.getEventBusApi().getBroadcastBus().addListener( 
   EventBusC.EVENT_TYPE_WATCH_FOLDER, 
   Integer.toString(folderId) );

      For each modified Sord object in the watched folder, the client application receives one Event, whereby the data members are set as follows: 

       
 Event ev = ...
 
 // Folder being watched
 int folderId = Integer.parseInt(ev.getParam2());
 
 // Arguments 
 Object[] args = (Object[])AnyToObject.toObject(ev.getAny());
 
 // Inserted, updated (e.g. locked) or deleted Sord  
 Sord sord = (Sord)args[0];
 
 // Valid members of args[0]
 SordZ sordMembersZ = (SordZ)args[1];
 
 // What has happened: EventBusC.WATCH_INSERT, EventBusC.WATCH_UPDATE, EventBusC.WATCH_DELETE
 int what = (Integer)args[2];

      Watch folder events are sent to every current acitve connection, provided that a listener was registered for it and the associated user has at least read access to the changed object. It is also sent to the connection that fires this event.

      See Also:

    • WATCH_INSERT

      public static final int WATCH_INSERT
      An object was inserted.
      See Also:

    • WATCH_UPDATE

      public static final int WATCH_UPDATE
      An object was updated, locked or unlocked.
      See Also:

    • WATCH_DELETE

      public static final int WATCH_DELETE
      An object was deleted.
      See Also:

    • EVENT_OCR_REQUEST

      public static final long EVENT_OCR_REQUEST
      OCR Request Event. OCR Worker Processes listen to this event and process OCR on the supplied image data. In order to listen for this event, the session user must have the permission FLAG_ADMIN.
      Since:
      8.00.020.001
      See Also:

    • EVENT_OCR_RESULT

      public static final long EVENT_OCR_RESULT
      OCR Finished Event. OCR Worker Process sends this event if the OCR processing is finished. The client application initiates a OCR request by calling API function processOCR. It receives an Event ID
      Since:
      8.00.020.001
      See Also:

    • EVENT_FULLTEXT_INDEXING_STATUS_UPDATE

      public static final long EVENT_FULLTEXT_INDEXING_STATUS_UPDATE
      Notify about status change in fulltext indexing.
      Since:
      10.00.000.001
      See Also:

    • EVENT_TYPE_MAX_SYSTEM

      public static final long EVENT_TYPE_MAX_SYSTEM
      User defined events must have a higher type value than this limit.
      See Also:

  • Constructor Details

    • EventBusC

      public EventBusC()

  • Method Details

    • getEVENT_TYPE_WATCH_FOLDER

      public long getEVENT_TYPE_WATCH_FOLDER()

    • setEVENT_TYPE_WATCH_FOLDER

      public void setEVENT_TYPE_WATCH_FOLDER(long eVENTTYPEWATCHFOLDER)

    • getEVENT_TYPE_MAX_SYSTEM

      public long getEVENT_TYPE_MAX_SYSTEM()

    • setEVENT_TYPE_MAX_SYSTEM

      public void setEVENT_TYPE_MAX_SYSTEM(long eVENTTYPEMAXSYSTEM)

    • getBUSID_BROADCAST

      public long getBUSID_BROADCAST()

    • setBUSID_BROADCAST

      public void setBUSID_BROADCAST(long bUSIDBROADCAST)

    • getBUSID_USER

      public long getBUSID_USER()

    • setBUSID_USER

      public void setBUSID_USER(long bUSIDUSER)

    • getBUSID_MAX_SYSTEM

      public long getBUSID_MAX_SYSTEM()

    • setBUSID_MAX_SYSTEM

      public void setBUSID_MAX_SYSTEM(long bUSIDMAXSYSTEM)

    • getEVENT_TYPE_OPEN_CHAT

      public long getEVENT_TYPE_OPEN_CHAT()

    • setEVENT_TYPE_OPEN_CHAT

      public void setEVENT_TYPE_OPEN_CHAT(long eVENTTYPEOPENCHAT)

    • getEVENT_TYPE_CHAT

      public long getEVENT_TYPE_CHAT()

    • setEVENT_TYPE_CHAT

      public void setEVENT_TYPE_CHAT(long eVENTTYPECHAT)

    • getEVENT_TYPE_CLOSE_CHAT

      public long getEVENT_TYPE_CLOSE_CHAT()

    • setEVENT_TYPE_CLOSE_CHAT

      public void setEVENT_TYPE_CLOSE_CHAT(long eVENTTYPECLOSECHAT)