Package de.elo.ix.client

Interface IXServicePortIF

All Superinterfaces:
byps.Remote, de.elo.utils.net.Remote, Remote
All Known Implementing Classes:
IXServicePortIF_BYPS
public interface IXServicePortIF extends byps.Remote
Indexserver API.

  • Field Details

    • serialVersionUID

      static final long serialVersionUID
      Serialization type ID.
      See Also:

  • Method Details

    • alive

      void alive(ClientInfo ci) throws byps.RemoteException
      Extends the ticket lifetime.
      Parameters:
      ci - ClientInfo object with language, country and ticket
      Throws:
      byps.RemoteException - Exception with message text of format "[ELOIX:number] text". The number is one of the constants defined in IXExceptionC. Exception with message text of format "[ELOIX:number] text".

    • beginEditWorkFlowNode

      @Deprecated WFEditNode beginEditWorkFlowNode(ClientInfo ci, int nFlowId, int nNodeId, LockZ lockZ) throws byps.RemoteException
      Deprecated.
      Use beginForwardWorkflowNode(de.elo.ix.client.ClientInfo, int, int, de.elo.ix.client.BeginForwardWorkflowNodeInfo, de.elo.ix.client.LockZ)
      Locks a person task node of an active workflow inside the database and returns data needed to edit it. If lockZ is not set to LockC.NO, WFNode.inUseDate will be set to now.
      Parameters:
      ci - ClientInfo object with language, country and ticket.
      nFlowId - Workflow ID.
      nNodeId - Workflow node ID.
      lockZ - Use LockC.YES or LockC.IF_FREE to lock all nodes of the workflow.
      Returns:
      Node data needed for editing.
      Throws:
      byps.RemoteException - Exception with message text of format "[ELOIX:number] text". The number is one of the constants defined in IXExceptionC. Exception with message text of format "[ELOIX:number] text".

    • changeSordMask

      EditInfo changeSordMask(ClientInfo ci, Sord sord, String maskId, EditInfoZ editInfoZ) throws byps.RemoteException
      Changes the storage mask of a archive entry.

      The function does not update the object in the database. The method checkinSord must be used to write the changes into the database.

      For new Sord objects (Sord.id < 0), ACL items are replaced by the definitions of the mask. Existing objects keep the previous ACL setting.

      ObjKeys with IDs < ID_LINK (=50) are converted into the format of the new associated DocMaskLine. ObjKeys with IDs >= ID_LINK are not changed.

      Parameters:
      ci - ClientInfo object with language, country and ticket.
      sord - Indexing information of an archive entry.
      maskId - ID or name of the new storage mask.
      editInfoZ - Determines, which members to return in EditInfo. Reasonable predefined values are EditInfoC.mbSord and new EditInfoZ(EditInfoC.mbMask, SordC.mbAll). Be aware of the performance effects of this parameter: avoid using EditInfoC.mbAll.
      Returns:
      Data to edit an archive entry.
      Throws:
      byps.RemoteException - Exception with message text of format "[ELOIX:number] text". The number is one of the constants defined in IXExceptionC. Exception with message text of format "[ELOIX:number] text".
      See Also:

    • checkinColors

      void checkinColors(ClientInfo ci, ColorData[] colors, LockZ unlockZ) throws byps.RemoteException
      Check-in the marker definitions (colors for the archive entries). This method deletes the current markers and inserts the supplied ones in colors. To insert a new color, set its Id to -1. If the supplied colors array does not contain a system color (Id == 0), a new system color object is created. The objects must have unique IDs (or -1) and unique names. Since the existing colors are entirely replaced by this function, use checkoutColors2(ClientInfo, int, LockZ) with option ColorDataC.ALL_COLORS to obtain all existing colors to prepare a call to this function.
      Parameters:
      ci - ClientInfo object with language, country and ticket
      colors - Array of Color objects
      unlockZ - Remove lock
      Throws:
      byps.RemoteException - Exception with message text of format "[ELOIX:number] text". The number is one of the constants defined in IXExceptionC. Exception with message text of format "[ELOIX:number] text".

    • checkinConfigFiles

      void checkinConfigFiles(ClientInfo ci, ConfigFile[] configFiles, LockZ unlockZ) throws byps.RemoteException
      Uploads configuration files to the configuration directory on the server.
      Parameters:
      ci - ClientInfo object with language, country and ticket
      configFiles - Objects with file name, directory and data.
      unlockZ - reserved.
      Throws:
      byps.RemoteException - Exception with message text of format "[ELOIX:number] text". The number is one of the constants defined in IXExceptionC. Exception with message text of format "[ELOIX:number] text".

    • checkinConfigFilesBegin

      ConfigFile[] checkinConfigFilesBegin(ClientInfo ci, String[] names) throws byps.RemoteException
      Prepare ConfigFile objects with URLs to upload configuration or intray files. The names[.] the must contain the destination directory and file name.
      Examples
      Example for file names Description
      names[.]=peter/postbox/file1.txt Prepares a ConfigFile object to write file1.txt into peter s server side intray directory
      configFile[.].dir=eloscripts/file1.txt Prepares a ConfigFile object to write file1.txt into the directory for scripts. 
       
 //Example for uploading a file into the server side intray of a user.
 IXConnection conn = ...
 String userName = ...
 File file = ...
 String destFile = userName + "/" + CONST.CONFIG_FILE.POSTBOX + "/" + file.getName();
 ConfigFile[] configFiles = conn.ix().checkinConfigFilesBegin(new String[] {destFile});
 String uploadResult = conn.upload(configFiles[0].url, file);
 configFiles[0].setUploadResult(uploadResult);
 configFiles = conn.ix().checkinConfigFilesEnd(configFiles);
      Parameters:
      ci - ClientInfo object with language, country and ticket
      names - Files to insert.
      Returns:
      Array of ConfigFile objects each of which contains an upload URL.
      Throws:
      byps.RemoteException - Exception with message text of format "[ELOIX:number] text". The number is one of the constants defined in IXExceptionC. Exception with message text of format "[ELOIX:number] text".

    • checkinConfigFilesEnd

      ConfigFile[] checkinConfigFilesEnd(ClientInfo ci, ConfigFile[] configFiles, LockZ unlockZ) throws byps.RemoteException
      Finishes a check-in procedure for configuration files.

      For files that have been uploaded into the in-tray folder of other users, no ConfigFile object can be returned, because the in-tray folders of other users are not readable.

      Parameters:
      ci - ClientInfo object with language, country and ticket
      configFiles - Uploaded file information. Esp. configFiles[.].uploadResult. configFiles[.].fileData is ignored.
      unlockZ - Reserved
      Returns:
      Array of configuration files containing download URLs.
      Throws:
      byps.RemoteException - Exception with message text of format "[ELOIX:number] text". The number is one of the constants defined in IXExceptionC. Exception with message text of format "[ELOIX:number] text".
      See Also:

    • checkinCounters

      void checkinCounters(ClientInfo ci, CounterInfo[] counterInfos, LockZ unlockZ) throws byps.RemoteException
      Update counter values or create new counters.
      Parameters:
      ci - ClientInfo object with language, country and ticket
      counterInfos - Array of counter objects. If counter object counterInfos[.] exists, its value is overwritten. If counter object does not exist, it is created an initialized by the given value.
      unlockZ - Removes a lock previously set by checkoutCounters.
      Throws:
      byps.RemoteException - Exception with message text of format "[ELOIX:number] text". The number is one of the constants defined in IXExceptionC. Exception with message text of format "[ELOIX:number] text".

    • checkinDocBegin

      Document checkinDocBegin(ClientInfo ci, Document document) throws byps.RemoteException
      Prepares the Indexserver to enable a document to be checked in.

      The check in procedure consists of three steps. First a call to checkinDocBegin prepares the Indexserver to upload a document. The function returns among other things the URL to which the document must be up loaded. In the second step the document is uploaded to this URL. The final step is to call checkinDocEnd with the result of the upload process. The upload result is interpreted by the Indexserver and the document is inserted into the database.

      The upload URL accesses the ELODM (document manager service) directly due to performance reasons . The URL is valid as long as the session ticket is valid.

      It is possible to insert more than one document or attachment versions and a signature file.

      The parameter document of checkinDocBegin must contain a minimum of one version in document.docs, document.atts or document.sig. The minimum that must be set in the version object is the member DocVersion.ext.

      Parameters:
      ci - ClientInfo object with language, country and ticket
      document - Document object.
      Returns:
      Document object with upload URL.
      Throws:
      byps.RemoteException - Exception with message text of format "[ELOIX:number] text". The number is one of the constants defined in IXExceptionC. Exception with message text of format "[ELOIX:number] text".
      See Also:

    • checkinDocDupl

      Document checkinDocDupl(ClientInfo ci, Sord sord, SordZ sordZ, Document document, LockZ unlockZ) throws byps.RemoteException
      Checks-in already existing documents again.

      This method is used to reduce transmission time as the document does not have to be checked-out.

      Parameters:
      ci - ClientInfo object with language, country and ticket
      sord - Indexing information or null.
      sordZ - Elements of sord to be stored into the database.
      document - Document object to be used for the duplicate
      unlockZ - Unlock the object
      Returns:
      Complete Document information - in particular the document ID
      Throws:
      byps.RemoteException - Exception with message text of format "[ELOIX:number] text". The number is one of the constants defined in IXExceptionC. Exception with message text of format "[ELOIX:number] text".

    • checkinDocEnd

      Document checkinDocEnd(ClientInfo ci, Sord sord, SordZ sordZ, Document document, LockZ unlockZ) throws byps.RemoteException
      Checks in an uploaded document.

      See checkinDocBegin, if you want to checkin new document or attachment version(s).

      Changing the document or attachment work version, version number, comment, flags or status:

      Document doc = new Document();
      doc.objId = an object ID or GUID
      doc.docs = new DocVersion[] {new DocVersion()};
      doc.docs[0].id = a document ID;
      doc.docs[0].workVersion = true;
      doc.docs[0].version = "2.0";
      doc.docs[0].comment = "new comment";
      doc.docs[0].milestone = true;
      doc.docs[0].deleted = false;
      ix.checkinDocEnd(ci, null, null, doc, LOCK.NO);

      If the supplied sord has sord.type==LBT_DOCUMENT, sord.type will be detected from the file extension of the given work version.

      If the document is only to be unlocked, see checkinSord.

      Parameters:
      ci - ClientInfo object with language, country and ticket
      sord - Indexing information or null.
      sordZ - Elements of sord to be stored into the database.
      document - Document object previously returned from checkinDocBegin
      unlockZ - Unlock the object.
      Returns:
      Complete Document information - in particular the document ID.
      Throws:
      byps.RemoteException - Exception with message text of format "[ELOIX:number] text". The number is one of the constants defined in IXExceptionC. Exception with message text of format "[ELOIX:number] text".
      See Also:

    • checkinDocMask

      int checkinDocMask(ClientInfo ci, DocMask docMask, DocMaskZ docMaskZ, LockZ unlockZ) throws byps.RemoteException
      Writes a keywording form into the database. A new mask is inserted when docMask.no is less than 0.

      If an existing keywording form is written with modified group names (DocMaskLine.key), a background thread is started to update the existing index values (Sord.objKeys[.].name). Use collectJobState to watch the state of the background job. Its name is "Update existing index values for keywording form=..."

      Parameters:
      ci - ClientInfo object with language, country and ticket.
      docMask - Mask object.
      docMaskZ - Members to be written.
      unlockZ - Unlock masks.
      Returns:
      Mask ID (DocMask.no)
      Throws:
      byps.RemoteException - Exception with message text of format "[ELOIX:number] text". The number is one of the constants defined in IXExceptionC. Exception with message text of format "[ELOIX:number] text".
      See Also:

    • checkinDocsBegin

      Document[] checkinDocsBegin(ClientInfo ci, Document[] documents) throws byps.RemoteException
      This method prepares the Index Server to allow multiple documents to be checked in at one time. Utilized in the same manner as checkinDocBegin but is for multiple documents.
      Parameters:
      ci - ClientInfo object with language, country and ticket.
      documents - Array of Document objects.
      Returns:
      Array of Document objects with upload URLs.
      Throws:
      byps.RemoteException - Exception with message text of format "[ELOIX:number] text". The number is one of the constants defined in IXExceptionC. Exception with message text of format "[ELOIX:number] text".
      See Also:

    • checkinDocsEnd

      Document[] checkinDocsEnd(ClientInfo ci, Sord[] sords, SordZ[] sordZs, Document[] documents, LockZ unlockZ) throws byps.RemoteException
      This method checks-in uploaded documents. Utilized in the same manner as checkinDocEnd but for multiple documents and sords.
      Parameters:
      ci - ClientInfo object with language, country and ticket
      sords - Array of Sord objects
      sordZs - Elements of sords to be stored into the database.
      documents - Document objects previously returned from checkinDocsBegin
      unlockZ - Unlock document
      Returns:
      Complete documents information - in particular the document ID.
      Throws:
      byps.RemoteException - Exception with message text of format "[ELOIX:number] text". The number is one of the constants defined in IXExceptionC. Exception with message text of format "[ELOIX:number] text".
      See Also:

    • checkinKeys

      @Deprecated int[] checkinKeys(ClientInfo ci, KeyInfo[] keyInfos, LockZ unlockZ) throws byps.RemoteException
      Deprecated.
      Writes or inserts key objects.

      If key data is only to be unlocked then the method should be called with keyInfos=null and lockZ=lockZ.YES.

      The key objects with KeyInfo[].id=-1 will be inserted in the database. Objects with KeyInfo[].id>=0 will be updated.

      Since the function requires an exclusive access to the user data, the data must be locked for the current user or must not be locked for anyone. To check in regardless of a lock supply lockZ.FORCE in lockZ.

      Parameters:
      ci - ClientInfo object with language, country and ticket
      keyInfos - List of key objects.
      unlockZ - Unlock key data or force access.
      Returns:
      IDs of written or inserted keys.
      Throws:
      byps.RemoteException - Exception with message text of format "[ELOIX:number] text". The number is one of the constants defined in IXExceptionC. Exception with message text of format "[ELOIX:number] text".
      See Also:

    • checkinKeywords

      void checkinKeywords(ClientInfo ci, Keyword[] kws, LockZ unlockZ) throws byps.RemoteException
      Insert keywords and all their children.
      The keyword IDs specify whether to insert or update
      kws[.].id={existing ID} Updates the keyword tree branch below the keyword with kws[.].id. The keyword must exist.
      kws[.].id={new root ID} Inserts or updates a new keyword list.
      Usage
      Operations Solution
      Insert a new child into an existing parent keyword Check-in the parent keyword with all current children plus the new child. Setting the text members and children arrays of the current children to null leaves them unchanged.
      Delete a child of an existing parent keyword Check-in the parent keyword with all current children minus the child to be deleted. Setting the text members and children arrays of the current children to null leaves them unchanged.
      Update text, add, enabled of an existing keyword Check-in the keyword with a non empty text member. Only when the text is not null and not an empty string will the members add and enabled be written into the database.

      IMPORTANT: This function assigns new IDs to all branches of the keyword trees below the parent keywords of the given keywords. The client program should read the parent keyword and all children below again to receive the new IDs.

      The access rights AccessC.FLAG_EDITCONFIG and AccessC.FLAG_EDITSWL are required to check-in keywords.

      Parameters:
      ci - ClientInfo object with language, country and ticket
      kws - Keyword[] Array of child keywords. Members kw[.].raw and kw[.].children[.].id are ignored.
      unlockZ - Remove lock.
      Throws:
      byps.RemoteException - Exception with message text of format "[ELOIX:number] text". The number is one of the constants defined in IXExceptionC. Exception with message text of format "[ELOIX:number] text".

    • checkinNotes

      int[] checkinNotes(ClientInfo ci, String objId, Note[] notes, NoteZ noteZ, LockZ unlockZ) throws byps.RemoteException
      Write or insert Notes.

      Only Sord objects that reference documents can have notes. It is also possible to delete a Note: notes[.].setDeleted(true);.

      NOTE: When checking changed notes of annotation in stamp type notes or annotations can only be checked in once. When attempting to check in stamp type notes that already exist an exception will be returned. Use MbOnlyLock to unlock notes and annotations.

      Parameters:
      ci - ClientInfo object with language, country and ticket.
      objId - String ID or GUID of associated Sord. This parameter can be null.
      notes - Note[] Array of note objects. If objId is supplied, notes[.].objId is ignored.
      noteZ - NoteZ Controls the members to be written.
      unlockZ - Removes a lock on the notes.
      Returns:
      array of note IDs.
      Throws:
      byps.RemoteException
      See Also:

    • checkinNotification

      Notification checkinNotification(ClientInfo ci, Notification notif, NotificationZ notiZ) throws byps.RemoteException
      Inserts or updates a Notification object if userGuid is null, the own Guid will be taken if userGuid is not the own Guid, admin rights are needed
      Parameters:
      ci - ClientInfo object with language, country and ticket.
      notif - Notification object which should be updated or inserted
      notiZ - Determines, which members of Notification to save. currently only mbPrio supported
      Returns:
      Notification
      Throws:
      byps.RemoteException - Exception with message text of format "[ELOIX:number] text". The number is one of the constants defined in IXExceptionC. Exception with message text of format "[ELOIX:number] text".
      Since:
      9.00.022.003

    • checkinReminder

      int[] checkinReminder(ClientInfo ci, Reminder remi, String[] receiverIds, boolean expandGroups, LockZ unlockZ) throws byps.RemoteException
      Inserts or updates a reminder object.

      Reminder.receiverId = -1 should be set if receiverId is to be ignored. Reminder.receiverName = null should be set if the receiverName is to be ignored.

      Parameters:
      ci - ClientInfo object with language, country and ticket.
      remi - Reminder object to insert or write.
      receiverIds - If not null, this array contains the user IDs or names for which copies of the reminder are created too.
      expandGroups - If remi.receiverId references a group and expandGroups is true, Reminder objects for all users of the group are created.
      unlockZ - Removes a lock on the notes.
      Returns:
      int Reminder IDs
      Throws:
      byps.RemoteException - Exception with message text of format "[ELOIX:number] text". The number is one of the constants defined in IXExceptionC. Exception with message text of format "[ELOIX:number] text".

    • checkinReplNames

      void checkinReplNames(ClientInfo ci, ReplSetName[] replNames, LockZ unlockZ) throws byps.RemoteException
      Writes replication set names.
      Parameters:
      ci - ClientInfo object with language, country and ticket
      replNames - of replication set names.
      unlockZ - Unlock the replication set names.
      Throws:
      byps.RemoteException - Exception with message text of format "[ELOIX:number] text". The number is one of the constants defined in IXExceptionC. Exception with message text of format "[ELOIX:number] text".

    • checkinReportOptions

      void checkinReportOptions(ClientInfo ci, ReportOptions options, LockZ unlockZ) throws byps.RemoteException
      Writes the report options.
      Parameters:
      ci - ClientInfo object with language, country and ticket
      options - Report options
      unlockZ - Unlock report data
      Throws:
      byps.RemoteException - Exception with message text of format "[ELOIX:number] text". The number is one of the constants defined in IXExceptionC. Exception with message text of format "[ELOIX:number] text".

    • checkinSord

      int checkinSord(ClientInfo ci, Sord sord, SordZ sordZ, LockZ unlockZ) throws byps.RemoteException
      Writes or inserts a archive entry into the database.

      A new object does not have to be created with createSord. If the object is missing a GUID then a new one is created.

      If the Sord object is only to be unlocked sordZ = SordC.mbOnlyUnlock should be used and a minimum of Sord.id or Sord.guid must be set.

      Parameters:
      ci - ClientInfo object with language, country and ticket.
      sord - Indexing information
      sordZ - Determines, which members of sord to save. Default is SordC.mbAll.
      unlockZ - Unlock archive entry. Default is LockC.NO.
      Returns:
      ID of the updated or inserted object.
      Throws:
      byps.RemoteException - Exception with message text of format "[ELOIX:number] text". The number is one of the constants defined in IXExceptionC. Exception with message text of format "[ELOIX:number] text".
      See Also:

    • checkinSordPath

      int[] checkinSordPath(ClientInfo ci, String parentId, Sord[] sords, SordZ sordZ) throws byps.RemoteException
      Checks the existence of an archive path and creates missing entries if necessary by traversing top-down through the Sords array.

      The folders are inserted inside the same database transaction. Thus either all folders are created or none.

      This function allows only one process at a given time to create a structure. This prevents from creating the same archive path twice by two parallel working processes.

      In order to write index values (Sord.objKeys/Sord.aspects), parameter sordZ has to contain SordC.mbObjKeys or SordC.mbAspectObjects resp. If sord.objKeys == null or sord.aspects=null or sordZ does not contain SordC.mbObjKeys/SordC.mbAspectObjects, the index values defaults defined by the keywording form are written.

      Parameters:
      ci - ClientInfo object with language, country and ticket
      parentId - ID expression (see checkoutSord) that references the start point of the path.
      sords - Top-down sorted array of indexing information, where the predecessor of an array element is its main parent object
      sordZ - Determines, which members of sord to save.
      Returns:
      Array of integer values representing the top-down sorted object IDs
      Throws:
      byps.RemoteException - Exception with message text of format "[ELOIX:number] text". The number is one of the constants defined in IXExceptionC. Exception with message text of format "[ELOIX:number] text".

    • checkinSordTypes

      void checkinSordTypes(ClientInfo ci, SordType[] sordTypes, LockZ unlockZ) throws byps.RemoteException
      Write or insert sord type information.
      Parameters:
      ci - ClientInfo object with language, country and ticket.
      sordTypes - Array of type information to be written or null, if only lock should be removed.
      unlockZ - Removes a lock previously set by checkoutSordTypes.
      Throws:
      byps.RemoteException - Exception with message text of format "[ELOIX:number] text". The number is one of the constants defined in IXExceptionC. Exception with message text of format "[ELOIX:number] text".

    • checkinStorage

      StoreInfo[] checkinStorage(ClientInfo ci, StoreInfo[] storeInfos, LockZ unlockZ) throws byps.RemoteException
      This method passes path information to the document manager.
      Parameters:
      ci - ClientInfo object with language, country and ticket
      storeInfos - path information for the Document Manager
      unlockZ - Unlock path data
      Returns:
      success
      Throws:
      byps.RemoteException - Exception with message text of format "[ELOIX:number] text". The number is one of the constants defined in IXExceptionC. Exception with message text of format "[ELOIX:number] text".

    • checkinSubs

      @Deprecated void checkinSubs(ClientInfo ci, SubsInfo[] deps, LockZ unlockZ) throws byps.RemoteException
      Deprecated.
      Replaced by checkinSubstitutions(ClientInfo, CheckinSubstitutionsInfo, SubstitutionZ, LockZ)
      Insert deputy/substitute information.
      Parameters:
      ci - ClientInfo
      deps - SubsInfo[]
      unlockZ - Unlock user data
      Throws:
      byps.RemoteException - Exception with message text of format "[ELOIX:number] text". The number is one of the constants defined in IXExceptionC. Exception with message text of format "[ELOIX:number] text".

    • checkinUserProfile

      void checkinUserProfile(ClientInfo ci, UserProfile userProfile, LockZ unlockZ) throws byps.RemoteException
      Write (add) user profile options.
      Parameters:
      ci - ClientInfo object with language, country and ticket
      userProfile - Options of a specific user or default options for all users.
      unlockZ - Remove lock - locking is currently not supported but may be added in future.
      Throws:
      byps.RemoteException - Exception with message text of format "[ELOIX:number] text". The number is one of the constants defined in IXExceptionC. Exception with message text of format "[ELOIX:number] text".
      See Also:

    • checkinUsers

      int[] checkinUsers(ClientInfo ci, UserInfo[] userInfos, CheckinUsersZ checkinUsersZ, LockZ unlockZ) throws byps.RemoteException
      Updates or inserts users or groups.

      When inserting users or groups either UserInfo.id=-1 should be set or the bit CheckinUsersC.NEW_USER in checkinUsersC should be used. The second case allows a complete user and group structure to be checked in with a single call of checkinUsers. Therefore the IDs in the submitted UserInfo objects must be unique and cannot be used by other users or groups in the archive database.

      If only the user data is to be unlocked then the method should be called with userInfos=null and lockZ=lockZ.YES.

      If the user of the current session is a sub-administrator (has right AccessC.FLAG_SUBADMIN) the UserInfo.parent members of the users in userInfos are internally set to the current users ID. In other words: sub-administrators are not free to define the parent of the users or groups.

      The method checks whether the users or groups to be checked-in have more rights than their parents (administrators).

      Since the function requires an exclusive access to the user data, the data must be locked for the current user or must not be locked for anyone. To check in regardless of a lock lockZ.FORCE must be supplied in lockZ.

      The users password is only written for new users or if CheckinUsersC.PASSWORD for the parameter checkinUsersZ is supplied along with the password member UserInfo.pwd!=null. In this case, the userInfos array must be of length=1. The user does not need to have the right AccessC.FLAG_SUBADMIN, but must have the right AccessC.FLAG_CHANGEPW. Only the members UserInfo.id and UserInfo.pwd are taken into account. This is how to change a password: UserInfo ui = new UserInfo();
      ui.id = current user id;
      ui.pwd = new password;
      ix.checkinUsers(ci, new UserInfo[] {ui}, CheckinUsersC.PASSWORD, LockC.NO);

      Password rules are checked, if the user changes the password or if a new user is stored. The password rules are defined in the user profile value at key UserProfileC.KEY_PASSWORD_RULES. If the password violates the password rules, an exception is throw with message "[ELOIX:3007]...". The error number (3007) is defined in IXExceptionC.PASSWORD_DENIED.

      The password expiring date is handled. If the password is changed, the expiring date in the user data is updated: UserInfo.userProps[UserInfoC.PROP_ACTION] = "EX{iso-date-without-time}". Interactive client applications should check the action field in order display a dialog, if the password has to be changed. They do not need to check the "EX<iso-date>", because it is replaced by "PWf" (must change password) for the UserInfo object in the LoginResult object return by the login() functions, resp. the create() functions of IXConnFactory. The following code is recommended: IXConnection conn = ...
      String action = conn.getLoginResult().getUser().userProps[UserInfoC.PROP_ACTION];
      boolean userShouldChangePassword = action.indexOf(UserInfoC.PROP_ACTION_USER_SHOULD_CHANGE_PASSWORD) >= 0;
      boolean userMustChangePassword = action.indexOf(UserInfoC.PROP_ACTION_USER_MUST_CHANGE_PASSWORD) >= 0;

      If more than 100 users are passed to this function, a background task is started to avoid a timeout error. The task status can be queried by collectJobStates(ClientInfo, boolean, boolean, boolean). and queryJobState(ClientInfo, String, boolean, boolean, boolean).

      Parameters:
      ci - ClientInfo object with language, country and ticket
      userInfos - User objects or null if you only want to unlock.
      checkinUsersZ - Combinations of CheckinUsersC values.
      unlockZ - Unlock user data or force access.
      Returns:
      Array of user IDs
      Throws:
      byps.RemoteException - Exception with message text of format "[ELOIX:number] text". The number is one of the constants defined in IXExceptionC. Exception with message text of format "[ELOIX:number] text".
      See Also:

    • checkinUser

      int checkinUser(ClientInfo ci, UserInfo userInfo, CheckinUsersZ checkinUsersZ, LockZ unlockZ) throws byps.RemoteException
      Update or insert a user or group. This function internally calls checkinUsers(ClientInfo, UserInfo[], CheckinUsersZ, LockZ) for one user object.
      Parameters:
      ci - ClientInfo object with language, country and ticket
      userInfo - User object or null if you only want to unlock.
      checkinUsersZ - Combinations of CheckinUsersC values.
      unlockZ - Unlock user data or force access.
      Returns:
      Updated or inserted user ID.
      Throws:
      byps.RemoteException
      Since:
      11.00.000.005

    • checkinOrgUnits

      Map<Integer,OrgUnitInfo> checkinOrgUnits(ClientInfo ci, OrgUnitInfo[] orgUnitInfos, CheckinOrgUnitInfo reserved, LockZ unlockZ) throws byps.RemoteException
      Inserts or updates organizational units.

      When inserting a new OU, OrgUnitInfo.id=-1 has to be set. More than one OU can be checked in with a single call of checkinOrgUnit. Therefore the names, IDs and GUIDs in the submitted OrgUnitInfo objects must be unique and cannot be used by other OUs in the archive database.

      If only the user and OU data is to be unlocked then the method should be called with orgUnitInfos=null and lockZ=lockZ.YES.

      Parameters:
      ci - ClientInfo object with language, country and ticket
      orgUnitInfos - OU objects
      reserved - This parameter must be null.
      unlockZ - Unlock user data or force access.
      Returns:
      OUs (with the result ID if an ID is -1)
      Throws:
      byps.RemoteException - Exception with message text of format "[ELOIX:number] text". The number is one of the constants defined in IXExceptionC. Exception with message text of format "[ELOIX:number] text".
      Since:
      9.00.000.008

    • deleteOrgUnits

      void deleteOrgUnits(ClientInfo ci, String[] ids, LockZ unlockZ) throws byps.RemoteException
      Delete OUs.
      Parameters:
      ci - ClientInfo object with language, country and ticket
      ids - IDs or names of OUs to be deleted.
      unlockZ - Unlock OU data or force access.
      Throws:
      byps.RemoteException - Exception with message text of format "[ELOIX:number] text". The number is one of the constants defined in IXExceptionC. Exception with message text of format "[ELOIX:number] text".
      Since:
      9.00.000.008
      See Also:

    • checkoutOrgUnits

      Map<Integer,OrgUnitInfo> checkoutOrgUnits(ClientInfo ci, CheckoutOrgUnitInfo reserved, LockZ lockZ) throws byps.RemoteException
      Read the data of all OUs.
      Parameters:
      ci - ClientInfo object with language, country and ticket
      reserved - This parameter must be null.
      lockZ - Lock OU data.
      Returns:
      Map of OUs, key is OrgUnitInfo.id
      Throws:
      byps.RemoteException - Exception with message text of format "[ELOIX:number] text". The number is one of the constants defined in IXExceptionC. Exception with message text of format "[ELOIX:number] text".
      Since:
      9.00.000.008
      See Also:

    • checkinWorkFlow

      int checkinWorkFlow(ClientInfo ci, WFDiagram wf, WFDiagramZ workFlowDiagramZ, LockZ unlockZ) throws byps.RemoteException
      Write/create a workflow.

      In case of a new workflow object of type WFTypeC.ACTIVE, the workflow is immediately started after written into database. This requires a valid WFDiagram.getObjId().

      Parameters:
      ci - ClientInfo object with language, country and ticket
      wf - WFDiagram
      workFlowDiagramZ - WFDiagramZ
      unlockZ - Unlock workflow.
      Returns:
      int workflow ID.
      Throws:
      byps.RemoteException - Exception with message text of format "[ELOIX:number] text". The number is one of the constants defined in IXExceptionC. Exception with message text of format "[ELOIX:number] text".
      See Also:

    • checkoutColors

      ColorData[] checkoutColors(ClientInfo ci, LockZ lockZ) throws byps.RemoteException
      Checkout the markers definitions (colors of archive entries). This function returns only visible and non-deleted colors. It returns the same result as checkoutColors2(ClientInfo, int, LockZ) passing ColorDataC.SORD_COLORS in options parameter. In order to receive all colors, call function checkoutColors2(ClientInfo, int, LockZ).
      Parameters:
      ci - ClientInfo object with language, country and ticket
      lockZ - Lock against concurrent modification.
      Returns:
      Array of Color objects sorted by name
      Throws:
      byps.RemoteException - Exception with message text of format "[ELOIX:number] text". The number is one of the constants defined in IXExceptionC. Exception with message text of format "[ELOIX:number] text".

    • checkoutConfigFiles

      ConfigFile[] checkoutConfigFiles(ClientInfo ci, String[] names, ConfigFileZ configFileZ, LockZ lockZ) throws byps.RemoteException
      Read config file names and file data.

      The names parameter selects the config files. Each element in this array contains the virtual path to a file. A path private to a user starts with the user s name. Paths may contain the wildcard * instead of a file name. In this case all files in the directory are returned.

      Usage
      Example Description
      name[.]=peter/template/* Selects all private document templates of user peter (document templates are currently not supported!)
      name[.]=peter/postbox/* Selects peters server side postbox files
      name[.]=template/* Selects all document templates available for all users (document templates are currently not supported!)
      name[.]=eloscripts/* Selects all scripts
      Parameters:
      ci - ClientInfo object with language, country and ticket
      names - Array of filter specifications to select the files to return.
      configFileZ - Specifies wich data is to return.
      lockZ - reserved
      Returns:
      Array of file names and file data.
      Throws:
      byps.RemoteException - Exception with message text of format "[ELOIX:number] text". The number is one of the constants defined in IXExceptionC. Exception with message text of format "[ELOIX:number] text".

    • checkoutCounters

      CounterInfo[] checkoutCounters(ClientInfo ci, String[] counterNames, boolean incrementCounters, LockZ lockZ) throws byps.RemoteException
      Get counter information.
      Parameters:
      ci - ClientInfo object with language, country and ticket
      counterNames - Array of counter names to be read. If null, all counters are returned.
      incrementCounters - If true the given counters are incremented. This parameter is ignored, if counterNames=null.
      lockZ - LockZ Locks against concurrent modifications.
      Returns:
      CounterInfo[] Array of counter objects with values BEFORE being incremented.
      Throws:
      byps.RemoteException - Exception with message text of format "[ELOIX:number] text". The number is one of the constants defined in IXExceptionC. Exception with message text of format "[ELOIX:number] text".

    • checkoutDoc

      EditInfo checkoutDoc(ClientInfo ci, String objId, String docId, EditInfoZ editInfoZ, LockZ lockZ) throws byps.RemoteException
      Reads the indexing information and the download URL of a document.

      At least one of the parameters objId and docId must be supplied. If only objId is supplied, the function reads the information for the current work version of the document. If docId is supplied, the function reads the information for a specific document or attachment version. All versions are returned if docId="-1" is supplied.

      The document member of the returned object contains the URL from where the document file can be read. Use raw HTTP functions to download the file.

      If the document is only to be unlocked, see checkinSord.

      Parameters:
      ci - ClientInfo object with language, country and ticket
      objId - Object ID, null or empty string
      docId - Document ID, null or empty string
      editInfoZ - Determines, which members of EditInfo to return. Reasonable predefined values are EditInfoC.mbOnlyId, EditInfoC.mbSordLean, EditInfoC.mbSord, EditInfoC.mbDocument, EditInfoC.mbSordDocAtt. Be aware of the performance effects of this parameter: avoid using EditInfoC.mbAll.
      lockZ - Lock archive entry.
      Returns:
      Data to edit an archive entry.
      Throws:
      byps.RemoteException - Exception with message text of format "[ELOIX:number] text". The number is one of the constants defined in IXExceptionC. Exception with message text of format "[ELOIX:number] text".
      See Also:

    • checkoutDocMask

      DocMask checkoutDocMask(ClientInfo ci, String maskId, DocMaskZ docMaskZ, LockZ lockZ) throws byps.RemoteException
      Reads a storage mask from the database.
      Parameters:
      ci - ClientInfo object with language, country and ticket
      maskId - Mask ID (DocMask.no) or name (DocMask.name)
      docMaskZ - Members to be read.
      lockZ - Lock masks against concurrent modification.
      Returns:
      Mask object
      Throws:
      byps.RemoteException - Exception with message text of format "[ELOIX:number] text". The number is one of the constants defined in IXExceptionC. Exception with message text of format "[ELOIX:number] text".
      See Also:

    • checkoutKeys

      @Deprecated KeyInfo[] checkoutKeys(ClientInfo ci, String[] ids, LockZ lockZ) throws byps.RemoteException
      Deprecated.
      Reads a list of key objects.
      Parameters:
      ci - ClientInfo object with language, country and ticket
      ids - Array of key IDs or names or null to read all keys.
      lockZ - Lock key data.
      Returns:
      Array of key objects
      Throws:
      byps.RemoteException - Exception with message text of format "[ELOIX:number] text". The number is one of the constants defined in IXExceptionC. Exception with message text of format "[ELOIX:number] text".
      See Also:

    • checkoutKeywords

      Keyword[] checkoutKeywords(ClientInfo ci, String[] kwids, KeywordZ keywordZ, int max, LockZ lockZ) throws byps.RemoteException
      Collects keywords and their children.

      The keyword objects with the given kwids[.] will be read.

      Parameter kwids
      kwids[.]= KeywordC.KWID_*,
      an index row name,
      an ID of a previously read keyword.
      null, to read all toplevel keyword lists. Parameter max is ignored.

      The parameter max controls how many keywords will be read.

      Parameter max
      max = 0 Only the first level directly below the given kwids[.] is read (up to 676 keywords). The children of the returned keywords are null
      max = -1 Entire tree below kwid is read.
      max > 0 Approximately up to this number of keywords are read. The children of a keyword are always read completely or they are null. Thus up to max+675 keywords could be returned.

      Hint: if max >= 0 and the Keyword.children of a keyword is an empty array (not null), the keyword has definitely no children. If Keyword.children = null, query the children with a further call to collectKeywords.

      Before one of the returned keywords can be used as an index value the members Keyword.enabled and Keyword.raw must be analyzed, see Keyword documentation.

      You need the access right AccessC.FLAG_EDITCONFIG to lock keywords against concurrent modification.

      Parameters:
      ci - ClientInfo object with language, country and ticket
      kwids - String IDs of keywords to checkout.
      keywordZ - If KeywordC.mbEdit, the place-holders in keywords texts are not substituted. If KeywordC.mbView the place-holders except KeywordC.PLACEHOLDER_COUNTER are replaced.
      max - int Read up to this number of keywords and keyword children.
      lockZ - Lock against concurrent modification.
      Returns:
      Keyword[] List of keywords
      Throws:
      byps.RemoteException - Exception with message text of format "[ELOIX:number] text". The number is one of the constants defined in IXExceptionC. Exception with message text of format "[ELOIX:number] text".
      See Also:

    • checkoutNotes

      Note[] checkoutNotes(ClientInfo ci, String objId, String[] noteIds, NoteZ noteZ, LockZ lockZ) throws byps.RemoteException
      Read notes of a given Sord.
      Parameters:
      ci - ClientInfo object with language, country and ticket.
      objId - String ID or GUID of associated Sord. If objId==null, parameter noteId must be set.
      noteIds - String GUIDs of notes to be returned. If noteIds==null, parameter objId must be set and the function returns all notes associated to the Sord object referenced by objId.
      noteZ - NoteZ Controls the members to be returned.
      lockZ - LockZ Locks the note object against concurrent modification.
      Returns:
      Note[] Array of note objects ordered by Note.createDate
      Throws:
      byps.RemoteException
      See Also:

    • checkoutNotification

      Notification checkoutNotification(ClientInfo ci, String watchGuid, String userGuid) throws byps.RemoteException
      Reads Notification for a watchGuid / userGuid combination if userGuid is null, the own Guid will be taken if userGuid is not the own Guid, admin rights are needed
      Parameters:
      ci - ClientInfo object with language, country and ticket.
      watchGuid - String
      userGuid - String Guid or ID or Name of the user to which the Notification belongs
      Returns:
      Notification if found
      Throws:
      byps.RemoteException - Exception with message text of format "[ELOIX:number] text". The number is one of the constants defined in IXExceptionC. Exception with message text of format "[ELOIX:number] text".
      Since:
      9.00.022.003

    • checkoutReminders

      Reminder[] checkoutReminders(ClientInfo ci, int[] reminderIds, LockZ lockZ) throws byps.RemoteException
      Reads and locks a reminder object.
      Parameters:
      ci - ClientInfo object with language, country and ticket.
      reminderIds - Reminder IDs
      lockZ - Locks against concurrent modification.
      Returns:
      Reminder objects
      Throws:
      byps.RemoteException - Exception with message text of format "[ELOIX:number] text". The number is one of the constants defined in IXExceptionC. Exception with message text of format "[ELOIX:number] text".

    • checkoutReplNames

      ReplSetName[] checkoutReplNames(ClientInfo ci, LockZ lockZ) throws byps.RemoteException
      Reads replication set names.
      Parameters:
      ci - ClientInfo object with language, country and ticket
      lockZ - Lock against concurrent modification.
      Returns:
      Array of replication set names.
      Throws:
      byps.RemoteException - Exception with message text of format "[ELOIX:number] text". The number is one of the constants defined in IXExceptionC. Exception with message text of format "[ELOIX:number] text".

    • checkoutReportOptions

      ReportOptions checkoutReportOptions(ClientInfo ci, LockZ lockZ) throws byps.RemoteException
      Reads the report options.
      Parameters:
      ci - ClientInfo object with language, country and ticket
      lockZ - Lock report data.
      Returns:
      Report options
      Throws:
      byps.RemoteException - Exception with message text of format "[ELOIX:number] text". The number is one of the constants defined in IXExceptionC. Exception with message text of format "[ELOIX:number] text".

    • checkoutSord

      EditInfo checkoutSord(ClientInfo ci, String objId, EditInfoZ editInfoZ, LockZ lockZ) throws byps.RemoteException
      Reads the data needed to edit an existing archive entry.
      Possible object identifiers (parameter objId)
      ID A numeric object number corresponding to Sord.getId() converted to string
      GUID A GUID corresponding to Sord.getGuid()
      Index value Use "OKEY:<index-group-name>=<index-value>" to select an object by an index value, example: "OKEY:SAPPATH=123124109824123/data". The wildcards "%" or "*" can be used in <index-group-name> or <index-value> to return all or any data that matches.
      Index match value Use "LMATCH:<index-group-name>=<fix-value>%<match-value>" to select an object by an index value that starts with <fix-value> and might be followed by <match-value>. The object that fits most characters in <match-value> is selected. Example: "LMATCH:ELOINDEX=S%CH". The wildcards "%" or "*" can be used in <index-group-name> or <match-value> to return all or any data that matches. This selection mode only be utilized on non-deleted Sords.
      Archive path Use "ARCPATH:<delim-char><SordName1><delim-char><SordName2>..." to select an object by an archive path. This selection mode only be utilized on non-deleted Sords.
      Archive path with base ID Use "ARCPATH[<ID>]:<delim-char><SordName1><delim-char><SordName2>..." to select an object by an archive path
      MD5 hash Use "MD5:<MD5-hash-hex-string>" to select an object by an MD5 hash. Use upper case letters for hexadecimal characters for the hash value.
      The object can be locked against concurrent modification if lockZ is set to lockZ.YES.
      Parameters:
      ci - ClientInfo object with language, country and ticket
      objId - Object identifier. The table above gives possible types of identifiers.
      editInfoZ - Determines, which members of EditInfo to return. Reasonable predefined values are EditInfoC.mbOnlyId, EditInfoC.mbSordLean, EditInfoC.mbSord. Be aware of the perfomance effects of this parameter: avoid using EditInfoC.mbAll.
      lockZ - Lock archive entry. Default is LockC.NO.
      Returns:
      Data to edit an archive entry.
      Throws:
      byps.RemoteException - Exception with message text of format "[ELOIX:number] text". The number is one of the constants defined in IXExceptionC. Exception with message text of format "[ELOIX:number] text".
      See Also:

    • checkoutSordHistory

      SordHist[] checkoutSordHistory(ClientInfo ci, String objId) throws byps.RemoteException
      checkoutSordHistory retrieves all history entries related to a given object.
      Parameters:
      ci - ClientInfo object with language, country and ticket
      objId - Object identifier. This may be the simple numeric identifier or the associated global unique identifier (GUID)
      Returns:
      SordHist[] An array of all sord history entries sorted by its creation date.
      Throws:
      byps.RemoteException - Exception with message text of format "[ELOIX:number] text". The number is one of the constants defined in IXExceptionC. Exception with message text of format "[ELOIX:number] text".

    • checkoutSordTypes

      SordType[] checkoutSordTypes(ClientInfo ci, int[] sordTypeIds, SordTypeZ sordTypeZ, LockZ lockZ) throws byps.RemoteException
      Get sord type information.

      SordType objects give access to labels, icons and extensions corresponding to Sord.type.

      Parameter sordTypeZ specifies which members of the returned objects should be filled. It also contains the content type of the image data to be returned. This content type correspond to directories named "jpg", "ico" resp. "bmp" below ".../am-eloam/configuration/initdata/images/sordtypes/". Use ELO CLIENT to fill the directories with images of the required type.

      Parameters:
      ci - ClientInfo object with language, country and ticket.
      sordTypeIds - Array of Sord type IDs that specify the Objects to return. Or null to return all Objects.
      sordTypeZ - Controls the data to be returned.
      lockZ - Locks against concurrent modification.
      Returns:
      SordType[] Array of sord type information.
      Throws:
      byps.RemoteException - Exception with message text of format "[ELOIX:number] text". The number is one of the constants defined in IXExceptionC. Exception with message text of format "[ELOIX:number] text".
      See Also:

    • checkoutStorage

      StoreInfo[] checkoutStorage(ClientInfo ci, String[] ids, LockZ lockZ) throws byps.RemoteException
      checkoutStorage retrieves an array of configured paths from the Document Manager. The contents matches the table elodmpath.
      Parameters:
      ci - ClientInfo object with language, country and ticket
      ids - array of IDs for the desired storage paths; pass null or an array of zero length to retrieve all
      lockZ - Lock path data
      Returns:
      path information from the Document Manager
      Throws:
      byps.RemoteException - Exception with message text of format "[ELOIX:number] text". The number is one of the constants defined in IXExceptionC. Exception with message text of format "[ELOIX:number] text".

    • checkoutSubs

      @Deprecated SubsInfo[] checkoutSubs(ClientInfo ci, String userId, LockZ lockZ) throws byps.RemoteException
      Deprecated.
      Replaced by checkoutSubstitutions(ClientInfo, CheckoutSubstitutionsInfo, SubstitutionZ, LockZ)
      Read the substitute information for the given user.

      The returned array contains the relations/users for which the given user is the substituted person or the substitute.

      Parameters:
      ci - ClientInfo object with language, country and ticket
      userId - User name or ID, only main administrators are allowed to collect substitute relationships for other users. Non-administrators must set this parameter to null or to their user ID.
      lockZ - Lock user data
      Returns:
      SubsInfo[]
      Throws:
      byps.RemoteException - Exception with message text of format "[ELOIX:number] text". The number is one of the constants defined in IXExceptionC. Exception with message text of format "[ELOIX:number] text".

    • checkoutUserProfile

      UserProfile checkoutUserProfile(ClientInfo ci, UserProfile userProfile, LockZ lockZ) throws byps.RemoteException
      Read user profile options.

      Set userProfile.userId to the current user, to read her or his entire option set. This means that the default values for all users and the options inherited from the users groups are included too.

      In order to read the user specific options without defaults and group options, set userProfile.excludeDefaultValues=true and userProfile.excludeGroupValues=true.

      Parameters:
      ci - ClientInfo object with language, country and ticket
      userProfile - Options of a specific user or default options for all users. If the userProfile.options array is null, all options are returned. Otherwise the keys in the option array select the options to return. A key might end with wildcard "*" in which case all options are selected that begin with the key.
      lockZ - Lock against concurrent modification - locking is currently not supported but may be added in future.
      Returns:
      User profile options.
      Throws:
      byps.RemoteException - Exception with message text of format "[ELOIX:number] text". The number is one of the constants defined in IXExceptionC. Exception with message text of format "[ELOIX:number] text".

    • checkoutUsers

      UserInfo[] checkoutUsers(ClientInfo ci, String[] ids, CheckoutUsersZ checkoutUsersZ, LockZ lockZ) throws byps.RemoteException
      Reads the user data for users or groups.

      The function has various options for specifying which users are to read, e. g. all users, users of a specific group or groups of a specific user. The options are controlled with the bit-mask parameter checkoutUsersC. Possible values are combinations of CheckoutUsersC values.

      Supplying lockZ.YES or lockZ.FORCE for the parameter lockZ locks the user data against concurrent modification. The lock can be released with checkinUsers or deleteUsers.

      All returned UserInfo objects have empty passwords because the passwords cannot be read from the archive database.

      Parameters:
      ci - ClientInfo object with language, country and ticket
      ids - User or group IDs, GUIDs or names.
      checkoutUsersZ - Controls the users or groups to retrieve.
      lockZ - Lock user data.
      Returns:
      List of users or groups sorted by name.
      Throws:
      byps.RemoteException - Exception with message text of format "[ELOIX:number] text". The number is one of the constants defined in IXExceptionC. Exception with message text of format "[ELOIX:number] text".
      See Also:

    • checkoutUser

      UserInfo checkoutUser(ClientInfo ci, String id, CheckoutUsersZ checkoutUsersZ, LockZ lockZ) throws byps.RemoteException
      Reads the user data for a user or group. This function internally calls checkoutUsers(ClientInfo, String[], CheckoutUsersZ, LockZ)
      Parameters:
      ci - ClientInfo object with language, country and ticket
      id - User or group ID, GUID or name.
      checkoutUsersZ - Controls the users or groups to retrieve.
      lockZ - Lock user data.
      Returns:
      User data.
      Throws:
      byps.RemoteException
      Since:
      11.00.000.005

    • checkoutWorkFlow

      WFDiagram checkoutWorkFlow(ClientInfo ci, String flowId, WFTypeZ typeZ, WFDiagramZ workFlowDiagramZ, LockZ lockZ) throws byps.RemoteException
      Reads a workflow definition.
      Parameters:
      ci - ClientInfo object with language, country and ticket
      flowId - Workflow name or ID
      typeZ - Workflow type: active flow, finished flow, template.
      workFlowDiagramZ - Members to return.
      lockZ - Lock workflow.
      Returns:
      Workflow definition
      Throws:
      byps.RemoteException - Exception with message text of format "[ELOIX:number] text". The number is one of the constants defined in IXExceptionC. Exception with message text of format "[ELOIX:number] text".
      See Also:

    • cleanupStart

      boolean cleanupStart(ClientInfo ci, DeleteOptions deleteOptions) throws byps.RemoteException
      cleanupStart(ClientInfo ci) removes all deleted objects and related entries from the archive database.

      Once started the call returns immediately, while the unique background thread cleans the archive until it finishes or cleanupStart(ClientInfo ci) is called. Only users owning main administrator rights may clean up archives.

      Parameters:
      ci - ClientInfo object with language, country and ticket
      deleteOptions - DeleteOptions object contains options for deleting archive SORDs.
      Returns:
      true, if the background cleaner can be started, false otherwise
      Throws:
      byps.RemoteException - Exception with message text of format "[ELOIX:number] text". The number is one of the constants defined in IXExceptionC. Exception with message text of format "[ELOIX:number] text".
      See Also:

    • cleanupState

      JobState cleanupState(ClientInfo ci) throws byps.RemoteException
      cleanupState(ClientInfo ci) returns state information in a BackgroundThreadInfo.
      Parameters:
      ci - ClientInfo object with language, country and ticket
      Returns:
      JobState
      Throws:
      byps.RemoteException - Exception with message text of format "[ELOIX:number] text". The number is one of the constants defined in IXExceptionC. Exception with message text of format "[ELOIX:number] text".
      See Also:

    • cleanupStop

      boolean cleanupStop(ClientInfo ci) throws byps.RemoteException
      cleanupStop(ClientInfo ci) stops the cleaning as soon as possible finishing open transactions first.

      The call returns, when the background cleaner has been stopped. Only users owning main administrative rights may clean up archives.

      Parameters:
      ci - ClientInfo object with language, country and ticket
      Returns:
      true, if the background cleaner can be stopped, false otherwise
      Throws:
      byps.RemoteException - Exception with message text of format "[ELOIX:number] text". The number is one of the constants defined in IXExceptionC. Exception with message text of format "[ELOIX:number] text".
      See Also:

    • collectJobStates

      JobState[] collectJobStates(ClientInfo ci, boolean activeJobs, boolean finishedJobs, boolean fullInfo) throws byps.RemoteException
      collectJobStates lists all the states of currently existing jobs from the IX backround job pool running or finished, but still listed.
      Parameters:
      ci - ClientInfo object with language, country and ticket
      activeJobs - Currently running jobs will be collected (filter information)
      finishedJobs - Finished jobs, that are still queued for state evaluation will be collectred (filter information)
      fullInfo - The procInfo member of JobState will be filled by jobs that support the member procInfo
      Returns:
      Array of background job states
      Throws:
      byps.RemoteException - Exception with message text of format "[ELOIX:number] text". The number is one of the constants defined in IXExceptionC. Exception with message text of format "[ELOIX:number] text".

    • collectWorkFlowNodes

      @Deprecated WFCollectNode[] collectWorkFlowNodes(ClientInfo ci, String flowName, WFTypeZ wfTypeZ, String nodeName, int nodeType, String objId, String enterDateIso, String exitDateIso, String[] userIds, boolean onlyActive, boolean onlyStartNodes) throws byps.RemoteException
      Deprecated.
      Use findFirstTasks or findFirstWorkflows instead
      Collect workflow nodes.
      Parameters:
      ci - ClientInfo object with language, country and ticket.
      flowName - restricts the search to workflows named like this string. It may contain wildcards, e. g. *bill*.
      wfTypeZ - This parameter controls the search for nodes of either active or finished workflows. If this parameter is null, the search is performed on active workflows.
      nodeName - restricts the search to nodes named like this string. It may contain wildcards, e. g. *bill*.
      nodeType - One of the TYPE_* constants defined in WFNodeC can be assigned. TYPE_NOTHING or 0 means that all node types will be returned.
      objId - Return nodes of the object specified by this ID. Can be null to return nodes of all objects.
      enterDateIso - Return nodes of this activation date. The value is an ISO date in the clients time zone. It can be a single date value or a time span of two ISO dates separated by "...". To return nodes with an activation date up to a given time, set enterDateIso="..."+time (the first time value can be omitted).
      exitDateIso - Return nodes of this exit date. The format used is the same as for enterDateIso.
      userIds - If not null and not empty, the search is restricted to nodes for these users. It may be an array of IDs, GUIDs or names.
      onlyActive - If true, the result is restricted to active nodes.
      onlyStartNodes - If true, only the start nodes of the matching workflows are returned - instead of the matching nodes.
      Returns:
      Array of node information objects.
      Throws:
      byps.RemoteException - Exception with message text of format "[ELOIX:number] text". The number is one of the constants defined in IXExceptionC. Exception with message text of format "[ELOIX:number] text".
      See Also:

    • collectWorkFlows

      @Deprecated IdName[] collectWorkFlows(ClientInfo ci, WFTypeZ typeZ) throws byps.RemoteException
      Deprecated.
      Use findFirstWorkflows instead
      Collects workflow names.

      This method will be deprecated in future versions of the ELO Indexserver. It is recommended that the findFirstTasks() and findNextTasks() methods are used for retrieving workflow information from the Indexserver.

      Parameters:
      ci - ClientInfo object with language, country and ticket.
      typeZ - Workflow type: active flow, finished flow, template.
      Returns:
      Array of workfow names and IDs.
      Throws:
      byps.RemoteException - Exception with message text of format "[ELOIX:number] text". The number is one of the constants defined in IXExceptionC. Exception with message text of format "[ELOIX:number] text".
      See Also:

    • findFirstWorkflows

      FindResult findFirstWorkflows(ClientInfo ci, FindWorkflowInfo findInfo, int max, WFDiagramZ wfDiagramZ) throws byps.RemoteException
      Finds active workflows.

      This method returns all active workflows for the current user.

      Parameters:
      ci - ClientInfo object with language, country and ticket
      findInfo - FindTasksInfo information about the current search
      max - int maximal count of Workflow-Objects
      wfDiagramZ - WFDiagramZ needed elements
      Returns:
      FindResult
      Throws:
      byps.RemoteException - Exception with message text of format "[ELOIX:number] text". The number is one of the constants defined in IXExceptionC. Exception with message text of format "[ELOIX:number] text".
      Since:
      6.00.094

    • findNextWorkflows

      FindResult findNextWorkflows(ClientInfo ci, String searchId, int index, int maxResults) throws byps.RemoteException
      Finds more active workflows.

      This method returns all active workflows for the current user.

      Parameters:
      ci - ClientInfo object with language, country and ticket
      searchId - String Id of the current search
      index - int startindex for the current search
      maxResults - int maximal count of Workflow-Objects
      Returns:
      FindResult
      Throws:
      byps.RemoteException - Exception with message text of format "[ELOIX:number] text". The number is one of the constants defined in IXExceptionC. Exception with message text of format "[ELOIX:number] text".
      Since:
      6.00.094

    • cookKeyword

      String cookKeyword(ClientInfo ci, String kwid) throws byps.RemoteException
      Replaces control sequences in the text of a keyword.
      Parameters:
      ci - ClientInfo object with language, country and ticket
      kwid - Keyword ID
      Returns:
      Keyword
      Throws:
      byps.RemoteException - Exception with message text of format "[ELOIX:number] text". The number is one of the constants defined in IXExceptionC. Exception with message text of format "[ELOIX:number] text".

    • copySord

      int copySord(ClientInfo ci, String newParentId, String objId, CopyInfo copyInfo, CopySordZ copySordZ) throws byps.RemoteException
      Moves an archive entry or creates a relation (logical copy).

      1. Move
      To move an archive entry into another parent set bit CopySordC.MOVE in copySordC. Put the ID or GUID of the new parent into newParentId. If a reference shold be moved instead of an original, parameter copyInfo has to be passed with CopyInfo.oldParentId set to the current parent ID of the relation. In order to control the manual sort order, supply a copyInfo object with CopyInfo.manSortIdx.

      2. Relation
      Bit CopySordC.REFERENCE in copySordC should be used to create a logical copy of the archive entry in newParentId.
      Set copyInfo=null or supply an object and set the CopyInfo.manSortIdx to control the manual sort order.

      References can be deleted with deleteSord

      Parameters:
      ci - ClientInfo object with language, country and ticket
      newParentId - ID or -GUID of the parent entry in the archive hierarchy.
      objId - ID or -GUID of the existing object.
      copyInfo - Special options, e. g. manually sort order.
      copySordZ - One of the CopySordC constants.
      Returns:
      ID of the moved/referenced object or the new id of the copied object objId.
      Throws:
      byps.RemoteException - Exception with message text of format "[ELOIX:number] text". The number is one of the constants defined in IXExceptionC. Exception with message text of format "[ELOIX:number] text".
      See Also:

    • createDoc

      EditInfo createDoc(ClientInfo ci, String parentId, String maskId, String docTemplate, EditInfoZ editInfoZ) throws byps.RemoteException
      Creates a new document with indexing information.

      Currently the same as createSord but the type member of the returned indexing information (if any) is set to SordC.LBT_DOCUMENT.

      If maskId is null or empty, the function tries to assign the mask defined in the configuration options of the Windows CLIENT. If this mask cannot be found, the behavior is unpredictable and -1 might be returned in sord.mask.

      Parameters:
      ci - ClientInfo object with language, country and ticket
      parentId - ID or GUID of parent entry.
      maskId - ID or name of storage mask.
      docTemplate - CURRENTLY NOT SUPPORTED! must be null
      editInfoZ - Determines, which members of EditInfo to return. Reasonable predefined values are EditInfoC.mbSord or EditInfoC.mbSordDocAtt. Be aware of the performance effects of this parameter: avoid using EditInfoC.mbAll.
      Returns:
      Data to edit a new archive entry.
      Throws:
      byps.RemoteException - Exception with message text of format "[ELOIX:number] text". The number is one of the constants defined in IXExceptionC. Exception with message text of format "[ELOIX:number] text".
      See Also:

    • createDocMask

      DocMask createDocMask(ClientInfo ci, String maskId) throws byps.RemoteException
      Creates a storage mask object and assigns default values.

      This function does not insert the mask object into the database. Initial values can be copied from the mask specified with maskId.

      Parameters:
      ci - ClientInfo object with language, country and ticket
      maskId - Mask ID (DocMask.no) or name (DocMask.name) or null
      Returns:
      Storage mask object.
      Throws:
      byps.RemoteException - Exception with message text of format "[ELOIX:number] text". The number is one of the constants defined in IXExceptionC. Exception with message text of format "[ELOIX:number] text".
      See Also:

    • createKey

      @Deprecated KeyInfo createKey(ClientInfo ci) throws byps.RemoteException
      Deprecated.
      Creates and initializes a key object.
      Parameters:
      ci - ClientInfo object with language, country and ticket
      Returns:
      Key object
      Throws:
      byps.RemoteException - Exception with message text of format "[ELOIX:number] text". The number is one of the constants defined in IXExceptionC. Exception with message text of format "[ELOIX:number] text".
      See Also:

    • createNote

      Note createNote(ClientInfo ci, String objId) throws byps.RemoteException
      Returns an initialized, temporary Note object.
      Parameters:
      ci - ClientInfo object with language, country and ticket.
      objId - String ID or GUID of associated Sord.
      Returns:
      Note object
      Throws:
      byps.RemoteException - Exception with message text of format "[ELOIX:number] text". The number is one of the constants defined in IXExceptionC. Exception with message text of format "[ELOIX:number] text".

    • createNote2

      Note createNote2(ClientInfo ci, String objId, int noteType, String templId) throws byps.RemoteException
      Returns an initialized, temporary Note object.

      The object is initialized by the given note template. Placeholders are replaced by the current values.

      Parameters:
      ci - ClientInfo object with language, country and ticket.
      objId - String ID or GUID of associated Sord.
      noteType - Type of the node. Ignored, if parameter templId is set.
      templId - ID of a note template.
      Returns:
      Note object
      Throws:
      byps.RemoteException - Exception with message text of format "[ELOIX:number] text". The number is one of the constants defined in IXExceptionC. Exception with message text of format "[ELOIX:number] text".

    • createReminder

      Reminder createReminder(ClientInfo ci, String objId) throws byps.RemoteException
      Creates a reminder for the Sord specified by objId.
      Parameters:
      ci - ClientInfo object with language, country and ticket.
      objId - String ID or GUID of an existing Sord.
      Returns:
      Reminder Initialized Reminder object.
      Throws:
      byps.RemoteException - Exception with message text of format "[ELOIX:number] text". The number is one of the constants defined in IXExceptionC. Exception with message text of format "[ELOIX:number] text".

    • createSord

      EditInfo createSord(ClientInfo ci, String parentId, String maskId, EditInfoZ editInfoZ) throws byps.RemoteException
      Creates an object containing all the data needed to edit the indexing information of a new archive entry.

      The function does not insert the new object into the database. checkinSord is used to insert a new object in the database.

      This function can also be used to retrieve the lists of storage masks, markers (colours) etc. For this purpose parameter parentId=null must be set along with maskId=null and supply EditInfoC.mbBasicData for editInfoZ.

      To create and initialize an object for indexing information, parameter editInfoZ must include bit EditInfoZ.mbSordMembers, e. g. EditInfoZ.mbSord. Parameter parentId can specify the ID or GUID of the parent entry in the archive hierarchy. Access rights and replication information are initialized from the parent.

      The maskId parameter is the name or ID of a storage mask that defines a template for the indexing information. If maskId is null or empty, the function tries to assign the mask with GUID DocMaskC.GUID_FOLDER. If this mask cannot be found, the default folder mask defined in the configuration options of the Windows CLIENT is used. If this mask is also not found, the behavior is unpredictable and a -1 might be returned in sord.mask.

      The parameters parentId and maskId are unchecked if an event script IXServerEvents.onCreateSord(IXServerEventsContext, String, String, EditInfoZ) is configured. In this case, both can have arbitrary values.

      Parameters:
      ci - ClientInfo object with language, country and ticket
      parentId - ID or GUID of parent entry.
      maskId - ID or name of a storage mask.
      editInfoZ - Determines, which members of EditInfo to return.
      Returns:
      Data to edit a new archive entry.
      Throws:
      byps.RemoteException - Exception with message text of format "[ELOIX:number] text". The number is one of the constants defined in IXExceptionC. Exception with message text of format "[ELOIX:number] text".
      See Also:

    • createUser

      UserInfo createUser(ClientInfo ci, String rightsAsUserId) throws byps.RemoteException
      Creates an object for user data.

      The returned UserInfo object is initialized with default values. User rights and keys are copied from the user rightsAsUserId.

      This function does not create a new user in the archive database. To insert a new user into the database the function checkinUsers must be used after the user has been created withcreateUser.

      If the user calling this function is a main administrator (has right AccessC.FLAG_ADMIN), the created user will have the same UserInfo.parent as the user specified in rightsAsUserId. If the user calling this function is a sub-administrator (has right AccessC.FLAG_SUBADMIN), the parent of the created user is the id of the calling user.

      Parameters:
      ci - ClientInfo object with language, country and ticket
      rightsAsUserId - User ID or name of an user. The initial rights are copied from this user.
      Returns:
      user data
      Throws:
      byps.RemoteException - Exception with message text of format "[ELOIX:number] text". The number is one of the constants defined in IXExceptionC. Exception with message text of format "[ELOIX:number] text".
      See Also:

    • createWFNode

      WFNode createWFNode(ClientInfo ci, int nodeId, int nodeTypeC) throws byps.RemoteException
      Initalizes a WFNode object.

      WFNode.userId is set to WFNodeC.USERID_OWNER if the supplied type is a person node.

      Parameters:
      ci - ClientInfo object with language, country and ticket.
      nodeId - int ID to be assigned to the new node.
      nodeTypeC - int One of the WFNodeC.TYPE_* constants.
      Returns:
      Note
      Throws:
      byps.RemoteException - Exception with message text of format "[ELOIX:number] text". The number is one of the constants defined in IXExceptionC. Exception with message text of format "[ELOIX:number] text".
      See Also:

    • createWorkFlow

      WFDiagram createWorkFlow(ClientInfo ci, String wfName, WFTypeZ typeZ) throws byps.RemoteException
      Prepares a WFDiagram structure.
      Parameters:
      ci - ClientInfo object with language, country and ticket
      wfName - Workflow name
      typeZ - WFTypeZ Workflow type, must be WFTypeC.TEMPLATE or WFTypeC.ACTIVE
      Returns:
      WFDiagram
      Throws:
      byps.RemoteException - Exception with message text of format "[ELOIX:number] text". The number is one of the constants defined in IXExceptionC. Exception with message text of format "[ELOIX:number] text".

    • deleteConfigFiles

      void deleteConfigFiles(ClientInfo ci, String[] names, LockZ unlockZ) throws byps.RemoteException
      Deletes configuration files.
      Parameters:
      ci - ClientInfo object with language, country and ticket
      names - Configuration file names (incl. directory)
      unlockZ - reserved
      Throws:
      byps.RemoteException - Exception with message text of format "[ELOIX:number] text". The number is one of the constants defined in IXExceptionC.

    • deleteCounters

      void deleteCounters(ClientInfo ci, String[] counterNames, LockZ unlockZ) throws byps.RemoteException
      Delete counters.

      This function is currently not implemented and always throws an exception. Counters cannot be deleted.

      Parameters:
      ci - ClientInfo object with language, country and ticket.
      counterNames - Array of counter names to be deleted.
      unlockZ - Removes a lock previously set by checkoutCounters.
      Throws:
      byps.RemoteException - Exception with message text of format "[ELOIX:number] text". The number is one of the constants defined in IXExceptionC.

    • deleteDocMask

      boolean deleteDocMask(ClientInfo ci, String maskId, String assignMaskId, LockZ unlockZ) throws byps.RemoteException
      Deletes a storage mask.

      If archive entries connected to the mask still exist in the database, another mask assignMaskId can be assigned to them.

      If assignMaskId is not defined and there are objects connected to the mask in the database the method throws an exception.

      Parameters:
      ci - ClientInfo object with language, country and ticket
      maskId - Mask ID (DocMask.no) or name (DocMask.name) of the mask to delete.
      assignMaskId - Mask ID (DocMask.no) or name (DocMask.name) of the mask to assign.
      unlockZ - Unlock masks.
      Returns:
      If mask not found the return value is false.
      Throws:
      byps.RemoteException - Exception with message text of format "[ELOIX:number] text". The number is one of the constants defined in IXExceptionC.
      See Also:

    • deleteKeys

      @Deprecated void deleteKeys(ClientInfo ci, String[] ids, LockZ unlockZ) throws byps.RemoteException
      Deprecated.
      Deletes keys.

      Since the function requires an exclusive access to the user data, the data must be locked for the current user or must not be locked for anyone. To check in regardless of a lock supply lockZ.FORCE in lockZ.

      Parameters:
      ci - ClientInfo object with language, country and ticket
      ids - Array of key IDs or names or null to read all keys.
      unlockZ - Unlock key data or force access.
      Throws:
      byps.RemoteException - Exception with message text of format "[ELOIX:number] text". The number is one of the constants defined in IXExceptionC.
      See Also:

    • deleteKeywords

      void deleteKeywords(ClientInfo ci, String[] kwids, LockZ unlockZ) throws byps.RemoteException
      Deletes the keywords with the given IDs.

      IMPORTANT: This function assigns new IDs to all branches of the keyword trees below the parent keywords of the given IDs. The client program should read the parent keyword and all children below again to receive the new IDs.

      The access rights AccessC.FLAG_EDITCONFIG and AccessC.FLAG_EDITSWL are required to delete keywords.

      Parameters:
      ci - ClientInfo object with language, country and ticket
      kwids - String[] Array of keyword IDs.
      unlockZ - Remove lock.
      Throws:
      byps.RemoteException - Exception with message text of format "[ELOIX:number] text". The number is one of the constants defined in IXExceptionC.

    • deleteNotes

      void deleteNotes(ClientInfo ci, String[] noteIds, LockZ unlockZ) throws byps.RemoteException
      Deletes notes.

      After a note or annotation has been deleted it should not be checked in again with MbAll. In this case the isDeleted() value is overwritten and the note or annotation will no longer be deleted. In this case MbOnlyLock should be used to remove the lock on the notes.

      Parameters:
      ci - ClientInfo object with language, country and ticket.
      noteIds - String[] GUIDs of notes to delete.
      unlockZ - Removes a lock.createso
      Throws:
      byps.RemoteException
      See Also:

    • deleteNotification

      int deleteNotification(ClientInfo ci, String objGuid, String userGuid) throws byps.RemoteException
      Deleting the Notification identified by objGuid / userGuid combination if the Notification has child Notifications, they will be deleted as well.
      Parameters:
      ci - ClientInfo object with language, country and ticket.
      objGuid - String
      userGuid - String Guid or ID or Name of the User to which the Notification belongs
      Returns:
      int number of deleted Notifications
      Throws:
      byps.RemoteException - Exception with message text of format "[ELOIX:number] text". The number is one of the constants defined in IXExceptionC.
      Since:
      9.00.022.003

    • deleteReminders

      void deleteReminders(ClientInfo ci, int[] reminderIds, LockZ unlockZ) throws byps.RemoteException
      Deletes the reminders (logically) with the the given IDs.
      Parameters:
      ci - ClientInfo object with language, country and ticket.
      reminderIds - String[]
      unlockZ - Removes a lock.
      Throws:
      byps.RemoteException - Exception with message text of format "[ELOIX:number] text". The number is one of the constants defined in IXExceptionC.

    • deleteReport

      void deleteReport(ClientInfo ci, String endDateISO) throws byps.RemoteException
      Deletes report entries until endDateISO.
      Parameters:
      ci - ClientInfo object with language, country and ticket
      endDateISO - Delete entries until this date based on the local time zone of the country specified in ci.
      Throws:
      byps.RemoteException - Exception with message text of format "[ELOIX:number] text". The number is one of the constants defined in IXExceptionC.

    • deleteSord

      boolean deleteSord(ClientInfo ci, String parentId, String objId, LockZ unlockZ, DeleteOptions deleteOptions) throws byps.RemoteException
      Deletes an archive entry and all child entries or deletes a relation (logical copy).

      A reference is deleted if parentId specifies an entry which is not the main parent of objId. The main parent can be found in Sord.parent after reading the indexing information for objId using checkoutSord. References are never deleted physically.

      A archive entry is deleted if parentId is set to null or the id of its main parent.

      If deleteFinally=true, all already logically deleted objects in the subtree of objId will be deleted physically. All related data (document versions, attachments, workflows, etc.) will also be physically deleted. Use this parameter with caution, since a reverse operation does not exist.

      To delete logically set deleteFinally=false, which only sets the the delete flag within the database.

      Parameters:
      ci - ClientInfo object with language, country and ticket
      parentId - ID or GUID of the parent entry in the archive hierarchy. May be null.
      objId - Object-ID or -GUID of the entry to delete.
      unlockZ - Unlock archive entry.
      deleteOptions - e. g. delete finally, delete until a given date. If null, the object will be delete logically.
      Returns:
      true, when all traversed SORDs have been deleted successfully.
      false, when at least one removal failed
      Throws:
      byps.RemoteException - Exception with message text of format "[ELOIX:number] text". The number is one of the constants defined in IXExceptionC.
      See Also:

    • deleteSordTypes

      void deleteSordTypes(ClientInfo ci, int[] sordTypeIds, LockZ unlockZ) throws byps.RemoteException
      Delete sord type information.
      Parameters:
      ci - ClientInfo object with language, country and ticket.
      sordTypeIds - Array of type IDs to delete.
      unlockZ - Removes a lock previously set by checkoutSordTypes.
      Throws:
      byps.RemoteException - Exception with message text of format "[ELOIX:number] text". The number is one of the constants defined in IXExceptionC.

    • deleteSubs

      @Deprecated void deleteSubs(ClientInfo ci, SubsInfo[] deps, LockZ unlockZ) throws byps.RemoteException
      Deprecated.
      Replaced by deleteSubstitutions(ClientInfo, DeleteSubstitutionsInfo, LockZ)
      Delete deputy information.
      Parameters:
      ci - ClientInfo
      deps - SubsInfo[]
      unlockZ - Unlock user data
      Throws:
      byps.RemoteException - Exception with message text of format "[ELOIX:number] text". The number is one of the constants defined in IXExceptionC.

    • deleteUserProfile

      void deleteUserProfile(ClientInfo ci, UserProfile userProfile, LockZ unlockZ) throws byps.RemoteException
      Deletes profile options.
      Parameters:
      ci - ClientInfo object with language, country and ticket
      userProfile - Options of a specific user or default options for all users. If the userProfile.options array is null, all options are deleted. Otherwise the keys in the option array select the options to return. A key might contain the wildcard "*". It is a placeholder for 0, 1 or many arbitrary characters.
      unlockZ - Remove lock - locking is currently not supported but may be added in future.
      Throws:
      byps.RemoteException - Exception with message text of format "[ELOIX:number] text". The number is one of the constants defined in IXExceptionC.

    • deleteUsers

      void deleteUsers(ClientInfo ci, String[] ids, LockZ unlockZ) throws byps.RemoteException
      Deletes users or groups.

      Since this function requires exclusive access to the user data, the data must be locked for the current user or must not be locked for anyone. To check in regardless of a lock lockZ.FORCE in lockZ must be supplied.

      If more than 100 users are passed to this function, a background task is started to avoid a timeout error. The task status can be queried by collectJobStates(ClientInfo, boolean, boolean, boolean). and queryJobState(ClientInfo, String, boolean, boolean, boolean).

      Parameters:
      ci - ClientInfo object with language, country and ticket
      ids - User or group IDs or names.
      unlockZ - Unlock user data or force access.
      Throws:
      byps.RemoteException - Exception with message text of format "[ELOIX:number] text". The number is one of the constants defined in IXExceptionC.
      See Also:

    • deleteUser

      void deleteUser(ClientInfo ci, String id, LockZ unlockZ) throws byps.RemoteException
      Deletes user or group.
      Parameters:
      ci - ClientInfo object with language, country and ticket
      id - User or group ID, GUID or name.
      unlockZ - Unlock user data or force access.
      Throws:
      byps.RemoteException - Exception with message text of format "[ELOIX:number] text". The number is one of the constants defined in IXExceptionC.
      Since:
      11.00.000.005

    • deleteWorkFlow

      void deleteWorkFlow(ClientInfo ci, String flowId, WFTypeZ typeZ, LockZ unlockZ) throws byps.RemoteException
      Deletes a workflow.

      WOrkflows that are deleted are not physically deleted and can be retrieved using checkoutWorkFlow(). Deleted workflows return true when the WFDiagram.isDeleted() method is called.

      Parameters:
      ci - ClientInfo object with language, country and ticket
      flowId - Workflow name or ID
      typeZ - Workflow type: active flow, finished flow, template.
      unlockZ - Remove lock
      Throws:
      byps.RemoteException - Exception with message text of format "[ELOIX:number] text". The number is one of the constants defined in IXExceptionC.

    • endEditWorkFlowNode

      @Deprecated void endEditWorkFlowNode(ClientInfo ci, int nFlowId, int nNodeId, boolean bTerminate, boolean bCancel, String sName, String sComment, int[] arrEnterNodesIds) throws byps.RemoteException
      Deprecated.
      Use forwardWorkflowNode(ClientInfo, int, int, ForwardWorkflowNodeInfo, LockZ)
      Stores an edited person node of an active workflow into the database and unlocks the workflow.

      The workflow is forwarded to the successor nodes as passed in parameter arrEnterNodesIds.

      Parameters:
      ci - ClientInfo object with language, country and ticket.
      nFlowId - Workflow ID.
      nNodeId - Workflow node ID.
      bTerminate - If true, the workflow will be terminated.
      bCancel - If true, no data is stored. The nodes will be unlocked.
      sName - New node name to store.
      sComment - New node comment to store.
      arrEnterNodesIds - The nodes to activate next.
      Throws:
      byps.RemoteException - Exception with message text of format "[ELOIX:number] text". The number is one of the constants defined in IXExceptionC.

    • findClose

      void findClose(ClientInfo ci, String searchId) throws byps.RemoteException
      Deletes the search results explicitly in the Indexserver process to save memory.
      Parameters:
      ci - ClientInfo object with language, country and ticket
      searchId - Search ID returned from findFirstSords
      Throws:
      byps.RemoteException - Exception with message text of format "[ELOIX:number] text". The number is one of the constants defined in IXExceptionC.

    • findFirstConfigFiles

      FindResult findFirstConfigFiles(ClientInfo ci, FindConfigFileInfo findInfo, int max, ConfigFileZ configFileZ) throws byps.RemoteException
      Finds configuration or postbox files.
      Parameters:
      ci - ClientInfo object with language, country and ticket
      findInfo - Find object.
      max - Maximum number of objects to be returned from this call.
      configFileZ - Members to return. ConfigFile.mbFileData is ignored.
      Returns:
      FindResult object
      Throws:
      byps.RemoteException - Exception with message text of format "[ELOIX:number] text". The number is one of the constants defined in IXExceptionC.
      See Also:

    • findFirstReportInfos

      FindResult findFirstReportInfos(ClientInfo ci, FindReportInfo opts, int max) throws byps.RemoteException
      Finds report entries.
      Parameters:
      ci - ClientInfo object with language, country and ticket
      opts - Selection criteria for report entries
      max - Maximum number of entries to be returned. This is internally limited to 1000.
      Returns:
      Array of report entries
      Throws:
      byps.RemoteException - Exception with message text of format "[ELOIX:number] text". The number is one of the constants defined in IXExceptionC.

    • findFirstSords

      FindResult findFirstSords(ClientInfo ci, FindInfo findInfo, int max, SordZ sordZ) throws byps.RemoteException
      Find archive entries and retrieve the first max objects.

      This function performs a search over indexing information, full text, or hierarchy (child lists).

      It returns either an ID array or a Sord object array. The maximum array length is restricted to the value of the max parameter. Further results can be read with findNextSords using the search ID FindResult.searchId returned by this function. The search ID has a limited lifetime which can be configured. The default value is 5 minutes. The search results can be explicitly deleted with findClose to save memory on the server side.

      This function does not write report entries ReportInfoC.ACT_IX_CHECKOUT_SORD for the results although it can return as much indexing information as checkoutSord does.

      Parameters:
      ci - ClientInfo object with language, country and ticket
      findInfo - Object contains search criteria.
      max - Maximum number of result objects to return. The value is internally limited to 1000.
      sordZ - Members to read into the returned Sord object Array. If this bit set only contains either SordC.mbId or SordC.mbGuid the returned FindResult contains an ID array FindResult.ids instead of a Sord object array.
      Returns:
      Search result.
      Throws:
      byps.RemoteException - Exception with message text of format "[ELOIX:number] text". The number is one of the constants defined in IXExceptionC.
      See Also:

    • findFirstTasks

      FindResult findFirstTasks(ClientInfo ci, FindTasksInfo findInfo, int max) throws byps.RemoteException
      Finds reminders, activities and active workflow nodes.
      Parameters:
      ci - ClientInfo object with language, country and ticket.
      findInfo - FindTasksInfo
      max - int
      Returns:
      FindResult
      Throws:
      byps.RemoteException - Exception with message text of format "[ELOIX:number] text". The number is one of the constants defined in IXExceptionC.
      See Also:

    • findNextConfigFiles

      FindResult findNextConfigFiles(ClientInfo ci, String searchId, int idx, int max, ConfigFileZ configFileZ) throws byps.RemoteException
      Finds next configuration files.
      Parameters:
      ci - ClientInfo object with language, country and ticket
      searchId - Search-ID returned from a previous call to findFirstConfigFiles.
      idx - In the list of found files, return files starting from this index.
      max - Return at most max file objects.
      configFileZ - Members to return. ConfigFile.mbFileData is ignored.
      Returns:
      FindResult
      Throws:
      byps.RemoteException - Exception with message text of format "[ELOIX:number] text". The number is one of the constants defined in IXExceptionC.

    • findNextReportInfos

      FindResult findNextReportInfos(ClientInfo ci, String searchId, int idx, int max) throws byps.RemoteException
      Finds report entries.
      Parameters:
      ci - ClientInfo object with language, country and ticket
      searchId - Search ID returned from findFirstReportInfos
      idx - Start index of results
      max - Maximum number of results
      Returns:
      Array of report entries
      Throws:
      byps.RemoteException - Exception with message text of format "[ELOIX:number] text". The number is one of the constants defined in IXExceptionC.

    • findNextSords

      FindResult findNextSords(ClientInfo ci, String searchId, int idx, int max, SordZ sordZ) throws byps.RemoteException
      Retrieves further results of a previous search with findFirstSords.
      Parameters:
      ci - ClientInfo object with language, country and ticket
      searchId - Search ID returned from findFirstSords
      idx - Start index at which result objects are returned.
      max - Maximum number of result objects to return. The value is internally limited to 1000.
      sordZ - Members to read into the returned Sord object Array. If this bit set only contains either SordC.mbId or SordC.mbGuid the returned FindResult object contains an ID array FindResult.ids instead of a Sord object array.
      Returns:
      Search result.
      Throws:
      byps.RemoteException - Exception with message text of format "[ELOIX:number] text". The number is one of the constants defined in IXExceptionC.
      See Also:

    • findNextTasks

      FindResult findNextTasks(ClientInfo ci, String searchId, int idx, int max) throws byps.RemoteException
      Continues the find process started with findFirstTasks.
      Parameters:
      ci - ClientInfo object with language, country and ticket.
      searchId - String
      idx - int
      max - int
      Returns:
      FindResult
      Throws:
      byps.RemoteException - Exception with message text of format "[ELOIX:number] text". The number is one of the constants defined in IXExceptionC.
      See Also:

    • finishExport

      void finishExport(ClientInfo ci, String exportId) throws byps.RemoteException
      Removes temp-files after an export.

      This method should be called, after the generated ZIP-archive has been successfully downloaded.

      Parameters:
      ci - ClientInfo object with language, country and ticket.
      exportId - String the exportId (GUID) of the export.
      Throws:
      byps.RemoteException - Exception with message text of format "[ELOIX:number] text". The number is one of the constants defined in IXExceptionC.

    • getConstants

      IXServicePortC getConstants(ClientInfo ci) throws byps.RemoteException
      Retrieves the constants.

      Constants are provided as objects to provide the advantage of type checking. (Java 1.4 does not support enumeration types).

      Parameters:
      ci - ClientInfo object with language, country and ticket
      Returns:
      Constant objects.
      Throws:
      byps.RemoteException - Exception with message text of format "[ELOIX:number] text". The number is one of the constants defined in IXExceptionC.

    • getExportZipUrl

      String getExportZipUrl(ClientInfo ci, String exportId) throws byps.RemoteException
      Gets the URL for downloading the generated ZIP-archive of this export.
      Parameters:
      ci - ClientInfo object with language, country and ticket.
      exportId - String the exportId (GUID) of the export.
      Returns:
      String with the URL
      Throws:
      byps.RemoteException - Exception with message text of format "[ELOIX:number] text". The number is one of the constants defined in IXExceptionC.

    • getImportZipUrl

      String getImportZipUrl(ClientInfo ci, String importId) throws byps.RemoteException
      Retrieves the URL for uploading the ZIP-archive for this import.
      Parameters:
      ci - ClientInfo object with language, country and ticket.
      importId - String the importId (GUID) of the import.
      Returns:
      String the URL
      Throws:
      byps.RemoteException - Exception with message text of format "[ELOIX:number] text". The number is one of the constants defined in IXExceptionC.

    • getServerInfo

      ServerInfo getServerInfo(ClientInfo ci) throws byps.RemoteException
      Retrieves configurational information, e.g. license key, additional Indexservers, etc. In order to update the current license information call configureLicense(ClientInfo, String).
      Parameters:
      ci - ClientInfo object with language, country and ticket
      Returns:
      Indexserver configuration.
      Throws:
      byps.RemoteException - Exception with message text of format "[ELOIX:number] text". The number is one of the constants defined in IXExceptionC.

    • setServerInfo

      void setServerInfo(ClientInfo ci, ServerInfo serverInfo) throws byps.RemoteException
      Sets the writable members of ServerInfo.
      Parameters:
      ci - ClientInfo object with language, country and ticket
      serverInfo - ServerInfo object.
      Throws:
      byps.RemoteException - Exception with message text of format "[ELOIX:number] text". The number is one of the constants defined in IXExceptionC.

    • getServerInfoDM

      ServerInfoDM getServerInfoDM(ClientInfo ci) throws byps.RemoteException
      Gets DM configuration information.
      Parameters:
      ci - ClientInfo object with language, country and ticket
      Returns:
      DM configuration
      Throws:
      byps.RemoteException - Exception with message text of format "[ELOIX:number] text". The number is one of the constants defined in IXExceptionC.
      Since:
      7.00.040.025
      See Also:

    • setServerInfoDM

      void setServerInfoDM(ClientInfo ci, ServerInfoDM serverInfo) throws byps.RemoteException
      Sets the writable members of the DM configuration.
      Parameters:
      ci - ClientInfo object with language, country and ticket
      serverInfo - DM configuration
      Throws:
      byps.RemoteException - Exception with message text of format "[ELOIX:number] text". The number is one of the constants defined in IXExceptionC.
      Since:
      7.00.040.025
      See Also:

    • getSessionOptions

      SessionOptions getSessionOptions(ClientInfo ci) throws byps.RemoteException
      Retrieve the current session options.
      Parameters:
      ci - ClientInfo
      Returns:
      SessionOptions
      Throws:
      byps.RemoteException - Exception with message text of format "[ELOIX:number] text". The number is one of the constants defined in IXExceptionC.

    • getUserNames

      UserName[] getUserNames(ClientInfo ci, String[] ids, CheckoutUsersZ checkoutUsersZ) throws byps.RemoteException
      Reads user or group names and IDs.

      The method performs an internal call to checkoutUsers. Note: Only the names and IDs are returned and not the complete user data.

      If the current user is assigned to organisation units, the function returns only users and groups assigned to at least one of the users organisation units.

      Parameters:
      ci - ClientInfo object with language, country and ticket
      ids - User or group IDs or names.
      checkoutUsersZ - See checkoutUsers.
      Returns:
      Array of Names and IDs
      Throws:
      byps.RemoteException - Exception with message text of format "[ELOIX:number] text". The number is one of the constants defined in IXExceptionC.
      See Also:

    • importWorkFlow

      int importWorkFlow(ClientInfo ci, String flowName, byte[] fileData) throws byps.RemoteException
      Imports a workflow template from a file.

      To export a workflow template into a file, use the workflow design dialogue in ELO-CLIENT.

      Parameters:
      ci - ClientInfo object with language, country and ticket
      flowName - Workflow name
      fileData - File content
      Returns:
      Workflow ID
      Throws:
      byps.RemoteException - Exception with message text of format "[ELOIX:number] text". The number is one of the constants defined in IXExceptionC.

    • importWorkFlow2

      int importWorkFlow2(ClientInfo ci, String flowName, byte[] fileData, WorkflowImportOptions importOptions) throws byps.RemoteException
      Imports a workflow template from a file.

      To export a workflow template into a file, use the workflow design dialogue in ELO-CLIENT.

      Parameters:
      ci - ClientInfo object with language, country and ticket
      flowName - Workflow name
      fileData - File content
      importOptions - Import options.
      Returns:
      Workflow ID
      Throws:
      byps.RemoteException - Exception with message text of format "[ELOIX:number] text". The number is one of the constants defined in IXExceptionC.
      Since:
      9.00.016.017

    • linkSords

      void linkSords(ClientInfo ci, String fromId, String[] toIds, LinkSordZ linkZ) throws byps.RemoteException
      Links archive entries.

      Links are associations between archive entries and are independent from the archive hierarchy.

      The links to or from an archive entry are listed in Sord.linksGoOut and Sord.linksComeIn. In the database structure and in the Indexserver API, links are vectors that point from one Sord to one or more other Sords. But the client applications usually do not take care of the direction. They add the links found in Sord.linksGoOut and Sord.linksComeIn in order to show the liked objects.

      There are two different types of links: pairs and cross-links. A pair connects exactly two Sord objects. Each pair has its own link-ID in the database. A cross-link connects a group of objects under the same link-ID. At the first glance it seems, that each object has a pair-link to each other object. But there is a significant difference when deleting links. E.g. if the Sord objects sord1, sord2, sord3 are connected with a cross-link, function checkoutSord will return for sord1: {sord2, sord3}, sord2: {sord1, sord3} and sord3: {sord1, sord2}. If function unlinkSords is called for the link sord1-sord2 (fromSord=sord1, toSords=[sord2]), the next calls to checkoutSord will return for sord1: {sord3}, sord2: {}, sord3: {sord1}. If the objects were connected by pair-links, the result would be sord1: {sord3}, sord2: {sord3}, sord3: {sord1, sord2}.

      Parameters:
      ci - ClientInfo object with language, country and ticket
      fromId - Object ID or GUID the links start from.
      toIds - Object IDs or GUIDs the links point to.
      linkZ - Controls how the objects are connected. If null or LinkSordC.PAIR, the function builds pairs of linked objects from fromId to toIds[.]. E.g. {fromId, toIds[0]}, {fromId, toIds[1]}. If LinkSordC.CROSS_LINK is passed, the function builds a cross-link with the associations: {fromId, toIds[0]}, { fromId, toIds[1] }, {toIds[0], toIds[1]}.
      Throws:
      byps.RemoteException - Exception with message text of format "[ELOIX:number] text". The number is one of the constants defined in IXExceptionC.
      See Also:

    • lockArchive

      int lockArchive(ClientInfo ci, String groupId) throws byps.RemoteException
      Locks the archive for users or retrieves the lock on the archive. The behavior of this function has changed with ELO11 since the security concept of keys is no more supported. In order to prevent particular users from using the archive, constrain the usage to members of a group. If all users should be able to login, pass UserInfoC.UNLOCK_ARCHIVE.
      Parameters:
      ci - ClientInfo object with language, country and ticket
      groupId - Group ID, GUID or name. Members of this group are allowed to login. If empty, return the current lock. If set as UserInfoC.UNLOCK_ARCHIVE, all users are allowed to access the archive.
      Returns:
      Previous lock. All users can login, if UserInfoC.ID_EVERYONE_GROUP is returned.
      Throws:
      byps.RemoteException - Exception with message text of format "[ELOIX:number] text". The number is one of the constants defined in IXExceptionC.

    • login

      LoginResult login(ClientInfo ci, String userName, String userPwd, String clientComputer, String runAsUser) throws byps.RemoteException
      Log on to Indexserver.

      If the function succeeds, the return value is an object containing a ticket that allows access to all the other interface functions.

      This ticket has a limited lifetime as returned in LoginResult.ticketDuration. The life time can be extended by calling alive.

      The runAsUser parameter is used in Single-Sign-On environments. The login is performed for every user with the same SSO account specific to the application and the runAsUser parameter specifies the security context for the Indexserver connection. The SSO account must have administrator privileges.

      Parameters:
      ci - ClientInfo object with language, country and ticket
      userName - user name
      userPwd - password
      clientComputer - client computer name for reporting
      runAsUser - if not null, use the security context of this user instead of the user specified in userName
      Returns:
      login information. Never null - if log-on fails, an exception is thrown.
      Throws:
      byps.RemoteException - Exception with message text of format "[ELOIX:number] text". The number is one of the constants defined in IXExceptionC. if user name and password is not a valid account, the message starts with "[ELOIX:3002]".
      See Also:

    • loginAdmin

      LoginResult loginAdmin(ClientInfo ci, String userName, String userPwd, String clientComputer, String reportAsUser) throws byps.RemoteException
      Login any user as an administrator.

      This function logs on the user given in reportAsUser as an administrator. The effective rights of the resulting session are not constrained to the rights of the given user. The client application is responsible for access checking.

      Parameters:
      ci - ClientInfo object with language, country and ticket
      userName - user name, must have FLAG_ADMIN and FLAG_IGNOREACL rights.
      userPwd - password
      clientComputer - client computer name for reporting
      reportAsUser - if not null, this user is used as owner of created objects. In contrast to login(), the security context is not constrained to the users rights. It is set to the rights of the account given by userName. Thus the resulting session works with the rights of userName but under the name and group associations of reportAsUser.
      Returns:
      login information. Never null - if log-on fails, an exception is thrown.
      Throws:
      byps.RemoteException - Exception with message text of format "[ELOIX:number] text". The number is one of the constants defined in IXExceptionC.
      See Also:

    • loginEloProf

      LoginResult loginEloProf(ClientInfo ci, int userId, String certificate, String clientComputer) throws byps.RemoteException
      This login is used by ELOprofessional applications if the Indexserver is used to forward workflows (WorkflowServer).

      This login returns a limited connection to the Indexserver. It is not possible to access documents or user data.

      Parameters:
      ci - ClientInfo object with language, country and ticket
      userId - User ID
      certificate - This string is checked against the wf-certificate parameter in web.xml for authentication.
      clientComputer - client computer name for reporting
      Returns:
      login information. Never null - if log-on fails, an exception is thrown.
      Throws:
      byps.RemoteException - Exception with message text of format "[ELOIX:number] text". The number is one of the constants defined in IXExceptionC.

    • loginKerberos

      @Deprecated LoginResult loginKerberos(ClientInfo ci, byte[] ticket, String clientComputer) throws byps.RemoteException
      Deprecated.
      This function is no more supported in ELO 12.
      Login using Kerberos ticket.
      Parameters:
      ci - ClientInfo object with language, country and ticket
      ticket - The KRB_AP_REQ Message as defined in RFC 1510
      clientComputer - client computer name for reporting
      Returns:
      This function does always throw Exception "[EIX:9999]...unsupported function".
      Throws:
      byps.RemoteException - Exception with message text of format "[ELOIX:number] text". The number is one of the constants defined in IXExceptionC.

    • logout

      void logout(ClientInfo ci) throws byps.RemoteException
      Log out user.

      The ticket contained in ci becomes invalid.

      Parameters:
      ci - ClientInfo object with language, country and ticket
      Throws:
      byps.RemoteException - Exception with message text of format "[ELOIX:number] text". The number is one of the constants defined in IXExceptionC. does never throw an exception
      See Also:

    • parseException

      IXExceptionData parseException(ClientInfo ci, String exceptionString) throws byps.RemoteException
      Parses the given string of an exception into a structured IXExceptionData object.

      If the given string does not represent an IXException, the exceptionType NOT_IX is returned (value -1) and the given exception string can be found in "message".

      Parameters:
      ci - ClientInfo object with language, country and ticket.
      exceptionString - String the exception as a string.
      Returns:
      parsed Exception Data.
      Throws:
      byps.RemoteException

    • processFindResult

      JobState processFindResult(ClientInfo ci, String searchId, ProcessInfo procInfo) throws byps.RemoteException
      Executes the processing information given by processInfo for all objects found by a findFirstSords call.
      Parameters:
      ci - ClientInfo object with language, country and ticket
      searchId - Search ID returned in FindResult.searchId from a previous call to findFirstSords
      procInfo - holds the specific operations applied to each traversed tree node; the first member not null will be used
      Returns:
      The current job state
      Throws:
      byps.RemoteException - Exception with message text of format "[ELOIX:number] text". The number is one of the constants defined in IXExceptionC.
      See Also:

    • processTrees

      JobState processTrees(ClientInfo ci, NavigationInfo navigationInfo, ProcessInfo procInfo) throws byps.RemoteException
      processTrees extends ValueClass implements a generic tree walk for all subtrees specified in navInfo.

      Specific operations for each node are queued in procInfo and will be applied in order of appearance.

      Parameters:
      ci - ClientInfo object with language, country and ticket
      navigationInfo - specifies limits to scale the tree traversals
      procInfo - holds the specific operations applied to each traversed tree node; the first member not null will be used
      Returns:
      The current job state or null, if the process is finished before the function returns.
      Throws:
      byps.RemoteException - Exception with message text of format "[ELOIX:number] text". The number is one of the constants defined in IXExceptionC.

    • queryJobState

      JobState queryJobState(ClientInfo ci, String jobGuid, boolean activeJobs, boolean finishedJobs, boolean fullInfo) throws byps.RemoteException
      Returns the job state for a given job GUID.
      Parameters:
      ci - ClientInfo object with language, country and ticket
      jobGuid -
      activeJobs - Currently running jobs will be searched for jobGuid
      finishedJobs - Finished jobs will be searched for jobGuid
      fullInfo - Requests the full job state information, if the job supports the member procInfo
      Returns:
      list of current job states
      Throws:
      byps.RemoteException - Exception with message text of format "[ELOIX:number] text". The number is one of the constants defined in IXExceptionC.

    • refSord

      void refSord(ClientInfo ci, String oldParentId, String newParentId, String objId, int manSortIdx) throws byps.RemoteException
      Creates a new object relationship.
      Parameters:
      ci - ClientInfo object with language, country and ticket
      oldParentId - ID or -GUID of the old parent entry in the archive hierarchy
      newParentId - ID or -GUID of the new parent entry in the archive hierarchy, must be valid.
      objId - ID or -GUID of the existing object, must be valid
      manSortIdx - The position where the object will be inserted/moved to in the parent hierarchy. Values at -1 or -2 inserts it at the last position (see throws description).

      Semantics: When oldParentId is null, a new logical reference is created. Otherwise the result depends on the object s main relation:
      If oldParentId is also the main relation, the object will be moved to its new location represented by newParentId. If oldParentId is representing a logical relation, this reference will be moved to the new location beneath newParentId. The object's main relation will remain untouched.

      Throws:
      byps.RemoteException - Exception with message text of format "[ELOIX:number] text". The number is one of the constants defined in IXExceptionC. If the relation to be created already exists and manSortIdx is -2, an IXExceptionC.ALREADY_EXISTS execption is thrown. If manSortIdx is > -2, the relation is moved to the position of manSortIdx.

    • restoreSord

      boolean restoreSord(ClientInfo ci, String objId, RestoreOptions restoreOptions) throws byps.RemoteException
      Restores an archive entry, its references and notes.

      Passing true for singleObject restores only the object represented by objId.
      Otherwise, the complete subtree beginning at objId will be restored.

      Parameters:
      ci - ClientInfo object with language, country and ticket
      objId - Object-ID or -GUID of the entry to restore.
      restoreOptions - further options to control the restore process.
      Returns:
      true, when all visited SORDs have been restored successfully.
      false, when at least one intended restore failed
      Throws:
      byps.RemoteException - Exception with message text of format "[ELOIX:number] text". The number is one of the constants defined in IXExceptionC.
      See Also:

    • setSessionOptions

      void setSessionOptions(ClientInfo ci, SessionOptions opts) throws byps.RemoteException
      This function sets options related to the session identified by the given ticket.
      Parameters:
      ci - ClientInfo object with language, country and ticket.
      opts - Session options to be set.
      Throws:
      byps.RemoteException - Exception with message text of format "[ELOIX:number] text". The number is one of the constants defined in IXExceptionC.

    • startAdHocWorkFlow

      int startAdHocWorkFlow(ClientInfo ci, String name, String objId, String[] arrUserIds, String nodeName, boolean forValidation, boolean serialFlow, String cancelUserId, String cancelMessage, String finishedUserId, String finishedMessage, String finishedScript) throws byps.RemoteException
      Starts an Ad Hoc Workflow.
      Parameters:
      ci - ClientInfo object with language, country and ticket.
      name - Workflow name
      objId - ID of the object for which the workflow is started.
      arrUserIds - IDs of users who receive the workflow nodes.
      nodeName - Start node name.
      forValidation - If true, the workflow comes back to the user who started it.
      serialFlow - If true, the workflow routes the object from user to user. The workflow finishes when the last user has edited their node. If serialFlow is false, the workflow routes the object to all users. The first user who edits their node terminates the workflow.
      cancelUserId - If the workflow is canceled, this user receives a message, cancelMessage.
      cancelMessage - The message that is send to the user specified with cancelUserId, if the workflow is canceled.
      finishedUserId - If the workflow is finished, this user receives a message, finishedMessage.
      finishedMessage - The message that is send to the user specified with cancelUserId, if the workflow is finished.
      finishedScript - This script is executed, when the workflow is finished.
      Returns:
      Workflow ID
      Throws:
      byps.RemoteException - Exception with message text of format "[ELOIX:number] text". The number is one of the constants defined in IXExceptionC.

    • startExport

      String startExport(ClientInfo ci, String[] topLevelIDs, long options) throws byps.RemoteException
      Starts an export-job.

      The given IDs and their children will be exported as specified in the options.

      Parameters:
      ci - ClientInfo object with language, country and ticket.
      topLevelIDs - String[] the IDs to export.
      options - long the options for this export coded as flags specified in ExportOptionsC.
      Returns:
      String the exportId (GUID) of the started export.
      Throws:
      byps.RemoteException - Exception with message text of format "[ELOIX:number] text". The number is one of the constants defined in IXExceptionC.
      See Also:

    • startExportExt

      String startExportExt(ClientInfo ci, ExportExtOptions options) throws byps.RemoteException
      Starts an export-job.

      This is an enhanced version which works with the same options as the ones in Windows Client

      Parameters:
      ci - ClientInfo object with language, country and ticket.
      options -
      Returns:
      String the exportId (GUID) of the started export.
      Throws:
      byps.RemoteException - Exception with message text of format "[ELOIX:number] text". The number is one of the constants defined in IXExceptionC.
      Since:
      8.00.030

    • startImport

      String startImport(ClientInfo ci, String filingPath, int guidMethod, long options) throws byps.RemoteException
      Starts an import-job.

      The given IDs and their children will be imported as specified in the options.

      Parameters:
      ci - ClientInfo object with language, country and ticket.
      filingPath - String the archive-path that should be used as target for the import.
      guidMethod - The method determining how to handle the assignement for guids.
      options - (long) The options for this import coded as flags specified in ImportOptionsC.
      Returns:
      String the importId (GUID) of the started export.
      Throws:
      byps.RemoteException - Exception with message text of format "[ELOIX:number] text". The number is one of the constants defined in IXExceptionC.

    • startWorkFlow

      int startWorkFlow(ClientInfo ci, String templFlowId, String flowName, String objId) throws byps.RemoteException
      Starts a workflow from a workflow template.
      Parameters:
      ci - ClientInfo object with language, country and ticket.
      templFlowId - Name or ID of the workflow template.
      flowName - Name of the new workflow.
      objId - ID of the object for which the workflow is started.
      Returns:
      workflow ID
      Throws:
      byps.RemoteException - Exception with message text of format "[ELOIX:number] text". The number is one of the constants defined in IXExceptionC.

    • takeWorkFlowNode

      void takeWorkFlowNode(ClientInfo ci, int nFlowId, int nNodeId, String sUserId, int nFlags, LockZ lockZ) throws byps.RemoteException
      Assign a node to a user.

      This function is useful in two situations:
      1. A user calls this function to assume a task for exclusive use. The task must be assigned to one of the user s groups or to a user substituted by the current user. Supply an empty sUserId.
      2. A user calls this function to pass the task to another user. The task must be assigned to the current user. Supply any user name or ID in sUserId.

      The function assigns in addition to the given node all nodes with the same WFNode.departmentGroup.
      Parameters:
      ci - ClientInfo object with language, country and ticket.
      nFlowId - Workflow ID.
      nNodeId - Workflow node ID.
      sUserId - ID or name of the user who receives the task. If null or empty, the task is assigned to the current user.
      nFlags - Combination of WFTakeNodeC values.
      lockZ - LockZ Specifies the lock mode used to access the workflow. Only administrators can use FORCE. The current lock is not changed.
      Throws:
      byps.RemoteException - Exception with message text of format "[ELOIX:number] text". The number is one of the constants defined in IXExceptionC.

    • terminateWorkFlow

      int terminateWorkFlow(ClientInfo ci, String flowId, LockZ unlockZ) throws byps.RemoteException
      Terminates a workflow.
      Parameters:
      ci - ClientInfo object with language, country and ticket.
      flowId - Workflow ID or name.
      unlockZ - Unlocks the nodes.
      Returns:
      int Workflow ID of finished workflow.
      Throws:
      byps.RemoteException - Exception with message text of format "[ELOIX:number] text". The number is one of the constants defined in IXExceptionC.

    • delegateWorkFlowNode

      void delegateWorkFlowNode(ClientInfo ci, WFDelegateNodeInfo delegateNodeInfo, LockZ lockZ) throws byps.RemoteException
      Delegates the specified workflow node to another user.

      An additional person node is inserted into the workflow for the given user and the workflow is forwarded to this node. If WFDelegateNodeInfo.backNodeName is set, a further node is added after the delegation node for the current user.

      Parameters:
      ci - ClientInfo object with language, country and ticket.
      delegateNodeInfo - Object describes the delegation node.
      lockZ - LockZ Specifies the lock mode used to access the workflow. Should be set to LockC.YES. Only administrators can use LockC.FORCE. The current lock is not changed.
      Throws:
      byps.RemoteException - Exception with message text of format "[ELOIX:number] text". The number is one of the constants defined in IXExceptionC.
      Since:
      7.00.000.032

    • deferWorkFlowNode

      void deferWorkFlowNode(ClientInfo ci, String flowId, int nodeId, String userDelayDateIso, LockZ lockZ) throws byps.RemoteException

      Sets the value userDelayDateIso of the given node.

      Parameters:
      ci - ClientInfo object with language, country and ticket.
      flowId - Workflow ID or name.
      nodeId - Node ID of a person node. The current user must be the owner of the node.
      userDelayDateIso - This date is set for Node.userDelayDateIso. Supply null or an empty string to delete the value.
      lockZ - LockZ Specifies the lock mode used to access the workflow. Only administrators can use FORCE. The current lock is not changed.
      Throws:
      byps.RemoteException - Exception with message text of format "[ELOIX:number] text". The number is one of the constants defined in IXExceptionC.
      Since:
      7.00.000.032
      See Also:

    • testAdapter

      String[] testAdapter(ClientInfo ci, String fn, String[] params) throws byps.RemoteException
      This function is used for testing.

      In productive environments it always throws an exception.

      Parameters:
      ci - ClientInfo
      fn - String
      params - String[]
      Returns:
      String[]
      Throws:
      byps.RemoteException

    • unlinkSords

      void unlinkSords(ClientInfo ci, String fromId, String[] toIds, LinkSordZ linkZ) throws byps.RemoteException
      Remove links between archive entries.
      Parameters:
      ci - ClientInfo object with language, country and ticket
      fromId - Object ID or GUID the links start from
      toIds - Object IDs or GUIDs the links point to
      linkZ - reserved, must be null
      Throws:
      byps.RemoteException - Exception with message text of format "[ELOIX:number] text". The number is one of the constants defined in IXExceptionC.
      See Also:

    • checkoutCryptInfos

      CryptInfo[] checkoutCryptInfos(ClientInfo ci, String[] ids, LockZ lockZ) throws byps.RemoteException
      Read and optionally lock the password information for document encryption.
      Parameters:
      ci - ClientInfo
      ids - An array of numeric IDs or names to identify the encryption information to be returned.
      lockZ - Lock mode.
      Returns:
      Array of encryption information objects.
      Throws:
      byps.RemoteException - Exception with message text of format "[ELOIX:number] text". The number is one of the constants defined in IXExceptionC.
      See Also:

    • checkinCryptInfos

      void checkinCryptInfos(ClientInfo ci, CryptInfo[] cryptInfos, LockZ unlockZ) throws byps.RemoteException
      Write and optionally unlock encryption information.

      The passwords supplied in cryptInfos must be encrypted with the IXClient.encryptPassword function.

      Administrators are allowed to alter internal keys and encryption set names.

      Usage of CryptInfo.keyInfo
      cryptInfos[.].keyInfo Description
      * Generate new internal keys and set cryptInfos[.].pwd as external password.
      Value from another ELO system Set this value as internal and external key pair. cryptInfos[.].pwd is ignored.
      Parameters:
      ci - ClientInfo
      cryptInfos - Array of encrytion objects to be written.
      unlockZ - Remove lock.
      Throws:
      byps.RemoteException - Exception with message text of format "[ELOIX:number] text". The number is one of the constants defined in IXExceptionC.
      See Also:

    • createNewEncryptionSet

      void createNewEncryptionSet(ClientInfo ci, CryptInfo cryptInfo, LockZ unlockZ) throws byps.RemoteException
      ToBeFilled
      Parameters:
      ci - ClientInfo
      cryptInfo - encryption object to be written.
      unlockZ - Remove lock.
      Throws:
      byps.RemoteException - Exception with message text of format "[ELOIX:number] text". The number is one of the constants defined in IXExceptionC.
      Since:
      12.00.000.028

    • provideCryptPassword

      void provideCryptPassword(ClientInfo ci, String encryptionSet, String pwd) throws byps.RemoteException
      Provide a password to be used in the current session for encrypting and decrypting of documents.

      The given password must be encrypted with the IXClient.encryptPassword function to hide it from administrators. An unencrypted password will cause an exception.

      To use the encryption/decryption functionality of Indexserver, the session option <ix.encryptDocuments> resp. <ix.decryptDocuments> has to be <true>. Then, Indexserver generates special URLs that cause it to encrypt documents on upload and decrypt documents on download.

      Be aware of the fact that encryption/decryption happens between Indexserver and Document Manager communication and not between Indexserver and the client application. Thus it is strongly recommended to use HTTPS between the client application and Indexserver. The Indexserver configuration option "ixUrlBase" can be helpful to achieve this.
      Parameters:
      ci - ClientInfo
      encryptionSet - Encryption set ID or name.
      pwd - Encrypted password.
      Throws:
      byps.RemoteException - Exception with message text of format "[ELOIX:number] text". The number is one of the constants defined in IXExceptionC.
      See Also:

    • provideSystemCryptPassword

      void provideSystemCryptPassword(ClientInfo ci, String encryptionSet, String pwd) throws byps.RemoteException
      Provide a system password to be used in the current session for encrypting and decrypting of documents.

      The given password must be encrypted with the IXClient.encryptPassword function. An unencrypted password will cause an exception.

      To use the encryption/decryption functionality of Indexserver, the session option <ix.encryptDocuments> resp. <ix.decryptDocuments> has to be <true>. Then, Indexserver generates special URLs that cause it to encrypt documents on upload and decrypt documents on download.

      Be aware of the fact that encryption/decryption happens between Indexserver and Document Manager communication and not between Indexserver and the client application. Thus it is strongly recommended to use HTTPS between the client application and Indexserver. The Indexserver configuration option "ixUrlBase" can be helpful to achieve this.
      Parameters:
      ci - ClientInfo
      encryptionSet - Encryption set ID or name.
      pwd - Encrypted password.
      Throws:
      byps.RemoteException - Exception with message text of format "[ELOIX:number] text". The number is one of the constants defined in IXExceptionC.
      Since:
      12.00.000.028
      See Also:

    • invalidateCache

      void invalidateCache(ClientInfo ci, int flags) throws byps.RemoteException
      Invalidate the internally used caches for users, storage masks, etc.
      Parameters:
      ci - ClientInfo
      flags - Set this value to 65535 (Hex: 0xFFFF) to invalidate all caches.
      Throws:
      byps.RemoteException - Exception with message text of format "[ELOIX:number] text". The number is one of the constants defined in IXExceptionC.
      See Also:

    • invalidateCache2

      InvalidateCacheResult invalidateCache2(ClientInfo ci, InvalidateCacheInfo info) throws byps.RemoteException
      Invalidate the internally used caches.
      Parameters:
      ci - ClientInfo
      info - Parameter object
      Returns:
      Result object
      Throws:
      byps.RemoteException - Exception with message text of format "[ELOIX:number] text". The number is one of the constants defined in IXExceptionC.
      Since:
      8.00.032.011

    • findFirstTranslateTerms

      FindResult findFirstTranslateTerms(ClientInfo ci, FindTranslateTermInfo findInfo, int max) throws byps.RemoteException
      Find terms for which a translation is available.

      Close the search results with a call to findClose.

      Parameters:
      ci - ClientInfo
      findInfo - Search criteria.
      max - Maximum terms to be returned by this call.
      Returns:
      FindResult object. Terms are returned in FindResult.terms.
      Throws:
      byps.RemoteException - Exception with message text of format "[ELOIX:number] text". The number is one of the constants defined in IXExceptionC.
      Since:
      7.00.000.000
      See Also:

    • findNextTranslateTerms

      FindResult findNextTranslateTerms(ClientInfo ci, String searchId, int idx, int max) throws byps.RemoteException
      Find next terms.
      Parameters:
      ci - ClientInfo
      searchId - String Id of a search opened by findFirstTranslateTerms.
      idx - In the list of found objects, return objects starting from this index.
      max - Return at most max objects.
      Returns:
      FindResult object. Terms are returned in FindResult.terms.
      Throws:
      byps.RemoteException - Exception with message text of format "[ELOIX:number] text". The number is one of the constants defined in IXExceptionC.
      Since:
      7.00.000.000
      See Also:

    • checkoutTranslateTerms

      TranslateTerm[] checkoutTranslateTerms(ClientInfo ci, String[] termIds, LockZ lockZ) throws byps.RemoteException
      Read terms from translation table for viewing or editing.

      It can also be used to retrieve the supported languages. Use this function, if only a few terms should be returned. Otherwise call findFirstTranslateTerms.

      Parameters:
      ci - ClientInfo
      termIds - Term-GUIDs for which translations should be selected. If a term-GUID cannot be found, an exception is thrown (IXExceptionC.NOT_FOUND). Set this element to null, if all terms should be returned. Set this element to an empty string, if only the lock should be applied. To retrieve the supported languages, set this parameter to TranslateTermC.GUID_SYSTEM_LANGUAGES. In this case the function returns one object whose only valid member is TranslateTerm.langs.
      lockZ - Set LockC.YES, LockC.IF_FREE or LockC.FORCE to lock for editing - locking is currently not supported but may be added in future.
      Returns:
      Array of TranslateTerm objects filled with terms in all available languages.
      Throws:
      byps.RemoteException - Exception with message text of format "[ELOIX:number] text". The number is one of the constants defined in IXExceptionC.
      Since:
      7.00.000.000
      See Also:

    • checkinTranslateTerms

      String[] checkinTranslateTerms(ClientInfo ci, TranslateTerm[] tterms, LockZ unlockZ) throws byps.RemoteException
      Write or insert terms into the translation table.

      This function should not be called frequently, because it causes the translation cache to be reloaded.

      Parameters:
      ci - ClientInfo
      tterms - TranslateTerm objects to be written or inserted. If the terms[.].guid is not found, the term is inserted. Otherwise the term is updated. To set the supported system languages, supply an object with guid TranslateTermC.GUID_SYSTEM_LANGUAGES. The system languages can only be set if there are no translations.
      unlockZ - Set LockC.YES to remove the lock. Use LockC.NO to keep the lock - locking is currently not supported but may be added in future.
      Returns:
      Term-GUIDs of written or created terms.
      Throws:
      byps.RemoteException - Exception with message text of format "[ELOIX:number] text". The number is one of the constants defined in IXExceptionC.
      Since:
      7.00.000.000
      See Also:

    • deleteTranslateTerms

      void deleteTranslateTerms(ClientInfo ci, String[] termIds, LockZ unlockZ) throws byps.RemoteException
      Delete terms from the translation table.

      This function should not be called frequently, because it causes the translation cache to be reloaded.

      Parameters:
      ci - ClientInfo
      termIds - Term-GUIDs to be deleted. The termIds that cannot be found are ignored.
      unlockZ - Set LockC.YES to remove the lock. Use LockC.NO to keep the lock - locking is currently not supported but may be added in future.
      Throws:
      byps.RemoteException - Exception with message text of format "[ELOIX:number] text". The number is one of the constants defined in IXExceptionC.
      Since:
      7.00.000.000
      See Also:

    • getWorkflowTemplateVersions

      WFVersion[] getWorkflowTemplateVersions(ClientInfo ci, String flowId, boolean onlyDeleted) throws byps.RemoteException
      Reads the version information of all versions of the given workflow.
      Parameters:
      ci - ClientInfo
      flowId - Workflow ID or name
      onlyDeleted - true, if only deleted versions should be returned.
      Returns:
      Array of version information objects.
      Throws:
      byps.RemoteException - Exception with message text of format "[ELOIX:number] text". The number is one of the constants defined in IXExceptionC.

    • checkoutWorkflowTemplate

      WFDiagram checkoutWorkflowTemplate(ClientInfo ci, String flowId, String versionId, WFDiagramZ wfZ, LockZ lockZ) throws byps.RemoteException
      Check out versions of a workflow template.
      Parameters:
      ci - ClientInfo
      flowId - Workflow name or ID.
      versionId - null or "0" or "" returns the version information of the current version, an ID from WFVersion.id returns a specific version.
      wfZ - Member selector
      lockZ - Lock mode
      Returns:
      WFDiagram object
      Throws:
      byps.RemoteException - Exception with message text of format "[ELOIX:number] text". The number is one of the constants defined in IXExceptionC.
      Since:
      7.00.000.008
      See Also:

    • checkinWorkflowTemplate

      int[] checkinWorkflowTemplate(ClientInfo ci, WFDiagram wf, WFDiagramZ wfZ, LockZ unlockZ) throws byps.RemoteException
      Check in a workflow template as a new version or overwrite an existing version.
      Parameters:
      ci - ClientInfo
      wf - Workflow
      wfZ - Member selector
      unlockZ - Unlock mode
      Returns:
      Workflow and version ID of the template version
      Throws:
      byps.RemoteException - Exception with message text of format "[ELOIX:number] text". The number is one of the constants defined in IXExceptionC.
      Since:
      7.00.000.008
      See Also:

    • deleteWorkflowTemplate

      void deleteWorkflowTemplate(ClientInfo ci, String flowId, String versionId, LockZ unlockZ) throws byps.RemoteException
      Deletes a workflow template version.
      Parameters:
      ci - ClientInfo
      flowId - Workflow name or ID.
      versionId - An existing version ID to delete a specific version, or null, or "", or "0" to delete the workflow with all versions.
      unlockZ - Unlock mode
      Throws:
      byps.RemoteException - Exception with message text of format "[ELOIX:number] text". The number is one of the constants defined in IXExceptionC.
      Since:
      7.00.000.008

    • checkoutNoteTemplates

      NoteTemplate[] checkoutNoteTemplates(ClientInfo ci, String userId, String[] ids, NoteTemplateZ ntemplZ, LockZ lockZ) throws byps.RemoteException
      Read the stamp definitions from the users options.
      Parameters:
      ci - ClientInfo
      userId - Read stamps belonging to this user. If NoteTemplateC.USERID_ALL is supplied, the stamps shared by all users are returned. If null or an empty string is supplied, the stamps shared by all users and the stamps of the current user are returned. Furthermore the stamps that belong to the user's groups are returned.
      ids - if not null, only the stamps referenced by this IDs are returned.
      ntemplZ - Members to be returned.
      lockZ - Currently ignored.
      Returns:
      Array of stamp definitions.
      Throws:
      byps.RemoteException - Exception with message text of format "[ELOIX:number] text". The number is one of the constants defined in IXExceptionC.
      Since:
      7.00.000.023
      See Also:

    • createNoteTemplate

      NoteTemplate createNoteTemplate(ClientInfo ci, String userId) throws byps.RemoteException
      Initializes a new NoteTemplate object.
      Parameters:
      ci - ClientInfo
      userId - If a user ID or name is specified, the note template is initialized for this user and only for this user is full access granted in the ACL. If NoteTemplateC.USERID_ALL is supplied, the note template ACL is initialized with access for everyone.
      Returns:
      NoteTemplate object.
      Throws:
      byps.RemoteException - Exception with message text of format "[ELOIX:number] text". The number is one of the constants defined in IXExceptionC.
      Since:
      7.00.000.040

    • deleteNoteTemplates

      void deleteNoteTemplates(ClientInfo ci, String userId, String[] ids, LockZ unlockZ) throws byps.RemoteException
      Delete the stamp definition with the given ID.
      Parameters:
      ci - ClientInfo
      userId - Read stamps belonging to this user. If NoteTemplateC.USERID_ALL is supplied, the stamps shared by all users are deleted. If null or an empty string is supplied, the stamps of the current user are deleted
      ids - Stamp IDs from NoteTemplate.id.
      unlockZ - Currently ignored.
      Throws:
      byps.RemoteException - Exception with message text of format "[ELOIX:number] text". The number is one of the constants defined in IXExceptionC.

    • checkinNoteTemplates

      int[] checkinNoteTemplates(ClientInfo ci, NoteTemplate[] noteTemplates, NoteTemplateZ ntemplZ, LockZ unlockZ) throws byps.RemoteException
      Writes the given stamp definition into the database.
      Parameters:
      ci - ClientInfo
      noteTemplates - Stamp objects to be written. Set noteTemplate.id=-1 to insert a new object.
      ntemplZ - Must be set to mbAll.
      unlockZ - Currently ignored.
      Returns:
      IDs of the stamp template.
      Throws:
      byps.RemoteException - Exception with message text of format "[ELOIX:number] text". The number is one of the constants defined in IXExceptionC.

    • reload

      void reload(ClientInfo ci) throws byps.RemoteException
      This function reloads all internal objects.

      Call this function with administrator privileges, if configuration options, scripts or configuration files are modified. Current sessions and processes are tried to be kept alive. But under some conditions, sessions get lost and running processes terminate with an exception!

      Parameters:
      ci - ClientInfo
      Throws:
      byps.RemoteException - Exception with message text of format "[ELOIX:number] text". The number is one of the constants defined in IXExceptionC.

    • reloadScripts

      void reloadScripts(ClientInfo ci) throws byps.RemoteException
      This function reloads all scripts.

      Call this function with administrator privileges,

      if some scripts are modified.
      Parameters:
      ci - ClientInfo
      Throws:
      byps.RemoteException - Exception with message text of format "[ELOIX:number] text". The number is one of the constants defined in IXExceptionC.
      Since:
      9.00.000.012

    • getCompiledScripts

      Map<Integer,String> getCompiledScripts(ClientInfo ci) throws byps.RemoteException
      This function returns a map containing information of all compiled scripts.
      Parameters:
      ci - ClientInfo
      Returns:
      Map (key = script's ID | value = scripts' MD5)
      Throws:
      byps.RemoteException - Exception with message text of format "[ELOIX:number] text". The number is one of the constants defined in IXExceptionC.
      Since:
      9.00.000.012

    • getScriptsToDebug

      String getScriptsToDebug(ClientInfo ci) throws byps.RemoteException
      This function returns the list of the scripts which are currently debugged, i.e. the property "scriptsToDebug".
      Parameters:
      ci - ClientInfo
      Returns:
      String
      Throws:
      byps.RemoteException - Exception with message text of format "[ELOIX:number] text". The number is one of the constants defined in IXExceptionC.
      Since:
      9.00.000.018

    • setScriptsToDebug

      void setScriptsToDebug(ClientInfo ci, String scriptsToDebug) throws byps.RemoteException
      This function allows to set the the property "scriptsToDebug".
      Parameters:
      ci - ClientInfo
      scriptsToDebug - String
      Throws:
      byps.RemoteException - Exception with message text of format "[ELOIX:number] text". The number is one of the constants defined in IXExceptionC.
      Since:
      9.00.000.018

    • getDebuggerPort

      int getDebuggerPort(ClientInfo ci) throws byps.RemoteException
      This function returns debugger's port.
      Parameters:
      ci - ClientInfo
      Returns:
      String
      Throws:
      byps.RemoteException - Exception with message text of format "[ELOIX:number] text". The number is one of the constants defined in IXExceptionC.
      Since:
      9.00.016.020

    • deleteKeywordList

      void deleteKeywordList(ClientInfo ci, String kwid, LockZ unlockZ) throws byps.RemoteException
      Deletes a keyword list.
      Parameters:
      ci - ClientInfo object
      kwid - ID or GUID of the keyword list
      unlockZ - Remove lock.
      Throws:
      byps.RemoteException - Exception with message text of format "[ELOIX:number] text". The number is one of the constants defined in IXExceptionC.

    • checkoutKeywordList

      KeywordList checkoutKeywordList(ClientInfo ci, String kwid, KeywordZ keywordZ, int max, LockZ lockZ) throws byps.RemoteException
      Reads a keyword list.

      This function internally calls checkoutKeywords.

      Parameters:
      ci - ClientInfo object
      kwid - ID or GUID of the keyword list
      keywordZ - Members to be read
      max - Maximum members to read, see checkoutKeywords.
      lockZ - Lock mode.
      Returns:
      Keyword list.
      Throws:
      byps.RemoteException - Exception with message text of format "[ELOIX:number] text". The number is one of the constants defined in IXExceptionC.
      See Also:

    • checkinKeywordList

      void checkinKeywordList(ClientInfo ci, KeywordList kwList, LockZ unlockZ) throws byps.RemoteException
      Write or insert a keyword list.

      This function internally calls checkinKeywords.

      Parameters:
      ci - ClientInfo object.
      kwList - Keyword list. Supply null to only unlock.
      unlockZ - Remove lock.
      Throws:
      byps.RemoteException - Exception with message text of format "[ELOIX:number] text". The number is one of the constants defined in IXExceptionC.

    • combineAcl

      CombineAclResult combineAcl(ClientInfo ci, AclItem[] lhs, AclItem[] rhs, CombineAclOptions options) throws byps.RemoteException
      Compares the given ACLs and computes the sum, difference and intersection.

      To remove the duplicate entries in an ACL, call this function with a null value for the rhs parameter. The CombineAclResult.sum contains the ACL without duplicates.

      Parameters:
      ci - ClientInfo object.
      lhs - Left operand
      rhs - Right operand, can be null.
      options - Options, can be null.
      Returns:
      Result object.
      Throws:
      byps.RemoteException - Exception with message text of format "[ELOIX:number] text". The number is one of the constants defined in IXExceptionC.
      Since:
      7.00.020.000

    • getAclAccess

      AclAccessResult getAclAccess(ClientInfo ci, AclAccessInfo aai) throws byps.RemoteException
      Returns the access of the given ACL.
      Parameters:
      ci - ClientInfo object.
      aai - Options, can be null.
      Returns:
      Result object.
      Throws:
      byps.RemoteException - Exception with message text of format "[ELOIX:number] text". The number is one of the constants defined in IXExceptionC.
      Since:
      8.00.032.004

    • getEditInfoFromESW

      EditInfo[] getEditInfoFromESW(ClientInfo ci, FileData[] fileDatas, EditInfoEswOptions eswOptions) throws byps.RemoteException
      Returns the EditInfo-Objects from the FileData-Objects.

      The rows "IXDTEXT", "ISCRYPT", "ATTACHID" and "SIGID" in the esw-file are not supported in this version.

      Parameters:
      ci - ClientInfo object with current client information
      fileDatas - List with FileData-Objects
      eswOptions - EditInfoEswOptions Options for the esw-file
      Returns:
      EditInfo[] List with EditInfo-Objects
      Throws:
      byps.RemoteException - Exception with message text of format "[ELOIX:number] text". The number is one of the constants defined in IXExceptionC.
      Since:
      7.00.000.043

    • getESWFromEditInfo

      FileData[] getESWFromEditInfo(ClientInfo ci, EditInfo[] editInfos, EditInfoEswOptions eswOptions) throws byps.RemoteException
      Returns the FileData-Objects from the EditInfo-Objects.

      Caution: sord.XDateIso and sord.IDateIso have to contain a value related to the servers timezone.

      Parameters:
      ci - ClientInfo object with current client information
      editInfos - EditInfo[] List with EditInfo-Objects
      eswOptions - EditInfoEswOptions Options for the esw-file
      Returns:
      FileData[] List with FileData-Objects
      Throws:
      byps.RemoteException - Exception with message text of format "[ELOIX:number] text". The number is one of the constants defined in IXExceptionC.
      Since:
      7.00.000.043

    • getSessionFromTicket

      LoginResult getSessionFromTicket(ClientInfo ci, int options) throws byps.RemoteException
      Returns the LoginResult object that represents the session of the ticket contained in the given ClientInfo object.
      Parameters:
      ci - ClientInfo object
      options - One of the SessionOptionsC.SESSION_FROM_* constants.
      Returns:
      LoginResult object
      Throws:
      byps.RemoteException - Exception with message text of format "[ELOIX:number] text". The number is one of the constants defined in IXExceptionC.
      Since:
      7.00.006.002
      See Also:

    • getSessionInfos

      SessionInfo[] getSessionInfos(ClientInfo ci, SessionInfoParams params) throws byps.RemoteException
      Returns the SessionInfo-Objects about all the active connections.
      Parameters:
      ci - ClientInfo object
      params - Execution
      Returns:
      Array of SessionInfo
      Throws:
      byps.RemoteException - Exception with message text of format "[ELOIX:number] text". The number is one of the constants defined in IXExceptionC.
      Since:
      8.00.032.006

    • executeScript

      ExecuteScriptResult executeScript(ClientInfo ci, ExecuteScriptParams params) throws byps.RemoteException
      Execute a script.
      Parameters:
      ci - ClientInfo object
      params - Execution params (script code, etc.)
      Returns:
      Script result
      Throws:
      byps.RemoteException - Exception with message text of format "[ELOIX:number] text". The number is one of the constants defined in IXExceptionC.

    • exportWorkflow

      FileData exportWorkflow(ClientInfo ci, WorkflowExportOptions wfExportOptions) throws byps.RemoteException
      Exports the workflow-version.
      Parameters:
      ci - ClientInfo object
      wfExportOptions - Options for the workflow-export.
      Returns:
      de.elo.ix.client.FileData FileData-Object
      Throws:
      byps.RemoteException - Exception with message text of format "[ELOIX:number] text". The number is one of the constants defined in IXExceptionC.
      Since:
      7.00.020.002

    • getDistinctValuesOfObjKey

      @Deprecated ValuesOfObjKey getDistinctValuesOfObjKey(ClientInfo ci, String okeyName, ValuesOfObjKeyOptions opts) throws byps.RemoteException
      Deprecated.
      Read all distinct values from the database that are used for the given ObjKey name, potentionally causing an enormous database load.
      Parameters:
      ci - ClientInfo object
      okeyName - ObjKey name resp. DocMaksLine key.
      opts - reserved, must be null
      Returns:
      Sorted array of values.
      Throws:
      byps.RemoteException - Exception with message text of format "[ELOIX:number] text". The number is one of the constants defined in IXExceptionC.
      Since:
      7.00.020.004
      See Also:

    • getArchiveStatistics

      ArchiveStatistics getArchiveStatistics(ClientInfo ci, long opts) throws byps.RemoteException
      Read characteristical properties of the archive.
      Parameters:
      ci - ClientInfo object
      opts - Combination of ArchiveStatisticsOptionsC constants.
      Returns:
      ArchiveStatistics object
      Throws:
      byps.RemoteException - Exception with message text of format "[ELOIX:number] text". The number is one of the constants defined in IXExceptionC.
      See Also:

    • collectMapDomains

      MapDomain[] collectMapDomains(ClientInfo ci) throws byps.RemoteException
      Collects the existing map domains.

      This function does not return the special domain MapDomainC.DOMAIN_IX_OPTIONS.

      Parameters:
      ci - ClientInfo object
      Returns:
      Array of domains.
      Throws:
      byps.RemoteException - Exception with message text of format "[ELOIX:number] text". The number is one of the constants defined in IXExceptionC.
      Since:
      7.00.040.001
      See Also:

    • checkinMapDomain

      void checkinMapDomain(ClientInfo ci, MapDomain mapDomain, LockZ unlockZ) throws byps.RemoteException
      Creates or updates a map domain.
      Parameters:
      ci - ClientInfo object
      mapDomain - MapDomain object
      unlockZ - Remove lock
      Throws:
      byps.RemoteException - Exception with message text of format "[ELOIX:number] text". The number is one of the constants defined in IXExceptionC.
      Since:
      7.00.040.001

    • checkoutMapDomain

      MapDomain checkoutMapDomain(ClientInfo ci, String domainName, LockZ lockZ) throws byps.RemoteException
      Reads the data of a map domain.
      Parameters:
      ci - ClientInfo object
      domainName - map domain name; an arbitrary (existing name) or a predefined name from MapDomainC
      lockZ - Lock mode
      Returns:
      MapDomain object
      Throws:
      byps.RemoteException - Exception with message text of format "[ELOIX:number] text". The number is one of the constants defined in IXExceptionC.
      Since:
      7.00.040.001

    • deleteMapDomain

      void deleteMapDomain(ClientInfo ci, String domainName, LockZ unlockZ) throws byps.RemoteException
      Deletes a map domain and removes the associated database tables.
      Parameters:
      ci - ClientInfo object
      domainName - map domain name
      unlockZ - Remove lock
      Throws:
      byps.RemoteException - Exception with message text of format "[ELOIX:number] text". The number is one of the constants defined in IXExceptionC.
      Since:
      7.00.040.001
      See Also:

    • checkinMap

      void checkinMap(ClientInfo ci, String domainName, String id, int objId, KeyValue[] data, LockZ unlockZ) throws byps.RemoteException
      Inserts or updates the given key-value-pairs in data in the map specified by id.

      The map can be associated to a Sord object by setting the parameter objId to a valid Sord ID. This implies, that the map is deleted, if the Sord object is finally deleted. Furthermore, the map can be copied with the Sord object. Therefore, the map ID must be equal to the Sord ID and the map domain must be prepared to copy items by setting MapDomain.copy=true.

      If domainName is set to MapDomainC.DOMAIN_IX_OPTIONS, the Indexserver configuration options from table eloixopt can be written. Therefore the key items in data must be formatted as data[.].key = [ixid] + optname. Whereby ixid is _ALL or the Indexserver ID specified in the web.xml or config.xml. The parameter id is ignored when reading Indexserver options. The unlockZ parameter is ignored too, because the options table does not support locking. Only Administrators are allowed to access the Indexserver options.

      Since ELO10: Map items can be of type MapValue which allows to store a BLOB. The maximum BLOB size should be at most FileDataC.MAX_BLOB_LENGTH. 

       
 InputStream istream = new FileInputStream(new File("c:\test.txt")); // is closed in checkinMap
 FileData fileData = new FileData();
 fileData.setContentType("text/plain");
 fileData.setStream(istream);
 MapValue mapValue = new MapValue();
 mapValue.setKey("myfile");
 mapValue.setBlobValue(fileData);
 conn.ix().checkinMap( "MyMapDomain", "1", 0, new KeyValue[] { mapValue }, LockC.NO );
      Parameters:
      ci - ClientInfo object
      domainName - map domain name; an arbitrary (existing name) or a predefined name from MapDomainC
      id - map ID
      objId - Sord ID, if the map should be attached to a Sord object; otherwise 0
      data - map items
      unlockZ - Remove lock
      Throws:
      byps.RemoteException - Exception with message text of format "[ELOIX:number] text". The number is one of the constants defined in IXExceptionC.
      Since:
      7.00.040.001
      See Also:

    • checkoutMap

      MapData checkoutMap(ClientInfo ci, String domainName, String id, String[] keyNames, LockZ lockZ) throws byps.RemoteException
      Reads a map or parts of a map.

      Since ELO10: In order to access BLOB values, lookup the value in the returned element MapData.mapItems or cast the related object in MapData.items to MapValue. 

       
 MapData map = conn.ix().checkoutMap( mapDomainName, "1", new String[] {"myfile"}, LockC.NO );
 MapValue mapValue = map.getMapItems().get("myfile");
 InputStream istream = mapValueR.getBlobValue().getStream();
 try {
   ...
 } finally {
   istream.close();
 }
      Parameters:
      ci - ClientInfo object
      domainName - map domain name; an arbitrary (existing name) or a predefined name from MapDomainC
      id - map ID. In order to get the map values associated to a Sord object pass the numeric Sord ID (Sord#id).
      keyNames - keys to be read; null to read all keys; wildcards allowed
      lockZ - Lock mode
      Returns:
      MapData object that contains the map items
      Throws:
      byps.RemoteException - Exception with message text of format "[ELOIX:number] text". The number is one of the constants defined in IXExceptionC.
      Since:
      7.00.040.001
      See Also:

    • deleteMap

      void deleteMap(ClientInfo ci, String domainName, String id, String[] keyNames, LockZ unlockZ) throws byps.RemoteException
      Delete map items.
      Parameters:
      ci - ClientInfo object
      domainName - map domain name; an arbitrary (existing name) or a predefined name from MapDomainC
      id - map ID. In order to delete the map values associated to a Sord object pass the numeric Sord ID (Sord#id).
      keyNames - keys to be deleted; null to delete the entire map with all keys and history; wildcards allowed
      unlockZ - Remove lock
      Throws:
      byps.RemoteException - Exception with message text of format "[ELOIX:number] text". The number is one of the constants defined in IXExceptionC.
      Since:
      7.00.040.001
      See Also:

    • getContextTerms

      @Deprecated ContextTerm[] getContextTerms(ClientInfo ci, FindInfo findInfo, String field, int max) throws byps.RemoteException
      Deprecated.
      Find terms for faceted search.
      Parameters:
      ci - ClientInfo
      findInfo - FindInfo
      field - Find facets for this field.
      max - Max number of terms to be returned.
      Returns:
      Array of context terms.
      Throws:
      byps.RemoteException - Exception with message text of format "[ELOIX:number] text". The number is one of the constants defined in IXExceptionC.
      Since:
      7.00.040.018

    • findContextTerms

      FindResult findContextTerms(ClientInfo ci, FindInfo findInfo, int maxTermsPerField) throws byps.RemoteException
      Find terms for faceted search.
      Parameters:
      ci - ClientInfo
      findInfo - This parameter is used to define the search.
      maxTermsPerField - Max number of terms per field to be returned.
      Returns:
      FindResult
      Throws:
      byps.RemoteException
      Since:
      11.00.000.009

    • findAggregations

      FindResult findAggregations(ClientInfo ci, FindInfo findInfo) throws byps.RemoteException
      Find aggregation data for dashboards and statistics.
      Parameters:
      ci - ClientInfo
      findInfo - Defines search and aggregation parameters.
      Returns:
      FindResult
      Throws:
      byps.RemoteException
      Since:
      21.03.000.001

    • executeRegisteredFunction

      Any executeRegisteredFunction(ClientInfo ci, String functionName, Any param) throws byps.RemoteException
      Execute a registered function defined in a JavaScript or in an event handler.
      Parameters:
      ci - ClientInfo
      functionName - Name of the function to be executed.
      param - Function parameter
      Returns:
      Return value
      Throws:
      byps.RemoteException - Exception with message text of format "[ELOIX:number] text". The number is one of the constants defined in IXExceptionC.
      Since:
      7.00.040.019

    • executeRegisteredFunctionString

      String executeRegisteredFunctionString(ClientInfo ci, String functionName, String param) throws byps.RemoteException
      Execute a registered function defined in a JavaScript or in an event handler.
      Parameters:
      ci - ClientInfo
      functionName - Name of the function to be executed.
      param - Function parameter as String
      Returns:
      Return value as String
      Throws:
      byps.RemoteException - Exception with message text of format "[ELOIX:number] text". The number is one of the constants defined in IXExceptionC.
      Since:
      9.00.022.002

    • getSearchTerms

      @Deprecated String[] getSearchTerms(ClientInfo ci, FindInfo findInfo, int termType) throws byps.RemoteException
      Deprecated.
      Get alternative terms for an iSearch search.

      This function can be used to list all index values currently used for a given index group. To achieve this, pass termType=SearchTermsC.TERMS and set findInfo.findDirect.query = "LINE." + indexgroup + ":" + valueprefix. If more than 10 values shoud be returned, set findInfo.findOptions.totalCount to the maximum values to be returned.

      Parameters:
      findInfo - This object defines the search criteria.
      termType - Use Constants in SearchTerms ( SearchTermsC.TERMS, SYNONYMS, CORRECTION )
      Returns:
      Array of search terms
      Throws:
      byps.RemoteException - Exception with message text of format "[ELOIX:number] text". The number is one of the constants defined in IXExceptionC.
      Since:
      7.00.040.018
      See Also:

    • findSearchTerms

      FindResult findSearchTerms(ClientInfo ci, FindInfo findInfo, int max) throws byps.RemoteException
      Corrections and synonyms.
      Parameters:
      ci -
      findInfo -
      max -
      Returns:
      FindResult
      Throws:
      byps.RemoteException
      Since:
      11.00.000.009

    • findCompletion

      FindResult findCompletion(ClientInfo ci, FindInfo findInfo, int max) throws byps.RemoteException
      Autocompletion/ Type as you search
      Use CompletionOptions in findInfo.indByElastic.eSearchOptions.
      Parameters:
      ci - ClientInfo object with language, country and ticket.
      findInfo - Search criteria.
      max - Maximum number of objects to return.
      Returns:
      FindResult
      Throws:
      byps.RemoteException
      Since:
      11.00.000.009

    • adminMode

      int adminMode(ClientInfo ci, int mode) throws byps.RemoteException
      Queries, enters or leaves the administration mode.

      In administration mode, only main administrators can logon to the archive.

      Parameters:
      ci - ClientInfo object with language, country and ticket.
      mode - One of the AdminModeC constants.
      Returns:
      The previous state of the administration mode (which is the equal to the current state, if mode == AdminModeC.QUERY).
      Throws:
      byps.RemoteException - Exception with message text of format "[ELOIX:number] text". The number is one of the constants defined in IXExceptionC.
      Since:
      7.00.040.022

    • configureFulltext

      @Deprecated FulltextConfig configureFulltext(ClientInfo ci, String userId, FulltextConfig opts) throws byps.RemoteException
      Deprecated.
      Get or set the fulltext configuration. Note: deprecated. Use checkinEsSettings and checkoutEsSettings instead.
      Parameters:
      ci - ClientInfo object with language, country and ticket.
      userId - reserved, must be null or empty.
      opts - Fulltext configuration options. Set this parameter to null, if the configuraion should be read. Only main administrators can write the configuration.
      Returns:
      The previous fulltext configuration (which is the equal to the current configuration, if opts == null)
      Throws:
      byps.RemoteException - Exception with message text of format "[ELOIX:number] text". The number is one of the constants defined in IXExceptionC.
      Since:
      7.00.040.023

    • notifyServer

      NotifyServerResult notifyServer(ClientInfo ci, NotifyServerInfo msg) throws byps.RemoteException
      This function notifies the Indexserver about an operation of the client program.

      Use this function in order to notify the license management, when a write access has been processed, e.g. scan a document or perform OCR analysis on a document.

      Parameters:
      ci - ClientInfo object with language, country and ticket.
      msg - NotifyServerInfo This object describes the executed operation.
      Throws:
      byps.RemoteException - Exception with message text of format "[ELOIX:number] text". The number is one of the constants defined in IXExceptionC.
      Since:
      8.00.000.005

    • configureBackup

      BackupProfile[] configureBackup(ClientInfo ci, BackupProfile[] backupProfiles) throws byps.RemoteException
      Query or send backup profile information of the ELOdm.

      The user calling this method must have the main administrator right (AccessC.FLAG_ADMIN).

      Parameters:
      ci - ClientInfo object with language, country and ticket.
      backupProfiles - New backup profile settings. This array overwrites all current backup profiles. Supply null, if profile information should be read.
      Returns:
      Backup profiles
      Throws:
      byps.RemoteException - Exception with message text of format "[ELOIX:number] text". The number is one of the constants defined in IXExceptionC.
      Since:
      8.00.000.006

    • controlBackup

      BackupPurgeStatus controlBackup(ClientInfo ci, ControlBackupInfo controlBackupInfo) throws byps.RemoteException
      Query the status of the backup and purge tasks of the ELOdm.

      In addition, the backup and purge tasks can be started or stopped. The user calling this method must have the main administrator right (AccessC.FLAG_ADMIN).

      Parameters:
      ci - ClientInfo object with language, country and ticket.
      controlBackupInfo - mode for the ELOdm backup and purge tasks
      Returns:
      status of the ELOdm backup and purge tasks
      Throws:
      byps.RemoteException - Exception with message text of format "[ELOIX:number] text". The number is one of the constants defined in IXExceptionC.
      Since:
      8.00.032.001

    • configurePurge

      PurgeSettings configurePurge(ClientInfo ci, PurgeSettings purgeSettings) throws byps.RemoteException
      Query or send the purge task settings of the ELOdm.

      The user calling this method must have the main administrator right (AccessC.FLAG_ADMIN).

      Parameters:
      ci - ClientInfo object with language, country and ticket.
      purgeSettings - new purge settings. Supply null, if information should be read.
      Returns:
      the purge settings (if purgeSettings is not null, the same object)
      Throws:
      byps.RemoteException - Exception with message text of format "[ELOIX:number] text". The number is one of the constants defined in IXExceptionC.
      Since:
      8.00.032.002

    • addUrlParams

      String addUrlParams(ClientInfo ci, String url, UrlParams params) throws byps.RemoteException
      Adds additional params to an upload or download URL.

      Currently, additional params are only available for download URLs.

      Parameters:
      ci - ClientInfo object with language, country and ticket.
      url - This URL is appended by the params
      params - UrlParams to be added
      Returns:
      The new URL
      Throws:
      byps.RemoteException - Exception with message text of format "[ELOIX:number] text". The number is one of the constants defined in IXExceptionC.
      Since:
      8.00.000.007

    • openEventBus

      long openEventBus(ClientInfo ci, EventBusParams params) throws byps.RemoteException
      Open a new event bus.

      Caution: the event bus API functions cannot be used with SOAP communication.

      An event bus is like a communication channel between two or more subscribers. One subscriber sends an event and the bus dispatches it to the subscribers that are listening.

      Before an application can send events, it has to call the function createEventBusSubscriber in order to create a subscriber ID. A subscriber can send events to an event bus or listen to events from an event bus. To send an event, the function sendEvents has to be called.
      In order to revive events from event busses, event listeners have to be registered with the event busses first. An event listener specifies a list of EventFilter objects which describe the requested event types and busses from which to receive events. A subscriber can register any number of event listeners to potentially different event busses with a single call to createEventBusListener. Further event listeners can be added by this function or deleted with deleteEventBusListener at any time.

      A helper object of IXConnection, which can be obtained by IXConnection.getEventBusApi(), listens for incoming events and forwards them to an object that implements the IXEventBusHandler interface. This object has to be provided by the client application and must be passed in a call to IXConnection.getEventBusApi().setHandler(...).

      Normally, client applications will use the predefined busses listed in EventBusC. This class defines a broadcast bus and busses related to users. Any subscriber can receive events from the broadcast bus. In difference to that, user busses can be listened only by the owner - a user bus acts somewhat like a mailbox.

      There is no constraint to subscribers for sending events to busses. A subscriber can send any event to a bus, if it knows the bus ID.

      In some circumstances, it is useful to work with a private channel between particular subscribers. This could be a channel used for chat messages between users. Another example is a channel between separated components of an application that share the same ticket an have to synchronize the user interfaces.

      Use this function to open an event bus e.g. to establish a private communication channel between two or more applications. The returned bus ID is built upon the given information in params. Two applications, that supply equal params objects, will receive equal bus IDs. At least one of the applications has to close the bus with closeEventBus if it is needed no more.

      Parameters:
      ci - ClientInfo object with language, country and ticket.
      params - Data which is used to build the bus ID.
      Returns:
      Event bus ID
      Throws:
      byps.RemoteException - Exception with message text of format "[ELOIX:number] text". The number is one of the constants defined in IXExceptionC.
      Since:
      8.00.010.000
      See Also:

    • closeEventBus

      void closeEventBus(ClientInfo ci, long busId) throws byps.RemoteException
      Close an event bus opened by openEventBus.

      Any subscriber that knows the bus ID can close this event bus. When a bus is closed, all outstanding events in the ELOix are deleted. After a bus is closed, neither listener will receive anymore events from this bus. This function ignores unknown or already closed bus IDs or bus IDs defined in EventBusC.

      Parameters:
      ci - ClientInfo object with language, country and ticket.
      busId - Event bus ID. A value returned from a call to openEventBus.
      Throws:
      byps.RemoteException - Exception with message text of format "[ELOIX:number] text". The number is one of the constants defined in IXExceptionC.
      Since:
      8.00.010.000
      See Also:

    • createEventBusSubscriber

      long createEventBusSubscriber(ClientInfo ci) throws byps.RemoteException
      Create an event bus subscriber.

      A subscriber sends events to an event bus or receives events from an event bus. An application resp. an IXConnection can open any number of subscribers. A subscriber has to be deleted with deleteEventBusSubscriber when it is no more needed. A bus is also deleted, if the last event listener is deleted. This might happen when deleteEventBusSubscriber or deleteEventBusListener is called. In this case, it is not necessary to call deleteEventBusSubscriber.

      Parameters:
      ci - ClientInfo object with language, country and ticket.
      Returns:
      Subscriber ID
      Throws:
      byps.RemoteException - Exception with message text of format "[ELOIX:number] text". The number is one of the constants defined in IXExceptionC.
      Since:
      8.00.010.000
      See Also:

    • deleteEventBusSubscriber

      void deleteEventBusSubscriber(ClientInfo ci, long subsId) throws byps.RemoteException
      Deletes an event bus subscriber.

      This function deletes a subscriber an all its event listeners.

      Parameters:
      ci - ClientInfo object with language, country and ticket.
      subsId - Subscriber ID
      Throws:
      byps.RemoteException - Exception with message text of format "[ELOIX:number] text". The number is one of the constants defined in IXExceptionC.
      Since:
      8.00.010.000
      See Also:

    • createEventBusListener

      long createEventBusListener(ClientInfo ci, long subsId, EventListener eventListener) throws byps.RemoteException
      Creates an event bus listener.

      This function creates an event bus listener that filters events from the event bus as described in the filter list of the eventListener parameter. Event bus listeners have to be deleted by either deleteEventBusListener or by deleting the subscriber with deleteEventBusSubscriber.

      Parameters:
      ci - ClientInfo object with language, country and ticket.
      eventListener - Event listener ID
      Throws:
      byps.RemoteException - Exception with message text of format "[ELOIX:number] text". The number is one of the constants defined in IXExceptionC.
      See Also:

    • deleteEventBusListener

      void deleteEventBusListener(ClientInfo ci, long lsnId) throws byps.RemoteException
      Deletes an event bus listener.

      This function deletes an event bus listener that was created by a call to createEventBusListener. The function does not throw an exception, if the Listener ID does not exist.

      Parameters:
      ci - ClientInfo object with language, country and ticket.
      lsnId - Listener ID
      Throws:
      byps.RemoteException - Exception with message text of format "[ELOIX:number] text". The number is one of the constants defined in IXExceptionC.
      Since:
      8.00.010.000
      See Also:

    • internalReceiveEvents

      Event[] internalReceiveEvents(ClientInfo ci, long subsId, long timeoutMillis) throws byps.RemoteException
      Read events from the server.

      This function should not be called directly. It is used internally by the event bus helper object of IXConnection.

      Parameters:
      ci - ClientInfo object with language, country and ticket.
      subsId - Subscriber ID
      timeoutMillis - Return after this time, even if no events are available. If set to 0, return the currently available events.
      Returns:
      Received events.
      Throws:
      byps.RemoteException - Exception with message text of format "[ELOIX:number] text". The number is one of the constants defined in IXExceptionC.
      Since:
      8.00.010.000
      See Also:

    • sendEvents

      void sendEvents(ClientInfo ci, long subsId, Event[] events) throws byps.RemoteException
      Send events to event busses.

      Call this function to send events to event busses.

      Parameters:
      ci - ClientInfo object with language, country and ticket.
      subsId - Subscriber ID
      events - Events to be sent.
      Throws:
      byps.RemoteException - Exception with message text of format "[ELOIX:number] text". The number is one of the constants defined in IXExceptionC.
      Since:
      8.00.010.000
      See Also:

    • createRsaKeys

      String[] createRsaKeys(ClientInfo ci) throws byps.RemoteException
      Helper function to create a RSA key pair.
      Parameters:
      ci - ClientInfo object with language, country and ticket.
      Returns:
      RSA key pair. String[0] contains a string representation of the public key, String[1] contains the private key.
      Throws:
      byps.RemoteException - Exception with message text of format "[ELOIX:number] text". The number is one of the constants defined in IXExceptionC.
      Since:
      8.00.010.000
      See Also:

    • encryptStringRsa

      String encryptStringRsa(ClientInfo ci, String key, String data, boolean encryptNotDecrypt) throws byps.RemoteException
      Encrypt or decrypt a string using the RSA algorithm.

      This function encrypts or decrypts the string data using the RSA algorithm. The string must not be longer than 768 characters. Pass the public RSA key in key, if the string should be encrypted. In order to decrypt the string, the private key has to be passed. Both keys must be created with createRsaKeys.

      Parameters:
      ci - ClientInfo object with language, country and ticket.
      key - Public or private RSA key
      data - String to be encrypted or decrypted
      encryptNotDecrypt - true, if the should be encrypted.
      Returns:
      Encrypted or decrypted string.
      Throws:
      byps.RemoteException - Exception with message text of format "[ELOIX:number] text". The number is one of the constants defined in IXExceptionC.
      Since:
      8.00.010.000
      See Also:

    • createActivityProject

      ActivityProject createActivityProject(ClientInfo ci, String projectName) throws byps.RemoteException
      This function creates an activity project in memory.

      If projectName is not null and not empty, the function checks whether the name is already used. The current session must have the permission AccessC.FLAG_EDITACT in order to call this function.

      Parameters:
      ci - ClientInfo object with language, country and ticket.
      projectName - Name of the new activity project or null or empty.
      Returns:
      ActivityProject object.
      Throws:
      byps.RemoteException - Exception with message text of format "[ELOIX:number] text". The number is one of the constants defined in IXExceptionC. IXExceptionC.ALREADY_EXISTS if the given project name does already exists.
      Since:
      8.00.012.001

    • checkinActivityProject

      String checkinActivityProject(ClientInfo ci, ActivityProject actProj, LockZ unlockZ) throws byps.RemoteException
      This function writes an activity project into the database.

      The current session must have the permission AccessC.FLAG_EDITACT in order to call this function.

      Parameters:
      ci - ClientInfo object with language, country and ticket.
      actProj - ActivityProject
      unlockZ - Unlock project
      Returns:
      Activity project name
      Throws:
      byps.RemoteException - Exception with message text of format "[ELOIX:number] text". The number is one of the constants defined in IXExceptionC.
      Since:
      8.00.012.001

    • checkoutActivityProject

      ActivityProject checkoutActivityProject(ClientInfo ci, String projectName, LockZ lockZ) throws byps.RemoteException
      This function reads and optionally locks an activity project.
      Parameters:
      ci - ClientInfo object with language, country and ticket.
      projectName - GUID of an existing activity project.
      lockZ - Lock project
      Returns:
      ActivityProject object.
      Throws:
      byps.RemoteException - Exception with message text of format "[ELOIX:number] text". The number is one of the constants defined in IXExceptionC. IXExceptionC.NOT_FOUND if the activity does not exist.
      Since:
      8.00.012.001

    • deleteActivityProject

      void deleteActivityProject(ClientInfo ci, String projectName, LockZ unlockZ) throws byps.RemoteException
      This function deletes an activity project from the database.

      The current session must have the permission AccessC.FLAG_EDITACT in order to call this function.

      Parameters:
      ci - ClientInfo object with language, country and ticket.
      projectName - GUID of an existing activity project.
      unlockZ - Unlock project
      Throws:
      byps.RemoteException - Exception with message text of format "[ELOIX:number] text". The number is one of the constants defined in IXExceptionC. IXExceptionC.NOT_FOUND if the activity does not exist.
      Since:
      8.00.012.001

    • findActivityProjects

      ActivityProject[] findActivityProjects(ClientInfo ci, FindActivityProjectsInfo findInfo) throws byps.RemoteException
      This function reads all activity projects.
      Parameters:
      ci - ClientInfo object with language, country and ticket.
      findInfo - Reserved.
      Returns:
      ActivityProject array.
      Throws:
      byps.RemoteException - Exception with message text of format "[ELOIX:number] text". The number is one of the constants defined in IXExceptionC.
      Since:
      8.00.012.001

    • createActivity

      Activity createActivity(ClientInfo ci, String projectName, String objId) throws byps.RemoteException
      This function creates an activity in memory based on the given project and assigned to the given object.

      The current session must have read access to the Sord, if parameter objId is specified.

      Parameters:
      ci - ClientInfo object with language, country and ticket.
      projectName - Activity project name.
      objId - Optional Sord ID.
      Returns:
      Activity object
      Throws:
      byps.RemoteException - Exception with message text of format "[ELOIX:number] text". The number is one of the constants defined in IXExceptionC.
      Since:
      8.00.012.001

    • checkinActivity

      String checkinActivity(ClientInfo ci, Activity act, LockZ unlockZ) throws byps.RemoteException
      This function inserts or updates an activity.

      The current session must have read access to the given Sord. In order to update an existing activity, the current session must be sender or receiver of the activity (Acitivty.senderId, Activity.receiverId).

      Parameters:
      ci - ClientInfo object with language, country and ticket.
      act - Activity object
      unlockZ - Unlock mode
      Returns:
      Activity GUID
      Throws:
      byps.RemoteException - Exception with message text of format "[ELOIX:number] text". The number is one of the constants defined in IXExceptionC.
      Since:
      8.00.012.001

    • deleteActivity

      void deleteActivity(ClientInfo ci, String actGuid, DeleteActivityOptions deleteOptions, LockZ unlockZ) throws byps.RemoteException
      This function deletes an activity.

      The current session must be sender or receiver of the activity (Acitivty.senderId, Activity.receiverId).

      Parameters:
      ci - ClientInfo object with language, country and ticket.
      actGuid - Activity ID
      deleteOptions - Optional. If this member is null, the activity is deleted logically. Thereby member Activity.backAt is set to the current date.
      unlockZ - Unlock mode
      Throws:
      byps.RemoteException - Exception with message text of format "[ELOIX:number] text". The number is one of the constants defined in IXExceptionC. IXExceptionC.NOT_FOUND if the activity does not exist.
      Since:
      8.00.012.001

    • checkoutActivity

      Activity checkoutActivity(ClientInfo ci, String actGuid, LockZ lockZ) throws byps.RemoteException
      This function reads and optionally locks an activity.

      The current session must be sender or receiver of the activity (Acitivty.senderId, Activity.receiverId).

      Parameters:
      ci - ClientInfo object with language, country and ticket.
      actGuid - Activity ID
      lockZ - Lock mode
      Returns:
      Activity object.
      Throws:
      byps.RemoteException - Exception with message text of format "[ELOIX:number] text". The number is one of the constants defined in IXExceptionC. IXExceptionC.NOT_FOUND if the activity does not exist.
      Since:
      8.00.012.001

    • findFirstActivities

      FindResult findFirstActivities(ClientInfo ci, FindActivityInfo findInfo, int max, ActivityZ activityZ) throws byps.RemoteException
      This function reads the activities of an object.
      Parameters:
      ci - ClientInfo object with language, country and ticket.
      findInfo - This parameter is used to define the object for which activities should be returned.
      max - Maximum number of objects to be returned in this call.
      activityZ - Element selector. This parameter defines, which Activity members have to be returned.
      Returns:
      FindResult object, activities are returned in FindResult.userTasks[.].activity
      Throws:
      byps.RemoteException - Exception with message text of format "[ELOIX:number] text". The number is one of the constants defined in IXExceptionC.
      Since:
      8.00.012.001

    • findNextActivities

      FindResult findNextActivities(ClientInfo ci, String searchId, int idx, int max, ActivityZ activityZ) throws byps.RemoteException
      This function reads the next activites of an object.
      Parameters:
      ci - ClientInfo object with language, country and ticket.
      searchId - A Search ID received from a previous call to findFirstActivities in FindResult.searchId.
      idx - Return results from this start index.
      max - Maximum number of objects to be returned in this call.
      activityZ - Element selector. This parameter defines, which Activity members have to be returned.
      Returns:
      FindResult object, activities are returned in FindResult.userTasks[.].activity
      Throws:
      byps.RemoteException - Exception with message text of format "[ELOIX:number] text". The number is one of the constants defined in IXExceptionC.
      Since:
      8.00.012.001

    • registerOcrWorker

      OcrWorker registerOcrWorker(ClientInfo ci, OcrWorker ocrWorker) throws byps.RemoteException
      This function is called from an OCR worker process to notify Indexserver about its state.

      The behavior of a OCR worker process is beyond the API documentation. Contact ELO support, if a different OCR has to be integrated.

      Parameters:
      ci - ClientInfo object with language, country and ticket.
      ocrWorker - An object that describes the worker.
      Returns:
      Reserved.
      Throws:
      byps.RemoteException - Exception with message text of format "[ELOIX:number] text". The number is one of the constants defined in IXExceptionC.
      Since:
      8.00.020.001

    • processOcr

      OcrResult processOcr(ClientInfo ci, OcrInfo ocrInfo) throws byps.RemoteException
      Compute OCR on the given image data or on an archived document.

      In order to use this function, the ELO OCR Service 8.0 has to be installed somewhere on the network and has to be configured for Indexserver access.

      The request can be performed synchronously or asynchronously. In asynchronous processing, the result is sent via the Indexserver Event API. In order to receive the result, the client application has to register a listener for the event type EventBusC.EVENT_OCR_RESULT.

      Use an empty OcrInfo object to check, whether OCR is available.

      This is a simple example for synchronous OCR processing: 

       
 IXConnection conn = ...
 String imageFile = ... // Input file in TIFF, etc. format
 String textFile = ... // Output file in text format
 
      
 // Is OCR via IX available? - Pass an empty OcrInfo object to processOcr in order to find it out. 
 OcrInfo ocrInfo = new OcrInfo();
 bool isOcrAvail = conn.Ix.processOcr(ocrInfo) != null;
 if (!isOcrAvail) return;
 
      
 // Query the languages supported by the OCR Engine
 OcrInfo ocrInfoLangs = new OcrInfo();
 ocrInfoLangs.queryLanguages = new OcrInfoQueryLanguages();
 OcrResult ocrResultLangs = conn.Ix.processOcr(ocrInfoLangs);
 
      
 // Anaylze file
 // Load entire image into memory
 OcrInfo ocrInfo = new OcrInfo();
 ocrInfo.recognizeFile = new OcrInfoRecognizeFile();
 ocrInfo.recognizeFile.imageData = new FileData();
 ocrInfo.recognizeFile.imageData.data = File.ReadAllBytes(imageFile);
 ocrInfo.recognizeFile.imageData.contentType = Path.GetExtension(imageFile);
 ocrInfo.recognizeFile.pageNo = -1; // analyze all pages
 ocrInfo.recognizeFile.outputFormat = OcrInfoC.TEXT; // return result as String
 ocrInfo.recognizeFile.recognizeLangs = new String[] {"German", "Czech"}; // Choosen from ocrResultLangs.internalLangs  
 
      
 // Process OCR
 OcrResult ocrResult = conn.Ix.processOcr(ocrInfo);
 
      
 // Write text output to file
 File.WriteAllText(textFile, ocrResult.recognizeFile.text, Encoding.UTF8);
      Parameters:
      ci - ClientInfo object with language, country and ticket.
      ocrInfo - Contains the image data, etc.
      Returns:
      Reserved (currently always null)
      Throws:
      byps.RemoteException - Exception with message text of format "[ELOIX:number] text". The number is one of the constants defined in IXExceptionC. If ELO OCR Service 8.0 is not installed or all OCR workers have been busy for more than 2min, IXExceptionC.TEMP_PROBLEM is thrown (ELOIX:2002). IF OCR processing fails, IXExceptionC.SERVER_ERROR is thrown (ELOIX:1000).
      Since:
      8.00.020.001

    • evalAutoFiling

      AutoFilingResult evalAutoFiling(ClientInfo ci, String maskId, Sord sord, AutoFilingOptions opts) throws byps.RemoteException
      Evaluate the destination archive path based on filing definitions of a keywording from.

      This function evaluates the parent folder of a Sord object based on the filing definition of a keywording form WITHOUT storing the Sord object. This is in contrast to the checkinSord and checkinDocEnd functions which store the Sord object in the resulting parent.

      Parameters:
      ci - ClientInfo object with language, country and ticket.
      maskId - Keywording form ID with filing definition. This paramter can be null, if AutoFilingOptions.autoFilingDefinition is supplied.
      sord - Sord object
      opts - reserved
      Returns:
      Archive destination
      Throws:
      byps.RemoteException - Exception with message text of format "[ELOIX:number] text". The number is one of the constants defined in IXExceptionC. If the Sord object does not contain all information required to replace the placeholders in the filing definition, IXExceptionC.INVALID_PARAM is thrown.

    • checkoutMapHistory

      MapHist[] checkoutMapHistory(ClientInfo ci, String domainName, String mapId, MapHistZ membersZ) throws byps.RemoteException
      Reads the history entries for the given map.

      History entries are only written for MapDomain objects with MapDomain.history=true. For MapDomain objects with MapDomain.history=false, an empty array is returned. If no history entries exist for the given domainName and mapId, an empty array is returned.

      Parameters:
      ci - ClientInfo object
      domainName - map domain name; an arbitrary (existing name) or a predefined name from MapDomainC
      mapId - map ID. In order to get the map values associated to a Sord object pass the numeric Sord ID (Sord#id).
      membersZ - Members to be returned. E.g. MapHistC.mbAll or MapHistC.mbAllNoItems.
      Returns:
      MapHist Object that contains the map items.
      Throws:
      byps.RemoteException - Exception with message text of format "[ELOIX:number] text". The number is one of the constants defined in IXExceptionC.
      See Also:

    • checkinDocBegin2

      Document checkinDocBegin2(ClientInfo ci, Sord sord, Document document, CheckinDocOptions opts) throws byps.RemoteException
      Prepares the Indexserver to enable a document to be checked in.

      Retrieves path id and encryption set from the sord object and sets these values in document versions of this document. In case of limited release document, work version is set to false. Document id will not be set to 0, if "keepIds" is true in option "opts" (when no new document but only signature should be added for a version controlled document, up to this version clients had to reset the actual document id after running method checkinDocBegin)

      Parameters:
      ci - ClientInfo object with language, country and ticket
      sord - Sord object
      document - Document object
      opts - CheckinDocOptions (with member "keepIds")
      Returns:
      Document object with upload URL.
      Throws:
      byps.RemoteException - Exception with message text of format "[ELOIX:number] text". The number is one of the constants defined in IXExceptionC.
      Since:
      8.00.032.007
      See Also:

    • controlBackgroundThread

      JobState controlBackgroundThread(ClientInfo ci, JobState jobState) throws byps.RemoteException
      Query the status of the job and control its state.

      Using this method the job can be cancelled. The user calling this method must have started the job or must have the administrator right (AccessC.FLAG_ADMIN).

      Parameters:
      ci - ClientInfo object with language, country and ticket.
      jobState - JobState object with job and controlling information.
      Returns:
      status of the job after executing the controlling informations.
      Throws:
      byps.RemoteException - Exception with message text of format "[ELOIX:number] text". The number is one of the constants defined in IXExceptionC.
      Since:
      8.00.036.000

    • findBackgroundThreads

      FindResult findBackgroundThreads(ClientInfo ci, FindBackgroundThreadOptions findBackgroundThreadOptions) throws byps.RemoteException
      Query all jobs executed in the background.

      The method returns all jobs started by the calling user. If the user has the administrator right (AccessC.FLAG_ADMIN) the findBackgroundThreadOptions parameter can filter for users.

      Parameters:
      ci - ClientInfo object with language, country and ticket.
      findBackgroundThreadOptions - FindBackgroundThreadOptions object with filter informations.
      Returns:
      FindResult containing the found jobs.
      Throws:
      byps.RemoteException - Exception with message text of format "[ELOIX:number] text". The number is one of the constants defined in IXExceptionC.
      Since:
      8.00.036.000

    • queryJobProtocol

      QueryJobProtocolResult queryJobProtocol(ClientInfo ci, QueryJobProtocolInfo queryJobProtocolInfo) throws byps.RemoteException
      Query the protocol of a background thread.

      The method returns all log messages that matches the restrictions given by the parameter queryJobProtocolInfo, and that are cached at the Indexserver. The amount of cached entries is configurable at the log4j configuration file.

      Parameters:
      ci - ClientInfo object with language, country and ticket.
      queryJobProtocolInfo - QueryJobProtocolInfo object containing the jobGuid and optional filters.
      Returns:
      QueryJobProtocolResult containing all cached log messages according to the filters set by queryJobProtocolInfo. If uncached log messages exists, the value downloadUrl is set.
      Throws:
      byps.RemoteException - Exception with message text of format "[ELOIX:number] text". The number is one of the constants defined in IXExceptionC.
      Since:
      8.00.036.001

    • checkoutKeywordsDynamic

      KeywordsDynamicResult checkoutKeywordsDynamic(ClientInfo ci, KeywordsDynamicInfo keywordsDynamicInfo) throws byps.RemoteException
      Queries dynamic keyword lists.

      A server script generates the data of dynamic keyword lists from external resources. Such resources may be databases of CRMs, webservices like twitter, an e-M@il provider, etc. The default installation does not provide any server scripts. They must be implemented by the end-user.

      Parameters:
      ci - ClientInfo object with language, country and ticket.
      keywordsDynamicInfo - KeywordsDynamicInfo contains the parameters like the sord, and the focused mask line.
      Returns:
      KeywordsDynamicResult containing the result as a table with some metadata.
      Throws:
      byps.RemoteException - Exception with message text of format "[ELOIX:number] text". The number is one of the constants defined in IXExceptionC. i.e. if the script was not found or required parameters are not provided.
      Since:
      9.00.000.001

    • checkoutSordPath

      SordPaths checkoutSordPath(ClientInfo ci, String objId, SordZ sordZ, CheckoutSordPathInfo csi) throws byps.RemoteException
      Gets the list of Sord object which are the predecessors of the sord given by the objId.

      If csi.inclRefPaths is set, all the sord of the referenced paths are also returned.

      Parameters:
      ci - ClientInfo object with language, country and ticket.
      objId - Sord ID
      sordZ - Elements of sord to be stored into the database.
      csi - Options for this function
      Returns:
      The list of sords that lead to the sord given by the objId.
      Throws:
      byps.RemoteException - Exception with message text of format "[ELOIX:number] text". The number is one of the constants defined in IXExceptionC.
      Since:
      9.00.000.005

    • checkoutPreviewImageURLs

      PreviewImageResult checkoutPreviewImageURLs(ClientInfo ci, PreviewImageInfo previewImageInfo) throws byps.RemoteException
      Generates URLs for preview images of documents.
      Parameters:
      ci - ClientInfo object with language, country and ticket.
      previewImageInfo - PreviewImageInfo containing documentIds, page information, etc.
      Returns:
      Map from document id Strings to its corresponding PreviewImageResult.
      Throws:
      byps.RemoteException - Exception with message text of format "[ELOIX:number] text". The number is one of the constants defined in IXExceptionC. if the provided parameters were wrong or incomplete; during processing if a document format is not supported or the document itself is errorneous.
      Since:
      9.00.000.007

    • applyForNotifications

      ApplyForNotificationsInfo applyForNotifications(ClientInfo ci, ApplyForNotificationsInfo info) throws byps.RemoteException
      Specify, which notifications should be sent by the server.
      Parameters:
      ci - ClientInfo object with language, country and ticket.
      info - parameter object or null, if only the current settings should be returned.
      Returns:
      previous settings
      Throws:
      byps.RemoteException - Exception with message text of format "[ELOIX:number] text". The number is one of the constants defined in IXExceptionC.
      Since:
      9.00.000.012
      See Also:

    • getPublicDownloads

      List<PublicDownload> getPublicDownloads(ClientInfo ci, PublicDownloadOptions opts) throws byps.RemoteException
      Gets the public downloads.
      Parameters:
      ci - ClientInfo object with language, country and ticket.
      opts - PublicDownloadOptions object to get the downloads. If opts is null, the public downloads created by current user are returned.
      Returns:
      the public download list
      Throws:
      byps.RemoteException - Exception with message text of format "[ELOIX:number] text". The number is one of the constants defined in IXExceptionC.
      Since:
      9.00.000.019

    • terminatePublicDownloadUrls

      void terminatePublicDownloadUrls(ClientInfo ci, PublicDownloadOptions opts) throws byps.RemoteException
      Deletes the public downloads
      Parameters:
      ci - ClientInfo object with language, country and ticket.
      opts - PublicDownloadOptions object to delete the downloads. If opts is null, no download will be deleted.
      Throws:
      byps.RemoteException - Exception with message text of format "[ELOIX:number] text". The number is one of the constants defined in IXExceptionC.
      Since:
      9.00.000.019

    • editPublicDownloadUrls

      void editPublicDownloadUrls(ClientInfo ci, PublicDownloadOptions opts) throws byps.RemoteException
      Edits the public downloads
      Parameters:
      ci - ClientInfo object with language, country and ticket.
      opts - PublicDownloadOptions object to delete the downloads. If opts is null, no download will be edited. The remaining download and the expiration are editable.
      Throws:
      byps.RemoteException - Exception with message text of format "[ELOIX:number] text". The number is one of the constants defined in IXExceptionC.
      Since:
      9.00.012.003

    • resolveRights

      List<ResolveRightsResult> resolveRights(ClientInfo ci, UserInfo ui, ResolveRightsInfo info) throws byps.RemoteException
      Resolves the rights of a user.

      This function calculates the effective rights of a given user. Hereby, the given parameter userInfo will not be checked in. This way it is possible to set hypothetical groups for the user and retrieve the results of the change without applying them. The effective rights always are calculated for every right.

      The groups of the given users will be combined with the groups he already is a member of. This combination works like the logical "or" function. If you want the result without a specific group, ignore the corresponding ResolveRightsResult which has set ResolveRightsResult.type= ResolveRightsResultC.DIRECT.

      Parameters:
      ci - ClientInfo object with language, country and ticket.
      ui - UserInfo with username groups and rights. If the user does not yet exist, provide a (new, nonexisting) username and set id=-1.
      info - ResolveRightsInfo optional parameters.
      Returns:
      List of ResolveRightsResult for each right, the user got directly or by inheritance. Please note that the same right may appear more than one in this list as it is possible to inherit a right by multiple ways.
      Throws:
      byps.RemoteException - Exception with message text of format "[ELOIX:number] text". The number is one of the constants defined in IXExceptionC.
      Since:
      9.00.000.020

    • startAdHocWorkFlow2

      int startAdHocWorkFlow2(ClientInfo ci, String name, String objId, UserNodeInfo[] userNodeInfo, StartAdHocWorkflowInfo startWfInfo) throws byps.RemoteException
      Starts an Ad Hoc Workflow.
      Parameters:
      ci - ClientInfo object with language, country and ticket.
      name - Workflow name
      objId - ID of the object for which the workflow is started.
      userNodeInfo - The information of all user nodes in the workflow.
      startWfInfo - The parameters to pass to the workflow.
      Returns:
      Workflow ID
      Throws:
      byps.RemoteException - Exception with message text of format "[ELOIX:number] text". The number is one of the constants defined in IXExceptionC.
      Since:
      9.00.012.002

    • startAdHocWorkFlow3

      int startAdHocWorkFlow3(ClientInfo ci, String name, String objId, StartAdHocWorkflowInfo startWfInfo) throws byps.RemoteException
      Starts an Ad Hoc Workflow.
      Parameters:
      ci - ClientInfo object with language, country and ticket.
      name - Workflow name
      objId - ID of the object for which the workflow is started.
      startWfInfo - The parameters to pass to the workflow.
      Returns:
      Workflow ID
      Throws:
      byps.RemoteException - Exception with message text of format "[ELOIX:number] text". The number is one of the constants defined in IXExceptionC.
      Since:
      10.00.000.008

    • insertPublicDownload

      PublicDownload insertPublicDownload(ClientInfo ci, PublicDownloadOptions opts) throws byps.RemoteException
      Creates and inserts a new public download
      Parameters:
      ci - ClientInfo object with language, country and ticket.
      opts - PublicDownloadOptions object to create the downloads.
      Throws:
      byps.RemoteException - Exception with message text of format "[ELOIX:number] text". The number is one of the constants defined in IXExceptionC.
      Since:
      9.00.014.003

    • createSubscription

      Subscription createSubscription(ClientInfo ci, String watchGuid) throws byps.RemoteException
      Initialize a subscription object.
      Parameters:
      ci - ClientInfo object with language, country and ticket.
      watchGuid - GUID of object to be watched.
      Returns:
      Subscription
      Throws:
      byps.RemoteException - Exception with message text of format "[ELOIX:number] text". The number is one of the constants defined in IXExceptionC.

    • checkinSubscription

      Subscription checkinSubscription(ClientInfo ci, Subscription subs, SubscriptionZ subsZ) throws byps.RemoteException
      Add a subscription.
      Parameters:
      ci - ClientInfo object with language, country and ticket.
      subs - Subscription
      subsZ - Bitset of valid elements, must be SubscriptionC.mbAll
      Returns:
      Subscription
      Throws:
      byps.RemoteException - Exception with message text of format "[ELOIX:number] text". The number is one of the constants defined in IXExceptionC.
      Since:
      9.00.014.003

    • deleteSubscription

      void deleteSubscription(ClientInfo ci, Subscription subs) throws byps.RemoteException
      Delete a subscription.
      Parameters:
      ci - ClientInfo object with language, country and ticket.
      subs - Subscription.
      Throws:
      byps.RemoteException - Exception with message text of format "[ELOIX:number] text". The number is one of the constants defined in IXExceptionC.
      Since:
      9.00.014.003

    • findFirstSubscriptions

      FindResult findFirstSubscriptions(ClientInfo ci, FindSubscriptionInfo findInfo, int max, SubscriptionZ subsZ) throws byps.RemoteException
      Find first max subscriptions. This function finds the subscriptions of the current user.
      Parameters:
      ci - ClientInfo object with language, country and ticket.
      findInfo -
      max -
      subsZ - Bitset of valid elements, must be SubscriptionC.mbAll
      Returns:
      FindResult
      Throws:
      byps.RemoteException - Exception with message text of format "[ELOIX:number] text". The number is one of the constants defined in IXExceptionC.
      Since:
      9.00.014.003

    • findNextSubscriptions

      FindResult findNextSubscriptions(ClientInfo ci, String searchId, int idx, int max, SubscriptionZ subsZ) throws byps.RemoteException
      Find next max subscriptions beginning at index idx.
      Parameters:
      ci - ClientInfo object with language, country and ticket.
      searchId - Search-ID returned from previous call to findFirstSubscriptions(ClientInfo, FindSubscriptionInfo, int, SubscriptionZ)
      idx - Return results starting at this index.
      max - Return not more than this number of results.
      subsZ - Bitset of valid elements, must be SubscriptionC.mbAll
      Returns:
      FindResult
      Throws:
      byps.RemoteException - Exception with message text of format "[ELOIX:number] text". The number is one of the constants defined in IXExceptionC.
      Since:
      9.00.014.003

    • findFirstNotes

      FindResult findFirstNotes(ClientInfo ci, FindInfo findInfo, int max, NoteZ noteZ) throws byps.RemoteException
      Find first notes. This function starts a search for Note object and returns the first objects found in FindResult.notes. At least FindInfo.findByNotes must be set. The member FindInfo.findChildren optionally constrain the results to a folder. The search must be closed with findClose(ClientInfo, String) in order to release internally cached data.
      Parameters:
      ci - ClientInfo object with language, country and ticket.
      findInfo - FindInfo object that contains the search criterias.
      max - Return up to this number of result objects.
      noteZ - Element selector for Note objects.
      Returns:
      FindResult object
      Throws:
      byps.RemoteException - Exception with message text of format "[ELOIX:number] text". The number is one of the constants defined in IXExceptionC.
      Since:
      9.00.016.003
      See Also:

    • findNextNotes

      FindResult findNextNotes(ClientInfo ci, String searchId, int idx, int max, NoteZ noteZ) throws byps.RemoteException
      Find next notes. This function continues a search for Note objects startet with function findFirstNotes(ClientInfo, FindInfo, int, NoteZ).
      Parameters:
      ci - ClientInfo object with language, country and ticket.
      searchId - Search ID from FindResult.searchId
      idx - Start index in the result set.
      max - Return up to this number of result objects.
      noteZ - Element selector for Note objects.
      Returns:
      FindResult object.
      Throws:
      byps.RemoteException - Exception with message text of format "[ELOIX:number] text". The number is one of the constants defined in IXExceptionC.
      Since:
      9.00.016.003
      See Also:

    • checkinReport

      void checkinReport(ClientInfo ci, ReportInfo report, CheckinReportInfo reserved, LockZ lockZ) throws byps.RemoteException
      Inserts custom report entries.

      This function writes new entries into the report table. These entries always are appended to the report table. Once in the report table, no data will be overwritten by this function. The ReportInfo element must provide an action number ReportInfo.actionNo at least. The action number has to be within the range ReportInfoC.ACT_CUSTOM_FIRST and ReportInfoC.ACT_CUSTOM_LAST. Besides the action number, the report entry can hold custom data in the fields objId, extra1, extra2, text and extraInfo. If specified, the object in extraInfo must be Serializable. If the report entry to insert does not belong to a Sord, set the objId value to 0.

      Parameters:
      ci - ClientInfo object with language, country and ticket.
      report - The report to write.
      reserved - This parameter must be null.
      Throws:
      byps.RemoteException - Exception with message text of format "[ELOIX:number] text". The number is one of the constants defined in IXExceptionC.
      Since:
      9.00.016.006
      See Also:

    • linkSords2

      void linkSords2(ClientInfo ci, String fromId, String[] toIds, LinkSordZ linkSordZ, LinkSordInfo linkSordInfo) throws byps.RemoteException
      Links archive entries like linkSords(de.elo.ix.client.ClientInfo, java.lang.String, java.lang.String[], de.elo.ix.client.LinkSordZ).

      This method provides the additional parameter LinkSordInfo to specify more options for linking sords together.

      Parameters:
      ci - ClientInfo object with language, country and ticket
      fromId - Object ID or GUID the links start from.
      toIds - Object IDs or GUIDs the links point to.
      linkSordZ - Controls how the objects are connected. If null or LinkSordC.PAIR, the function builds pairs of linked objects from fromId to toIds[.]. E.g. {fromId, toIds[0]}, {fromId, toIds[1]}. If LinkSordC.CROSS_LINK is passed, the function builds a cross-link with the associations: {fromId, toIds[0]}, { fromId, toIds[1] }, {toIds[0], toIds[1]}.
      linkSordInfo - Controls link generation.
      Throws:
      byps.RemoteException - Exception with message text of format "[ELOIX:number] text". The number is one of the constants defined in IXExceptionC.
      Since:
      9.00.016.008
      See Also:

    • getWebDAVPathFromObjID

      String getWebDAVPathFromObjID(ClientInfo ci, String objId) throws byps.RemoteException
      Returns the WebDAV path from an Object ID.
      Parameters:
      ci - ClientInfo object with language, country and ticket
      objId - ObjectId or GUID of the sord to get the path.
      Returns:
      WebDAV path of the give Object ID.
      Throws:
      byps.RemoteException - Exception with message text of format "[ELOIX:number] text". The number is one of the constants defined in IXExceptionC.
      Since:
      9.00.016.010

    • getWebDAVPathFromObjID2

      GetWebDAVPathResult getWebDAVPathFromObjID2(ClientInfo ci, GetWebDAVPathOptions options) throws byps.RemoteException
      Returns the WebDAV path from an Object ID.
      Parameters:
      ci - ClientInfo object with language, country and ticket
      options - GetWebDAVPathOptions object
      Returns:
      GetWebDAVPathResult object which contains the WebDAV path
      Throws:
      byps.RemoteException - Exception with message text of format "[ELOIX:number] text". The number is one of the constants defined in IXExceptionC.
      Since:
      9.00.030.024

    • checkoutWorkflowHistory

      CheckoutWorkflowHistoryResult checkoutWorkflowHistory(ClientInfo ci, CheckoutWorkflowHistoryParams checkoutWorkflowHistoryParams) throws byps.RemoteException
      Reads the histories of a node or a whole workflow.
      Parameters:
      ci - ClientInfo object with language, country and ticket
      checkoutWorkflowHistoryParams - workflow Guid
      Returns:
      CheckoutWorkflowHistoryResult object
      Throws:
      byps.RemoteException - Exception with message text of format "[ELOIX:number] text". The number is one of the constants defined in IXExceptionC.
      Since:
      9.00.030.018

    • checkinDocMaskLineTemplate

      int checkinDocMaskLineTemplate(ClientInfo ci, DocMaskLineTemplate dmlt, DocMaskLineTemplateZ dmltZ, CheckInDocMaskLineTemplateOptions options, LockZ lockZ) throws byps.RemoteException
      Writes a keyword template into the database. If this keyword template is already used in keywording forms, these keywording forms will be updated. This function requires ELO 10 license.
      Parameters:
      ci - ClientInfo object with language, country and ticket.
      dmlt - Template object.
      dmltZ - Members to be written
      options - Options object
      lockZ - Unlock template or force access.
      Throws:
      byps.RemoteException - Exception with message text of format "[ELOIX:number] text". The number is one of the constants defined in IXExceptionC. Exception with message text of format "[ELOIX:number] text".
      Since:
      9.99.009.002

    • checkoutDocMaskLineTemplates

      DocMaskLineTemplate[] checkoutDocMaskLineTemplates(ClientInfo ci, String[] groups, DocMaskLineTemplateZ dmltZ, LockZ lockZ) throws byps.RemoteException
      Check out keyword templates. This function requires ELO 10 license.
      Parameters:
      ci - ClientInfo object with language, country and ticket.
      groups - Groups to be checked out. If groups is null, all template are checked out.
      dmltZ - Member to be read.
      lockZ - Unlock templates.
      Returns:
      Keyword templates
      Throws:
      byps.RemoteException - Exception with message text of format "[ELOIX:number] text". The number is one of the constants defined in IXExceptionC. Exception with message text of format "[ELOIX:number] text".
      Since:
      9.99.009.002

    • deleteDocMaskLineTemplates

      void deleteDocMaskLineTemplates(ClientInfo ci, String[] groups, LockZ unlockZ) throws byps.RemoteException
      Delete keyword templates This function requires ELO 10 license.
      Parameters:
      ci - ClientInfo object with language, country and ticket.
      groups - Groups to be deleted.
      unlockZ - Unlock template or force access
      Throws:
      byps.RemoteException - Exception with message text of format "[ELOIX:number] text". The number is one of the constants defined in IXExceptionC. Exception with message text of format "[ELOIX:number] text".
      Since:
      9.99.009.002

    • beginForwardWorkflowNode

      WFEditNode beginForwardWorkflowNode(ClientInfo ci, int flowId, int nodeId, BeginForwardWorkflowNodeInfo fwdInfo, LockZ lockZ) throws byps.RemoteException
      Prepare forwarding of a workflow node. Use this function to lock a workflow and get the data required for forwarding a node.
      Parameters:
      ci - ClientInfo object with language, country and ticket.
      flowId - Workflow ID
      nodeId - Workflow node ID. The node must be active and assigned to the current user.
      fwdInfo - reserved, must be null
      lockZ - Lock workflow
      Returns:
      Node data
      Throws:
      byps.RemoteException
      Since:
      9.99.009.005

    • forwardWorkflowNode

      ForwardWorkflowNodeResult forwardWorkflowNode(ClientInfo ci, int flowId, int nodeId, ForwardWorkflowNodeInfo fwdInfo, LockZ unlockZ) throws byps.RemoteException
      Forward a workflow node, terminate a workflow or modify node data.
      Example 1: Forward a workflow node: 
       
 // Lock workflow and read node data
 WFEditNode editNode = conn.ix().beginForwardWorkflowNode(flowId, nodeId, null, LockC.IF_FREE);
 // Select successor nodes to be activated
 // Make sure to select only one successor if: (editNode.getNode().getFlags() & WFNodeC.FLAG_ONE_SUCCESSOR) != 0
 List succNodes = Arrays.asList(editNode.getSuccNodes()[0].getId());
 // Optionally: change node name and comment
 WFNode activeNode = editNode.getNode();
 activeNode.setName("new name");
 activeNode.setComment("new comment");
 // Forward
 ForwardWorkflowNodeInfo fwdInfo = new ForwardWorkflowNodeInfo();
 fwdInfo.setNode(activeNode);
 fwdInfo.setSuccessorNodesToActivate(succNodes); 
 connU.ix().forwardWorkflowNode(flowId, nodeId, fwdInfo, LockC.YES);
      Example 2: Cancel forwarding after beginForwardWorkflowNode has locked the workflow 
       
 // Lock workflow and read node data
 WFEditNode editNode = conn.ix().beginForwardWorkflowNode(flowId, nodeId, null, LockC.IF_FREE);
 // Cancel forward
 ForwardWorkflowNodeInfo fwdInfo = null;
 connU.ix().forwardWorkflowNode(flowId, nodeId, fwdInfo, LockC.YES);
      Example 3: Change node priority, name and comment 
       
 // Lock workflow 
 WFEditNode editNode = conn.ix().beginForwardWorkflowNode(flowId, nodeId, null, LockC.IF_FREE);
 // Change node priority, name and comment
 WFNode activeNode = editNode.getNode();
 activeNode.setPrio(UserTaskPriorityC.HIGHEST);
 activeNode.setName("new name");
 activeNode.setComment("new comment");
 // Update node and unlock
 ForwardWorkflowNodeInfo fwdInfo = new ForwardWorkflowNodeInfo();
 fwdInfo.setNode(activeNode);
 connU.ix().forwardWorkflowNode(flowId, nodeId, fwdInfo, LockC.YES);
      Parameters:
      ci - ClientInfo object with language, country and ticket.
      flowId - Workflow ID
      nodeId - Workflow node ID. The node must be active and assigned to the current user.
      fwdInfo - reserved, must be null
      unlockZ - Unlock worfklow
      Returns:
      reserved
      Throws:
      byps.RemoteException - Exception with message text of format "[ELOIX:number] text". The number is one of the constants defined in IXExceptionC. Exception with message text of format "[ELOIX:number] text".
      Since:
      9.99.009.005

    • findFirstUsers

      FindResult findFirstUsers(ClientInfo ci, FindUserInfo findUserInfo, int max) throws byps.RemoteException
      Find user data. This function allows to find users by their name, description, or one of their properties. Wildcards can be used as defined in the session options, see SessionOptionsC.DB_WILDCARDS. Example: 
       
 FindUserInfo findUserInfo = new FindUserInfo();
 findUserInfo.setName("testFind?sers-*");
 int idx = 0, max = 100;
 FindResult fr = conn.ix().findFirstUsers(findUserInfo, max);
 try {
   while (true) {
     for (UserName userName : fr.getUserNames().values()) {
       // process userName object
     }
    
     if (!fr.isMoreResults()) break;
   
     idx += fr.getUserNames().length;
     fr = conn.ix().findNextUsers(fr.getSearchId(), idx, max);
   }
 }
 catch (RemoteException e) {
   // process exception
   throw e;
 }
 finally {
   conn.ix().findClose(fr.getSearchId());
 }
      Additionally, FindResult#sortedResult returns a sorted list of either UserInfo or UserName objects, depending on FindUserInfo.returnUserInfoMap.
      Parameters:
      ci - ClientInfo object with language, country and ticket
      findUserInfo - Search criteria.
      max - Maximum number of users to return.
      Returns:
      FindResult object.
      Throws:
      byps.RemoteException - Exception with message text of format "[ELOIX:number] text". The number is one of the constants defined in IXExceptionC. Exception with message text of format "[ELOIX:number] text".
      Since:
      9.00.050.001

    • findNextUsers

      FindResult findNextUsers(ClientInfo ci, String searchId, int idx, int max) throws byps.RemoteException
      Find next user data.
      Parameters:
      ci - ClientInfo object with language, country and ticket
      searchId - Search ID received from the FindResult.searchId returned from findFirstUsers(ClientInfo, FindUserInfo, int).
      idx - Start index.
      max - Maximum number of users to return.
      Returns:
      FindResult object.
      Throws:
      byps.RemoteException - Exception with message text of format "[ELOIX:number] text". The number is one of the constants defined in IXExceptionC. Exception with message text of format "[ELOIX:number] text".
      Since:
      9.00.050.001

    • checkLicense

      LicenseResult checkLicense(ClientInfo ci, LicenseInfo licenseInfo) throws byps.RemoteException
      Check licensing information. This function checks the given license information using proprietary algorithms.
      Parameters:
      ci - ClientInfo object with language, country and ticket
      licenseInfo - License information.
      Returns:
      Reserved.
      Throws:
      byps.RemoteException - If the license information is invalid, this function throws an exception with code IXExceptionC.ACCESS_DENIED.
      Since:
      10.17.010.002

    • moveDocuments

      JobState moveDocuments(ClientInfo ci, MoveDocumentsInfo moveDocumentsInfo) throws byps.RemoteException
      Move documents from one storage path to another storage path.
      Parameters:
      ci - ClientInfo object with language, country and ticket
      moveDocumentsInfo - Parameter of this function.
      Returns:
      Background job state
      Throws:
      byps.RemoteException
      Since:
      10.17.059.002

    • startWorkFlow2

      int startWorkFlow2(ClientInfo ci, String objId, StartWorkflowInfo startWorkflowInfo) throws byps.RemoteException
      Starts a workflow from a workflow template.
      Parameters:
      ci - ClientInfo object with language, country and ticket.
      objId - ID of the object for which the workflow is started.
      startWorkflowInfo - Parameter of this function
      Returns:
      workflow ID
      Throws:
      byps.RemoteException - Exception with message text of format "[ELOIX:number] text". The number is one of the constants defined in IXExceptionC.
      Since:
      10.99.999.029

    • checkoutEsStatus

      ESStatusObj checkoutEsStatus(ClientInfo ci) throws byps.RemoteException
      Checkout status of iSearch and updaters and reindexers, for ESConfigPage only.
      Parameters:
      ci - - ClientInfo object with language, country and ticket.
      Returns:
      ESStatusObj
      Throws:
      byps.RemoteException
      Since:
      11.00.000.022

    • checkoutEsInfo

      ESInfoObj checkoutEsInfo(ClientInfo ci) throws byps.RemoteException
      Check out the ElasticSearch informations for ESConfigPage only. Note: For internal use only. Might change in the near future.
      Parameters:
      ci - - ClientInfo object with language, country and ticket.
      Returns:
      ESInfoObj
      Throws:
      byps.RemoteException
      Since:
      11.00.000.008

    • checkoutEsSettings

      ESSettingsObj checkoutEsSettings(ClientInfo ci) throws byps.RemoteException
      Check out the ElasticSearch settings for ESConfigPage only. Note: For internal use only. Might change in the near future.
      Parameters:
      ci - ClientInfo object with language, country and ticket.
      Returns:
      ESSettingsObj
      Throws:
      byps.RemoteException
      Since:
      11.00.000.044

    • checkinEsSettings

      ESSettingsObj checkinEsSettings(ClientInfo ci, ESSettingsObj settings) throws byps.RemoteException
      Check in ElasticSearch settings for ESConfigPage only. Note: For internal use only. Might change in the near future.
      Parameters:
      ci - ClientInfo object with language, country and ticket.
      settings -
      Throws:
      byps.RemoteException
      Since:
      11.00.000.044

    • runEsProcess

      boolean runEsProcess(ClientInfo ci, String processName, boolean startProcess) throws byps.RemoteException
      Run a iSearch process now (if it is not running) or interrupt it if its running.
      Parameters:
      ci - ClientInfo object with language, country and ticket.
      processName - either "update" or "reindex"
      startProcess - true if process should be started, false if process should be interrupted
      Returns:
      true if process was changes status was changes, else false
      Throws:
      byps.RemoteException
      Since:
      11.00.000.024

    • checkinSubstitutions

      SubstitutionsResult checkinSubstitutions(ClientInfo ci, CheckinSubstitutionsInfo checkinSubstitutionsInfo, SubstitutionZ substitutionZ, LockZ unlockZ) throws byps.RemoteException
      Insert new substitutions or update existing ones.

      New substitutions are added if Substitution.guid is empty, existing ones are updated if Substitution.guid is set.

      The current user is allowed to create a substitution where Substitution.user is user A, if:

      • The current user is user A
      • The current user is a sub administrator of A
      • The current user is a direct superior of A (ignoring groups, UserInfo.superiorId of A must be the current user)
      • The current user has main administrator rights.

      The current user is allowed to change a substitution where Substitution.user is user A, if:

      • The current user is a sub administrator of A
      • The current user is a direct superior of A (ignoring groups, UserInfo.superiorId of A must be the current user)
      • The current user has main administrator rights.
      • The current user created the substitution (Substitution.creatorId
      Parameters:
      ci - ClientInfo object with language, country and ticket.
      checkinSubstitutionsInfo - Substitutions to be checked in
      substitutionZ - Determines, which members of Substitution to save
      unlockZ - unlock substitutions
      Returns:
      GUIDs of checked in substitutions in SubstitutionsResult.substitutionGuids, SubstitutionsResult.substitutions is empty.
      Throws:
      byps.RemoteException - If the current user is not allowed to checkin any of the provided substitutions, a IXExceptionC.ACCESS_DENIED exception is thrown and none are saved.
      Since:
      12.00.000.008

    • checkoutSubstitutions

      SubstitutionsResult checkoutSubstitutions(ClientInfo ci, CheckoutSubstitutionsInfo checkoutSubstitutionsInfo, SubstitutionZ substitutionZ, LockZ lockZ) throws byps.RemoteException
      Checkout substitutions.

      Substitutions are checked out by the provided CheckoutSubstitutionsInfo and the selected members in SubscriptionZ are returned.

      Every user is allowed to checkout any substitution.

      Parameters:
      ci - ClientInfo object with language, country and ticket.
      checkoutSubstitutionsInfo - Define which substitutions should be returned.
      substitutionZ - Determines, which members of Substitution to return
      lockZ - Lock substitutions
      Returns:
      List of substitutions
      Throws:
      byps.RemoteException
      Since:
      12.00.000.008

    • deleteSubstitutions

      boolean deleteSubstitutions(ClientInfo ci, DeleteSubstitutionsInfo deleteSubstitutionsInfo, LockZ unlockZ) throws byps.RemoteException
      Delete substitutions by its GUIDs.

      The current user is allowed to delete a substitution where Substitution.user is user A, if:

      • The current user created the substitution (Substitution.creatorId
      • The current user is a sub administrator of A
      • The current user is a direct superior of A (ignoring groups, UserInfo.superiorId of A must be the current user)
      • The current user has main administrator rights.
      Parameters:
      ci - ClientInfo object with language, country and ticket.
      deleteSubstitutionsInfo - Determines which substitutions should be deleted
      unlockZ - Unlock substitutions before deleting it. A substitution can only be deleted if it is unlocked or locked by the current user. LockC.FORCE can only be used by a user with main administrator rights.
      Returns:
      true if deleting was successful, false if not
      Throws:
      byps.RemoteException - If the current user is not allowed to delete any of the provided substitutions, a IXExceptionC.ACCESS_DENIED exception is thrown and none are deleted.
      Since:
      12.00.000.008

    • activateSubstitution

      boolean activateSubstitution(ClientInfo ci, String substitutionGuid, LockZ unlockZ) throws byps.RemoteException
      Activate the submitted substitution.

      Activates a submitted substitution if it the substitution can be activated manually (Substitution's SubstitutionSettings.canBeActivatedManually must be set to true) and it is outside of any substitution period (defined in Substitution.substitutionPeriods

      A substitution can be activated by the current user, if:

      • The current user is the substitute (Substitution.substituteId
      • The current user is member of the group who is the substitute
      • The current user is sub administrator of the substitute
      • The current user is the direct superior of the substitute (ignoring groups, UserInfo.superiorId of the substitute must be the current user)
      • The current user has main administrator rights.
      Parameters:
      ci - ClientInfo object with language, country and ticket.
      substitutionGuid - GUID of substitution to be activated
      unlockZ - Unlock substitution before activating it. A substitution can only be activated if it is unlocked or locked by the current user. LockC.FORCE can only be used by a user with main administrator rights.
      Returns:
      true if activation was successful, else false
      Throws:
      byps.RemoteException -
      • If the current user is not allowed to activate the provided substitution, a IXExceptionC.ACCESS_DENIED exception is thrown.
      • If it is not possible to activate the provided substitution (the substitution is already activated or it is not allowed to activate the substitution manually) a IXExceptionC.PROHIBITED_OPERATION exception is thrown.
      Since:
      12.00.000.008

    • deactivateSubstitution

      boolean deactivateSubstitution(ClientInfo ci, String substitutionGuid, LockZ unlockZ) throws byps.RemoteException
      Deactivate the submitted substitution.

      Deactivates a submitted substitution if the substitution was activated manually (Substitution's SubstitutionSettings.canBeActivatedManually must be set to true) and it is outside of any substitution period (defined in Substitution.substitutionPeriods

      A substitution can be deactivated by the current user, if:

      • The current user is the substitute (Substitution.substituteId
      • The current user is member of the group who is the substitute
      • The current user is sub administrator of the substitute
      • The current user is the direct superior of the substitute (ignoring groups, UserInfo.superiorId of the substitute must be the current user)
      • The current user has main administrator rights.
      Parameters:
      ci - ClientInfo object with language, country and ticket.
      substitutionGuid - GUID of substitution to be deactivated
      unlockZ - Unlock substitution before deactivating it. A substitution can only be deactived if it is unlocked or locked by the current user. LockC.FORCE can only be used by a user with main administrator rights.
      Returns:
      true if deactivation was successful, else false
      Throws:
      byps.RemoteException -
      Since:
      12.00.000.008

    • createSuperiorSubstitution

      String createSuperiorSubstitution(ClientInfo ci, CreateSuperiorSubstitutionInfo createSuperiorSubstitutionInfo) throws byps.RemoteException
      Create a Substitution as a superior.

      A superior is able to substitute any of his users (he must be the direct superior (ignoring groups, UserInfo.superiorId of the user to be substituted must be the current user).

      The created substitution grants the superior access to the user's postbox, can be forwarded and can be activated manually, but does not have any SubstitutionPeriods set. It also contains a flag to show its a superior substituion (SubstitutionSettings.superiorSubstitution is set to true.

      The created substitution is saved, but is not yet active. It can be activated by adding SubstitutionPeriod or calling activateSubstitution(de.elo.ix.client.ClientInfo, java.lang.String, de.elo.ix.client.LockZ).

      Parameters:
      ci - ClientInfo object with language, country and ticket.
      createSuperiorSubstitutionInfo - Object to define the superior substitution
      Returns:
      created GUID of the created substitution
      Throws:
      byps.RemoteException - If the current user is not allowed to create the desired superior substitution, a IXExceptionC.ACCESS_DENIED exception is thrown.
      Since:
      12.00.000.008

    • forwardSubstitution

      String forwardSubstitution(ClientInfo ci, ForwardSubstitutionInfo forwardSubstitutionInfo, LockZ unlockZ) throws byps.RemoteException
      Forward or transfer a substitution to an other user.

      A substitution can be forwarded or transfered to an other user if SubstitutionSettings.canBeForwarded is set to true and the current user is allowed to forward the substitution.

      Define how the substitution is forwarded by setting the corresponding parameters in ForwardSubstitutionInfo.

      The current user is allowed to forward a substitution, if:

      • The current user is the substitute (Substitution.substituteId
      • The current user is member of the group who is the substitute
      • The current user is sub administrator of the substitute
      • The current user is the direct superior of the substitute (ignoring groups, UserInfo.superiorId of the substitute must be the current user)
      • The current user has main administrator rights.
      Parameters:
      ci - ClientInfo object with language, country and ticket.
      forwardSubstitutionInfo - Object to define how to forward the substitution
      unlockZ - Unlock substitution before forwarding it. A substitution can only be forwarded if it is unlocked or locked by the current user. LockC.FORCE can only be used by a user with main administrator rights
      Returns:
      the GUID of the new substitution
      Throws:
      byps.RemoteException -
      Since:
      12.00.000.008

    • configureLicense

      License configureLicense(ClientInfo ci, String licenseFileContent) throws byps.RemoteException
      Read or update license information.
      Parameters:
      ci - ClientInfo object with language, country and ticket.
      licenseFileContent - License file content. If null or empty, read current license information.
      Returns:
      Decoded license data.
      Throws:
      byps.RemoteException - IXExceptionC.INVALID_PARAM if license information is not valid.
      Since:
      12.00.000.038

    • computeDocumentHash

      ComputeDocumentHashResult computeDocumentHash(ClientInfo ci, ComputeDocumentHashInfo computeInfo) throws byps.RemoteException
      Compute the hash value of an archived document.
      Parameters:
      ci - ClientInfo object with language, country and ticket.
      computeInfo - An object that defines the document ID.
      Returns:
      Computation result
      Throws:
      byps.RemoteException
      Since:
      12.00.000.040

    • checkoutColors2

      ColorData[] checkoutColors2(ClientInfo ci, int options, LockZ lockZ) throws byps.RemoteException
      Checkout the markers definitions (colors of archive entries) for administration purposes. This function returns all colors, inclusive hidden and deleted colors.
      Parameters:
      ci - ClientInfo object with language, country and ticket
      options - A combination of ColorDataC.INCLUSIVE_DELETED and ColorDataC.INCLUSIVE_HIDDEN. Pass ColorDataC.ALL_COLORS to receive all existing colors.
      lockZ - Lock against concurrent modification.
      Returns:
      Array of Color objects sorted by name
      Throws:
      byps.RemoteException - Exception with message text of format "[ELOIX:number] text". The number is one of the constants defined in IXExceptionC. Exception with message text of format "[ELOIX:number] text".
      Since:
      20.00.000.001

    • createAspect

      Aspect createAspect(ClientInfo ci, String name, List<AspectLine> lines) throws byps.RemoteException
      Initialize an Aspect object. Note: The name and type of an aspect line is fixed with the initial value during the first check in and cannot be changed later.
      Parameters:
      ci - ClientInfo object with language, country and ticket.
      name - Optional. This name is converted to upper case and used as aspect name.
      lines - Optional. The objects of this list are completed with default values before they and are added to Aspect.lines in the returned object.
      Returns:
      Initialized object.
      Throws:
      byps.RemoteException
      Since:
      20.00.000.100

    • checkoutAspect

      Aspect checkoutAspect(ClientInfo ci, String aspectId, AspectZ aspectZ, LockZ lockZ) throws byps.RemoteException
      Read and maybe lock an Aspect object. An exception is thrown, if access is denied or if the aspect does not exist.
      Parameters:
      ci - ClientInfo object with language, country and ticket.
      aspectId - Numeric ID, GUID or name of the aspect to read.
      aspectZ - Members to be read.
      lockZ - Lock mode.
      Returns:
      Aspect object.
      Throws:
      byps.RemoteException
      Since:
      20.00.000.100

    • checkoutAspects

      List<Aspect> checkoutAspects(ClientInfo ci, List<String> aspectIds, AspectZ aspectZ, LockZ lockZ) throws byps.RemoteException
      Read and maybe lock a list of Aspect objects (EIX-2437). An exception is thrown, if access is denied or if one of the aspects does not exist.
      Parameters:
      ci - ClientInfo object with language, country and ticket.
      aspectIds - List of numeric IDs, GUIDs or names of the aspects to read.
      aspectZ - Members to be read.
      lockZ - Lock mode.
      Returns:
      List of Aspect objects.
      Throws:
      byps.RemoteException
      Since:
      21.00.000.024

    • checkinAspect

      int checkinAspect(ClientInfo ci, Aspect aspect, AspectZ aspectZ, LockZ unlockZ) throws byps.RemoteException
      Update or insert an Aspect object. This function requires permission AccessC.FLAG_EDITMASK. An exception is thrown, if access is denied or if the aspect does not exist. Note: The name and type of an aspect line is fixed with the initial value during the first check in and cannot be changed later.
      Parameters:
      ci - ClientInfo object with language, country and ticket.
      aspect - Aspect object.
      aspectZ - Members to be written.
      unlockZ - Remove lock using this mode.
      Returns:
      Aspect ID
      Throws:
      byps.RemoteException
      Since:
      20.00.000.100

    • deleteAspect

      boolean deleteAspect(ClientInfo ci, String aspectId, LockZ unlockZ) throws byps.RemoteException
      Delete an Aspect object. This function requires permission AccessC.FLAG_EDITMASK. An exception is thrown, if access is denied or if the aspect does not exist.
      Parameters:
      ci - ClientInfo object with language, country and ticket.
      aspectId - Numeric ID, GUID or name of the aspect to read.
      unlockZ - Remove lock using this mode.
      Returns:
      If aspect not found the return value is false.
      Throws:
      byps.RemoteException
      Since:
      20.00.000.100

    • createAspectMask

      DocMask createAspectMask(ClientInfo ci, String name, List<AspectAssoc> aspectAssocs) throws byps.RemoteException
      Initializes a DocMask object as a keywording form for aspects. Use checkinDocMask(ClientInfo, DocMask, DocMaskZ, LockZ) to store the keywording form in the database. Note that the name of an aspect association can be set only initially. Aspect associations cannot be renamed via checkinDocMask.
      Parameters:
      ci - ClientInfo object with language, country and ticket.
      name - Keywording form name.
      aspectAssocs - Aspect associations. This objects are completed by default values and added to DocMask.localAspectAssocs in the returned object.
      Returns:
      DocMask object.
      Throws:
      byps.RemoteException
      Since:
      20.00.000.100

    • createAspectAssoc

      AspectAssoc createAspectAssoc(ClientInfo ci, String name, String aspectId, Cardinality cardinality) throws byps.RemoteException
      Initializes an AspectAssoc object. All parameters are mandatory.
      Parameters:
      ci - ClientInfo object with language, country and ticket.
      name - Aspect association name.
      aspectId - Aspect name or ID.
      cardinality - Aspect cardinality.
      Returns:
      AspectAssoc object.
      Throws:
      byps.RemoteException
      Since:
      20.00.000.100