Serialized Form

  • Package de.elo.ix.client

    • Class de.elo.ix.client.AccessC

      class AccessC extends Object implements Serializable
      serialVersionUID:
      384025970L
    • Class de.elo.ix.client.AclAccessInfo

      class AclAccessInfo extends Object implements Serializable
      serialVersionUID:
      11569337L
      • Serialized Fields

        • acl
          String acl
        • aclItems
          AclItem[] aclItems
        • objId
          String objId
        • parentId
          String parentId
          Parent's ID of the current object. (Useful to get the inherited ACLs of objects which haven't any ID yet, i.e. the ones being just added in archive.)
          Since:
          8.00.032.010
    • Class de.elo.ix.client.AclAccessResult

      class AclAccessResult extends Object implements Serializable
      serialVersionUID:
      200528028L
      • Serialized Fields

        • access
          int access
    • Class de.elo.ix.client.AclItem

      class AclItem extends ValueClass implements Serializable
      serialVersionUID:
      1255072841L
      • Serialized Fields

        • access
          int access
          Access mode. Bitset of LUR_*.
          See Also:
        • andGroups
          IdName[] andGroups
          Only valid for group items. Contains the IDs and names of additional groups. The user has to be a member in each of this groups to be able to access the object.
          Since:
          7.00.000.005
        • id
          int id
          ID of user, group, key.
        • name
          String name
          Name of user, group, key.
        • type
          int type
          Item type: user, group, key, ...
    • Class de.elo.ix.client.AclItemC

      class AclItemC extends Object implements Serializable
      serialVersionUID:
      1507233874L
      • Serialized Fields

        • ACL_EVERYONE
          AclItem[] ACL_EVERYONE
          ACL items for group "Everyone" with full access.
          Since:
          7.00.000.013
        • ACL_EVERYONE_RAW
          String ACL_EVERYONE_RAW
          String representation of an ACL entry for group "Everyone" with full access.
          Since:
          7.00.000.013
    • Class de.elo.ix.client.Activity

      class Activity extends ValueClass implements Serializable
      serialVersionUID:
      460199434L
      • Serialized Fields

        • backAt
          String backAt
          Date when activity object was returned, ISO format. This value does not contain a time portion.
        • backMode
          String backMode
          Application defined purpose.
        • comment
          String comment
          Comment for the activity.
        • destination
          String destination
          Application defined purpose.
        • dueDateIso
          String dueDateIso
          Date when activity object is expected to be returned. This value does not contain a time portion.
        • fileName
          String fileName
          Application defined purpose.
        • guid
          String guid
          GUID of the activity object.
        • name
          String name
          Short name/description of the activity object.
        • objGuid
          String objGuid
          GUID of the assigned archive entry.
        • objId
          int objId
          Object ID of the associated folder or document. Read-only.
          Since:
          8.00.018.001
        • objType
          int objType
          Object type of the associated folder or document. Read-only.
          Since:
          8.00.018.001
        • prio
          int prio
          Priority for the activity. Priority A has value 0, UserTaskPriorityC.HIGHEST Priority B has value 1. Priority C has value 2, UserTaskPriorityC#LOWEST
          See Also:
        • project
          String project
          Project name for the activity.
        • receiverId
          int receiverId
          The ID of the recipient.
        • receiverName
          String receiverName
          Activity was created for this user. Readonly.
        • revVers
          String revVers
          Revision version of the activity object.
        • senderId
          int senderId
          ID of the user who created the activity.
        • senderName
          String senderName
          Activity was created by this user. Readonly.
        • sentAtIso
          String sentAtIso
          Date the activity was sent in ISO format. This value does not contain a time portion.
        • sentMode
          String sentMode
          Application defined purpose.
        • transId
          String transId
          Application defined value.
          Since:
          8.00.012.001
        • TStamp
          String TStamp
          Date and time of the last update. Readonly
        • TStampSync
          String TStampSync
          Timestamp of this object's last export by the replication.
          Since:
          9.99.009.001
        • ud0
          String ud0
          First application defined value.
          See Also:
        • ud1
          String ud1
          Second application defined value.
          See Also:
        • ud2
          String ud2
          Third application defined value.
          See Also:
        • ud3
          String ud3
          Fourth application defined value.
          See Also:
        • ud4
          String ud4
          Fifth application defined value.
          See Also:
        • ud5
          String ud5
          Sixth application defined value.
          See Also:
        • ud6
          String ud6
          Seventh application defined value.
          See Also:
        • ud7
          String ud7
          Eighth application defined value.
          See Also:
        • ud8
          String ud8
          Ninth application defined value.
          See Also:
        • ud9
          String ud9
          Tenth application defined value.
          See Also:
    • Class de.elo.ix.client.ActivityC

      class ActivityC extends ActivityDataC implements Serializable
      serialVersionUID:
      1091363488L
    • Class de.elo.ix.client.ActivityDataC

      class ActivityDataC extends Object implements Serializable
      serialVersionUID:
      72578008L
      • Serialized Fields

        • lnBackAt
          int lnBackAt
          DB column: backat
        • lnBackMode
          int lnBackMode
          DB column: backmode
        • lnComment
          int lnComment
          DB column: actcomment
        • lnDestination
          int lnDestination
          DB column: destination
        • lnDueDateIso
          int lnDueDateIso
          DB column: duedate
        • lnFileName
          int lnFileName
          DB column: filename
        • lnGuid
          int lnGuid
          DB column: actguid
        • lnName
          int lnName
          DB column: shortdesc
        • lnObjGuid
          int lnObjGuid
          DB column: docguid
        • lnProject
          int lnProject
          DB column: project
        • lnRevVers
          int lnRevVers
          DB column: revvers
        • lnSentAtIso
          int lnSentAtIso
          DB column: sentat
        • lnSentMode
          int lnSentMode
          DB column: sentmode
        • lnTransId
          int lnTransId
          Column length: Application defined value. DB column: transmitid
          Since:
          8.00.012.001
        • lnTStamp
          int lnTStamp
          DB column: acttstamp
        • lnTStampSync
          int lnTStampSync
          Column length: Timestamp of this object's last export by the replication. DB column: acttstampsync
          Since:
          9.99.009.001
        • lnUd0
          int lnUd0
          DB column: ud0
        • lnUd1
          int lnUd1
          DB column: ud1
        • lnUd2
          int lnUd2
          DB column: ud2
        • lnUd3
          int lnUd3
          DB column: ud3
        • lnUd4
          int lnUd4
          DB column: ud4
        • lnUd5
          int lnUd5
          DB column: ud5
        • lnUd6
          int lnUd6
          DB column: ud6
        • lnUd7
          int lnUd7
          DB column: ud7
        • lnUd8
          int lnUd8
          DB column: ud8
        • lnUd9
          int lnUd9
          DB column: ud9
    • Class de.elo.ix.client.ActivityOption

      class ActivityOption extends ValueClass implements Serializable
      serialVersionUID:
      595132669L
      • Serialized Fields

        • id
          int id
          Option ID. This value can be one of the predefined option IDs in ActivityOptionC. Or you can use an application defined value greater or equal to ActivityOptionC.ID_VALUE.
          See Also:
        • keywords
          String[] keywords
          Keywords. This array defines the values that can or must be used to set the option. If no keywords are defined, this member is null or an empty array.
        • mandatory
          boolean mandatory
          A value must be defined for this option. This option has to be checked by the client application. It is not checked by Indexserver.
        • name
          String name
          Activity option name. The name must not contain one of this characters: ! $ - + *
        • onlyKeyword
          boolean onlyKeyword
          The value can only be selected from the associated keyword list. This option has to be checked by the client application. It is not checked by Indexserver.
        • readOnly
          boolean readOnly
          The value can not be edited in the user interface. This option has to be checked by the client application. It is not checked by Indexserver.
        • sorted
          boolean sorted
          The value has to be displayed in an appropriate order. This option has to be checked by the client application. It is not checked by Indexserver.
        • stamp
          boolean stamp
          This option is a stamp field. This option has to be checked by the client application. It is not checked by Indexserver.
    • Class de.elo.ix.client.ActivityOptionC

      class ActivityOptionC extends ValueClass implements Serializable
      serialVersionUID:
      1364827052L
    • Class de.elo.ix.client.ActivityProject

      class ActivityProject extends ValueClass implements Serializable
      serialVersionUID:
      2121298555L
      • Serialized Fields

        • lockedWhenFinished
          boolean lockedWhenFinished
          Activity project is locked when finished.
          Since:
          8.00.012.001
        • major
          int major
          Reserved.
        • minor
          int minor
          Reserved.
        • options
          ActivityOption[] options
          Options.
          Since:
          8.00.012.001
        • optValue
          String optValue
          Reserved.
        • project
          String project
          Project name. This can be one of the predefined project names: ActivityProjectC.DEFAULT, ActivityProjectC.REQUEST, ActivityProjectC.NOTIFY. Or an arbitrary name for an application defined use case. The name must be unique because it is internally used as an ID. It has to start with a letter and must only contain letters, numbers or underscores.
        • protectedProject
          boolean protectedProject
          Activity project is protected.
          Since:
          8.00.012.001
    • Class de.elo.ix.client.ActivityProjectC

      class ActivityProjectC extends ActivityProjectDataC implements Serializable
      serialVersionUID:
      1697907147L
    • Class de.elo.ix.client.ActivityProjectDataC

      class ActivityProjectDataC extends Object implements Serializable
      serialVersionUID:
      1946995741L
      • Serialized Fields

        • lnOptValue
          int lnOptValue
          DB column: optvalue
        • lnProject
          int lnProject
          DB column: project
    • Class de.elo.ix.client.ActivityZ

      class ActivityZ extends ValueClass implements Serializable
      serialVersionUID:
      730005706L
      • Serialized Fields

        • bset
          long bset
          Bitset field.
    • Class de.elo.ix.client.AdminModeC

      class AdminModeC extends Object implements Serializable
      serialVersionUID:
      1820929375L
    • Class de.elo.ix.client.Alert

      class Alert extends ValueClass implements Serializable
      serialVersionUID:
      280775671L
      • Serialized Fields

        • dest
          int dest
          Deprecated.
        • destName
          String destName
          Deprecated.
          User name of the recipient.
          Since:
          6.00.099
        • extra1
          int extra1
          Deprecated.
          Extra data 1. DB column: extra1
        • extra2
          int extra2
          Deprecated.
          Extra data 2. DB column: extra2
        • memo
          String memo
          Deprecated.
          Comment text. DB column: alertmemo
        • objId
          int objId
          Deprecated.
          Object ID. DB column: objid
        • source
          int source
          Deprecated.
          User ID of the sender. DB column: source
        • sourceName
          String sourceName
          Deprecated.
          User name of the sender.
          Since:
          6.00.099
        • time
          int time
          Deprecated.
          Date and time when the alert was created. DB column: alerttime
        • timeIso
          String timeIso
          Deprecated.
          ISO date when the alert was created. Timezone is related to ClientInfo.timezone.
          Since:
          6.00.099
        • type
          int type
          Deprecated.
          Alert type. DB column: alerttype
    • Class de.elo.ix.client.AlertC

      class AlertC extends AlertDataC implements Serializable
      serialVersionUID:
      1426544289L
    • Class de.elo.ix.client.AlertDataC

      class AlertDataC extends Object implements Serializable
      serialVersionUID:
      1498169909L
      • Serialized Fields

        • lnMemo
          int lnMemo
          DB column: alertmemo
    • Class de.elo.ix.client.Any

      class Any extends ValueClass implements Serializable
      serialVersionUID:
      5323175140640169411L
    • Class de.elo.ix.client.AnyC

      class AnyC extends Object implements Serializable
      serialVersionUID:
      908393697L
    • Class de.elo.ix.client.ApplyForNotificationsInfo

      class ApplyForNotificationsInfo extends ValueClass implements Serializable
      serialVersionUID:
      77743605L
    • Class de.elo.ix.client.ArchiveStatistics

      class ArchiveStatistics extends ValueClass implements Serializable
      serialVersionUID:
      2056457945L
      • Serialized Fields

        • maxDocId
          int maxDocId
          Last document (version) ID.
        • maxObjId
          int maxObjId
          Last object ID.
    • Class de.elo.ix.client.ArchiveStatisticsOptionsC

      class ArchiveStatisticsOptionsC extends Object implements Serializable
      serialVersionUID:
      276716257L
    • Class de.elo.ix.client.ArchivingModeC

      class ArchivingModeC extends Object implements Serializable
      serialVersionUID:
      1464718703L
      • Serialized Fields

        • dummy
          int dummy
    • Class de.elo.ix.client.ArcPath

      class ArcPath extends ValueClass implements Serializable
      serialVersionUID:
      945258954L
      • Serialized Fields

        • path
          IdName[] path
          IdName array. Contains the identifiers and names for the archive paths. The first element is for the cabinet level. An entry does not exist for the archive level.
        • pathAsString
          String pathAsString
          Path as string. The first charachter is the path separator.
          Since:
          7.00.000.028
    • Class de.elo.ix.client.Aspect

      class Aspect extends ValueClass implements Serializable
      serialVersionUID:
      382788180L
      • Serialized Fields

        • deleted
          boolean deleted
          Deleted status.
        • displayName
          String displayName
          Locale specific name. Readonly. This value is the resolved Aspect.translationKey.
        • guid
          String guid
          Aspect GUID.
        • id
          int id
          Aspect ID. For a new aspect, this value is -1. This value cannot be changed for an existing aspect.
        • lines
          Map<String,AspectLine> lines
          Map of aspect lines. Key is the lineKey of an aspect line (technical name). Value is the AspectLine object itself.
        • lockId
          int lockId
          User ID that holds a lock on this object. If -1, the object is unlocked.
        • lockName
          String lockName
          Name of the user that has locked the aspect. Read-only, ignored in checkinAspect.
        • name
          String name
          Aspect name.
          This must be a String of alpha-numeric characters between 'A' and 'Z', 'a' and 'z', '0' and '9'.
          Additionally, it can contain the underscore '_' and the dot '.'.
          Underscore and dot are not allowed for the first character of the name.
        • packageName
          String packageName
          Package name of Aspect.
          Since:
          20.00.000.104
        • translationKey
          String translationKey
          Translation key. Defines the Aspect.displayName as technical resource ID.
        • TStamp
          String TStamp
          Timestamp of last modification.
        • TStampSync
          String TStampSync
          Timestamp of this object's last export by the replication.
    • Class de.elo.ix.client.AspectAssoc

      class AspectAssoc extends ValueClass implements Serializable
      serialVersionUID:
      1696936442L
      • Serialized Fields

        • acl
          String acl
          Access control list.
        • aclItems
          AclItem[] aclItems
          Access control list.
        • aspectId
          int aspectId
          ID of the referenced aspect.
        • cardinality
          Cardinality cardinality
          Cardinality.
        • displayName
          String displayName
          Locale specific name. Readonly. This value is the resolved AspectAssoc.translationKey.
        • name
          String name
          Technical aspect association name. This member must start with a character between 'A' and 'Z'. The following characters must be alpha-numeric including underscore.
        • regionInherit
          boolean regionInherit
          Indicates if the Sord object passes the aspect object to all sub-entries if this AspectAssoc object is contained in a region mask.
        • translationKey
          String translationKey
          Translation-keyword for AspectAssoc.displayName. Defines the AspectAssoc.displayName as technical resource ID. If this value is set, translations are only based on content of properties files and not on translation table.
    • Class de.elo.ix.client.AspectAssocC

      class AspectAssocC extends Object implements Serializable
      serialVersionUID:
      116302474L
      • Serialized Fields

        • lnAcl
          int lnAcl
          Column length: Access control list. DB column: acl
        • lnName
          int lnName
          Column length: Technical aspect association name. This member must start with a character between 'A' and 'Z'. DB column: name
        • lnTranslationKey
          int lnTranslationKey
          Column length: Translation-keyword for AspectAssoc.displayName. Defines the #displayName as DB column: translationkey
    • Class de.elo.ix.client.AspectC

      class AspectC extends AspectDataC implements Serializable
      serialVersionUID:
      145937112L
    • Class de.elo.ix.client.AspectDataC

      class AspectDataC extends Object implements Serializable
      serialVersionUID:
      805231473L
      • Serialized Fields

        • lnGuid
          int lnGuid
          Column length: Aspect GUID. DB column: guid
        • lnName
          int lnName
          Column length: Aspect name.
          DB column: name
        • lnPackageName
          int lnPackageName
          Column length: Package name of Aspect. DB column: packagename
          Since:
          20.00.000.104
        • lnTranslationKey
          int lnTranslationKey
          Column length: Translation key. Defines the #displayName as technical resource ID. DB column: translationkey
        • lnTStamp
          int lnTStamp
          Column length: Timestamp of last modification. DB column: tstamp
        • lnTStampSync
          int lnTStampSync
          Column length: Timestamp of this object's last export by the replication. DB column: tstampsync
    • Class de.elo.ix.client.AspectInfo

      class AspectInfo extends ValueClass implements Serializable
      serialVersionUID:
      177693548L
      • Serialized Fields

        • displayName
          String displayName
          Translated name of this aspect. This value is read-only and therefore ignored when changed and checked-in. Furthermore, the Indexserver always translates this value into the client language regardless whether the translation settings is enabled or not.
          Since:
          21.01.000.000
        • guid
          String guid
          GUID
        • id
          int id
          Aspect ID.
        • name
          String name
          Aspect name.
        • packageName
          String packageName
          Package name.
          Since:
          21.02.000.000
        • translationKey
          String translationKey
          Translation-keyword for AspectInfo.name.
    • Class de.elo.ix.client.AspectLine

      class AspectLine extends ValueClass implements Serializable
      serialVersionUID:
      876310037L
      • Serialized Fields

        • access
          int access
          Bitset of AccessC.LUR_* constants. It contains the access bits for the current user. Only AccessC.LUR_READ and AccessC.LUR_WRITE are used.
        • allowedMaskIdsForKeywordingRelation
          List<Integer> allowedMaskIdsForKeywordingRelation
          Specifies the DocMask.id allowed in a AspectLineC.TYPE_RELATION. Mandatory if AspectLine is of type AspectLineC.TYPE_RELATION. Only Sords with the specified DocMask.id can be referenced in this AspectLine.
          See Also:
        • aspectId
          int aspectId
          This line information belongs to an aspect with the ID AspectId.
        • canBeFoundViaKeywordingRelation
          boolean canBeFoundViaKeywordingRelation
          If the sord is referenced by keywording-relation, this flag must be true if this index value should be available for search in iSearch within the referencing sord.
          Since:
          21.00.000.019
        • comment
          String comment
          Quickinfo text for the attribute.
          Since:
          21.00.000.012
        • commentTranslationKey
          String commentTranslationKey
          Translation-keyword for AspectLine.comment.
          Since:
          21.00.000.012
        • defaultValue
          String defaultValue
          This value is assigned to the element for a new Sord object.
        • displayName
          String displayName
          The display name of the attribute. This value is displayed in the lable before the edit field. It can be translated into reps. from the users language: set SessionOptionsC.TRANSLATE_TERM.
          See Also:
        • dynamicKeywordReference
          String dynamicKeywordReference
          A script or plugin at the server can serve as the data source of a dynamic keyword list. This value represents the name of that script or plugin. If the value is not empty, the client can request a list of available input values by calling the function IXServicePortIF.checkoutKeywordsDynamic(ClientInfo, KeywordsDynamicInfo). In case of a plugin, this value starts with the Bundle-SymbolicName and can be optionally appended by a path. E.g. serverScriptName="com.partner.dkeywords/invoice-solution". The path has to start with a forward slash and is passed to DynamicKeywordEventsFactory.create(de.elo.ix.client.IXServerEventsContext, java.lang.String).
          Since:
          21.00.000.004
        • excludeFromISearch
          boolean excludeFromISearch
          If true a index value will not be searchable via iSearch. Does not affect the index search.
        • externalData
          String externalData
          External data. Can be used to store an arbitary string.
        • important
          boolean important
          Display index value next to the objects short description. This element has to be interpreted by the client application. Further it is used while generating dynamic keywords.
        • key
          String key
          The attribute identifier.
        • keywordListId
          String keywordListId
          Keyword List ID.
          Since:
          21.03.000.002
        • nameTranslationKey
          String nameTranslationKey
          Translation-keyword for AspectLine.displayName.
        • notTokenized
          boolean notTokenized
          Defines whether a index value should be searchable as TOKENIZED or UN_TOKENIZED
        • postfixAsterix
          boolean postfixAsterix
          Add "*" after index value in search operation.
        • prefixAsterix
          boolean prefixAsterix
          Add "*" before index value in search operation.
        • subType
          String subType
          This field can be used by clients to determine a subtype of the given type. For the purpose of properly displaying a value there are subtypes defined at client side.
          The server does not evaluate the subtype.
          Since:
          21.00.000.008
        • translate
          boolean translate
          Translate index values into or from the users language.
          See Also:
        • type
          int type
          The type of the line information.
          This can be one of the AspectLineC.TYPE_* constants but none of the DocMaskLineC.TYPE_* constants.
    • Class de.elo.ix.client.AspectLineC

      class AspectLineC extends AspectLineDataC implements Serializable
      serialVersionUID:
      959060219L
    • Class de.elo.ix.client.AspectLineDataC

      class AspectLineDataC extends Object implements Serializable
      serialVersionUID:
      122031227L
      • Serialized Fields

        • lnAllowedReferencedMaskIdsRaw
          int lnAllowedReferencedMaskIdsRaw
          Column length: Specifies the DocMask.id allowed in a AspectLineC.TYPE_RELATION. DB column: allowedrefmaskids
        • lnComment
          int lnComment
          Column length: Quickinfo text for the attribute. DB column: linecomment
          Since:
          21.00.000.012
        • lnCommentTranslationKey
          int lnCommentTranslationKey
          Column length: Translation-keyword for AspectLine.comment. DB column: linecommenttrkey
          Since:
          21.00.000.012
        • lnDefaultValue
          int lnDefaultValue
          Column length: This value is assigned to the element for a new Sord object. DB column: linedefault
        • lnDisplayName
          int lnDisplayName
          Column length: The display name of the attribute. This value is displayed in the lable before the edit field. DB column: linedisplayName
        • lnDynamicKeywordReference
          int lnDynamicKeywordReference
          Column length: A script or plugin at the server can serve as the data source of a dynamic keyword list. This DB column: dynkeywordreference
          Since:
          21.00.000.004
        • lnExternalData
          int lnExternalData
          Column length: External data. Can be used to store an arbitary string. DB column: lineext
        • lnKey
          int lnKey
          Column length: The attribute identifier. DB column: linekey
        • lnKeywordListId
          int lnKeywordListId
          Column length: Keyword List ID. DB column: swlgroupid
          Since:
          21.03.000.002
        • lnNameTranslationKey
          int lnNameTranslationKey
          Column length: Translation-keyword for AspectLine.displayName. DB column: linenametrkey
        • lnSubType
          int lnSubType
          Column length: This field can be used by clients to determine a subtype of the given type. For the purpose of DB column: subtype
          Since:
          21.00.000.008
    • Class de.elo.ix.client.AspectZ

      class AspectZ extends ValueClass implements Serializable
      serialVersionUID:
      310908917L
      • Serialized Fields

        • bset
          long bset
          Bitset field for constants from the AspectC class.
    • Class de.elo.ix.client.AutoFilingOptions

      class AutoFilingOptions extends ValueClass implements Serializable
      serialVersionUID:
      7924046066699369255L
    • Class de.elo.ix.client.AutoFilingResult

      class AutoFilingResult extends ValueClass implements Serializable
      serialVersionUID:
      1881161566L
      • Serialized Fields

        • parentIds
          int[] parentIds
          Destination object IDs. The first array element belongs to the main path. The other elements belong to reference paths. The element value is the object ID of the last entry in the path, if the path exists. If the path does not exist, the element value is -1. An element value of 0 indicates that the object is stored in the "chaos" folder. This happens if an asterix * is used as filing definition. If the filing definition given in IXServicePortIF.evalAutoFiling(ClientInfo, String, Sord, AutoFilingOptions) is empty, the array has one element of value 1.
        • pathsAsString
          String[] pathsAsString
          Destination archive paths. The first array element is the main path used to store the object. The other elements are archive paths for references to the object. The first character of each path is the separator. A path element is empty, if 1. the filing definition is an asterix (*, "chaos" folder) or if 2. the filing definition does not specify an archive path (e.g. "longest match" definition) and the destination path does not exist. A path element is the separator, if the destination path is the topmost archive level. If the filing definition given in IXServicePortIF.evalAutoFiling(ClientInfo, String, Sord, AutoFilingOptions) is empty, the array has one element of value "¶".
    • Class de.elo.ix.client.BackupProfile

      class BackupProfile extends ValueClass implements Serializable
      serialVersionUID:
      1230334315L
      • Serialized Fields

        • name
          String name
          Backup profile name
        • nbOfDocsPerLoop
          int nbOfDocsPerLoop
          Maximum number of documents per backup loop.
        • pathId
          int pathId
          Storage path id
        • retention
          int retention
          Reserved
        • slot
          int slot
          Backup slot
        • sqlDocSelect
          String sqlDocSelect
          Optional SQL command to select the documents to be stored.
        • writeKeywording
          boolean writeKeywording
          Store keywording too
    • Class de.elo.ix.client.BackupPurgeStatus

      class BackupPurgeStatus extends ValueClass implements Serializable
      serialVersionUID:
      52201250L
      • Serialized Fields

        • backupStatus
          BackupStatus backupStatus
          Status of the ELOdm backup task
        • purgeStatus
          PurgeStatus purgeStatus
          Status of the ELOdm purge task
    • Class de.elo.ix.client.BackupStatus

      class BackupStatus extends ValueClass implements Serializable
      serialVersionUID:
      1288074907L
      • Serialized Fields

        • errorMessage
          String errorMessage
          an error message, if an error occured, else an empty String
        • isRunning
          boolean isRunning
          if the ELOdm backup task is running (the purge task can only run in combination with the backup task)
        • numberOfDocsCopied
          int numberOfDocsCopied
          number of copied documents since start of the backup task
        • secondsUntilNextCheck
          int secondsUntilNextCheck
          waiting time in seconds until the next proccessing (when the backup profiles are traversed)
    • Class de.elo.ix.client.BApi

      class BApi extends Object implements Serializable
      serialVersionUID:
      1349127100L
    • Class de.elo.ix.client.BeginForwardWorkflowNodeInfo

      class BeginForwardWorkflowNodeInfo extends ValueClass implements Serializable
      serialVersionUID:
      1328510959028043007L
    • Class de.elo.ix.client.Bitset

      class Bitset extends Object implements Serializable
      serialVersionUID:
      1084624222L
      • Serialized Fields

        • v
          long v
          Internal 64 bit integer value
    • Class de.elo.ix.client.BRequest_IXEventBusHandler_processEventBusEvents

      class BRequest_IXEventBusHandler_processEventBusEvents extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      1736645961L
      • Serialized Fields

        • events
          Event[] events
        • subsId
          long subsId
    • Class de.elo.ix.client.BRequest_IXServerEvents_executeRegisteredFunction

      class BRequest_IXServerEvents_executeRegisteredFunction extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      1363890826L
    • Class de.elo.ix.client.BRequest_IXServerEvents_executeRegisteredFunctionString

      class BRequest_IXServerEvents_executeRegisteredFunctionString extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      1679329575L
    • Class de.elo.ix.client.BRequest_IXServerEvents_getAppInfo

      class BRequest_IXServerEvents_getAppInfo extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      1887140750L
    • Class de.elo.ix.client.BRequest_IXServerEvents_getUserNames

      class BRequest_IXServerEvents_getUserNames extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      1950460032L
    • Class de.elo.ix.client.BRequest_IXServerEvents_hasMethod

      class BRequest_IXServerEvents_hasMethod extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      110863678L
    • Class de.elo.ix.client.BRequest_IXServerEvents_onAfterCheckinActivity

      class BRequest_IXServerEvents_onAfterCheckinActivity extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      1027171864L
    • Class de.elo.ix.client.BRequest_IXServerEvents_onAfterCheckinDocEnd

      class BRequest_IXServerEvents_onAfterCheckinDocEnd extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      1920958924L
    • Class de.elo.ix.client.BRequest_IXServerEvents_onAfterCheckinMap

      class BRequest_IXServerEvents_onAfterCheckinMap extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      1002917709L
    • Class de.elo.ix.client.BRequest_IXServerEvents_onAfterCheckinNotes

      class BRequest_IXServerEvents_onAfterCheckinNotes extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      1729896360L
    • Class de.elo.ix.client.BRequest_IXServerEvents_onAfterCheckinReminder

      class BRequest_IXServerEvents_onAfterCheckinReminder extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      2130431109L
    • Class de.elo.ix.client.BRequest_IXServerEvents_onAfterCheckinSord

      class BRequest_IXServerEvents_onAfterCheckinSord extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      1025485545L
    • Class de.elo.ix.client.BRequest_IXServerEvents_onAfterCheckinUsers

      class BRequest_IXServerEvents_onAfterCheckinUsers extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      1723326561L
    • Class de.elo.ix.client.BRequest_IXServerEvents_onAfterDelegateWorkflowNode

      class BRequest_IXServerEvents_onAfterDelegateWorkflowNode extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      1606438474L
    • Class de.elo.ix.client.BRequest_IXServerEvents_onAfterDeleteMap

      class BRequest_IXServerEvents_onAfterDeleteMap extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      40991853L
    • Class de.elo.ix.client.BRequest_IXServerEvents_onAfterDeleteSord

      class BRequest_IXServerEvents_onAfterDeleteSord extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      1270939805L
    • Class de.elo.ix.client.BRequest_IXServerEvents_onAfterEndEditWorkFlowNode

      class BRequest_IXServerEvents_onAfterEndEditWorkFlowNode extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      812031586L
    • Class de.elo.ix.client.BRequest_IXServerEvents_onAfterLogin

      class BRequest_IXServerEvents_onAfterLogin extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      1693784539L
    • Class de.elo.ix.client.BRequest_IXServerEvents_onAfterPackageImport

      class BRequest_IXServerEvents_onAfterPackageImport extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      1673085511L
    • Class de.elo.ix.client.BRequest_IXServerEvents_onAfterRefSord

      class BRequest_IXServerEvents_onAfterRefSord extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      807852157L
    • Class de.elo.ix.client.BRequest_IXServerEvents_onAfterStartWorkFlow

      class BRequest_IXServerEvents_onAfterStartWorkFlow extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      527527197L
    • Class de.elo.ix.client.BRequest_IXServerEvents_onAfterTerminateDeleteWorkFlow

      class BRequest_IXServerEvents_onAfterTerminateDeleteWorkFlow extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      1413290201L
    • Class de.elo.ix.client.BRequest_IXServerEvents_onBeforeCheckinActivity

      class BRequest_IXServerEvents_onBeforeCheckinActivity extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      1917517477L
    • Class de.elo.ix.client.BRequest_IXServerEvents_onBeforeCheckinDocEnd

      class BRequest_IXServerEvents_onBeforeCheckinDocEnd extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      129508967L
    • Class de.elo.ix.client.BRequest_IXServerEvents_onBeforeCheckinMap

      class BRequest_IXServerEvents_onBeforeCheckinMap extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      1578945530L
    • Class de.elo.ix.client.BRequest_IXServerEvents_onBeforeCheckinNotes

      class BRequest_IXServerEvents_onBeforeCheckinNotes extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      1241851157L
    • Class de.elo.ix.client.BRequest_IXServerEvents_onBeforeCheckinSord

      class BRequest_IXServerEvents_onBeforeCheckinSord extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      1702478812L
    • Class de.elo.ix.client.BRequest_IXServerEvents_onBeforeCheckinUsers

      class BRequest_IXServerEvents_onBeforeCheckinUsers extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      1235281358L
    • Class de.elo.ix.client.BRequest_IXServerEvents_onBeforeDelegateWorkflowNode

      class BRequest_IXServerEvents_onBeforeDelegateWorkflowNode extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      24574499L
    • Class de.elo.ix.client.BRequest_IXServerEvents_onBeforeDeleteMap

      class BRequest_IXServerEvents_onBeforeDeleteMap extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      393231686L
    • Class de.elo.ix.client.BRequest_IXServerEvents_onBeforeDeleteSord

      class BRequest_IXServerEvents_onBeforeDeleteSord extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      694911984L
    • Class de.elo.ix.client.BRequest_IXServerEvents_onBeforeFindSords

      class BRequest_IXServerEvents_onBeforeFindSords extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      384369013L
    • Class de.elo.ix.client.BRequest_IXServerEvents_onBeforeFindSordsInternalSQL

      class BRequest_IXServerEvents_onBeforeFindSordsInternalSQL extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      894418660L
    • Class de.elo.ix.client.BRequest_IXServerEvents_onBeforeLogin

      class BRequest_IXServerEvents_onBeforeLogin extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      2101716238L
    • Class de.elo.ix.client.BRequest_IXServerEvents_onBeforeRefSord

      class BRequest_IXServerEvents_onBeforeRefSord extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      372486646L
    • Class de.elo.ix.client.BRequest_IXServerEvents_onBeforeStartWorkFlow

      class BRequest_IXServerEvents_onBeforeStartWorkFlow extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      1522940694L
    • Class de.elo.ix.client.BRequest_IXServerEvents_onBeforeTakeWorkFlowNode

      class BRequest_IXServerEvents_onBeforeTakeWorkFlowNode extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      727945599L
    • Class de.elo.ix.client.BRequest_IXServerEvents_onBeforeTerminateDeleteWorkFlow

      class BRequest_IXServerEvents_onBeforeTerminateDeleteWorkFlow extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      1955749196L
    • Class de.elo.ix.client.BRequest_IXServerEvents_onCheckSordAccess

      class BRequest_IXServerEvents_onCheckSordAccess extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      1507824766L
    • Class de.elo.ix.client.BRequest_IXServerEvents_onCreateDoc

      class BRequest_IXServerEvents_onCreateDoc extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      1029500828L
    • Class de.elo.ix.client.BRequest_IXServerEvents_onCreateSord

      class BRequest_IXServerEvents_onCreateSord extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      1849307166L
    • Class de.elo.ix.client.BRequest_IXServerEvents_onFileUploadBuildResponse

      class BRequest_IXServerEvents_onFileUploadBuildResponse extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      2105244922L
    • Class de.elo.ix.client.BRequest_IXServerEvents_onFindClose

      class BRequest_IXServerEvents_onFindClose extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      1223837305L
    • Class de.elo.ix.client.BRequest_IXServerEvents_onFindSordsResult

      class BRequest_IXServerEvents_onFindSordsResult extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      127227249L
    • Class de.elo.ix.client.BRequest_IXServerEvents_onInheritKeywording

      class BRequest_IXServerEvents_onInheritKeywording extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      53854844L
    • Class de.elo.ix.client.BRequest_IXServerEvents_onReadSord

      class BRequest_IXServerEvents_onReadSord extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      227337860L
    • Class de.elo.ix.client.BRequest_IXServerEvents_onSendFeedToISearch

      class BRequest_IXServerEvents_onSendFeedToISearch extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      532525160L
    • Class de.elo.ix.client.BRequest_IXServerEvents_onSendSordToISearch

      class BRequest_IXServerEvents_onSendSordToISearch extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      646500952L
    • Class de.elo.ix.client.BRequest_IXServicePortIF_activateSubstitution

      class BRequest_IXServicePortIF_activateSubstitution extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      1610586682L
    • Class de.elo.ix.client.BRequest_IXServicePortIF_addUrlParams

      class BRequest_IXServicePortIF_addUrlParams extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      177992598L
    • Class de.elo.ix.client.BRequest_IXServicePortIF_adminMode

      class BRequest_IXServicePortIF_adminMode extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      1311037156L
      • Serialized Fields

    • Class de.elo.ix.client.BRequest_IXServicePortIF_alive

      class BRequest_IXServicePortIF_alive extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      1536711337L
    • Class de.elo.ix.client.BRequest_IXServicePortIF_applyForNotifications

      class BRequest_IXServicePortIF_applyForNotifications extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      1849289399L
    • Class de.elo.ix.client.BRequest_IXServicePortIF_beginEditWorkFlowNode

      class BRequest_IXServicePortIF_beginEditWorkFlowNode extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      626823938L
      • Serialized Fields

        • ci
          ClientInfo ci
        • lockZ
          LockZ lockZ
        • nFlowId
          int nFlowId
        • nNodeId
          int nNodeId
    • Class de.elo.ix.client.BRequest_IXServicePortIF_beginForwardWorkflowNode

      class BRequest_IXServicePortIF_beginForwardWorkflowNode extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      48774765L
    • Class de.elo.ix.client.BRequest_IXServicePortIF_changeSordMask

      class BRequest_IXServicePortIF_changeSordMask extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      1393938400L
    • Class de.elo.ix.client.BRequest_IXServicePortIF_checkinActivity

      class BRequest_IXServicePortIF_checkinActivity extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      1990464102L
    • Class de.elo.ix.client.BRequest_IXServicePortIF_checkinActivityProject

      class BRequest_IXServicePortIF_checkinActivityProject extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      310669779L
    • Class de.elo.ix.client.BRequest_IXServicePortIF_checkinAspect

      class BRequest_IXServicePortIF_checkinAspect extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      1522867567L
    • Class de.elo.ix.client.BRequest_IXServicePortIF_checkinColors

      class BRequest_IXServicePortIF_checkinColors extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      1576322695L
    • Class de.elo.ix.client.BRequest_IXServicePortIF_checkinConfigFiles

      class BRequest_IXServicePortIF_checkinConfigFiles extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      1785918050L
    • Class de.elo.ix.client.BRequest_IXServicePortIF_checkinConfigFilesBegin

      class BRequest_IXServicePortIF_checkinConfigFilesBegin extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      453135787L
    • Class de.elo.ix.client.BRequest_IXServicePortIF_checkinConfigFilesEnd

      class BRequest_IXServicePortIF_checkinConfigFilesEnd extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      1770305117L
    • Class de.elo.ix.client.BRequest_IXServicePortIF_checkinCounters

      class BRequest_IXServicePortIF_checkinCounters extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      1020556978L
    • Class de.elo.ix.client.BRequest_IXServicePortIF_checkinCryptInfos

      class BRequest_IXServicePortIF_checkinCryptInfos extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      1795186254L
    • Class de.elo.ix.client.BRequest_IXServicePortIF_checkinDocBegin

      class BRequest_IXServicePortIF_checkinDocBegin extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      165848488L
    • Class de.elo.ix.client.BRequest_IXServicePortIF_checkinDocBegin2

      class BRequest_IXServicePortIF_checkinDocBegin2 extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      846335882L
    • Class de.elo.ix.client.BRequest_IXServicePortIF_checkinDocDupl

      class BRequest_IXServicePortIF_checkinDocDupl extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      1795690130L
    • Class de.elo.ix.client.BRequest_IXServicePortIF_checkinDocEnd

      class BRequest_IXServicePortIF_checkinDocEnd extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      1604643226L
    • Class de.elo.ix.client.BRequest_IXServicePortIF_checkinDocMask

      class BRequest_IXServicePortIF_checkinDocMask extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      1795441139L
    • Class de.elo.ix.client.BRequest_IXServicePortIF_checkinDocMaskLineTemplate

      class BRequest_IXServicePortIF_checkinDocMaskLineTemplate extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      702278853L
    • Class de.elo.ix.client.BRequest_IXServicePortIF_checkinDocsBegin

      class BRequest_IXServicePortIF_checkinDocsBegin extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      2078187849L
    • Class de.elo.ix.client.BRequest_IXServicePortIF_checkinDocsEnd

      class BRequest_IXServicePortIF_checkinDocsEnd extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      1794336151L
    • Class de.elo.ix.client.BRequest_IXServicePortIF_checkinEsSettings

      class BRequest_IXServicePortIF_checkinEsSettings extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      954352776L
    • Class de.elo.ix.client.BRequest_IXServicePortIF_checkinKeys

      class BRequest_IXServicePortIF_checkinKeys extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      573935819L
    • Class de.elo.ix.client.BRequest_IXServicePortIF_checkinKeywordList

      class BRequest_IXServicePortIF_checkinKeywordList extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      1216164720L
    • Class de.elo.ix.client.BRequest_IXServicePortIF_checkinKeywords

      class BRequest_IXServicePortIF_checkinKeywords extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      125387007L
    • Class de.elo.ix.client.BRequest_IXServicePortIF_checkinMap

      class BRequest_IXServicePortIF_checkinMap extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      1126894501L
    • Class de.elo.ix.client.BRequest_IXServicePortIF_checkinMapDomain

      class BRequest_IXServicePortIF_checkinMapDomain extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      1848884425L
    • Class de.elo.ix.client.BRequest_IXServicePortIF_checkinNotes

      class BRequest_IXServicePortIF_checkinNotes extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      615204554L
    • Class de.elo.ix.client.BRequest_IXServicePortIF_checkinNoteTemplates

      class BRequest_IXServicePortIF_checkinNoteTemplates extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      1356325488L
    • Class de.elo.ix.client.BRequest_IXServicePortIF_checkinNotification

      class BRequest_IXServicePortIF_checkinNotification extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      1249191106L
    • Class de.elo.ix.client.BRequest_IXServicePortIF_checkinOrgUnits

      class BRequest_IXServicePortIF_checkinOrgUnits extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      656770626L
    • Class de.elo.ix.client.BRequest_IXServicePortIF_checkinReminder

      class BRequest_IXServicePortIF_checkinReminder extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      1167138871L
    • Class de.elo.ix.client.BRequest_IXServicePortIF_checkinReplNames

      class BRequest_IXServicePortIF_checkinReplNames extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      897197218L
    • Class de.elo.ix.client.BRequest_IXServicePortIF_checkinReport

      class BRequest_IXServicePortIF_checkinReport extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      1996643915L
    • Class de.elo.ix.client.BRequest_IXServicePortIF_checkinReportOptions

      class BRequest_IXServicePortIF_checkinReportOptions extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      955196883L
    • Class de.elo.ix.client.BRequest_IXServicePortIF_checkinSord

      class BRequest_IXServicePortIF_checkinSord extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      574183525L
    • Class de.elo.ix.client.BRequest_IXServicePortIF_checkinSordPath

      class BRequest_IXServicePortIF_checkinSordPath extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      998405674L
    • Class de.elo.ix.client.BRequest_IXServicePortIF_checkinSordTypes

      class BRequest_IXServicePortIF_checkinSordTypes extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      890210068L
    • Class de.elo.ix.client.BRequest_IXServicePortIF_checkinStorage

      class BRequest_IXServicePortIF_checkinStorage extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      1212457916L
    • Class de.elo.ix.client.BRequest_IXServicePortIF_checkinSubs

      class BRequest_IXServicePortIF_checkinSubs extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      574188810L
    • Class de.elo.ix.client.BRequest_IXServicePortIF_checkinSubscription

      class BRequest_IXServicePortIF_checkinSubscription extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      995161332L
    • Class de.elo.ix.client.BRequest_IXServicePortIF_checkinSubstitutions

      class BRequest_IXServicePortIF_checkinSubstitutions extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      1361363937L
    • Class de.elo.ix.client.BRequest_IXServicePortIF_checkinTranslateTerms

      class BRequest_IXServicePortIF_checkinTranslateTerms extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      366611184L
    • Class de.elo.ix.client.BRequest_IXServicePortIF_checkinUser

      class BRequest_IXServicePortIF_checkinUser extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      574246562L
    • Class de.elo.ix.client.BRequest_IXServicePortIF_checkinUserProfile

      class BRequest_IXServicePortIF_checkinUserProfile extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      1903655079L
    • Class de.elo.ix.client.BRequest_IXServicePortIF_checkinUsers

      class BRequest_IXServicePortIF_checkinUsers extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      621774353L
    • Class de.elo.ix.client.BRequest_IXServicePortIF_checkinWorkFlow

      class BRequest_IXServicePortIF_checkinWorkFlow extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      614110410L
    • Class de.elo.ix.client.BRequest_IXServicePortIF_checkinWorkflowTemplate

      class BRequest_IXServicePortIF_checkinWorkflowTemplate extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      847491504L
    • Class de.elo.ix.client.BRequest_IXServicePortIF_checkLicense

      class BRequest_IXServicePortIF_checkLicense extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      523346511L
    • Class de.elo.ix.client.BRequest_IXServicePortIF_checkoutActivity

      class BRequest_IXServicePortIF_checkoutActivity extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      708798549L
    • Class de.elo.ix.client.BRequest_IXServicePortIF_checkoutActivityProject

      class BRequest_IXServicePortIF_checkoutActivityProject extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      1209441042L
    • Class de.elo.ix.client.BRequest_IXServicePortIF_checkoutAspect

      class BRequest_IXServicePortIF_checkoutAspect extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      2091110412L
    • Class de.elo.ix.client.BRequest_IXServicePortIF_checkoutAspects

      class BRequest_IXServicePortIF_checkoutAspects extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      399913217L
    • Class de.elo.ix.client.BRequest_IXServicePortIF_checkoutColors

      class BRequest_IXServicePortIF_checkoutColors extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      2037655284L
    • Class de.elo.ix.client.BRequest_IXServicePortIF_checkoutColors2

      class BRequest_IXServicePortIF_checkoutColors2 extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      1257195686L
    • Class de.elo.ix.client.BRequest_IXServicePortIF_checkoutConfigFiles

      class BRequest_IXServicePortIF_checkoutConfigFiles extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      846870983L
    • Class de.elo.ix.client.BRequest_IXServicePortIF_checkoutCounters

      class BRequest_IXServicePortIF_checkoutCounters extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      575147667L
      • Serialized Fields

        • ci
          ClientInfo ci
        • counterNames
          String[] counterNames
        • incrementCounters
          boolean incrementCounters
        • lockZ
          LockZ lockZ
    • Class de.elo.ix.client.BRequest_IXServicePortIF_checkoutCryptInfos

      class BRequest_IXServicePortIF_checkoutCryptInfos extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      1964025427L
    • Class de.elo.ix.client.BRequest_IXServicePortIF_checkoutDoc

      class BRequest_IXServicePortIF_checkoutDoc extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      753364764L
    • Class de.elo.ix.client.BRequest_IXServicePortIF_checkoutDocMask

      class BRequest_IXServicePortIF_checkoutDocMask extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      2135358504L
    • Class de.elo.ix.client.BRequest_IXServicePortIF_checkoutDocMaskLineTemplates

      class BRequest_IXServicePortIF_checkoutDocMaskLineTemplates extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      550757795L
    • Class de.elo.ix.client.BRequest_IXServicePortIF_checkoutEsInfo

      class BRequest_IXServicePortIF_checkoutEsInfo extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      1977746920L
    • Class de.elo.ix.client.BRequest_IXServicePortIF_checkoutEsSettings

      class BRequest_IXServicePortIF_checkoutEsSettings extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      1123191949L
    • Class de.elo.ix.client.BRequest_IXServicePortIF_checkoutEsStatus

      class BRequest_IXServicePortIF_checkoutEsStatus extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      1947553060L
    • Class de.elo.ix.client.BRequest_IXServicePortIF_checkoutKeys

      class BRequest_IXServicePortIF_checkoutKeys extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      1879670928L
    • Class de.elo.ix.client.BRequest_IXServicePortIF_checkoutKeywordList

      class BRequest_IXServicePortIF_checkoutKeywordList extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      2139755509L
    • Class de.elo.ix.client.BRequest_IXServicePortIF_checkoutKeywords

      class BRequest_IXServicePortIF_checkoutKeywords extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      1470317638L
    • Class de.elo.ix.client.BRequest_IXServicePortIF_checkoutKeywordsDynamic

      class BRequest_IXServicePortIF_checkoutKeywordsDynamic extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      1951955225L
    • Class de.elo.ix.client.BRequest_IXServicePortIF_checkoutMap

      class BRequest_IXServicePortIF_checkoutMap extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      753372992L
    • Class de.elo.ix.client.BRequest_IXServicePortIF_checkoutMapDomain

      class BRequest_IXServicePortIF_checkoutMapDomain extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      223879132L
    • Class de.elo.ix.client.BRequest_IXServicePortIF_checkoutMapHistory

      class BRequest_IXServicePortIF_checkoutMapHistory extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      739067188L
    • Class de.elo.ix.client.BRequest_IXServicePortIF_checkoutNotes

      class BRequest_IXServicePortIF_checkoutNotes extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      1856680027L
    • Class de.elo.ix.client.BRequest_IXServicePortIF_checkoutNoteTemplates

      class BRequest_IXServicePortIF_checkoutNoteTemplates extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      1837424715L
    • Class de.elo.ix.client.BRequest_IXServicePortIF_checkoutNotification

      class BRequest_IXServicePortIF_checkoutNotification extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      294879111L
    • Class de.elo.ix.client.BRequest_IXServicePortIF_checkoutOrgUnits

      class BRequest_IXServicePortIF_checkoutOrgUnits extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      2042492025L
    • Class de.elo.ix.client.BRequest_IXServicePortIF_checkoutPreviewImageURLs

      class BRequest_IXServicePortIF_checkoutPreviewImageURLs extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      755346067L
    • Class de.elo.ix.client.BRequest_IXServicePortIF_checkoutReminders

      class BRequest_IXServicePortIF_checkoutReminders extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      400637221L
      • Serialized Fields

    • Class de.elo.ix.client.BRequest_IXServicePortIF_checkoutReplNames

      class BRequest_IXServicePortIF_checkoutReplNames extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      1175566339L
    • Class de.elo.ix.client.BRequest_IXServicePortIF_checkoutReportOptions

      class BRequest_IXServicePortIF_checkoutReportOptions extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      1436296110L
    • Class de.elo.ix.client.BRequest_IXServicePortIF_checkoutSord

      class BRequest_IXServicePortIF_checkoutSord extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      1879918634L
    • Class de.elo.ix.client.BRequest_IXServicePortIF_checkoutSordHistory

      class BRequest_IXServicePortIF_checkoutSordHistory extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      782528246L
    • Class de.elo.ix.client.BRequest_IXServicePortIF_checkoutSordPath

      class BRequest_IXServicePortIF_checkoutSordPath extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      1700856977L
    • Class de.elo.ix.client.BRequest_IXServicePortIF_checkoutSordTypes

      class BRequest_IXServicePortIF_checkoutSordTypes extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      1182553489L
    • Class de.elo.ix.client.BRequest_IXServicePortIF_checkoutStorage

      class BRequest_IXServicePortIF_checkoutStorage extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      1576625569L
    • Class de.elo.ix.client.BRequest_IXServicePortIF_checkoutSubs

      class BRequest_IXServicePortIF_checkoutSubs extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      1879923919L
    • Class de.elo.ix.client.BRequest_IXServicePortIF_checkoutSubstitutions

      class BRequest_IXServicePortIF_checkoutSubstitutions extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      880264710L
    • Class de.elo.ix.client.BRequest_IXServicePortIF_checkoutTranslateTerms

      class BRequest_IXServicePortIF_checkoutTranslateTerms extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      1899181963L
    • Class de.elo.ix.client.BRequest_IXServicePortIF_checkoutUser

      class BRequest_IXServicePortIF_checkoutUser extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      1879981671L
    • Class de.elo.ix.client.BRequest_IXServicePortIF_checkoutUserProfile

      class BRequest_IXServicePortIF_checkoutUserProfile extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      1452265150L
    • Class de.elo.ix.client.BRequest_IXServicePortIF_checkoutUsers

      class BRequest_IXServicePortIF_checkoutUsers extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      1850110228L
    • Class de.elo.ix.client.BRequest_IXServicePortIF_checkoutWorkFlow

      class BRequest_IXServicePortIF_checkoutWorkFlow extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      981594235L
    • Class de.elo.ix.client.BRequest_IXServicePortIF_checkoutWorkflowHistory

      class BRequest_IXServicePortIF_checkoutWorkflowHistory extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      1555002297L
    • Class de.elo.ix.client.BRequest_IXServicePortIF_checkoutWorkflowTemplate

      class BRequest_IXServicePortIF_checkoutWorkflowTemplate extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      968696309L
    • Class de.elo.ix.client.BRequest_IXServicePortIF_cleanupStart

      class BRequest_IXServicePortIF_cleanupStart extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      97888340L
    • Class de.elo.ix.client.BRequest_IXServicePortIF_cleanupState

      class BRequest_IXServicePortIF_cleanupState extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      97888387L
    • Class de.elo.ix.client.BRequest_IXServicePortIF_cleanupStop

      class BRequest_IXServicePortIF_cleanupStop extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      689578544L
    • Class de.elo.ix.client.BRequest_IXServicePortIF_closeEventBus

      class BRequest_IXServicePortIF_closeEventBus extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      1579680296L
      • Serialized Fields

    • Class de.elo.ix.client.BRequest_IXServicePortIF_collectJobStates

      class BRequest_IXServicePortIF_collectJobStates extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      1479025845L
      • Serialized Fields

        • activeJobs
          boolean activeJobs
        • ci
          ClientInfo ci
        • finishedJobs
          boolean finishedJobs
        • fullInfo
          boolean fullInfo
    • Class de.elo.ix.client.BRequest_IXServicePortIF_collectMapDomains

      class BRequest_IXServicePortIF_collectMapDomains extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      1590880889L
    • Class de.elo.ix.client.BRequest_IXServicePortIF_collectWorkFlowNodes

      class BRequest_IXServicePortIF_collectWorkFlowNodes extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      791411518L
      • Serialized Fields

        • ci
          ClientInfo ci
        • enterDateIso
          String enterDateIso
        • exitDateIso
          String exitDateIso
        • flowName
          String flowName
        • nodeName
          String nodeName
        • nodeType
          int nodeType
        • objId
          String objId
        • onlyActive
          boolean onlyActive
        • onlyStartNodes
          boolean onlyStartNodes
        • userIds
          String[] userIds
        • wfTypeZ
          WFTypeZ wfTypeZ
    • Class de.elo.ix.client.BRequest_IXServicePortIF_collectWorkFlows

      class BRequest_IXServicePortIF_collectWorkFlows extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      1540999264L
    • Class de.elo.ix.client.BRequest_IXServicePortIF_combineAcl

      class BRequest_IXServicePortIF_combineAcl extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      1476771969L
    • Class de.elo.ix.client.BRequest_IXServicePortIF_computeDocumentHash

      class BRequest_IXServicePortIF_computeDocumentHash extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      44526166L
    • Class de.elo.ix.client.BRequest_IXServicePortIF_configureBackup

      class BRequest_IXServicePortIF_configureBackup extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      251783250L
    • Class de.elo.ix.client.BRequest_IXServicePortIF_configureFulltext

      class BRequest_IXServicePortIF_configureFulltext extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      655595212L
    • Class de.elo.ix.client.BRequest_IXServicePortIF_configureLicense

      class BRequest_IXServicePortIF_configureLicense extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      270703695L
      • Serialized Fields

    • Class de.elo.ix.client.BRequest_IXServicePortIF_configurePurge

      class BRequest_IXServicePortIF_configurePurge extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      1407134747L
    • Class de.elo.ix.client.BRequest_IXServicePortIF_controlBackgroundThread

      class BRequest_IXServicePortIF_controlBackgroundThread extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      796672607L
    • Class de.elo.ix.client.BRequest_IXServicePortIF_controlBackup

      class BRequest_IXServicePortIF_controlBackup extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      429289481L
    • Class de.elo.ix.client.BRequest_IXServicePortIF_cookKeyword

      class BRequest_IXServicePortIF_cookKeyword extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      922862219L
    • Class de.elo.ix.client.BRequest_IXServicePortIF_copySord

      class BRequest_IXServicePortIF_copySord extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      1944880601L
    • Class de.elo.ix.client.BRequest_IXServicePortIF_createActivity

      class BRequest_IXServicePortIF_createActivity extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      806333153L
    • Class de.elo.ix.client.BRequest_IXServicePortIF_createActivityProject

      class BRequest_IXServicePortIF_createActivityProject extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      1769051912L
    • Class de.elo.ix.client.BRequest_IXServicePortIF_createAspect

      class BRequest_IXServicePortIF_createAspect extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      1436719274L
    • Class de.elo.ix.client.BRequest_IXServicePortIF_createAspectAssoc

      class BRequest_IXServicePortIF_createAspectAssoc extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      1713257867L
    • Class de.elo.ix.client.BRequest_IXServicePortIF_createAspectMask

      class BRequest_IXServicePortIF_createAspectMask extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      471248566L
    • Class de.elo.ix.client.BRequest_IXServicePortIF_createDoc

      class BRequest_IXServicePortIF_createDoc extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      734350810L
    • Class de.elo.ix.client.BRequest_IXServicePortIF_createDocMask

      class BRequest_IXServicePortIF_createDocMask extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      171070926L
    • Class de.elo.ix.client.BRequest_IXServicePortIF_createEventBusListener

      class BRequest_IXServicePortIF_createEventBusListener extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      563568172L
    • Class de.elo.ix.client.BRequest_IXServicePortIF_createEventBusSubscriber

      class BRequest_IXServicePortIF_createEventBusSubscriber extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      1671043104L
    • Class de.elo.ix.client.BRequest_IXServicePortIF_createKey

      class BRequest_IXServicePortIF_createKey extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      734344371L
    • Class de.elo.ix.client.BRequest_IXServicePortIF_createNewEncryptionSet

      class BRequest_IXServicePortIF_createNewEncryptionSet extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      923619825L
    • Class de.elo.ix.client.BRequest_IXServicePortIF_createNote

      class BRequest_IXServicePortIF_createNote extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      1289740092L
    • Class de.elo.ix.client.BRequest_IXServicePortIF_createNote2

      class BRequest_IXServicePortIF_createNote2 extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      1327237138L
    • Class de.elo.ix.client.BRequest_IXServicePortIF_createNoteTemplate

      class BRequest_IXServicePortIF_createNoteTemplate extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      1517964638L
    • Class de.elo.ix.client.BRequest_IXServicePortIF_createReminder

      class BRequest_IXServicePortIF_createReminder extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      1943697476L
    • Class de.elo.ix.client.BRequest_IXServicePortIF_createRsaKeys

      class BRequest_IXServicePortIF_createRsaKeys extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      518307262L
    • Class de.elo.ix.client.BRequest_IXServicePortIF_createSord

      class BRequest_IXServicePortIF_createSord extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      1289591200L
    • Class de.elo.ix.client.BRequest_IXServicePortIF_createSubscription

      class BRequest_IXServicePortIF_createSubscription extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      1409951761L
    • Class de.elo.ix.client.BRequest_IXServicePortIF_createSuperiorSubstitution

      class BRequest_IXServicePortIF_createSuperiorSubstitution extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      1699616032L
    • Class de.elo.ix.client.BRequest_IXServicePortIF_createUser

      class BRequest_IXServicePortIF_createUser extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      1289528163L
    • Class de.elo.ix.client.BRequest_IXServicePortIF_createWFNode

      class BRequest_IXServicePortIF_createWFNode extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      2023998883L
      • Serialized Fields

        • ci
          ClientInfo ci
        • nodeId
          int nodeId
        • nodeTypeC
          int nodeTypeC
    • Class de.elo.ix.client.BRequest_IXServicePortIF_createWorkFlow

      class BRequest_IXServicePortIF_createWorkFlow extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      1798241359L
    • Class de.elo.ix.client.BRequest_IXServicePortIF_deactivateSubstitution

      class BRequest_IXServicePortIF_deactivateSubstitution extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      1303678393L
    • Class de.elo.ix.client.BRequest_IXServicePortIF_deferWorkFlowNode

      class BRequest_IXServicePortIF_deferWorkFlowNode extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      77680797L
    • Class de.elo.ix.client.BRequest_IXServicePortIF_delegateWorkFlowNode

      class BRequest_IXServicePortIF_delegateWorkFlowNode extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      2095741220L
    • Class de.elo.ix.client.BRequest_IXServicePortIF_deleteActivity

      class BRequest_IXServicePortIF_deleteActivity extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      2125754512L
    • Class de.elo.ix.client.BRequest_IXServicePortIF_deleteActivityProject

      class BRequest_IXServicePortIF_deleteActivityProject extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      1847611287L
    • Class de.elo.ix.client.BRequest_IXServicePortIF_deleteAspect

      class BRequest_IXServicePortIF_deleteAspect extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      859111911L
    • Class de.elo.ix.client.BRequest_IXServicePortIF_deleteConfigFiles

      class BRequest_IXServicePortIF_deleteConfigFiles extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      28637388L
    • Class de.elo.ix.client.BRequest_IXServicePortIF_deleteCounters

      class BRequest_IXServicePortIF_deleteCounters extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      885266568L
    • Class de.elo.ix.client.BRequest_IXServicePortIF_deleteDocMask

      class BRequest_IXServicePortIF_deleteDocMask extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      1672606371L
    • Class de.elo.ix.client.BRequest_IXServicePortIF_deleteDocMaskLineTemplates

      class BRequest_IXServicePortIF_deleteDocMaskLineTemplates extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      1672428606L
    • Class de.elo.ix.client.BRequest_IXServicePortIF_deleteEventBusListener

      class BRequest_IXServicePortIF_deleteEventBusListener extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      1871772453L
      • Serialized Fields

    • Class de.elo.ix.client.BRequest_IXServicePortIF_deleteEventBusSubscriber

      class BRequest_IXServicePortIF_deleteEventBusSubscriber extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      1276207409L
      • Serialized Fields

    • Class de.elo.ix.client.BRequest_IXServicePortIF_deleteKeys

      class BRequest_IXServicePortIF_deleteKeys extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      894462987L
    • Class de.elo.ix.client.BRequest_IXServicePortIF_deleteKeywordList

      class BRequest_IXServicePortIF_deleteKeywordList extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      1321521914L
    • Class de.elo.ix.client.BRequest_IXServicePortIF_deleteKeywords

      class BRequest_IXServicePortIF_deleteKeywords extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      9903403L
    • Class de.elo.ix.client.BRequest_IXServicePortIF_deleteMap

      class BRequest_IXServicePortIF_deleteMap extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      1691419845L
    • Class de.elo.ix.client.BRequest_IXServicePortIF_deleteMapDomain

      class BRequest_IXServicePortIF_deleteMapDomain extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      1747919839L
    • Class de.elo.ix.client.BRequest_IXServicePortIF_deleteNotes

      class BRequest_IXServicePortIF_deleteNotes extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      1955485472L
    • Class de.elo.ix.client.BRequest_IXServicePortIF_deleteNoteTemplates

      class BRequest_IXServicePortIF_deleteNoteTemplates extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      2114072954L
    • Class de.elo.ix.client.BRequest_IXServicePortIF_deleteNotification

      class BRequest_IXServicePortIF_deleteNotification extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      109683220L
    • Class de.elo.ix.client.BRequest_IXServicePortIF_deleteOrgUnits

      class BRequest_IXServicePortIF_deleteOrgUnits extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      792061036L
    • Class de.elo.ix.client.BRequest_IXServicePortIF_deleteReminders

      class BRequest_IXServicePortIF_deleteReminders extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      1922531104L
      • Serialized Fields

    • Class de.elo.ix.client.BRequest_IXServicePortIF_deleteReport

      class BRequest_IXServicePortIF_deleteReport extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      385335563L
    • Class de.elo.ix.client.BRequest_IXServicePortIF_deleteSord

      class BRequest_IXServicePortIF_deleteSord extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      894215281L
    • Class de.elo.ix.client.BRequest_IXServicePortIF_deleteSordTypes

      class BRequest_IXServicePortIF_deleteSordTypes extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      789245482L
      • Serialized Fields

    • Class de.elo.ix.client.BRequest_IXServicePortIF_deleteSubs

      class BRequest_IXServicePortIF_deleteSubs extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      894209996L
    • Class de.elo.ix.client.BRequest_IXServicePortIF_deleteSubscription

      class BRequest_IXServicePortIF_deleteSubscription extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      363712994L
    • Class de.elo.ix.client.BRequest_IXServicePortIF_deleteSubstitutions

      class BRequest_IXServicePortIF_deleteSubstitutions extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      536795083L
    • Class de.elo.ix.client.BRequest_IXServicePortIF_deleteTranslateTerms

      class BRequest_IXServicePortIF_deleteTranslateTerms extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      158441882L
    • Class de.elo.ix.client.BRequest_IXServicePortIF_deleteUser

      class BRequest_IXServicePortIF_deleteUser extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      894152244L
    • Class de.elo.ix.client.BRequest_IXServicePortIF_deleteUserProfile

      class BRequest_IXServicePortIF_deleteUserProfile extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      634031555L
    • Class de.elo.ix.client.BRequest_IXServicePortIF_deleteUsers

      class BRequest_IXServicePortIF_deleteUsers extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      1948915673L
    • Class de.elo.ix.client.BRequest_IXServicePortIF_deleteWorkFlow

      class BRequest_IXServicePortIF_deleteWorkFlow extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      478820000L
    • Class de.elo.ix.client.BRequest_IXServicePortIF_deleteWorkflowTemplate

      class BRequest_IXServicePortIF_deleteWorkflowTemplate extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      1634712102L
    • Class de.elo.ix.client.BRequest_IXServicePortIF_editPublicDownloadUrls

      class BRequest_IXServicePortIF_editPublicDownloadUrls extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      245225739L
    • Class de.elo.ix.client.BRequest_IXServicePortIF_encryptStringRsa

      class BRequest_IXServicePortIF_encryptStringRsa extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      1840380736L
      • Serialized Fields

    • Class de.elo.ix.client.BRequest_IXServicePortIF_endEditWorkFlowNode

      class BRequest_IXServicePortIF_endEditWorkFlowNode extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      551973808L
      • Serialized Fields

        • arrEnterNodesIds
          int[] arrEnterNodesIds
        • bCancel
          boolean bCancel
        • bTerminate
          boolean bTerminate
        • ci
          ClientInfo ci
        • nFlowId
          int nFlowId
        • nNodeId
          int nNodeId
        • sComment
          String sComment
        • sName
          String sName
    • Class de.elo.ix.client.BRequest_IXServicePortIF_evalAutoFiling

      class BRequest_IXServicePortIF_evalAutoFiling extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      1823282746L
    • Class de.elo.ix.client.BRequest_IXServicePortIF_executeRegisteredFunction

      class BRequest_IXServicePortIF_executeRegisteredFunction extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      778610599L
    • Class de.elo.ix.client.BRequest_IXServicePortIF_executeRegisteredFunctionString

      class BRequest_IXServicePortIF_executeRegisteredFunctionString extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      553270730L
    • Class de.elo.ix.client.BRequest_IXServicePortIF_executeScript

      class BRequest_IXServicePortIF_executeScript extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      905800490L
    • Class de.elo.ix.client.BRequest_IXServicePortIF_exportWorkflow

      class BRequest_IXServicePortIF_exportWorkflow extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      809552457L
    • Class de.elo.ix.client.BRequest_IXServicePortIF_findActivityProjects

      class BRequest_IXServicePortIF_findActivityProjects extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      1955899064L
    • Class de.elo.ix.client.BRequest_IXServicePortIF_findAggregations

      class BRequest_IXServicePortIF_findAggregations extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      1808446624L
    • Class de.elo.ix.client.BRequest_IXServicePortIF_findBackgroundThreads

      class BRequest_IXServicePortIF_findBackgroundThreads extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      610169452L
    • Class de.elo.ix.client.BRequest_IXServicePortIF_findClose

      class BRequest_IXServicePortIF_findClose extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      928687287L
    • Class de.elo.ix.client.BRequest_IXServicePortIF_findCompletion

      class BRequest_IXServicePortIF_findCompletion extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      65203925L
    • Class de.elo.ix.client.BRequest_IXServicePortIF_findContextTerms

      class BRequest_IXServicePortIF_findContextTerms extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      1019580761L
      • Serialized Fields

    • Class de.elo.ix.client.BRequest_IXServicePortIF_findFirstActivities

      class BRequest_IXServicePortIF_findFirstActivities extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      1661199666L
    • Class de.elo.ix.client.BRequest_IXServicePortIF_findFirstConfigFiles

      class BRequest_IXServicePortIF_findFirstConfigFiles extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      954269076L
    • Class de.elo.ix.client.BRequest_IXServicePortIF_findFirstNotes

      class BRequest_IXServicePortIF_findFirstNotes extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      299362112L
    • Class de.elo.ix.client.BRequest_IXServicePortIF_findFirstReportInfos

      class BRequest_IXServicePortIF_findFirstReportInfos extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      693111280L
    • Class de.elo.ix.client.BRequest_IXServicePortIF_findFirstSords

      class BRequest_IXServicePortIF_findFirstSords extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      303977764L
    • Class de.elo.ix.client.BRequest_IXServicePortIF_findFirstSubscriptions

      class BRequest_IXServicePortIF_findFirstSubscriptions extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      1290105973L
    • Class de.elo.ix.client.BRequest_IXServicePortIF_findFirstTasks

      class BRequest_IXServicePortIF_findFirstTasks extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      304485389L
    • Class de.elo.ix.client.BRequest_IXServicePortIF_findFirstTranslateTerms

      class BRequest_IXServicePortIF_findFirstTranslateTerms extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      1162113222L
    • Class de.elo.ix.client.BRequest_IXServicePortIF_findFirstUsers

      class BRequest_IXServicePortIF_findFirstUsers extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      305931911L
    • Class de.elo.ix.client.BRequest_IXServicePortIF_findFirstWorkflows

      class BRequest_IXServicePortIF_findFirstWorkflows extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      546938477L
    • Class de.elo.ix.client.BRequest_IXServicePortIF_findNextActivities

      class BRequest_IXServicePortIF_findNextActivities extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      2116795663L
    • Class de.elo.ix.client.BRequest_IXServicePortIF_findNextConfigFiles

      class BRequest_IXServicePortIF_findNextConfigFiles extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      2108007283L
    • Class de.elo.ix.client.BRequest_IXServicePortIF_findNextNotes

      class BRequest_IXServicePortIF_findNextNotes extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      1493835871L
    • Class de.elo.ix.client.BRequest_IXServicePortIF_findNextReportInfos

      class BRequest_IXServicePortIF_findNextReportInfos extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      1846849487L
      • Serialized Fields

    • Class de.elo.ix.client.BRequest_IXServicePortIF_findNextSords

      class BRequest_IXServicePortIF_findNextSords extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      1498451523L
    • Class de.elo.ix.client.BRequest_IXServicePortIF_findNextSubscriptions

      class BRequest_IXServicePortIF_findNextSubscriptions extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      1930960532L
    • Class de.elo.ix.client.BRequest_IXServicePortIF_findNextTasks

      class BRequest_IXServicePortIF_findNextTasks extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      1498959148L
      • Serialized Fields

    • Class de.elo.ix.client.BRequest_IXServicePortIF_findNextTranslateTerms

      class BRequest_IXServicePortIF_findNextTranslateTerms extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      1524508923L
      • Serialized Fields

    • Class de.elo.ix.client.BRequest_IXServicePortIF_findNextUsers

      class BRequest_IXServicePortIF_findNextUsers extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      1500405670L
      • Serialized Fields

    • Class de.elo.ix.client.BRequest_IXServicePortIF_findNextWorkflows

      class BRequest_IXServicePortIF_findNextWorkflows extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      1653142322L
      • Serialized Fields

        • ci
          ClientInfo ci
        • index
          int index
        • maxResults
          int maxResults
        • searchId
          String searchId
    • Class de.elo.ix.client.BRequest_IXServicePortIF_findSearchTerms

      class BRequest_IXServicePortIF_findSearchTerms extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      1321253200L
    • Class de.elo.ix.client.BRequest_IXServicePortIF_finishExport

      class BRequest_IXServicePortIF_finishExport extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      1487849891L
    • Class de.elo.ix.client.BRequest_IXServicePortIF_forwardSubstitution

      class BRequest_IXServicePortIF_forwardSubstitution extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      162120340L
    • Class de.elo.ix.client.BRequest_IXServicePortIF_forwardWorkflowNode

      class BRequest_IXServicePortIF_forwardWorkflowNode extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      572079312L
    • Class de.elo.ix.client.BRequest_IXServicePortIF_getAclAccess

      class BRequest_IXServicePortIF_getAclAccess extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      939270158L
    • Class de.elo.ix.client.BRequest_IXServicePortIF_getArchiveStatistics

      class BRequest_IXServicePortIF_getArchiveStatistics extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      538085115L
      • Serialized Fields

    • Class de.elo.ix.client.BRequest_IXServicePortIF_getCompiledScripts

      class BRequest_IXServicePortIF_getCompiledScripts extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      1449667401L
    • Class de.elo.ix.client.BRequest_IXServicePortIF_getConstants

      class BRequest_IXServicePortIF_getConstants extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      14637361L
    • Class de.elo.ix.client.BRequest_IXServicePortIF_getContextTerms

      class BRequest_IXServicePortIF_getContextTerms extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      1075096680L
    • Class de.elo.ix.client.BRequest_IXServicePortIF_getDebuggerPort

      class BRequest_IXServicePortIF_getDebuggerPort extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      1274938050L
    • Class de.elo.ix.client.BRequest_IXServicePortIF_getDistinctValuesOfObjKey

      class BRequest_IXServicePortIF_getDistinctValuesOfObjKey extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      1260382845L
    • Class de.elo.ix.client.BRequest_IXServicePortIF_getEditInfoFromESW

      class BRequest_IXServicePortIF_getEditInfoFromESW extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      835848697L
    • Class de.elo.ix.client.BRequest_IXServicePortIF_getESWFromEditInfo

      class BRequest_IXServicePortIF_getESWFromEditInfo extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      1694552757L
    • Class de.elo.ix.client.BRequest_IXServicePortIF_getExportZipUrl

      class BRequest_IXServicePortIF_getExportZipUrl extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      1446672866L
    • Class de.elo.ix.client.BRequest_IXServicePortIF_getImportZipUrl

      class BRequest_IXServicePortIF_getImportZipUrl extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      254632211L
    • Class de.elo.ix.client.BRequest_IXServicePortIF_getPublicDownloads

      class BRequest_IXServicePortIF_getPublicDownloads extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      1822446082L
    • Class de.elo.ix.client.BRequest_IXServicePortIF_getScriptsToDebug

      class BRequest_IXServicePortIF_getScriptsToDebug extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      272016144L
    • Class de.elo.ix.client.BRequest_IXServicePortIF_getSearchTerms

      class BRequest_IXServicePortIF_getSearchTerms extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      349631039L
    • Class de.elo.ix.client.BRequest_IXServicePortIF_getServerInfo

      class BRequest_IXServicePortIF_getServerInfo extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      2074326767L
    • Class de.elo.ix.client.BRequest_IXServicePortIF_getServerInfoDM

      class BRequest_IXServicePortIF_getServerInfoDM extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      563195558L
    • Class de.elo.ix.client.BRequest_IXServicePortIF_getSessionFromTicket

      class BRequest_IXServicePortIF_getSessionFromTicket extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      147146740L
      • Serialized Fields

    • Class de.elo.ix.client.BRequest_IXServicePortIF_getSessionInfos

      class BRequest_IXServicePortIF_getSessionInfos extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      1406789391L
    • Class de.elo.ix.client.BRequest_IXServicePortIF_getSessionOptions

      class BRequest_IXServicePortIF_getSessionOptions extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      109969832L
    • Class de.elo.ix.client.BRequest_IXServicePortIF_getUserNames

      class BRequest_IXServicePortIF_getUserNames extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      730904509L
    • Class de.elo.ix.client.BRequest_IXServicePortIF_getWebDAVPathFromObjID

      class BRequest_IXServicePortIF_getWebDAVPathFromObjID extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      1491154434L
    • Class de.elo.ix.client.BRequest_IXServicePortIF_getWebDAVPathFromObjID2

      class BRequest_IXServicePortIF_getWebDAVPathFromObjID2 extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      1018852852L
    • Class de.elo.ix.client.BRequest_IXServicePortIF_getWorkflowTemplateVersions

      class BRequest_IXServicePortIF_getWorkflowTemplateVersions extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      775523732L
      • Serialized Fields

    • Class de.elo.ix.client.BRequest_IXServicePortIF_importWorkFlow

      class BRequest_IXServicePortIF_importWorkFlow extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      2013797722L
      • Serialized Fields

    • Class de.elo.ix.client.BRequest_IXServicePortIF_importWorkFlow2

      class BRequest_IXServicePortIF_importWorkFlow2 extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      1996780008L
    • Class de.elo.ix.client.BRequest_IXServicePortIF_insertPublicDownload

      class BRequest_IXServicePortIF_insertPublicDownload extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      1596476256L
    • Class de.elo.ix.client.BRequest_IXServicePortIF_internalReceiveEvents

      class BRequest_IXServicePortIF_internalReceiveEvents extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      1518401879L
      • Serialized Fields

        • ci
          ClientInfo ci
        • subsId
          long subsId
        • timeoutMillis
          long timeoutMillis
    • Class de.elo.ix.client.BRequest_IXServicePortIF_invalidateCache

      class BRequest_IXServicePortIF_invalidateCache extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      767982831L
      • Serialized Fields

    • Class de.elo.ix.client.BRequest_IXServicePortIF_invalidateCache2

      class BRequest_IXServicePortIF_invalidateCache2 extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      1962336065L
    • Class de.elo.ix.client.BRequest_IXServicePortIF_linkSords

      class BRequest_IXServicePortIF_linkSords extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      1326760021L
    • Class de.elo.ix.client.BRequest_IXServicePortIF_linkSords2

      class BRequest_IXServicePortIF_linkSords2 extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      1820112259L
    • Class de.elo.ix.client.BRequest_IXServicePortIF_lockArchive

      class BRequest_IXServicePortIF_lockArchive extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      2083874271L
    • Class de.elo.ix.client.BRequest_IXServicePortIF_login

      class BRequest_IXServicePortIF_login extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      1526465549L
    • Class de.elo.ix.client.BRequest_IXServicePortIF_loginAdmin

      class BRequest_IXServicePortIF_loginAdmin extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      139618532L
    • Class de.elo.ix.client.BRequest_IXServicePortIF_loginEloProf

      class BRequest_IXServicePortIF_loginEloProf extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      1544232786L
      • Serialized Fields

    • Class de.elo.ix.client.BRequest_IXServicePortIF_loginKerberos

      class BRequest_IXServicePortIF_loginKerberos extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      575080338L
      • Serialized Fields

    • Class de.elo.ix.client.BRequest_IXServicePortIF_logout

      class BRequest_IXServicePortIF_logout extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      75785664L
    • Class de.elo.ix.client.BRequest_IXServicePortIF_moveDocuments

      class BRequest_IXServicePortIF_moveDocuments extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      1730554767L
    • Class de.elo.ix.client.BRequest_IXServicePortIF_notifyServer

      class BRequest_IXServicePortIF_notifyServer extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      1873214498L
    • Class de.elo.ix.client.BRequest_IXServicePortIF_openEventBus

      class BRequest_IXServicePortIF_openEventBus extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      1111320026L
    • Class de.elo.ix.client.BRequest_IXServicePortIF_parseException

      class BRequest_IXServicePortIF_parseException extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      218602898L
    • Class de.elo.ix.client.BRequest_IXServicePortIF_processFindResult

      class BRequest_IXServicePortIF_processFindResult extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      255834993L
    • Class de.elo.ix.client.BRequest_IXServicePortIF_processOcr

      class BRequest_IXServicePortIF_processOcr extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      2058356197L
    • Class de.elo.ix.client.BRequest_IXServicePortIF_processTrees

      class BRequest_IXServicePortIF_processTrees extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      1894562916L
    • Class de.elo.ix.client.BRequest_IXServicePortIF_provideCryptPassword

      class BRequest_IXServicePortIF_provideCryptPassword extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      515214142L
    • Class de.elo.ix.client.BRequest_IXServicePortIF_provideSystemCryptPassword

      class BRequest_IXServicePortIF_provideSystemCryptPassword extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      1645565553L
    • Class de.elo.ix.client.BRequest_IXServicePortIF_queryJobProtocol

      class BRequest_IXServicePortIF_queryJobProtocol extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      1653875517L
    • Class de.elo.ix.client.BRequest_IXServicePortIF_queryJobState

      class BRequest_IXServicePortIF_queryJobState extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      221322822L
      • Serialized Fields

        • activeJobs
          boolean activeJobs
        • ci
          ClientInfo ci
        • finishedJobs
          boolean finishedJobs
        • fullInfo
          boolean fullInfo
        • jobGuid
          String jobGuid
    • Class de.elo.ix.client.BRequest_IXServicePortIF_refSord

      class BRequest_IXServicePortIF_refSord extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      1607355701L
      • Serialized Fields

    • Class de.elo.ix.client.BRequest_IXServicePortIF_registerOcrWorker

      class BRequest_IXServicePortIF_registerOcrWorker extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      318217117L
    • Class de.elo.ix.client.BRequest_IXServicePortIF_reload

      class BRequest_IXServicePortIF_reload extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      86902351L
    • Class de.elo.ix.client.BRequest_IXServicePortIF_reloadScripts

      class BRequest_IXServicePortIF_reloadScripts extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      1767312455L
    • Class de.elo.ix.client.BRequest_IXServicePortIF_resolveRights

      class BRequest_IXServicePortIF_resolveRights extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      262295187L
    • Class de.elo.ix.client.BRequest_IXServicePortIF_restoreSord

      class BRequest_IXServicePortIF_restoreSord extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      487898554L
    • Class de.elo.ix.client.BRequest_IXServicePortIF_runEsProcess

      class BRequest_IXServicePortIF_runEsProcess extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      2070765516L
      • Serialized Fields

        • ci
          ClientInfo ci
        • processName
          String processName
        • startProcess
          boolean startProcess
    • Class de.elo.ix.client.BRequest_IXServicePortIF_sendEvents

      class BRequest_IXServicePortIF_sendEvents extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      1721831543L
      • Serialized Fields

    • Class de.elo.ix.client.BRequest_IXServicePortIF_setScriptsToDebug

      class BRequest_IXServicePortIF_setScriptsToDebug extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      1212168964L
    • Class de.elo.ix.client.BRequest_IXServicePortIF_setServerInfo

      class BRequest_IXServicePortIF_setServerInfo extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      1300195555L
    • Class de.elo.ix.client.BRequest_IXServicePortIF_setServerInfoDM

      class BRequest_IXServicePortIF_setServerInfoDM extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      347556966L
    • Class de.elo.ix.client.BRequest_IXServicePortIF_setSessionOptions

      class BRequest_IXServicePortIF_setSessionOptions extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      830182988L
    • Class de.elo.ix.client.BRequest_IXServicePortIF_startAdHocWorkFlow

      class BRequest_IXServicePortIF_startAdHocWorkFlow extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      1995358580L
      • Serialized Fields

        • arrUserIds
          String[] arrUserIds
        • cancelMessage
          String cancelMessage
        • cancelUserId
          String cancelUserId
        • ci
          ClientInfo ci
        • finishedMessage
          String finishedMessage
        • finishedScript
          String finishedScript
        • finishedUserId
          String finishedUserId
        • forValidation
          boolean forValidation
        • name
          String name
        • nodeName
          String nodeName
        • objId
          String objId
        • serialFlow
          boolean serialFlow
    • Class de.elo.ix.client.BRequest_IXServicePortIF_startAdHocWorkFlow2

      class BRequest_IXServicePortIF_startAdHocWorkFlow2 extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      1726573786L
    • Class de.elo.ix.client.BRequest_IXServicePortIF_startAdHocWorkFlow3

      class BRequest_IXServicePortIF_startAdHocWorkFlow3 extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      1726573785L
    • Class de.elo.ix.client.BRequest_IXServicePortIF_startExport

      class BRequest_IXServicePortIF_startExport extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      1213820864L
      • Serialized Fields

    • Class de.elo.ix.client.BRequest_IXServicePortIF_startExportExt

      class BRequest_IXServicePortIF_startExportExt extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      1607764545L
    • Class de.elo.ix.client.BRequest_IXServicePortIF_startImport

      class BRequest_IXServicePortIF_startImport extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      1318178737L
      • Serialized Fields

        • ci
          ClientInfo ci
        • filingPath
          String filingPath
        • guidMethod
          int guidMethod
        • options
          long options
    • Class de.elo.ix.client.BRequest_IXServicePortIF_startWorkFlow

      class BRequest_IXServicePortIF_startWorkFlow extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      211211499L
    • Class de.elo.ix.client.BRequest_IXServicePortIF_startWorkFlow2

      class BRequest_IXServicePortIF_startWorkFlow2 extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      2042378073L
    • Class de.elo.ix.client.BRequest_IXServicePortIF_takeWorkFlowNode

      class BRequest_IXServicePortIF_takeWorkFlowNode extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      1305676322L
      • Serialized Fields

        • ci
          ClientInfo ci
        • lockZ
          LockZ lockZ
        • nFlags
          int nFlags
        • nFlowId
          int nFlowId
        • nNodeId
          int nNodeId
        • sUserId
          String sUserId
    • Class de.elo.ix.client.BRequest_IXServicePortIF_terminatePublicDownloadUrls

      class BRequest_IXServicePortIF_terminatePublicDownloadUrls extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      158007264L
    • Class de.elo.ix.client.BRequest_IXServicePortIF_terminateWorkFlow

      class BRequest_IXServicePortIF_terminateWorkFlow extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      1986005738L
    • Class de.elo.ix.client.BRequest_IXServicePortIF_testAdapter

      class BRequest_IXServicePortIF_testAdapter extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      1934035815L
    • Class de.elo.ix.client.BRequest_IXServicePortIF_unlinkSords

      class BRequest_IXServicePortIF_unlinkSords extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      1910068060L
    • Class de.elo.ix.client.BRequest_PackageService_checkinPackage

      class BRequest_PackageService_checkinPackage extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      2067070446L
    • Class de.elo.ix.client.BRequest_PackageService_checkoutPackages

      class BRequest_PackageService_checkoutPackages extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      705572264L
    • Class de.elo.ix.client.BRequest_PackageService_createPackage

      class BRequest_PackageService_createPackage extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      2042064267L
    • Class de.elo.ix.client.BRequest_PackageService_deletePackages

      class BRequest_PackageService_deletePackages extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      1855028659L
    • Class de.elo.ix.client.BRequest_PackageService_exportPackageContent

      class BRequest_PackageService_exportPackageContent extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      676279044L
    • Class de.elo.ix.client.BResult_1

      class BResult_1 extends byps.BMethodResult<Boolean> implements Serializable
      serialVersionUID:
      139578694L
    • Class de.elo.ix.client.BResult_10

      class BResult_10 extends byps.BMethodResult<String> implements Serializable
      serialVersionUID:
      31972170L
    • Class de.elo.ix.client.BResult_1001617329

      class BResult_1001617329 extends byps.BMethodResult<UserName[]> implements Serializable
      serialVersionUID:
      1737934677L
    • Class de.elo.ix.client.BResult_100361105

      class BResult_100361105 extends byps.BMethodResult<int[]> implements Serializable
      serialVersionUID:
      1083146178L
    • Class de.elo.ix.client.BResult_1005790586

      class BResult_1005790586 extends byps.BMethodResult<ContextTerm[]> implements Serializable
      serialVersionUID:
      1028792992L
    • Class de.elo.ix.client.BResult_1034263904

      class BResult_1034263904 extends byps.BMethodResult<CombineAclResult> implements Serializable
      serialVersionUID:
      928929669L
    • Class de.elo.ix.client.BResult_1047127860

      class BResult_1047127860 extends byps.BMethodResult<Document[]> implements Serializable
      serialVersionUID:
      1007078901L
    • Class de.elo.ix.client.BResult_1057373949

      class BResult_1057373949 extends byps.BMethodResult<ReportOptions> implements Serializable
      serialVersionUID:
      1483320409L
    • Class de.elo.ix.client.BResult_105830886

      class BResult_105830886 extends byps.BMethodResult<SubsInfo[]> implements Serializable
      serialVersionUID:
      1366049664L
    • Class de.elo.ix.client.BResult_1067648097

      class BResult_1067648097 extends byps.BMethodResult<PackageContent> implements Serializable
      serialVersionUID:
      342747275L
    • Class de.elo.ix.client.BResult_1078168929

      class BResult_1078168929 extends byps.BMethodResult<FileData[]> implements Serializable
      serialVersionUID:
      1463196284L
    • Class de.elo.ix.client.BResult_1088095067

      class BResult_1088095067 extends byps.BMethodResult<TranslateTerm[]> implements Serializable
      serialVersionUID:
      253657563L
    • Class de.elo.ix.client.BResult_1107316733

      class BResult_1107316733 extends byps.BMethodResult<DocMaskLineTemplate[]> implements Serializable
      serialVersionUID:
      874621629L
    • Class de.elo.ix.client.BResult_1112009864

      class BResult_1112009864 extends byps.BMethodResult<KeyInfo[]> implements Serializable
      serialVersionUID:
      1906806987L
    • Class de.elo.ix.client.BResult_1116629552

      class BResult_1116629552 extends byps.BMethodResult<PackageResult> implements Serializable
      serialVersionUID:
      1816826769L
    • Class de.elo.ix.client.BResult_1118179461

      class BResult_1118179461 extends byps.BMethodResult<List<PluginInfo>> implements Serializable
      serialVersionUID:
      841662246L
    • Class de.elo.ix.client.BResult_1132956238

      class BResult_1132956238 extends byps.BMethodResult<UserInfo[]> implements Serializable
      serialVersionUID:
      1840998419L
    • Class de.elo.ix.client.BResult_1143177929

      class BResult_1143177929 extends byps.BMethodResult<HashTag> implements Serializable
      serialVersionUID:
      50804539L
    • Class de.elo.ix.client.BResult_1153931872

      class BResult_1153931872 extends byps.BMethodResult<ValuesOfObjKey> implements Serializable
      serialVersionUID:
      1917165361L
    • Class de.elo.ix.client.BResult_1159353819

      class BResult_1159353819 extends byps.BMethodResult<PluginHistory> implements Serializable
      serialVersionUID:
      1517615606L
    • Class de.elo.ix.client.BResult_1191976387

      class BResult_1191976387 extends byps.BMethodResult<Any> implements Serializable
      serialVersionUID:
      1472696983L
    • Class de.elo.ix.client.BResult_1197100286

      class BResult_1197100286 extends byps.BMethodResult<SessionOptions> implements Serializable
      serialVersionUID:
      678319756L
    • Class de.elo.ix.client.BResult_1233469422

      class BResult_1233469422 extends byps.BMethodResult<BackupProfile[]> implements Serializable
      serialVersionUID:
      778916661L
    • Class de.elo.ix.client.BResult_1264954948

      class BResult_1264954948 extends byps.BMethodResult<IXServicePortC> implements Serializable
      serialVersionUID:
      1553005093L
    • Class de.elo.ix.client.BResult_1301335819

      class BResult_1301335819 extends byps.BMethodResult<FindResult> implements Serializable
      serialVersionUID:
      526443365L
    • Class de.elo.ix.client.BResult_1320348587

      class BResult_1320348587 extends byps.BMethodResult<LicenseReport> implements Serializable
      serialVersionUID:
      1169396716L
    • Class de.elo.ix.client.BResult_1330120264

      class BResult_1330120264 extends byps.BMethodResult<License> implements Serializable
      serialVersionUID:
      514066999L
    • Class de.elo.ix.client.BResult_133130047

      class BResult_133130047 extends byps.BMethodResult<SordType[]> implements Serializable
      serialVersionUID:
      324094143L
    • Class de.elo.ix.client.BResult_1376733713

      class BResult_1376733713 extends byps.BMethodResult<SessionInfo[]> implements Serializable
      serialVersionUID:
      98220986L
    • Class de.elo.ix.client.BResult_1383534582

      class BResult_1383534582 extends byps.BMethodResult<ArchivReport> implements Serializable
      serialVersionUID:
      878709939L
    • Class de.elo.ix.client.BResult_1401065069

      class BResult_1401065069 extends byps.BMethodResult<UserProfile> implements Serializable
      serialVersionUID:
      1364135521L
    • Class de.elo.ix.client.BResult_1425760760

      class BResult_1425760760 extends byps.BMethodResult<ServerInfoDM> implements Serializable
      serialVersionUID:
      1576794397L
    • Class de.elo.ix.client.BResult_1426941339

      class BResult_1426941339 extends byps.BMethodResult<MyELOState> implements Serializable
      serialVersionUID:
      1775232095L
    • Class de.elo.ix.client.BResult_1436376940

      class BResult_1436376940 extends byps.BMethodResult<JobState> implements Serializable
      serialVersionUID:
      201271360L
    • Class de.elo.ix.client.BResult_1443841819

      class BResult_1443841819 extends byps.BMethodResult<NoteTemplate[]> implements Serializable
      serialVersionUID:
      980746876L
    • Class de.elo.ix.client.BResult_148564345

      class BResult_148564345 extends byps.BMethodResult<GetWebDAVPathResult> implements Serializable
      serialVersionUID:
      1968102497L
    • Class de.elo.ix.client.BResult_1485735592

      class BResult_1485735592 extends byps.BMethodResult<UserInfo> implements Serializable
      serialVersionUID:
      853868916L
    • Class de.elo.ix.client.BResult_1495731174

      class BResult_1495731174 extends byps.BMethodResult<KeywordList> implements Serializable
      serialVersionUID:
      888818351L
    • Class de.elo.ix.client.BResult_15

      class BResult_15 extends byps.BMethodResult<InputStream> implements Serializable
      serialVersionUID:
      31972165L
    • Class de.elo.ix.client.BResult_1535847981

      class BResult_1535847981 extends byps.BMethodResult<HashSet<HashTag>> implements Serializable
      serialVersionUID:
      1539142900L
    • Class de.elo.ix.client.BResult_1537059480

      class BResult_1537059480 extends byps.BMethodResult<KeyInfo> implements Serializable
      serialVersionUID:
      1208871945L
    • Class de.elo.ix.client.BResult_1552114559

      class BResult_1552114559 extends byps.BMethodResult<KeywordsDynamicResult> implements Serializable
      serialVersionUID:
      2135982691L
    • Class de.elo.ix.client.BResult_1556767716

      class BResult_1556767716 extends byps.BMethodResult<HashMap<String,HashTag>> implements Serializable
      serialVersionUID:
      1590515712L
    • Class de.elo.ix.client.BResult_1576340510

      class BResult_1576340510 extends byps.BMethodResult<PurgeSettings> implements Serializable
      serialVersionUID:
      664594975L
    • Class de.elo.ix.client.BResult_1585309177

      class BResult_1585309177 extends byps.BMethodResult<MyELOContent> implements Serializable
      serialVersionUID:
      1516472013L
    • Class de.elo.ix.client.BResult_1597637633

      class BResult_1597637633 extends byps.BMethodResult<PluginInfo> implements Serializable
      serialVersionUID:
      827925525L
    • Class de.elo.ix.client.BResult_1652390957

      class BResult_1652390957 extends byps.BMethodResult<PluginMessage> implements Serializable
      serialVersionUID:
      416061290L
    • Class de.elo.ix.client.BResult_1663767661

      class BResult_1663767661 extends byps.BMethodResult<WFDiagram> implements Serializable
      serialVersionUID:
      1136640270L
    • Class de.elo.ix.client.BResult_1696936442

      class BResult_1696936442 extends byps.BMethodResult<AspectAssoc> implements Serializable
      serialVersionUID:
      1781176849L
    • Class de.elo.ix.client.BResult_1698025638

      class BResult_1698025638 extends byps.BMethodResult<HtCloudData> implements Serializable
      serialVersionUID:
      264783261L
    • Class de.elo.ix.client.BResult_1698110251

      class BResult_1698110251 extends byps.BMethodResult<CounterInfo[]> implements Serializable
      serialVersionUID:
      237230375L
    • Class de.elo.ix.client.BResult_1699606509

      class BResult_1699606509 extends byps.BMethodResult<ForwardWorkflowNodeResult> implements Serializable
      serialVersionUID:
      792677022L
    • Class de.elo.ix.client.BResult_1700162512

      class BResult_1700162512 extends byps.BMethodResult<FioResult> implements Serializable
      serialVersionUID:
      944476422L
    • Class de.elo.ix.client.BResult_1701141707

      class BResult_1701141707 extends byps.BMethodResult<Reminder[]> implements Serializable
      serialVersionUID:
      1830105166L
    • Class de.elo.ix.client.BResult_1701204890

      class BResult_1701204890 extends byps.BMethodResult<ServerInfo> implements Serializable
      serialVersionUID:
      1855130839L
    • Class de.elo.ix.client.BResult_1712381166

      class BResult_1712381166 extends byps.BMethodResult<InvalidateCacheResult> implements Serializable
      serialVersionUID:
      226398691L
    • Class de.elo.ix.client.BResult_1737266313

      class BResult_1737266313 extends byps.BMethodResult<ConfigFile[]> implements Serializable
      serialVersionUID:
      470722300L
    • Class de.elo.ix.client.BResult_1754570852

      class BResult_1754570852 extends byps.BMethodResult<CheckoutWorkflowHistoryResult> implements Serializable
      serialVersionUID:
      439024483L
    • Class de.elo.ix.client.BResult_1756288553

      class BResult_1756288553 extends byps.BMethodResult<MapHist[]> implements Serializable
      serialVersionUID:
      2129303359L
    • Class de.elo.ix.client.BResult_1768472140

      class BResult_1768472140 extends byps.BMethodResult<WFVersion[]> implements Serializable
      serialVersionUID:
      1408305917L
    • Class de.elo.ix.client.BResult_1788243283

      class BResult_1788243283 extends byps.BMethodResult<JobState[]> implements Serializable
      serialVersionUID:
      538961305L
    • Class de.elo.ix.client.BResult_18214274

      class BResult_18214274 extends byps.BMethodResult<UserReport> implements Serializable
      serialVersionUID:
      124408536L
    • Class de.elo.ix.client.BResult_1822579866

      class BResult_1822579866 extends byps.BMethodResult<WFEditNode> implements Serializable
      serialVersionUID:
      218334399L
    • Class de.elo.ix.client.BResult_1826370901

      class BResult_1826370901 extends byps.BMethodResult<KeyValue[]> implements Serializable
      serialVersionUID:
      584143824L
    • Class de.elo.ix.client.BResult_1835331414

      class BResult_1835331414 extends byps.BMethodResult<SordPaths> implements Serializable
      serialVersionUID:
      267493766L
    • Class de.elo.ix.client.BResult_1870182600

      class BResult_1870182600 extends byps.BMethodResult<ColorData[]> implements Serializable
      serialVersionUID:
      1546359614L
    • Class de.elo.ix.client.BResult_1881161566

      class BResult_1881161566 extends byps.BMethodResult<AutoFilingResult> implements Serializable
      serialVersionUID:
      1082076800L
    • Class de.elo.ix.client.BResult_1888107655

      class BResult_1888107655 extends byps.BMethodResult<String[]> implements Serializable
      serialVersionUID:
      1300693476L
    • Class de.elo.ix.client.BResult_19

      class BResult_19 extends byps.BMethodResult<Object> implements Serializable
      serialVersionUID:
      31972161L
    • Class de.elo.ix.client.BResult_190251704

      class BResult_190251704 extends byps.BMethodResult<ContentStream> implements Serializable
      serialVersionUID:
      440976898L
    • Class de.elo.ix.client.BResult_1959732439

      class BResult_1959732439 extends byps.BMethodResult<PackageData> implements Serializable
      serialVersionUID:
      1315253863L
    • Class de.elo.ix.client.BResult_1963952629

      class BResult_1963952629 extends byps.BMethodResult<MapDomain[]> implements Serializable
      serialVersionUID:
      2087116643L
    • Class de.elo.ix.client.BResult_1995912373

      class BResult_1995912373 extends byps.BMethodResult<NoteTemplate> implements Serializable
      serialVersionUID:
      496923600L
    • Class de.elo.ix.client.BResult_200528028

      class BResult_200528028 extends byps.BMethodResult<AclAccessResult> implements Serializable
      serialVersionUID:
      670536426L
    • Class de.elo.ix.client.BResult_2006133032

      class BResult_2006133032 extends byps.BMethodResult<WFCollectNode[]> implements Serializable
      serialVersionUID:
      1542551545L
    • Class de.elo.ix.client.BResult_2011132580

      class BResult_2011132580 extends byps.BMethodResult<MapData> implements Serializable
      serialVersionUID:
      1152181358L
    • Class de.elo.ix.client.BResult_2013723887

      class BResult_2013723887 extends byps.BMethodResult<List<Action>> implements Serializable
      serialVersionUID:
      793710070L
    • Class de.elo.ix.client.BResult_2015686193

      class BResult_2015686193 extends byps.BMethodResult<WFNode> implements Serializable
      serialVersionUID:
      1749255216L
    • Class de.elo.ix.client.BResult_202623104

      class BResult_202623104 extends byps.BMethodResult<ESStatusObj> implements Serializable
      serialVersionUID:
      1132952027L
    • Class de.elo.ix.client.BResult_2054753789

      class BResult_2054753789 extends byps.BMethodResult<DocMask> implements Serializable
      serialVersionUID:
      65290103L
    • Class de.elo.ix.client.BResult_2056457945

      class BResult_2056457945 extends byps.BMethodResult<ArchiveStatistics> implements Serializable
      serialVersionUID:
      1754530970L
    • Class de.elo.ix.client.BResult_206201524

      class BResult_206201524 extends byps.BMethodResult<Keyword[]> implements Serializable
      serialVersionUID:
      271580133L
    • Class de.elo.ix.client.BResult_2062827124

      class BResult_2062827124 extends byps.BMethodResult<PublicDownload> implements Serializable
      serialVersionUID:
      59064871L
    • Class de.elo.ix.client.BResult_21

      class BResult_21 extends byps.BMethodResult<Object> implements Serializable
      serialVersionUID:
      31972138L
    • Class de.elo.ix.client.BResult_2121298555

      class BResult_2121298555 extends byps.BMethodResult<ActivityProject> implements Serializable
      serialVersionUID:
      1182476551L
    • Class de.elo.ix.client.BResult_222450704

      class BResult_222450704 extends byps.BMethodResult<QueryJobProtocolResult> implements Serializable
      serialVersionUID:
      269034055L
    • Class de.elo.ix.client.BResult_231031238

      class BResult_231031238 extends byps.BMethodResult<StoreInfo[]> implements Serializable
      serialVersionUID:
      1008002146L
    • Class de.elo.ix.client.BResult_239574905

      class BResult_239574905 extends byps.BMethodResult<FulltextConfig> implements Serializable
      serialVersionUID:
      334967155L
    • Class de.elo.ix.client.BResult_256674679

      class BResult_256674679 extends byps.BMethodResult<Reminder> implements Serializable
      serialVersionUID:
      516768961L
    • Class de.elo.ix.client.BResult_276702696

      class BResult_276702696 extends byps.BMethodResult<SystemReport> implements Serializable
      serialVersionUID:
      270472684L
    • Class de.elo.ix.client.BResult_323351719

      class BResult_323351719 extends byps.BMethodResult<Subscription> implements Serializable
      serialVersionUID:
      679516051L
    • Class de.elo.ix.client.BResult_333475674

      class BResult_333475674 extends byps.BMethodResult<HealthCheckInfos> implements Serializable
      serialVersionUID:
      1093888861L
    • Class de.elo.ix.client.BResult_341056676

      class BResult_341056676 extends byps.BMethodResult<Document> implements Serializable
      serialVersionUID:
      945357981L
    • Class de.elo.ix.client.BResult_382788180

      class BResult_382788180 extends byps.BMethodResult<Aspect> implements Serializable
      serialVersionUID:
      417397832L
    • Class de.elo.ix.client.BResult_42339713

      class BResult_42339713 extends byps.BMethodResult<MapDomain> implements Serializable
      serialVersionUID:
      58447221L
    • Class de.elo.ix.client.BResult_460199434

      class BResult_460199434 extends byps.BMethodResult<Activity> implements Serializable
      serialVersionUID:
      1768431067L
    • Class de.elo.ix.client.BResult_460462395

      class BResult_460462395 extends byps.BMethodResult<ESSettingsObj> implements Serializable
      serialVersionUID:
      1851338646L
    • Class de.elo.ix.client.BResult_491352407

      class BResult_491352407 extends byps.BMethodResult<SordHist[]> implements Serializable
      serialVersionUID:
      652213248L
    • Class de.elo.ix.client.BResult_494610451

      class BResult_494610451 extends byps.BMethodResult<Notification> implements Serializable
      serialVersionUID:
      2092431731L
    • Class de.elo.ix.client.BResult_498630295

      class BResult_498630295 extends byps.BMethodResult<Map<Integer,String>> implements Serializable
      serialVersionUID:
      1349324407L
    • Class de.elo.ix.client.BResult_5

      class BResult_5 extends byps.BMethodResult<Integer> implements Serializable
      serialVersionUID:
      139578690L
    • Class de.elo.ix.client.BResult_52201250

      class BResult_52201250 extends byps.BMethodResult<BackupPurgeStatus> implements Serializable
      serialVersionUID:
      1769614830L
    • Class de.elo.ix.client.BResult_545905411

      class BResult_545905411 extends byps.BMethodResult<LicenseResult> implements Serializable
      serialVersionUID:
      1133476629L
    • Class de.elo.ix.client.BResult_6

      class BResult_6 extends byps.BMethodResult<Long> implements Serializable
      serialVersionUID:
      139578689L
    • Class de.elo.ix.client.BResult_607287445

      class BResult_607287445 extends byps.BMethodResult<ActivityProject[]> implements Serializable
      serialVersionUID:
      1768200726L
    • Class de.elo.ix.client.BResult_63967077

      class BResult_63967077 extends byps.BMethodResult<ExecuteScriptResult> implements Serializable
      serialVersionUID:
      311083626L
    • Class de.elo.ix.client.BResult_661820173

      class BResult_661820173 extends byps.BMethodResult<PreviewImageResult> implements Serializable
      serialVersionUID:
      765305647L
    • Class de.elo.ix.client.BResult_730157667

      class BResult_730157667 extends byps.BMethodResult<OcrWorker> implements Serializable
      serialVersionUID:
      296180383L
    • Class de.elo.ix.client.BResult_736351635

      class BResult_736351635 extends byps.BMethodResult<Action> implements Serializable
      serialVersionUID:
      790953868L
    • Class de.elo.ix.client.BResult_736983867

      class BResult_736983867 extends byps.BMethodResult<ESInfoObj> implements Serializable
      serialVersionUID:
      965560936L
    • Class de.elo.ix.client.BResult_755261279

      class BResult_755261279 extends byps.BMethodResult<IdName[]> implements Serializable
      serialVersionUID:
      933605785L
    • Class de.elo.ix.client.BResult_770771503

      class BResult_770771503 extends byps.BMethodResult<DocumentProcessor> implements Serializable
      serialVersionUID:
      1741431584L
    • Class de.elo.ix.client.BResult_776454091

      class BResult_776454091 extends byps.BMethodResult<Note[]> implements Serializable
      serialVersionUID:
      799026444L
    • Class de.elo.ix.client.BResult_77743605

      class BResult_77743605 extends byps.BMethodResult<ApplyForNotificationsInfo> implements Serializable
      serialVersionUID:
      1249722428L
    • Class de.elo.ix.client.BResult_777531606

      class BResult_777531606 extends byps.BMethodResult<LoginResult> implements Serializable
      serialVersionUID:
      115175465L
    • Class de.elo.ix.client.BResult_784089396

      class BResult_784089396 extends byps.BMethodResult<IXExceptionData> implements Serializable
      serialVersionUID:
      942817669L
    • Class de.elo.ix.client.BResult_785380175

      class BResult_785380175 extends byps.BMethodResult<EditInfo[]> implements Serializable
      serialVersionUID:
      30303361L
    • Class de.elo.ix.client.BResult_8006547

      class BResult_8006547 extends byps.BMethodResult<List<Aspect>> implements Serializable
      serialVersionUID:
      721010051L
    • Class de.elo.ix.client.BResult_809229049

      class BResult_809229049 extends byps.BMethodResult<CryptInfo[]> implements Serializable
      serialVersionUID:
      681379622L
    • Class de.elo.ix.client.BResult_810727301

      class BResult_810727301 extends byps.BMethodResult<NotifyServerResult> implements Serializable
      serialVersionUID:
      1125286952L
    • Class de.elo.ix.client.BResult_820228328

      class BResult_820228328 extends byps.BMethodResult<EditInfo> implements Serializable
      serialVersionUID:
      474407488L
    • Class de.elo.ix.client.BResult_847213937

      class BResult_847213937 extends byps.BMethodResult<ComputeDocumentHashResult> implements Serializable
      serialVersionUID:
      1581552653L
    • Class de.elo.ix.client.BResult_86336767

      class BResult_86336767 extends byps.BMethodResult<ConfigResult> implements Serializable
      serialVersionUID:
      1989679479L
    • Class de.elo.ix.client.BResult_881442092

      class BResult_881442092 extends byps.BMethodResult<List<PublicDownload>> implements Serializable
      serialVersionUID:
      1007204783L
    • Class de.elo.ix.client.BResult_884364631

      class BResult_884364631 extends byps.BMethodResult<ReplSetName[]> implements Serializable
      serialVersionUID:
      1628589312L
    • Class de.elo.ix.client.BResult_888671717

      class BResult_888671717 extends byps.BMethodResult<FileData> implements Serializable
      serialVersionUID:
      970359246L
    • Class de.elo.ix.client.BResult_892356058

      class BResult_892356058 extends byps.BMethodResult<InheritKeywordingResult> implements Serializable
      serialVersionUID:
      1595522649L
    • Class de.elo.ix.client.BResult_893011331

      class BResult_893011331 extends byps.BMethodResult<Map<Integer,OrgUnitInfo>> implements Serializable
      serialVersionUID:
      1901668644L
    • Class de.elo.ix.client.BResult_907729609

      class BResult_907729609 extends byps.BMethodResult<List<ResolveRightsResult>> implements Serializable
      serialVersionUID:
      1537036490L
    • Class de.elo.ix.client.BResult_910482075

      class BResult_910482075 extends byps.BMethodResult<Event[]> implements Serializable
      serialVersionUID:
      1281727937L
    • Class de.elo.ix.client.BResult_937420667

      class BResult_937420667 extends byps.BMethodResult<Note> implements Serializable
      serialVersionUID:
      1910622485L
    • Class de.elo.ix.client.BResult_944564842

      class BResult_944564842 extends byps.BMethodResult<LdapConfig> implements Serializable
      serialVersionUID:
      1497088357L
    • Class de.elo.ix.client.BResult_954316611

      class BResult_954316611 extends byps.BMethodResult<SubstitutionsResult> implements Serializable
      serialVersionUID:
      1116886945L
    • Class de.elo.ix.client.BResult_998509414

      class BResult_998509414 extends byps.BMethodResult<OcrResult> implements Serializable
      serialVersionUID:
      870856762L
    • Class de.elo.ix.client.BStub_IXEventBusHandler

      class BStub_IXEventBusHandler extends byps.BStub implements Serializable
      serialVersionUID:
      627994447L
    • Class de.elo.ix.client.BStub_IXServerEvents

      class BStub_IXServerEvents extends byps.BStub implements Serializable
      serialVersionUID:
      1938363825L
    • Class de.elo.ix.client.BStub_IXServicePortIF

      class BStub_IXServicePortIF extends byps.BStub implements Serializable
      serialVersionUID:
      1795705954L
    • Class de.elo.ix.client.BStub_PackageService

      class BStub_PackageService extends byps.BStub implements Serializable
      serialVersionUID:
      514751403L
    • Class de.elo.ix.client.CheckAccessOptions

      class CheckAccessOptions extends ValueClass implements Serializable
      serialVersionUID:
      391414716936396079L
    • Class de.elo.ix.client.CheckinDocOptions

      class CheckinDocOptions extends ValueClass implements Serializable
      serialVersionUID:
      1433031299L
    • Class de.elo.ix.client.CheckinOrgUnitInfo

      class CheckinOrgUnitInfo extends Object implements Serializable
      serialVersionUID:
      740959052L
    • Class de.elo.ix.client.CheckinReportInfo

      class CheckinReportInfo extends Object implements Serializable
      serialVersionUID:
      -4940148871232187692L
    • Class de.elo.ix.client.CheckinUsersC

      class CheckinUsersC extends Object implements Serializable
      serialVersionUID:
      1602486374L
    • Class de.elo.ix.client.CheckinUsersZ

      class CheckinUsersZ extends ValueClass implements Serializable
      serialVersionUID:
      403687865L
      • Serialized Fields

        • bset
          long bset
          Bitset field for constants from CheckinUsersC class.
    • Class de.elo.ix.client.CheckoutOrgUnitInfo

      class CheckoutOrgUnitInfo extends Object implements Serializable
      serialVersionUID:
      948431844L
    • Class de.elo.ix.client.CheckoutSordPathInfo

      class CheckoutSordPathInfo extends Object implements Serializable
      serialVersionUID:
      730679282L
      • Serialized Fields

        • inclRefPaths
          boolean inclRefPaths
    • Class de.elo.ix.client.CheckoutUsersC

      class CheckoutUsersC extends Object implements Serializable
      serialVersionUID:
      531758278L
    • Class de.elo.ix.client.CheckoutUsersZ

      class CheckoutUsersZ extends ValueClass implements Serializable
      serialVersionUID:
      1897433533L
      • Serialized Fields

        • bset
          long bset
          Bitset field for constants from CheckoutUsersC class.
    • Class de.elo.ix.client.CheckoutWorkflowHistoryParams

      class CheckoutWorkflowHistoryParams extends ValueClass implements Serializable
      serialVersionUID:
      -6781025337358097240L
      • Serialized Fields

        • flowId
          String flowId
          Workflow ID or workflow GUID.
        • nodeId
          int nodeId
          Node ID. If node ID is 0, histories of all node are return.
    • Class de.elo.ix.client.CheckoutWorkflowHistoryResult

      class CheckoutWorkflowHistoryResult extends ValueClass implements Serializable
      serialVersionUID:
      3461148104312791140L
    • Class de.elo.ix.client.ClientInfo

      class ClientInfo extends ValueClass implements Serializable
      serialVersionUID:
      1258190913L
      • Serialized Fields

        • callId
          String callId
          This string is used for debugging purposes only. It is displayed in error messages and reports.
        • country
          String country
          Country in ISO 3166 format. This value defines number formats (especially the decimal delimiter) used in numeric values in Sord.objKeys.
          Examples
          CZ Czeach Republic
          FR France
          DE Germany
          A country can also be specified in ClientInfo.language.
        • language
          String language
          The user's language as IETF language tag. A language is specified as IETF language tag. The language part conforms to ISO 639-1. Starting with IX version 21.3, a language tag is optionally followed by a country tag from ISO 3166-1 alpha-2. The parts are separated by hyphen.
          Examples:
          de German
          de-CH German language in Switzerland
          de-AT German language in Austria
          If a translation for a given language is not found, other language tags are taken into account as described in FindTranslateTermInfo. The country part in this value is overwritten by ClientInfo.country if provided.
        • options
          int options
          Internal use only. Bit 0 of this member is set for requests that are send from one Indexserver instance to another instance in load balancing scenarios.
          Since:
          8.00.010.000
        • ticket
          String ticket

          This is the session ID in the communication between the client and the Indexserver. It has a limited lifetime. The lifetime can be configured at the ELOAM (access manager server). The Indexserver returns a valid ticket if the IXServicePortIF.login call succeeds. The lifetime of the ticket can be extended by calling IXServicePortIF.alive.

          See Also:
        • timeZone
          String timeZone
          The time zone for the ELO client. Can be one of the predefined time zone IDs in the Java platform or a string of format "GMT" + sign + hh + ":" + mm.
    • Class de.elo.ix.client.ClientInfoC

      class ClientInfoC extends Object implements Serializable
      serialVersionUID:
      847449421L
    • Class de.elo.ix.client.ColorData

      class ColorData extends ValueClass implements Serializable
      serialVersionUID:
      1735048729L
      • Serialized Fields

        • deleted
          boolean deleted
          Logically deleted.
          Since:
          7.00.000.003
        • displayName
          String displayName
          Localized name. This read-only value is the localized ColorData.nameTranslationKey. If ColorData.nameTranslationKey is empty, this value is set to ColorData.name.
          Since:
          21.02.000.006
          See Also:
        • guid
          String guid
          GUID
          Since:
          7.00.000.003
        • hidden
          boolean hidden
          This color should not be selectable in client applications. This color is reserved as marker for technical purposes.
          Since:
          20.00.000.001
        • id
          int id
          Colour number (ID).
        • name
          String name
          Colour name
        • nameTranslationKey
          String nameTranslationKey
          Translation key. Optional identifier in the localization property files or translations stored via IXServicePortIF.checkinTranslateTerms(ClientInfo, TranslateTerm[], LockZ).
          Since:
          21.02.000.006
        • packageName
          String packageName
          Package name of ColorData
          Since:
          20.00.000.009
        • RGB
          int RGB
          RGB value.
        • TStamp
          String TStamp
          TStamp
          Since:
          7.00.000.003
        • TStampSync
          String TStampSync
          Timestamp of this object's last export by the replication.
          Since:
          9.99.009.001
    • Class de.elo.ix.client.ColorDataC

      class ColorDataC extends ColorDataInternC implements Serializable
      serialVersionUID:
      881975137L
      • Serialized Fields

        • GUID_BLUE
          String GUID_BLUE
          Color blue
          Since:
          7.00.000.003
        • GUID_GREEN
          String GUID_GREEN
          Color green
          Since:
          7.00.000.003
        • GUID_RED
          String GUID_RED
          Color red
          Since:
          7.00.000.003
        • GUID_SYSTEM
          String GUID_SYSTEM
          System color
          Since:
          7.00.000.003
    • Class de.elo.ix.client.ColorDataInternC

      class ColorDataInternC extends Object implements Serializable
      serialVersionUID:
      1208511866L
      • Serialized Fields

        • lnGuid
          int lnGuid
          Column length: GUID DB column: colorguid
          Since:
          7.00.000.003
        • lnName
          int lnName
          DB column: colorname
        • lnNameTranslationKey
          int lnNameTranslationKey
          Column length: Translation key. Optional identifier in the localization property files or translations stored DB column: trankey
          Since:
          21.02.000.006
        • lnPackageName
          int lnPackageName
          Column length: Package name of ColorData DB column: packagename
          Since:
          20.00.000.009
        • lnTStamp
          int lnTStamp
          Column length: TStamp DB column: colortstamp
          Since:
          7.00.000.003
        • lnTStampSync
          int lnTStampSync
          Column length: Timestamp of this object's last export by the replication. DB column: colortstampsync
          Since:
          9.99.009.001
    • Class de.elo.ix.client.CombineAclOptions

      class CombineAclOptions extends Object implements Serializable
      serialVersionUID:
      66519402L
      • Serialized Fields

        • lhsAclStr
          String lhsAclStr
          Left operand for ACL operation in String representation.
          Since:
          7.00.020.005
        • rhsAclStr
          String rhsAclStr
          Right operand for ACL operation in String representation.
          Since:
          7.00.020.005
    • Class de.elo.ix.client.CombineAclResult

      class CombineAclResult extends Object implements Serializable
      serialVersionUID:
      1034263904L
      • Serialized Fields

        • compareCode
          int compareCode
          Compare result. Negative if ACL lhs is less than rhs. Positive if ACL lhs is greater than rhs. Zero if ACLs are equal.
        • compareIgnoreAccessCode
          int compareIgnoreAccessCode
          Compare result by ignoring the member AclItem.access. Negative if ACL lhs is less than rhs. Posiitve if ACL lhs is greater than rhs. Zero if ACLs are equal.
        • difference
          AclItem[] difference
          Contains the ACL items that are in ACL lhs but not in rhs.
        • differenceAclStr
          String differenceAclStr
          String representation of AclItem array difference.
          Since:
          7.00.020.005
          See Also:
        • intersection
          AclItem[] intersection
          Contains the ACL items that are in both ACLs.
        • intersectionAclStr
          String intersectionAclStr
          String representation of AclItem array intersection.
          Since:
          7.00.020.005
          See Also:
        • inverseDifference
          AclItem[] inverseDifference
          Contains the ACL items that are in ACL rhs but not in lhs.
        • inverseDifferenceAclStr
          String inverseDifferenceAclStr
          String representation of AclItem array inverseDifference.
          Since:
          7.00.020.005
          See Also:
        • spaceIntersection
          AclItem[] spaceIntersection
          Contains the result of the combination of a workspace ACL with another ACL. This field is set only if at least one of the ACLs contains an X-access. As the operation is not commutative, it expects the ACL of the workspace in the first AclItem[] parameter of IXServicePortIF.combineAcl(ClientInfo, AclItem[], AclItem[], CombineAclOptions).
          Since:
          21.04.000.009
        • spaceIntersectionStr
          String spaceIntersectionStr
          String representation of AclItem array CombineAclResult.spaceIntersection.
          Since:
          21.04.000.009
        • sum
          AclItem[] sum
          Contains the sum of both ACLs.
        • sumAclStr
          String sumAclStr
          String representation of AclItem array sum.
          Since:
          7.00.020.005
          See Also:
    • Class de.elo.ix.client.ComputeDocumentHashInfo

      class ComputeDocumentHashInfo extends ValueClass implements Serializable
      serialVersionUID:
      7807368261920245023L
      • Serialized Fields

        • docId
          int docId
          Document ID.
    • Class de.elo.ix.client.ComputeDocumentHashResult

      class ComputeDocumentHashResult extends ValueClass implements Serializable
      serialVersionUID:
      5306485552365663601L
    • Class de.elo.ix.client.ConfigFile

      class ConfigFile extends ValueClass implements Serializable
      serialVersionUID:
      582012382L
      • Serialized Fields

        • dir
          String dir
          The path to the file.
        • fileData
          FileData fileData
          The content of the file.
        • isDirectory
          boolean isDirectory
          Returns true if the object is a directory, false if it is a file.
        • lastModifiedISO
          String lastModifiedISO
          The last-modified date of the script file. This value is related to the UTC time-zone.
        • name
          String name
          The name of the file or the extension.
        • size
          long size
          File size.
        • uploadResult
          String uploadResult
          HTTP-Response returned when file is uploaded.
        • url
          String url
          Download or upload URL.
    • Class de.elo.ix.client.ConfigFileC

      class ConfigFileC extends Object implements Serializable
      serialVersionUID:
      2098566124L
    • Class de.elo.ix.client.ConfigFileZ

      class ConfigFileZ extends ValueClass implements Serializable
      serialVersionUID:
      821574897L
      • Serialized Fields

        • bset
          long bset
          Bitset field for constants of the ConfigFileC class.
    • Class de.elo.ix.client.ContextTerm

      class ContextTerm extends Object implements Serializable
      serialVersionUID:
      1464223403L
      • Serialized Fields

        • docNum
          int docNum
        • term
          String term
    • Class de.elo.ix.client.ContextTermResults

      class ContextTermResults extends Object implements Serializable
      serialVersionUID:
      143746134739396739L
    • Class de.elo.ix.client.ControlBackupInfo

      class ControlBackupInfo extends ValueClass implements Serializable
      serialVersionUID:
      1738666671L
      • Serialized Fields

        • mode
          int mode
          Start, stop and status of the ELOdm backup and purge tasks (constants in ControlBackupInfoC)
    • Class de.elo.ix.client.ControlBackupInfoC

      class ControlBackupInfoC extends ValueClass implements Serializable
      serialVersionUID:
      1165618755L
    • Class de.elo.ix.client.CopyInfo

      class CopyInfo extends ValueClass implements Serializable
      serialVersionUID:
      2138439536L
      • Serialized Fields

        • adjustAclDifference
          boolean adjustAclDifference
          The permissions of the moved object are modified. The permissions inherited from the old parent are substracted and the permissions of the new parent are added to the object.
          Since:
          7.00.020.010
        • adjustAclIgnoreDocuments
          boolean adjustAclIgnoreDocuments
          Recursivly adjust the permissions of the child-documents of the moved object too.
          Since:
          7.00.020.010
        • adjustAclIgnoreFolders
          boolean adjustAclIgnoreFolders
          Recursivly adjust the permissions of the sub-folders of the moved object too.
          Since:
          7.00.020.010
        • adjustAclInBackground
          boolean adjustAclInBackground
          Recursivly adjust the permissions of the child-elements in the background.
          Since:
          7.00.020.010
        • adjustAclOverwrite
          boolean adjustAclOverwrite
          Set the permissions of the moved object equal to the permissions of the new parent.
          Since:
          7.00.020.010
        • checkRecursion
          boolean checkRecursion
          Check for recursion. If this member is set, the function IXServicePortIF.copySord(ClientInfo, String, String, CopyInfo, CopySordZ) checks whether the copy or move operation causes a recursion in the archive hierarchy. If so, the function throws an exception with IXExceptionC.ACCESS_DENIED.
          Since:
          8.00.020.005
        • depth
          int depth
          Depth up to which the structure is to be copied. THIS FUNCTION IS NOT CURRENTLY SUPPORTED!
        • manSortIdx
          int manSortIdx
          Manually determine the position. Use 0 to insert at the beginning of the child list. Use -1 to insert at the end of the child list ( this is the fastest mode). A value n greater then 0 inserts the object at the position n.
        • name
          String name
          COPY-Mode: Name of the destination archive entry. THIS FUNCTION IS NOT CURRENTLY SUPPORTED!
        • oldParentId
          String oldParentId
          Parent ID for move operation. Set this element to the old parent ID when a reference has to be moved. If an original entry has to be moved, set the main parent ID or leave the value empty.
          Since:
          8.00.030.001
    • Class de.elo.ix.client.CopyOptions

      class CopyOptions extends Object implements Serializable
      serialVersionUID:
      1427182574L
      • Serialized Fields

        • acceptChanges
          boolean acceptChanges
          Accept the change. Only one of the three options keepOriginalPermissions, takeTargetPermissions and acceptChanges can be true.
          Since:
          8.00.032.005
        • adjustAclDifference
          boolean adjustAclDifference
          The permissions of the moved objects are modified. The permissions inherited from the old parent are substracted and the permissions of the new parent are added to the object.
          Since:
          9.00.000.006
        • copyOnlyBaseElement
          boolean copyOnlyBaseElement
          Copy only the base element.
        • copyOnlyWorkAttachment
          boolean copyOnlyWorkAttachment
          If inclAttachments and copyOnlyWorkAttachment are true, copy only the work attachments. Setting copyOnlyWorkAttachment to true when inclAttachments is false is invalid.
          Since:
          8.00.032.008
        • copyOnlyWorkversion
          boolean copyOnlyWorkversion
          Do not copy all documents versions but only workversion
          Since:
          8.00.032.003
        • copyStructuresAndDocuments
          boolean copyStructuresAndDocuments
          Copy all structures with the documents.
        • inclAttachments
          boolean inclAttachments
          Also copy all attachments.
          Since:
          8.00.032.008
        • keepCurrentNotes
          boolean keepCurrentNotes
          Keep the current documentnotes.
        • keepOriginalOwner
          boolean keepOriginalOwner
          Keep the original owner of the archive element.
        • keepOriginalPermissions
          boolean keepOriginalPermissions
          Keep the current permissions. Only one of the three options keepOriginalPermissions, takeTargetPermissions and acceptChanges can be true.
          Since:
          8.00.032.005
        • keepReferences
          boolean keepReferences
          Keep references to original objects in copied parents. This member is ignored, if ProcessInfo.inclReferences=false. If this member is true or only the parent is included in the tree, the copied reference links the copied parent to the original object. If this member is false and both the parent and object of a reference is included in the tree, the copied reference links the copied parent to the copied object.
          Since:
          8.00.000.004
        • moveOnly
          boolean moveOnly
          Only move the element.
          Since:
          9.00.000.006
        • newParentId
          int newParentId
          ParentId of the new element.
        • takeTargetPermissions
          boolean takeTargetPermissions
          Take the target permissions. Only one of the three options keepOriginalPermissions, takeTargetPermissions and acceptChanges can be true.
          Since:
          8.00.032.005
        • targetName
          String targetName
          Name of the target archive element.
    • Class de.elo.ix.client.CopyResult

      class CopyResult extends Object implements Serializable
      serialVersionUID:
      1904597264L
    • Class de.elo.ix.client.CopySordC

      class CopySordC extends Object implements Serializable
      serialVersionUID:
      1616091412L
    • Class de.elo.ix.client.CopySordZ

      class CopySordZ extends ValueClass implements Serializable
      serialVersionUID:
      2059126408L
      • Serialized Fields

        • bset
          long bset
          Bitset field for constants from the CopySordC class.
    • Class de.elo.ix.client.CounterInfo

      class CounterInfo extends ValueClass implements Serializable
      serialVersionUID:
      1809378891L
      • Serialized Fields

        • name
          String name
          Name of the counter
        • value
          int value
          The current value of the counter
    • Class de.elo.ix.client.CounterInfoC

      class CounterInfoC extends Object implements Serializable
      serialVersionUID:
      1843901056L
    • Class de.elo.ix.client.CountResult

      class CountResult extends Object implements Serializable
      serialVersionUID:
      1581335066L
      • Serialized Fields

        • attBytesCount
          long attBytesCount
          count of the bytes of the current attachment version
        • docAttachCount
          int docAttachCount
          count of the found document attachments
        • docBytesCount
          long docBytesCount
          count of the bytes of the current document version
        • docCount
          int docCount
          count of the found documents
        • docVersionsCount
          int docVersionsCount
          count of the documents in the version history
        • otherAttachVersionsCount
          int otherAttachVersionsCount
          count of the other attachment versions
          Since:
          7.00.000.002
        • otherAttVersBytesCount
          long otherAttVersBytesCount
          count of the bytes of other attachment versions
          Since:
          7.00.000.002
        • otherDocVersBytesCount
          long otherDocVersBytesCount
          count of the bytes of other document versions
          Since:
          7.00.000.002
        • structCount
          int structCount
          count of the found structures
    • Class de.elo.ix.client.CryptInfo

      class CryptInfo extends ValueClass implements Serializable
      serialVersionUID:
      1826259804L
      • Serialized Fields

        • aesSystemInitVector
          String aesSystemInitVector
          Since:
          12.00.000.028
        • aesSystemKeyInfo
          String aesSystemKeyInfo
          Since:
          12.00.000.028
        • aesUserInitVector
          String aesUserInitVector
          Since:
          12.00.000.028
        • aesUserKeyInfo
          String aesUserKeyInfo
          Since:
          12.00.000.028
        • currentPwd
          String currentPwd
          Since:
          12.00.000.028
        • currentSystemPwd
          String currentSystemPwd
          Since:
          12.00.000.028
        • id
          int id
          Numerical ID of the encryption information. The first ID is 1.
        • keyInfo
          String keyInfo
          Only for TwoFish-Encyption! Key material. Contains the external and internal password in serialized and encrypted format. Only for internal use. This member is ignored in checkinCryptInfos.
        • name
          String name
          Name.
        • pwd
          String pwd
          External password used for encrypting documents. It is empty if this object was returned by checkoutCryptInfos.
        • systemPwd
          String systemPwd
          Since:
          12.00.000.028
        • systemUserId
          String systemUserId
          Since:
          12.00.000.028
        • version
          String version
          Since:
          12.00.000.028
    • Class de.elo.ix.client.CryptInfoC

      class CryptInfoC extends Object implements Serializable
      serialVersionUID:
      1843621056L
    • Class de.elo.ix.client.DeleteActivityOptions

      class DeleteActivityOptions extends ValueClass implements Serializable
      serialVersionUID:
      78913228L
      • Serialized Fields

        • deleteFinally
          boolean deleteFinally
          Delete activity finally. The database information for the activity is deleted, if this member is true. Otherwise the Activity.backAt is set to the current date.
    • Class de.elo.ix.client.DeleteOptions

      class DeleteOptions extends ValueClass implements Serializable
      serialVersionUID:
      329713511L
      • Serialized Fields

        • deleteCertainDocumentVersionsOnly
          boolean deleteCertainDocumentVersionsOnly
          Delete physically certain document versions of the objects. In order to delete physically certain document versions, first mark document versions as deleted (using DocVersion.setDeleted, followed by checkinDocEnd). Then call deleteSord after having set DeleteOptions.deleteFinally=true and DeleteOptions.deleteCertainDocumentVersionsOnly=true. (In order to delete all document versions, use field deleteDocumentVersionsOnly)
          Since:
          8.00.030.002
        • deleteDocumentVersionsOnly
          boolean deleteDocumentVersionsOnly
          Delete the document versions of the objects but keep keywording information. In order to delete only the document versions, call deleteSord on an maybe undeleted object and set DeleteOptions.deleteFinally=true and DeleteOptions.deleteDocumentVersionsOnly=true.
          Since:
          7.00.000.044
        • deleteExpiredFolders
          boolean deleteExpiredFolders
          Delete only expired folders and documents. Only expired empty folders can be deleted. Only supported in function IXServicePortIF.cleanupStart(ClientInfo, DeleteOptions). This option can be combined with DeleteOptions.deleteFinally.
          Behavior
          deleteFinally Action
          false All expired objects will be marked as deleted (but not finally deleted). The objects ACL is checked before it is deleted. LockC.FORCE is applied when deleting an object.
          true Objects that are expired and marked are deleted finally.
          Since:
          8.00.032.009
        • deleteExpiredOnly
          boolean deleteExpiredOnly
          Delete only expired objects. Only supported in function IXServicePortIF.cleanupStart(ClientInfo, DeleteOptions). This option can be combined with DeleteOptions.deleteFinally.
          Behavior
          deleteFinally Action
          false All expired objects will be marked as deleted (but not finally deleted). The objects ACL is checked before it is deleted. LockC.FORCE is applied when deleting an object.
          true Objects that are expired and marked are deleted finally.
          Since:
          6.00.098
        • deleteFinally
          boolean deleteFinally
          deleteFinally=true causes the objects to be removed physically. When used together with cleanupStart, this option is always true. Exception: see DeleteOptions.deleteExpiredOnly
        • deleteResidueFree
          boolean deleteResidueFree
          Delete all references to the objects in the database. This includes reporting, replication control information, fulltext, etc. This option is ignroed, if deleteFinally is false.
          Since:
          7.00.000.044
        • folderMustBeEmpty
          boolean folderMustBeEmpty
          Delete a folder only if it is empty. Set this member to true, if deleteSord should delete only empty folders. If the parameters to deleteSord specify the original location of a non-empty folder, the exception IXExceptionC.ACCESS_DENIED is thrown. This option is ignored, if deleteSord is invokded with a reference.
          Since:
          8.00.010.003
        • maxIDate
          String maxIDate
          maxIDate ist the ISO representation of the local date used to mark the upper limit for deleting.
        • maxTStamp
          String maxTStamp
          Delete objects modified last time before this date. Only supported in function cleanupStart. If deleteFinally is true and this member is set, ony those objects are deleted finally, which were deleted logically before the given time. It must be an ISO value in the local time zone.
          Since:
          7.00.000.041
    • Class de.elo.ix.client.DeleteOrgUnitInfo

      class DeleteOrgUnitInfo extends Object implements Serializable
      serialVersionUID:
      537993523L
      • Serialized Fields

        • ids
          int[] ids
          OU identifiers
        • names
          String[] names
          OU names
    • Class de.elo.ix.client.DocHistory

      class DocHistory extends ValueClass implements Serializable
      serialVersionUID:
      189452795L
      • Serialized Fields

        • comment
          String comment
          The user can enter a comment that describes the version. DB column: histcomment
        • createDate
          int createDate
          The version is created at this date. The value is an ELO date format. DB column: createdate
        • deleteDate
          int deleteDate
          The version is deleted at this date. The value is an ELO date format. The value is zero, if isDeleted() returns false.
          Since:
          9.00.000.000
        • docId
          int docId
          Document version ID. DB column: documentid
        • docMD5
          String docMD5
          The MD5 hash of the document file. DB column: docmd5
        • flags
          int flags
          MFG_BURNIN DB column: docflags
        • guid
          String guid
          GUID of the document version. DB column: docguid
        • language
          String language
          Language of the document content. This value is estimated by ELO Textreader when the document is sent for fulltext extraction. See TranslateTermC.DEFAULT_LANGUAGES for a list of language-tags.
          Since:
          21.04.000.001
        • nbOfValidSignatures
          int nbOfValidSignatures
          Number of valid signatures.
          Since:
          9.00.016.002
          See Also:
        • objId
          int objId
          Document version belongs to this object. DB column: objectid
        • sigId
          int sigId
          Document signature ID. DB column: docsignature
        • status
          int status
          Deleted versions have Status=1. DB column: docstatus
        • tStamp
          String tStamp
          The last update time of the version in ISO format (with dots). DB column: doctstamp
        • TStampSync
          String TStampSync
          Timestamp of this object's last export by the replication.
          Since:
          9.99.009.001
        • type
          int type
          The type of this DocHistory makes the difference between attachments and document versions.
          Since:
          9.99.009.001
          See Also:
        • user
          int user
          The user who inserts the version into the archive. DB column: userid
        • version
          String version
          The version number (like 1.0) of the document version. DB column: histversion
    • Class de.elo.ix.client.DocHistoryC

      class DocHistoryC extends Object implements Serializable
      serialVersionUID:
      1456349355L
      • Serialized Fields

        • lnComment
          int lnComment
          DB column: histcomment
        • lnDocMD5
          int lnDocMD5
          DB column: docmd5
        • lnGuid
          int lnGuid
          DB column: docguid
        • lnLanguage
          int lnLanguage
          Column length: Language of the document content. DB column: language
          Since:
          21.04.000.001
        • lnTStamp
          int lnTStamp
          DB column: doctstamp
        • lnTStampSync
          int lnTStampSync
          Column length: Timestamp of this object's last export by the replication. DB column: doctstampsync
          Since:
          9.99.009.001
        • lnVersion
          int lnVersion
          DB column: histversion
    • Class de.elo.ix.client.DocInfoDM

      class DocInfoDM extends ValueClass implements Serializable
      serialVersionUID:
      673204378L
      • Serialized Fields

        • createDateIso
          String createDateIso
          Create date ISO. DB column: createdate
        • encrSet
          int encrSet
          Encryption set.
          Since:
          6.00.097
        • ext
          String ext
          File extension DB column: ext
        • extOrig
          String extOrig
          Original file extension for encrypted documents
          Since:
          6.00.097
        • fclip
          String fclip
          reserved DB column: fclip
        • ftExt
          String ftExt
          Fulltext file extension.
          Since:
          12.00.000.042
        • fulltextContentSize
          int fulltextContentSize
          Fulltext content file size. Since the fulltext content file is usually stored in UTF-8 encoding, the file size might be different from the number of characters.
          Since:
          7.00.040.006
        • fulltextContentTStamp
          String fulltextContentTStamp
          Fulltext content timestamp
          Since:
          7.00.040.006
        • guid
          String guid
          Document GUID. DB column: docguid
        • id
          int id
          Document version ID. DB column: docid
        • lastAccessIso
          String lastAccessIso
          Last access date ISO. DB column: lastaccess
        • lastUpdateIso
          String lastUpdateIso
          Last update date ISO. DB column: lastupdate
        • md5
          String md5
          MD5 hash. DB column: md5
        • owner
          int owner
          User ID. DB column: owner
        • pathId
          int pathId
          Storage path ID DB column: pathid
        • pathId2
          int pathId2
          reserved DB column: pathid2
        • previewExt
          String previewExt
          Preview file extension.
          Since:
          7.00.026.001
        • previewExtOrig
          String previewExtOrig
          Original preview file extension for encrypted previews.
          Since:
          12.00.000.044
        • previewSize
          int previewSize
          Size of preview file. Is 0, if there is no preview file assigned. Is -1, if preview creation has failed.
          Since:
          7.00.026.001
        • previewSizeL
          long previewSizeL
          Size of preview file. Is 0, if there is no preview file assigned. Is -1, if preview creation has failed.
          Since:
          9.00.000.023
        • relFilePath
          String relFilePath
          Relative file path
          Since:
          9.00.030.023
        • size
          int size
          Deprecated.
          File size. DB column: docsize
        • sizeL
          long sizeL
          Document file size.
          Since:
          9.00.000.023
        • sizeOrig
          int sizeOrig
          Original file size for encrypted documents
          Since:
          6.00.097
        • sizeOrigL
          long sizeOrigL
          Original file extension for encrypted documents
          Since:
          9.00.000.023
    • Class de.elo.ix.client.DocInfoDMC

      class DocInfoDMC extends Object implements Serializable
      serialVersionUID:
      1042422760L
      • Serialized Fields

        • lnCreateDateIso
          int lnCreateDateIso
          DB column: createdate
        • lnExt
          int lnExt
          DB column: ext
        • lnExtOrig
          int lnExtOrig
          Column length: Original file extension for encrypted documents DB column: extorig
          Since:
          6.00.097
        • lnFclip
          int lnFclip
          DB column: fclip
        • lnFtExt
          int lnFtExt
          Column length: Fulltext file extension. DB column: ftext
          Since:
          12.00.000.042
        • lnFulltextContentTStamp
          int lnFulltextContentTStamp
          Column length: Fulltext content timestamp DB column: fttstamp
          Since:
          7.00.040.006
        • lnGuid
          int lnGuid
          DB column: docguid
        • lnLastAccessIso
          int lnLastAccessIso
          DB column: lastaccess
        • lnLastUpdateIso
          int lnLastUpdateIso
          DB column: lastupdate
        • lnMd5
          int lnMd5
          DB column: md5
        • lnPreviewExt
          int lnPreviewExt
          Column length: Preview file extension. DB column: previewext
          Since:
          7.00.026.001
        • lnPreviewExtOrig
          int lnPreviewExtOrig
          Column length: Original preview file extension for encrypted previews. DB column: previewextorig
          Since:
          12.00.000.044
        • lnPreviewSizeL
          int lnPreviewSizeL
          Column length: Size of preview file. Is 0, if there is no preview file assigned. Is -1, if preview creation DB column: previewsize
          Since:
          9.00.000.023
        • lnRelFilePath
          int lnRelFilePath
          Column length: Relative file path DB column: relfilepath
          Since:
          9.00.030.023
        • lnSizeL
          int lnSizeL
          Column length: Document file size. DB column: docsize
          Since:
          9.00.000.023
        • lnSizeOrigL
          int lnSizeOrigL
          Column length: Original file extension for encrypted documents DB column: docsizeorig
          Since:
          9.00.000.023
    • Class de.elo.ix.client.DocMask

      class DocMask extends ValueClass implements Serializable
      serialVersionUID:
      2054753789L
      • Serialized Fields

        • acl
          String acl
          Access control for the mask line
        • aclItems
          AclItem[] aclItems
          Access control to mask line. Currently this can only be null or one item representing a key.
        • aspectAssocs
          Map<String,AspectAssoc> aspectAssocs
          Keywording aspect associations. These are the effective aspect associations inluding locally defined associations and inherited associations. Only valid for DocMask.dataOrganisation = DocMaskC.DATA_ORGANISATION_ASPECT.
          Since:
          20.00.000.100
        • barcode
          String barcode
          Barcode string.
        • DAcl
          String DAcl
          New objects are created with these ACL permission settings.
        • dataOrganisation
          int dataOrganisation
          This member specifies how the index values are stored in database.
          Since:
          9.00.039.001
          See Also:
        • deleted
          boolean deleted
          Deleted status.
          Since:
          7.00.000.001
        • deletionDeadline
          String deletionDeadline
          Deletion deadline for new objects.
          Since:
          20.00.000.110
        • details
          DocMaskDetails details
          Detailed properties for the DocMask object.
        • DKind
          int DKind
          The marker color ID for new objects created with this mask.
        • docAclItems
          AclItem[] docAclItems
          These access control items are the initial values for new documents inserted with this mask.
        • DPath
          int DPath
          Document storage path name where the documents of this mask should be stored.
        • flowId
          int flowId
          The ID of a workflow that is started if a new object with this mask is created. If the SessionOption START_DOCMASK_WORKFLOWS is set, the Indexserver starts this workflow, if an associated document is created. Otherwise the client application is responsible for starting the workflow.
          See Also:
        • flowId2
          int flowId2
          The ID of a workflow that is to be started if a new version of an associated document is checked in. If the SessionOption START_DOCMASK_WORKFLOWS is set, the Indexserver starts this workflow, if an associated document is checked in. Otherwise the client application is responsible for starting the workflow.
          Since:
          7.00.040.016
          See Also:
        • guid
          String guid
          GUID
          Since:
          7.00.000.001
        • id
          int id
          Storage mask ID.
        • index
          String index
          This control string provides a way of storing new storage mask objects automatically in a particular archive path.
        • inheritFromMasks
          List<DocMaskInherit> inheritFromMasks
          Inherit aspects from this keywording forms. Only valid for DocMask.dataOrganisation = DocMaskC.DATA_ORGANISATION_ASPECT.
          Since:
          20.00.000.100
        • lifetime
          String lifetime
          New objects are valid for this length of time.
        • lines
          DocMaskLine[] lines
          See Also:
        • localAspectAssocs
          Map<String,AspectAssoc> localAspectAssocs
          Keywording aspect associations which are defined locally in this mask. Only valid for DocMask.dataOrganisation = DocMaskC.DATA_ORGANISATION_ASPECT.
          Since:
          20.00.000.102
        • lockId
          int lockId
          User ID of the user that has locked the storage mask. If -1, no lock is held.
        • lockName
          String lockName
          Name of the user that has locked th storage mask. Read-only, ignored in checkinDocMask.
          Since:
          7.00.026.002
        • maskIdsForChildEntries
          List<Integer> maskIdsForChildEntries
          Child entries in the archive hierarchy should only use this keywording forms. If this element is null or empty, child entries can use any keywording form. Otherwise, new child entries have to be assigned to one of the listed form. This rule only applies to physical and not to logical references. The maximum number of keywording forms is defined by DocMaskC.MAX_MASK_IDS_FOR_CHILD_ENTRIES.
          Since:
          11.00.000.003
          See Also:
        • name
          String name
          Storage mask name. It can be translated into reps. from the users language: set SessionOptionsC.TRANSLATE_TERM.
          See Also:
        • nameTranslationKey
          String nameTranslationKey
          Translation-keyword for DocMask.name.
          Since:
          9.00.018.005
        • packageName
          String packageName
          Package name of DocMask
          Since:
          20.00.000.009
        • sordType
          int sordType
          Prepare this type for a new Sord object.

          If this value is 0, the Sord type is SordC.LBT_DOCUMENT for a new document. For a new folder, the default sord type is set as the parent's sord type plus 1. If the parent is undefined, the default type is 1.

          If this value is not 0, it must be given between 1 and SordC.LBT_DOCUMENT-1 for folder types and between SordC.LBT_DOCUMENT and SordC.LBT_DOCUMENT_MAX for document types.

          Since:
          11.00.000.002
        • text
          String text
          Tab captions. List of tab captions separated by pipe char |.
        • textTranslationKey
          String textTranslationKey
          Translation-keyword for DocMask.text.
          Since:
          9.00.018.005
        • transitiveChildren
          List<Integer> transitiveChildren
          Transitive children of the mask.
          Since:
          21.02.000.010
        • TStamp
          String TStamp
          Last update time of the storage mask data.
        • TStampSync
          String TStampSync
          Timestamp of this object's last export by the replication.
          Since:
          9.99.009.001
    • Class de.elo.ix.client.DocMaskC

      class DocMaskC extends DocMaskDataC implements Serializable
      serialVersionUID:
      387842089L
      • Serialized Fields

        • GUID_BASIC
          String GUID_BASIC
          Predefined GUID for keywording form "Freie Eingabe".
          Since:
          7.00.000.003
        • GUID_CONTACT
          String GUID_CONTACT
          Deprecated.
          the GUID value is now used for GUID_SEARCH
          Predefined GUID for keywording form "Kontakt".
          Since:
          7.00.000.003
        • GUID_ELOSCRIPTS
          String GUID_ELOSCRIPTS
          Predefined GUID for the keywording form used for scripts.
          Since:
          8.00.020.001
        • GUID_EMAIL
          String GUID_EMAIL
          Predefined GUID for keywording form "EMail".
          Since:
          7.00.000.003
        • GUID_FOLDER
          String GUID_FOLDER
          Predefined GUID for the keywording form used for folders by default.
          Since:
          7.00.000.024
        • GUID_MS_SHAREPOINT_DOCUMENT
          String GUID_MS_SHAREPOINT_DOCUMENT
          Prefefined GUID for a keywording form for MS Sharepoint documents.
          Since:
          10.17.059.003
        • GUID_SEARCH
          String GUID_SEARCH
          Predefined GUID for the keywording form used to search entries regardless of their storage mask.
          Since:
          7.00.000.024
        • GUID_STRUCTURE_ELEMENT
          String GUID_STRUCTURE_ELEMENT
          Deprecated.
          use GUID_FOLDER
          Predefined GUID for keywording form "Strukturelement".
          Since:
          7.00.000.003
        • GUID_USER_FOLDER
          String GUID_USER_FOLDER
          Predefined GUID for the keywording form used by user folders.
          Since:
          9.00.000.011
        • lnAcl
          int lnAcl
          ACL length
          Since:
          7.00.000.006
    • Class de.elo.ix.client.DocMaskDataC

      class DocMaskDataC extends Object implements Serializable
      serialVersionUID:
      1968969939L
      • Serialized Fields

        • lnBarcode
          int lnBarcode
          DB column: maskbarcode
        • lnDAcl
          int lnDAcl
          DB column: maskdacl
        • lnDeletionDeadline
          int lnDeletionDeadline
          Column length: Deletion deadline for new objects. DB column: deletiondeadline
          Since:
          20.00.000.110
        • lnGuid
          int lnGuid
          Column length: GUID DB column: maskguid
          Since:
          7.00.000.001
        • lnIndex
          int lnIndex
          DB column: maskindex
        • lnInternalAcl
          int lnInternalAcl
          Column length: Internal acl. DB column: maskacl
          Since:
          7.00.000.006
        • lnLifetime
          int lnLifetime
          DB column: lifetime
        • lnName
          int lnName
          DB column: maskname
        • lnNameTranslationKey
          int lnNameTranslationKey
          Column length: Translation-keyword for DocMask.name. DB column: masknametrkey
          Since:
          9.00.018.005
        • lnPackageName
          int lnPackageName
          Column length: Package name of DocMask DB column: packagename
          Since:
          20.00.000.009
        • lnRawMaskIdsForChildEntries
          int lnRawMaskIdsForChildEntries
          Column length: Child entries in the archive hierarchy should only use this keywording forms. If this element DB column: maskidsforchildentries
          Since:
          11.00.000.003
        • lnRawPosInfo
          int lnRawPosInfo
          DB column: maskposinfo
        • lnRawPosInfo2
          int lnRawPosInfo2
          Column length: This field extends RawPosInfo for more docMask lines (EIX-739). DB column: maskposinfo2
          Since:
          12.00.000.003
        • lnRawPosInfo3
          int lnRawPosInfo3
          Column length: This field extends RawPosInfo for more docMask lines (EIX-739). DB column: maskposinfo3
          Since:
          12.00.000.003
        • lnText
          int lnText
          DB column: masktext
        • lnTextTranslationKey
          int lnTextTranslationKey
          Column length: Translation-keyword for DocMask.text. DB column: masktexttrkey
          Since:
          9.00.018.005
        • lnTStamp
          int lnTStamp
          DB column: masktstamp
        • lnTStampSync
          int lnTStampSync
          Column length: Timestamp of this object's last export by the replication. DB column: masktstampsync
          Since:
          9.99.009.001
    • Class de.elo.ix.client.DocMaskDetails

      class DocMaskDetails extends ValueClass implements Serializable
      serialVersionUID:
      639048562L
      • Serialized Fields

        • archivingMode
          int archivingMode
          Archiving mode. Sort order and archiving mode share the same database column. If the mask is used for documents, set sortOrder=SordOrderC.NONE. ELO 7.0: This value is only valid for document masks, documentMask=true.
          See Also:
        • createIndexPath
          boolean createIndexPath
          If DocMask.index is defined, this option effects that the resulting archieve path is created, if it does not exist.
          Since:
          6.00.098
        • createIndexReferencesPaths
          boolean createIndexReferencesPaths
          If DocMask.index is defined including reference paths, this option effects that the resulting reference paths are created, if they do not exist.
          Since:
          6.00.098
        • documentContainer
          boolean documentContainer
          Folders indexed with this mask get the flag SordDetails.documentContainer set accordingly.
          Since:
          9.00.018.004
        • documentMask
          boolean documentMask
          Mask can be used to edit indexing information of a document.
        • enabledByParent
          boolean enabledByParent
          Usage depends on the keywording form of the parent entry. This keywording form should only be used for a Sord, if the keywording form of the parent Sord explicitly allows that in it's member DocMask.maskIdsForChildEntries.
          Since:
          11.00.000.020
        • encryptionSet
          int encryptionSet
          Encryption set number.
        • folderMask
          boolean folderMask
          Mask can be used to edit indexing information of a folder
          Since:
          7.00.000.000
        • fulltext
          boolean fulltext
          Document is or should be containted in the fultext database.
        • inheritAclDisabled
          boolean inheritAclDisabled
          Do not inherit permissions from parent Sords.
          Since:
          11.00.000.055
        • keywordingRelationAllowed
          boolean keywordingRelationAllowed
          Mask can be referenced from a DocMaskLine of type DocMaskLineC.TYPE_RELATION.
          If this mask has a data organisation DocMaskC.DATA_ORGANISATION_ASPECT the value determines if it can be referenced by an AspectLine of type AspectLineC.TYPE_RELATION.
          Since:
          12.00.000.023
          See Also:
        • region
          boolean region
          Sords of this mask, in case they are a folder, establish a region within the repository tree.
          This flag is only valid for masks of data organisation. DocMaskC.DATA_ORGANISATION_ASPECT.
          Since:
          21.04.000.003
        • releaseDocument
          boolean releaseDocument
          Documents using this mask may be used as release notes
          Since:
          8.00.032.007
        • searchMask
          boolean searchMask
          Mask can be used to search for indexing information.
        • sortOrder
          int sortOrder
          Sort order of child entries. Sort order and archiving mode share the same database column. If the mask is used for folders, set archivingMode=ArchivingModeC.NONE. If both sortOrder and archivingMode are set, sortOrder has precedence and archivingMode is ignored. ELO 7.0: This value is only valid for folder masks, folderMask=true.
          See Also:
        • translateSordName
          boolean translateSordName
          If true translate the sord's short description into or from the user language.
          Since:
          9.00.030.013
    • Class de.elo.ix.client.DocMaskInherit

      class DocMaskInherit extends ValueClass implements Serializable
      serialVersionUID:
      898206391L
      • Serialized Fields

        • parentMaskId
          int parentMaskId
    • Class de.elo.ix.client.DocMaskInheritC

      class DocMaskInheritC extends Object implements Serializable
      serialVersionUID:
      1012897984L
    • Class de.elo.ix.client.DocMaskLine

      class DocMaskLine extends ValueClass implements Serializable
      serialVersionUID:
      1291500689L
      • Serialized Fields

        • access
          int access
          Bitset of AccessC.LUR_* constants. It contains the access bits for the current user. Only AccessC.LUR_READ and AccessC.LUR_WRITE are used.
          Since:
          7.00.000.047
        • acl
          String acl
          Access control for mask line.
        • aclItems
          AclItem[] aclItems
          Access control for mask line. Currently this can only be null or one item representing a key.
        • allowedMaskIdsForKeywordingRelation
          List<Integer> allowedMaskIdsForKeywordingRelation
          Specifies the DocMask.id allowed in a DocMaskLineC.TYPE_RELATION. Mandatory if DocMaskLine is of type DocMaskLineC.TYPE_RELATION. Only Sords with the specified DocMask.id can be referenced in this DocMaskLine.
          Since:
          12.00.000.023
          See Also:
        • canEdit
          boolean canEdit
          Determines whether the index line can be modified. Read-only.
        • comment
          String comment
          Quickinfo text for the attribute.
        • commentTranslationKey
          String commentTranslationKey
          Translation-keyword for DocMaskLine.comment.
          Since:
          9.00.018.005
        • defaultValue
          String defaultValue
          This value is assigned to the ObjKey.data element for a new Sord object.
          Since:
          7.00.040.016
        • disableWordWheel
          boolean disableWordWheel
          Disable word wheel. Clients should not provide a function to list all existing values for this index vlaue. The Indexserver does not set or test this value.
          Since:
          7.00.040.015
        • editCol
          int editCol
          Column position of edit control
        • editRow
          int editRow
          Row postion of edit control
        • editWidth
          int editWidth
          With of edit control
        • excludeFromISearch
          boolean excludeFromISearch
          If true a index value will not be searchable via iSearch. Does not affect the index search.
          Since:
          10.00.020.023
        • externalData
          String externalData
          External data. Can be used to store an arbitary string.
          Since:
          7.00.000.000
        • hidden
          boolean hidden
          This value should not be displayed to the user.
        • id
          int id
          The ID of the line information.
        • important
          boolean important
          Display index value next to the objects short description. This element has to be interpreted by the client application. Indexserver ignores this value.
          Since:
          7.00.000.004
        • inherit
          boolean inherit
          Inherit this keywording field to subordinated entries.

          This option is used to make sure, that all entries in an archive sub-tree have the same value for this keywording field. Thereby the field is identified by its group name (DocMaskLine.key and ObjKey.name).

          The option corresponds to DocMaskLine.inheritFromParent. As far as DocMaskLine.inheritFromParent is also true in the keywording forms definition of all sub-items, the option DocMaskLine.inherit effects the following:
          • The value of the keywording field can only be changed in the parent entry of the sub-tree. This is the uppermost entry that has the field, which means that the parent's parent does not have this field.
          • All sub-items of the parent inherit this value during a background process. The value is forwarded recursively to the entire sub-tree under the parent. The recursion stops at items that are assigned to a keywording form without this field.
          • When a child entry under the parent is updated, this field is always corrected to the parent's value.
          • For an object moved into a parent, the object and all sub-items inherit the keywording field.

          If DocMaskLine.inheritFromParent is false in the keywording form definition of a sub-item, inheritance stops for the sub-item. Thus, the index field is treated as a different field although it has the same group name.

          Since:
          9.00.016.011
        • inheritFromParent
          boolean inheritFromParent
          Do not inherit the parent's value.
          Since:
          9.00.030.019
          See Also:
        • key
          String key
          The attribute group name. This member corresponds to ObjKey.name.
          See Also:
        • labelCol
          int labelCol
          Column position of label control
        • labelRow
          int labelRow
          Row position of label control
        • maskId
          int maskId
          This line information belongs to a storage mask with the ID MaskId.
        • max
          int max
          The maximum value of this attribute.
        • min
          int min
          The minimum value of this attribute.
        • name
          String name
          The name of the attribute. This value is displayed in the lable before the edit field. It can be translated into reps. from the users language: set SessionOptionsC.TRANSLATE_TERM.
          See Also:
        • nameTranslationKey
          String nameTranslationKey
          Translation-keyword for DocMaskLine.name.
          Since:
          9.00.018.005
        • nextTab
          boolean nextTab
          Creates a new tab in the keywording dialogue.
        • notTokenized
          boolean notTokenized
          Defines whether a index value should be searchable as TOKENIZED or UN_TOKENIZED
          Since:
          9.00.022.000
        • onlyBuzzwords
          boolean onlyBuzzwords
          The index line can only contain buzzwords.
        • postfixAsterix
          boolean postfixAsterix
          Add "*" after index value in search operation.
        • prefixAsterix
          boolean prefixAsterix
          Add "*" before index value in search operation.
        • readOnly
          boolean readOnly
          This value should not be edited in a user interface (convention). Scripts are allowed to edit the value.
        • required
          boolean required
          Entry is required.
          Since:
          10.00.020.010
        • serverScriptName
          String serverScriptName
          A script or plugin at the server can serve as the data source of a dynamic keyword list. This value represents the name of that script or plugin. If the value is not empty, the client can request a list of available input values by calling the function IXServicePortIF.checkoutKeywordsDynamic(ClientInfo, KeywordsDynamicInfo). In case of a plugin, this value starts with the Bundle-SymbolicName and can be optionally appended by a path. E.g. serverScriptName="com.partner.dkeywords/invoice-solution". The path has to start with a forward slash and is passed to DynamicKeywordEventsFactory.create(de.elo.ix.client.IXServerEventsContext, java.lang.String).
          Since:
          9.00.000.001
        • tabIndex
          int tabIndex
          This value represents the number of the tab, this line has to appear on. The first tab's index value is 0. It is on the client's hand to set valid values when checking in document masks.
          Since:
          9.00.000.000
        • tabOrder
          int tabOrder
          Tabulator order of edit control
        • translate
          boolean translate
          Translate index values into or from the users language.
          Since:
          7.00.000.004
          See Also:
        • type
          int type
          The type of the line information. This can be one of the DocMaskLineC.TYPE_* constants.
          See Also:
        • validateExpression
          String validateExpression
          RegEx to validate user input for entry.
          Since:
          10.00.020.010
        • valueArray
          boolean valueArray
          Allows multiple values for keywording tables. For keywording forms organized as tables, see DocMaskC.DATA_ORGANISATION_TABLE, index lines must be explicitly declared for storing multiple values. If this member is true, the index line is able to store an arbitrary number of values. For keywording forms organized as name-value pairs, see DocMaskC.DATA_ORGANISATION_OBJKEYS, index lines can store multiple values by default and this member has to be ignored.
          Since:
          9.00.039.001
        • version
          boolean version
          Display index value in version information dialog when checking in a document. This element has to be interpreted by the client application. Indexserver ignores this value.
          Since:
          7.00.000.004
    • Class de.elo.ix.client.DocMaskLineC

      class DocMaskLineC extends DocMaskLineDataC implements Serializable
      serialVersionUID:
      1453574806L
      • Serialized Fields

        • lnAcl
          int lnAcl
          ACL length
          Since:
          7.00.000.006
    • Class de.elo.ix.client.DocMaskLineDataC

      class DocMaskLineDataC extends Object implements Serializable
      serialVersionUID:
      1178569423L
      • Serialized Fields

        • lnAllowedReferencedMaskIdsRaw
          int lnAllowedReferencedMaskIdsRaw
          Column length: Specifies the DocMask.id allowed in a DocMaskLineC.TYPE_RELATION. DB column: allowedrefmaskids
          Since:
          12.00.000.023
        • lnComment
          int lnComment
          DB column: linecomment
        • lnCommentTranslationKey
          int lnCommentTranslationKey
          Column length: Translation-keyword for DocMaskLine.comment. DB column: linecommenttrkey
          Since:
          9.00.018.005
        • lnDefaultValue
          int lnDefaultValue
          Column length: This value is assigned to the ObjKey.data element for a new Sord object. DB column: linedefault
          Since:
          7.00.040.016
        • lnExternalData
          int lnExternalData
          Column length: External data. Can be used to store an arbitary string. DB column: lineext
          Since:
          7.00.000.000
        • lnInternalAcl
          int lnInternalAcl
          Column length: Internal acl. DB column: lineacl
          Since:
          7.00.000.006
        • lnKey
          int lnKey
          DB column: linekey
        • lnName
          int lnName
          DB column: linebez
        • lnNameTranslationKey
          int lnNameTranslationKey
          Column length: Translation-keyword for DocMaskLine.name. DB column: linebeztrkey
          Since:
          9.00.018.005
        • lnServerScriptName
          int lnServerScriptName
          Column length: A script or plugin at the server can serve as the data source of a dynamic keyword list. This DB column: linescript
          Since:
          9.00.000.001
        • lnValidateExpression
          int lnValidateExpression
          Column length: RegEx to validate user input for entry. DB column: validateexpression
          Since:
          10.00.020.010
    • Class de.elo.ix.client.DocMaskLineTemplate

      class DocMaskLineTemplate extends ValueClass implements Serializable
      serialVersionUID:
      -3905966498656250335L
      • Serialized Fields

        • acl
          String acl
          Access control for mask line.
        • aclItems
          AclItem[] aclItems
          Access control for mask line. Currently this can only be null or one item representing a key.
        • allowedMaskIdsForKeywordingRelation
          List<Integer> allowedMaskIdsForKeywordingRelation
          Specifies the DocMask.id allowed in a DocMaskLineC.TYPE_RELATION. Mandatory if DocMaskLine is of type DocMaskLineC.TYPE_RELATION. Only Sords with the specified DocMask.id can be referenced in this DocMaskLine.
          Since:
          12.00.000.020
        • comment
          String comment
          Quickinfo text for the attribute.
        • commentTranslationKey
          String commentTranslationKey
          Translation-keyword for DocMaskLine.comment.
        • defaultValue
          String defaultValue
          This value is assigned to the ObjKey.data element for a new Sord object.
        • disableWordWheel
          boolean disableWordWheel
          Disable word wheel. Clients should not provide a function to list all existing values for this index vlaue. The Indexserver does not set or test this value.
        • excludeFromISearch
          boolean excludeFromISearch
          If true a index value will not be searchable via iSearch. Does not affect the index search.
          Since:
          10.00.020.023
        • externalData
          String externalData
          External data. Can be used to store an arbitary string.
        • hidden
          boolean hidden
          This value should not be displayed to the user.
        • id
          int id
          The ID of the line information.
        • important
          boolean important
          Display index value next to the objects short description. This element has to be interpreted by the client application. Indexserver ignores this value.
        • inherit
          boolean inherit
          Inherit this keywording field to subordinated entries.

          This option is used to make sure, that all entries in an archive sub-tree have the same value for this keywording field. Thereby the field is identified by its group name (DocMaskLine.key and ObjKey.name).

          The option corresponds to DocMaskLineTemplate.inheritFromParent. As far as DocMaskLineTemplate.inheritFromParent is also true in the keywording forms definition of all sub-items, the option DocMaskLineTemplate.inherit effects the following:

          • The value of the keywording field can only be changed in the parent entry of the sub-tree. This is the uppermost entry that has the field, which means that the parent's parent does not have this field.
          • All sub-items of the parent inherit this value during a background process. The value is forwarded recursively to the entire sub-tree under the parent. The recursion stops at items that are assigned to a keywording form without this field.
          • When a child entry under the parent is updated, this field is always corrected to the parent's value.
          • For an object moved into a parent, the object and all sub-items inherit the keywording field.

          If DocMaskLineTemplate.inheritFromParent is false in the keywording form definition of a sub-item, inheritance stops for the sub-item. Thus, the index field is treated as a different field although it has the same group name.

        • inheritFromParent
          boolean inheritFromParent
          Do not inherit the parent's value.
          See Also:
        • key
          String key
          The attribute group name. This member corresponds to ObjKey.name.
          See Also:
        • lockId
          int lockId
          User ID of the user that has locked the mask line template. If -1, no lock is held.
        • lockName
          String lockName
          Name of the user that has locked the mask line template. Read-only, ignored in checkinDocMaskLineTemplate.
        • max
          int max
          The maximum value of this attribute.
        • min
          int min
          The minimum value of this attribute.
        • name
          String name
          The name of the attribute. This value is displayed in the lable before the edit field. It can be translated into reps. from the users language: set SessionOptionsC.TRANSLATE_TERM.
          See Also:
        • nameTranslationKey
          String nameTranslationKey
          Translation-keyword for DocMaskLine.name.
        • notTokenized
          boolean notTokenized
          Defines whether a index value should be searchable as TOKENIZED or UN_TOKENIZED
        • onlyBuzzwords
          boolean onlyBuzzwords
          The index line can only contain buzzwords.
        • postfixAsterix
          boolean postfixAsterix
          Add "*" after index value in search operation.
        • prefixAsterix
          boolean prefixAsterix
          Add "*" before index value in search operation.
        • readOnly
          boolean readOnly
          This value should not be edited in a user interface (convention). Scripts are allowed to edit the value.
        • required
          boolean required
          Entry is required.
          Since:
          10.00.020.010
        • serverScriptName
          String serverScriptName
          A script at the server can serve as the data source of a dynamic keyword list. This value represents the name of that script. If the value is not empty, the client can request a list of available input values by calling the function IXServicePortIF.checkoutKeywordsDynamic(ClientInfo, KeywordsDynamicInfo).
        • translate
          boolean translate
          Translate index values into or from the users language.
          See Also:
        • TStamp
          String TStamp
          Last update time of the storage template data.
        • TStampSync
          String TStampSync
          Timestamp of this object's last export by the replication.
        • type
          int type
          The type of the line information. This can be one of the DocMaskLineC.TYPE_* constants.
          See Also:
        • validateExpression
          String validateExpression
          RegEx to validate user input for entry.
          Since:
          10.00.020.010
        • version
          boolean version
          Display index value in version information dialog when checking in a document. This element has to be interpreted by the client application. Indexserver ignores this value.
    • Class de.elo.ix.client.DocMaskLineTemplateC

      class DocMaskLineTemplateC extends DocMaskLineTemplateDataC implements Serializable
      serialVersionUID:
      8247191531986672869L
      • Serialized Fields

        • lnAcl
          int lnAcl
          ACL length
          Since:
          7.00.000.006
    • Class de.elo.ix.client.DocMaskLineTemplateDataC

      class DocMaskLineTemplateDataC extends Object implements Serializable
      serialVersionUID:
      96404005L
      • Serialized Fields

        • lnAllowedReferencedMaskIdsRaw
          int lnAllowedReferencedMaskIdsRaw
          Column length: Specifies the DocMask.id allowed in a DocMaskLineC.TYPE_RELATION. DB column: allowedrefmaskids
          Since:
          12.00.000.020
        • lnComment
          int lnComment
          DB column: linecomment
        • lnCommentTranslationKey
          int lnCommentTranslationKey
          DB column: linecommenttrkey
        • lnDefaultValue
          int lnDefaultValue
          DB column: linedefault
        • lnExternalData
          int lnExternalData
          DB column: lineext
        • lnInternalAcl
          int lnInternalAcl
          DB column: lineacl
        • lnKey
          int lnKey
          DB column: linekey
        • lnName
          int lnName
          DB column: linebez
        • lnNameTranslationKey
          int lnNameTranslationKey
          DB column: linebeztrkey
        • lnServerScriptName
          int lnServerScriptName
          DB column: linescript
        • lnTStamp
          int lnTStamp
          DB column: linetstamp
        • lnTStampSync
          int lnTStampSync
          DB column: linetstampsync
        • lnValidateExpression
          int lnValidateExpression
          Column length: RegEx to validate user input for entry. DB column: validateexpression
          Since:
          10.00.020.010
    • Class de.elo.ix.client.DocMaskLineTemplateZ

      class DocMaskLineTemplateZ extends ValueClass implements Serializable
      serialVersionUID:
      -3462528574226604809L
      • Serialized Fields

        • bset
          long bset
    • Class de.elo.ix.client.DocMaskZ

      class DocMaskZ extends ValueClass implements Serializable
      serialVersionUID:
      1064616030L
      • Serialized Fields

        • bset
          long bset
          Bitset field for constants from the DocMaskC class.
    • Class de.elo.ix.client.Document

      class Document extends ValueClass implements Serializable
      serialVersionUID:
      341056676L
      • Serialized Fields

        • atts
          DocVersion[] atts
          Attachment versions for the document.
        • docs
          DocVersion[] docs
          Versions of the document.
        • objId
          String objId
          Object ID for the document.
    • Class de.elo.ix.client.DocVersion

      class DocVersion extends ValueClass implements Serializable
      serialVersionUID:
      633004623L
      • Serialized Fields

        • accessDateIso
          String accessDateIso
          Last access date. ClientInfo determines the Timezone.

          Applies to document version and signature. Is undefined for preview and fulltextContent.

        • comment
          String comment
          Version comment

          Applies to document version. Is undefined for signature, preview and fulltextContent.

        • contentType
          String contentType
          Content-Type (MIME-Type).
          Since:
          6.00.095
          See Also:
        • createDateIso
          String createDateIso
          Create date. ClientInfo determines the Timezone.

          Applies to document version and signature. Is undefined for preview and fulltextContent.

        • deleted
          boolean deleted
          Indicates whether the version is logically deleted.

          Applies to document version. Is undefined for signature, preview and fulltextContent.

        • deleteDateIso
          String deleteDateIso
          Delete date. ClientInfo determines the Timezone.

          Is undefined if isDeleted() returns false.

          Since:
          9.00.000.000
        • encryptionSet
          int encryptionSet
          ID of the encryption set. It's password is used to encrypt or decrypt the document. It a new document or version should be checked in, this member must be set to Sord.details.encryptionSet before checkinDocBegin is called. When this object is retrieved via IX it is always set to Sord.details.encryptionSet.

          Applies to document version. Is undefined for signature.

        • ext
          String ext
          Document file extension (without ".")

          Applies to document version, signature and preview. Is readonly for fulltextContent.

          This value has precedence before contentType.
          See Also:
        • fileData
          FileData fileData
          Document, preview or fulltextContent file content. If checkoutDoc is called with option mbSordDocSmallContent and the requested document (version) is small (less than the configured value), this member contains the file data and content type. If mbPreview is additionally set, fileData contains the content of the preview - REGARDLESS of the size. In case there is no preview, fileData contains the data of the document (if it's a small file).

          Applies to document version, signature and preview.

        • fulltextContent
          DocVersion fulltextContent
          This object provides the content of the fulltext database for the document version. The information is read-only and only available for DocVersion objects that refer to a document version (and not an attachment, preview or signature). Currenly, only the members url, ext, contentType and encryptionSet are valid for a DocVersion object that belongs to fulltext content. Whereby ext is always txt and contentType is always text/plain. A Byte Order Mark preceedes the content data. If the related document version is encrypted, the appropriate encryption password has to be set, before the fulltext information can be downloaded. If the SessionOptionC.DECRYPT_DOCUMENTS is not set, the fulltext information is transmitted encrypted.

          Applies to document version. Is undefined for signature and preview.

          Since:
          7.00.020.003
        • guid
          String guid
          Document GUID.

          Applies to document version and signature. Is undefined for preview and fulltextContent.

        • id
          int id
          Document ID

          Applies to document version and signature. Is undefined for preview and fulltextContent.

        • language
          String language
          Language of the document content. This value is estimated by ELO Textreader when the document is sent for fulltext extraction. See TranslateTermC.DEFAULT_LANGUAGES for a list of language-tags.
          Since:
          21.04.000.001
        • md5
          String md5
          MD5 hash of the documet file.

          Applies to document version and signature. Is undefined for preview and fulltextContent.

        • milestone
          boolean milestone
          Indicates whether the version is marked as a milestone version.

          Applies to document version. Is undefined for signature and preview and fulltextContent.

        • nbOfValidSignatures
          int nbOfValidSignatures
          Number of valid signatures. This member holds the count of valid signatures in the signature file. It is only valid for a DocVersion object that represents a signature (member DocVersion.sig). A value of zero means, that the signatures are unchecked. A number greater than zero means, that all signatures are valid. In this case the member value is equal to the number of signatures. If at least one signature is invalid, the value is less than zero. The number of invalid signatures is thereby unknown. Client applications are responsible to check signatures. The ELOix does not check signatures.
          Since:
          9.00.016.002
        • ownerId
          int ownerId
          The owners user ID.

          Applies to document version. Is undefined for signature and preview and fulltextContent.

        • ownerName
          String ownerName
          The owners user name. This value is read only (ignored in checkinDoc...).

          Applies to document version. Is undefined for signature and preview and fulltextContent.

        • pathId
          int pathId
          Storage path ID

          Applies to document version and signature. Is undefined for preview and fulltextContent.

        • pathId2
          int pathId2
          (to be defined)

          Applies to document version and signature. Is undefined for preview and fulltextContent.

        • physPath
          String physPath
          Physical path

          Applies to document version and signature. Is undefined for preview and fulltextContent.

          Set SordC.mbPhysPath or EditInfoC.mbPhysPath in the member selector passed to checkoutSord or checkoutDoc to read the physical path.
        • preview
          DocVersion preview
          Document preview

          Applies to document version. Is null for signature and preview and fulltextContent.

          Since:
          6.00.087
        • previewUrl
          String previewUrl
          Deprecated.
          Use member preview instead

          URL to up-/download a document preview.

          Applies to document version. Is empty for signature and preview and fulltextContent.

        • relativeFilePath
          String relativeFilePath
          Relative file path for external file. This member specifies the location of the file relative to a custom path. If DocVersion.pathId does not refer a custom path, this member is empty and ignored in IXServicePortIF.checkinDocEnd(ClientInfo, Sord, SordZ, Document, LockZ).
          Since:
          9.00.030.023
        • sig
          DocVersion sig
          Document signature

          Applies to document version. Is null for signature and preview and fulltextContent.

        • size
          long size
          File size.
        • tStamp
          String tStamp
          Document timestamp

          Applies to document version and signature. Is undefined for preview. (Is available for fulltextContent)

          The format is JJJJ.MM.DD.hh.mm.ss
        • tStampSync
          String tStampSync
          Timestamp of this object's ACLs last export by the replication.
          Since:
          9.99.009.001
        • updateDateIso
          String updateDateIso
          Last update date. ClientInfo determines the Timezone.

          Applies to document version and signature. Is undefined for preview and fulltextContent.

        • uploadResult
          String uploadResult
          Result from the ELODM if the document was uploaded.

          Applies to document version, signature, preview and fulltextContent.

        • url
          String url
          URL to up-/download

          Applies to document version, signature,preview and fulltextContent.

        • version
          String version
          Version number

          Applies to document version. Is undefined for signature, preview and fulltextContent.

        • workVersion
          boolean workVersion
          Indicates whether the version is the current work version.

          Applies to document version. Is undefined for signature, preview and fulltextContent.

    • Class de.elo.ix.client.DocVersionC

      class DocVersionC extends Object implements Serializable
      serialVersionUID:
      615288749L
      • Serialized Fields

        • lnComment
          int lnComment
          Length of version comment.
        • lnExt
          int lnExt
          Length of file extension.
        • lnVersion
          int lnVersion
          Length of version number (like 1.0).
    • Class de.elo.ix.client.EditInfo

      class EditInfo extends ValueClass implements Serializable
      serialVersionUID:
      820228328L
      • Serialized Fields

        • aspectInfos
          List<AspectInfo> aspectInfos
          Aspect infos containing id, name, guid, translationKey of aspects.
          Since:
          21.00.000.001
        • docTemplates
          IdName[] docTemplates
          Document template names (Template files for new documents).
        • document
          Document document
          Document or attachment information.
        • keywords
          Keyword[] keywords
          Root keywords.
          Each item of this array contains the first item of the following keyword lists
          for documents, keyword[.].id is one of: KeywordC.KWID_STANDARD_LIST, Standard keyword list
          KeywordC.KWID_VERSION, Version number keyword list
          KeywordC.KWID_VERSION_COMMENT, Version comment keyword list
          Keyword lists of storage mask
          for non-documents, keyword[.].id is one of: KeywordC.KWID_STANDARD_LIST, Standard keyword list
          Keyword lists of storage mask
        • markerNames
          IdName[] markerNames
          Marker names (Colours).
        • mask
          DocMask mask
          Document mask data of the mask selected in sord.
        • maskNames
          MaskName[] maskNames
          Storage mask names.
        • notes
          Note[] notes
          Notes.
        • pathNames
          IdName[] pathNames
          Storage path names.
        • replNames
          IdName[] replNames
          Replication set names.
        • sord
          Sord sord
          Indexing information.
        • sordTypes
          SordType[] sordTypes
          Sord types (labels, icons, extensions corresponding to Sord.type).
    • Class de.elo.ix.client.EditInfoC

      class EditInfoC extends Object implements Serializable
      serialVersionUID:
      2100880359L
    • Class de.elo.ix.client.EditInfoEswOptions

      class EditInfoEswOptions extends Object implements Serializable
      serialVersionUID:
      522299581L
      • Serialized Fields

        • reserved
          int reserved
          Reserved
          Since:
          7.00.040.024
    • Class de.elo.ix.client.EditInfoZ

      class EditInfoZ extends ValueClass implements Serializable
      serialVersionUID:
      878901868L
      • Serialized Fields

        • bset
          long bset
          Bitset field for constants from the EditInfoC class.
        • sordZ
          SordZ sordZ
          SordZ object to control the SordC elements returned.
    • Class de.elo.ix.client.EloDmOpt

      class EloDmOpt extends ValueClass implements Serializable
      serialVersionUID:
      353149300L
      • Serialized Fields

        • id
          int id
          DB column: optno
        • instanceName
          String instanceName
          DB column: instance
          Since:
          10.00.000.008
        • remark
          String remark
          DB column: remark
        • value
          String value
          DB column: optval
    • Class de.elo.ix.client.EloDmOptC

      class EloDmOptC extends EloDmOptDataC implements Serializable
      serialVersionUID:
      605470240L
    • Class de.elo.ix.client.EloDmOptDataC

      class EloDmOptDataC extends Object implements Serializable
      serialVersionUID:
      1218961099L
      • Serialized Fields

        • lnInstanceName
          int lnInstanceName
          Column length: DB column: instance DB column: instancename
          Since:
          10.00.000.008
        • lnRemark
          int lnRemark
          DB column: remark
        • lnValue
          int lnValue
          DB column: optval
    • Class de.elo.ix.client.EloFtOpt

      class EloFtOpt extends ValueClass implements Serializable
      serialVersionUID:
      181406923L
      • Serialized Fields

        • id
          int id
          DB column: optid
        • remark
          String remark
          DB column: remark
        • value
          String value
          DB column: optval
    • Class de.elo.ix.client.EloFtOptC

      class EloFtOptC extends EloFtOptDataC implements Serializable
      serialVersionUID:
      1603857234L
    • Class de.elo.ix.client.EloFtOptDataC

      class EloFtOptDataC extends Object implements Serializable
      serialVersionUID:
      1220982870L
      • Serialized Fields

        • lnRemark
          int lnRemark
          DB column: remark
        • lnValue
          int lnValue
          DB column: optval
    • Class de.elo.ix.client.EloFtStop

      class EloFtStop extends ValueClass implements Serializable
      serialVersionUID:
      2135577346L
      • Serialized Fields

        • stopword
          String stopword
          DB column: stopword
    • Class de.elo.ix.client.EloFtStopC

      class EloFtStopC extends Object implements Serializable
      serialVersionUID:
      1842033553L
      • Serialized Fields

        • lnStopword
          int lnStopword
          DB column: stopword
    • Class de.elo.ix.client.EloIxOpt

      class EloIxOpt extends ValueClass implements Serializable
      serialVersionUID:
      1454054253L
      • Serialized Fields

        • ixId
          String ixId
          DB column: ixid
        • name
          String name
          DB column: optname
        • value
          String value
          DB column: optval
    • Class de.elo.ix.client.EloIxOpt_old

      class EloIxOpt_old extends ValueClass implements Serializable
      serialVersionUID:
      399031267L
      • Serialized Fields

        • optNo
          int optNo
          DB column: optno
        • optVal
          String optVal
          DB column: optval
        • remark
          String remark
          DB column: remark
    • Class de.elo.ix.client.EloIxOpt_oldC

      class EloIxOpt_oldC extends Object implements Serializable
      serialVersionUID:
      1148546611L
      • Serialized Fields

        • lnOptVal
          int lnOptVal
          DB column: optval
        • lnRemark
          int lnRemark
          DB column: remark
    • Class de.elo.ix.client.EloIxOptC

      class EloIxOptC extends EloIxOptDataC implements Serializable
      serialVersionUID:
      149956656L
    • Class de.elo.ix.client.EloIxOptDataC

      class EloIxOptDataC extends Object implements Serializable
      serialVersionUID:
      1223860309L
      • Serialized Fields

        • lnIxId
          int lnIxId
          DB column: ixid
        • lnName
          int lnName
          DB column: optname
        • lnValue
          int lnValue
          DB column: optval
    • Class de.elo.ix.client.Event

      class Event extends ValueClass implements Serializable
      serialVersionUID:
      877454055L
      • Serialized Fields

        • acl
          String acl
          Access control list. An empty ACL means here, that the event is dispatched to everyone.
          Since:
          8.00.010.005
        • any
          Any any
          Event payload data as Any object.
        • busId
          long busId
          Bus-ID
        • data
          byte[] data
          Event payload data as byte array.
        • id
          long id
          Event ID. If the sender awaits a response to this event, it should set a random number in id. The receiver should use the same number in the response.
        • param1
          long param1
          Value depends on event type. Event filters check this value.
          See Also:
        • param2
          String param2
          Value depends on event type. Event filters check this value.
          See Also:
        • senderId
          long senderId
          User ID of event sender. Might be used for other IDs in future too. Read-only.
        • type
          long type
          Event type. Event filters check this value. This must be one of the predefined event types or an application defined type with a larger value than EventBusC.EVENT_TYPE_MAX_SYSTEM.
          See Also:
    • Class de.elo.ix.client.EventBusC

      class EventBusC extends Object implements Serializable
      serialVersionUID:
      572745886L
    • Class de.elo.ix.client.EventBusParams

      class EventBusParams extends ValueClass implements Serializable
      serialVersionUID:
      1489333610L
      • Serialized Fields

        • channelId
          String channelId
          Create an event bus ID based on this string. An arbitary string can be supplied.
        • noForwardToOtherIxs
          boolean noForwardToOtherIxs
          Do not open this bus on other Indexservers. In load balancing environments, event busses are opened on each Indexserver by default. Set this option to true to open this event bus only on the currently attached Indexserver.
          Since:
          8.00.032.011
        • ticket
          String ticket
          Create event bus ID based on this ticket.
        • userId
          String userId
          Get the event bus ID for this user. A numeric ID, GUID or user name can be specified. The returned bus ID is computed as EventBusC.BUSID_USER + uid, where uid is the numeric user ID.
    • Class de.elo.ix.client.EventFilter

      class EventFilter extends ValueClass implements Serializable
      serialVersionUID:
      1095275943L
      • Serialized Fields

        • busId
          long busId
          Event bus ID
        • param1
          long param1
          First event param. Optional. Depends on event type.
          See Also:
        • param2
          String param2
          Second event param. Optional. Depends on event type.
          See Also:
        • type
          long type
          Event type. This must be one of the predefined event types or an application defined type with a larger value than EventBusC.EVENT_TYPE_MAX_SYSTEM.
          See Also:
    • Class de.elo.ix.client.EventListener

      class EventListener extends ValueClass implements Serializable
      serialVersionUID:
      1005733106L
      • Serialized Fields

        • filters
          EventFilter[] filters
          Array of event filters.
    • Class de.elo.ix.client.ExecuteScriptParams

      class ExecuteScriptParams extends Object implements Serializable
      serialVersionUID:
      936440117L
      • Serialized Fields

        • functionName
          String functionName
          Call this function in the script code. A function defined in script code that was supplied in a previsious call can be invoked too, as long as this object does not specify scriptCode, scriptString or scriptObjId.
        • functionParams
          String[] functionParams
          Function parameters.
        • scriptCode
          FileData scriptCode
          This object contains the script code to be executed as a byte array. The FileData.contentType is either "text/javascript" or "text/vbscript". FileData.data has to be encoded in UTF-8. The scriptCode.data length must be less or equal than 65535. If this member is set, the members scriptString and scriptObjId should be null.
          See Also:
        • scriptEngine
          String scriptEngine
          This value defines the scripting engine to be used to execute the script. Currently, this value must be null or empty or "EloixAuto". If the value is null or empty, EloixAuto is used by default.
        • scriptObjId
          String scriptObjId
          If the script to be executed is available in the ELO archive, this member can specify the object ID (or ARCPATH: - see checkoutSord) of the script document. The file is assumed to be encoded in characterset ISO-8859-1, if it does not start with a BOM. If this member is set, the members scriptCode and scriptString should be null.
        • scriptString
          String scriptString
          This object contains the script code to be executed as a string object. The string must either start with "javascript:" or "vbscript:". The maximum scriptString length is 65535 UTF-8 characters. If this member is set, the members scriptCode and scriptObjId should be null.
    • Class de.elo.ix.client.ExecuteScriptResult

      class ExecuteScriptResult extends Object implements Serializable
      serialVersionUID:
      63967077L
      • Serialized Fields

        • errorColumn
          int errorColumn
          Column where the error occured.
        • errorLine
          int errorLine
          Line where the error occured.
        • errorMessage
          String errorMessage
          Error message.
        • returnedString
          String returnedString
          Return value as string.
    • Class de.elo.ix.client.ExportExtOptions

      class ExportExtOptions extends ValueClass implements Serializable
      serialVersionUID:
      291967L
      • Serialized Fields

        • dateEndIso
          String dateEndIso
          Ending date for filter in ISO format (null for no date)
        • dateStartIso
          String dateStartIso
          Beginning date for filter in ISO format (null for no date)
        • dateType
          int dateType
          Which type of date must be considered?
        • exportAttachments
          boolean exportAttachments
        • exportDocs
          boolean exportDocs
        • exportDocsVersions
          boolean exportDocsVersions
        • exportEncrytedDocs
          boolean exportEncrytedDocs
          Export encrypted documents too?
        • exportKeywords
          boolean exportKeywords
        • exportReminders
          boolean exportReminders
        • exportStructure
          boolean exportStructure
          Export documents to filesystem structure. If this member is false, only documents are exported and they are all located at the root export folder.
          Since:
          9.00.016.014
        • ignoreEmptyFolders
          boolean ignoreEmptyFolders
          Do not export empty branches (without any document).
          Since:
          10.00.020.009
        • masksList
          String[] masksList
          List of masks IDs to export Empty list means: export all objects regardless of the masks.
        • replaceRefWithOriginal
          boolean replaceRefWithOriginal
        • searchId
          String searchId
          If the source is the search and if all results have to be exported, then this option must be set with the search's ID.
        • srcList
          String[] srcList
          List of the source objects IDs (folders in archive or search results)
        • srcType
          int srcType
          Type of the export's source (archive or search results)
    • Class de.elo.ix.client.ExportExtOptionsC

      class ExportExtOptionsC extends Object implements Serializable
      serialVersionUID:
      162646972L
    • Class de.elo.ix.client.ExportOptionsC

      class ExportOptionsC extends Object implements Serializable
      serialVersionUID:
      2043834611L
    • Class de.elo.ix.client.FileData

      class FileData extends ValueClass implements Serializable
      serialVersionUID:
      888671717L
      • Serialized Fields

        • contentType
          String contentType
          MIME-Type/document extension, for example text/xml or image/tiff or txt.
        • data
          byte[] data
          File data as byte array.
        • stream
          InputStream stream
          File data as input stream. This member can only be used if the FileData object is a member of MapValue or DocVersion.
          Since:
          10.00.020.005
    • Class de.elo.ix.client.FileDataC

      class FileDataC extends Object implements Serializable
      serialVersionUID:
      1011013570L
      • Serialized Fields

        • lnContentType
          int lnContentType
          Since:
          10.00.020.007
    • Class de.elo.ix.client.FileDataZ

      class FileDataZ extends ValueClass implements Serializable
      serialVersionUID:
      686143141L
      • Serialized Fields

        • bset
          long bset
          Bitset field for constants from the DocMaskC class.
    • Class de.elo.ix.client.FindActivityInfo

      class FindActivityInfo extends ValueClass implements Serializable
      serialVersionUID:
      1456865464L
      • Serialized Fields

        • inclDeleted
          boolean inclDeleted
          Find activities for deleted folders and documents too.
          Since:
          8.00.018.001
        • inclDeputy
          boolean inclDeputy
          Search for the activities of the deputized users too.
        • inclGroup
          boolean inclGroup
          Search for all groups of sender and receiver too.
        • objId
          String objId
          Find by object ID. Find activities assigned to this object. Optional.
        • receiverId
          String receiverId
          Find activities created for this receiver. Can be set to a user ID, user GUID or user name. Optional.
          See Also:
        • senderId
          String senderId
          Find activities created by this user. Can be set to a user ID, user GUID or user name. Optional.
          See Also:
        • senderOrReceiver
          boolean senderOrReceiver
          Search for sender or receiver. Combine the senderId and receiverId by logical OR operation.
    • Class de.elo.ix.client.FindActivityProjectsInfo

      class FindActivityProjectsInfo extends ValueClass implements Serializable
      serialVersionUID:
      151574948L
      • Serialized Fields

        • projectName
          String projectName
          Project name. This value can contain wildcards.
    • Class de.elo.ix.client.FindAlertInfo

      class FindAlertInfo extends Object implements Serializable
      serialVersionUID:
      897433042L
      • Serialized Fields

        • destId
          String destId
          Find alerts sendet to this user, ID or name. Only main administrators can set this value to an arbitary user ID. Other users can only set one of her or his groups or one of her or his substituted users.
        • inclAlam
          boolean inclAlam
          Find alarm notifications. Ignored, if inclAll is true.
        • inclAll
          boolean inclAll
          Find all notification types. If this member is set, the other members related to notification types are ignored.
        • inclInTray
          boolean inclInTray
          Find notifications related to the In Tray. Ignored, if inclAll is true.
        • inclOthers
          boolean inclOthers
          Find all other notifications that are not explicitly listed here. Ignored, if inclAll is true.
        • inclReminder
          boolean inclReminder
          Find reminder notifications. Ignored, if inclAll is true.
        • inclSubs
          boolean inclSubs
          Find notifications related to substitution rules. Ignored, if inclAll is true.
        • inclWorkFlow
          boolean inclWorkFlow
          Find workflow notifications. Ignored, if inclAll is true.
        • objId
          String objId
          Find notifications related to this object. For valid values see checkoutSord.
          See Also:
        • sourceId
          String sourceId
          Find alerts created by this user, ID or name.
        • timeIso
          String timeIso
          Find notifiations with this create date or in this date range. A date range must be separated by "...".
    • Class de.elo.ix.client.FindBackgroundThreadOptions

      class FindBackgroundThreadOptions extends ValueClass implements Serializable
      serialVersionUID:
      1054287589L
      • Serialized Fields

        • dateAfter
          String dateAfter
          Filter jobs started after this date.
        • dateBefore
          String dateBefore
          Filter jobs started before this date.
        • guids
          String[] guids
          Filter jobs with specific Job-GUIDs.
        • inclActiveJobs
          boolean inclActiveJobs
          Includes running Jobs in the result. Defaults to true.
        • inclFinishedJobs
          boolean inclFinishedJobs
          Includes finished Jobs in the result. Defaults to false.
        • inclFullInfo
          boolean inclFullInfo
          enables extended result information in the ProcessInfo member (if available)
        • sortOrder
          int sortOrder
          The order in which the results has to be sorted.
          See Also:
        • userInfo
          UserInfo[] userInfo
          Filter jobs of specific users; Ignored if the caller is no admin.
    • Class de.elo.ix.client.FindByAcl

      class FindByAcl extends ValueClass implements Serializable
      serialVersionUID:
      1535514212L
      • Serialized Fields

        • acls
          String[] acls
          Find objects that are protected by one of this ACLs. For access checking, the order of the ACL items is irrelevant. That means, two ACL lists with the same items in different order are equal. But for this search option, the order of the items are relevant. Thus, the ACLs in the database must exactly match the given values. Wildcard * is supported, if only one ACL is supplied. This member is ignored, if FindByAcl.distinctAcl is true.
        • distinctAcl
          boolean distinctAcl
          Return a list of unique ACL entries. The ACL entries are wrapped in arbitary Sord objects which are returned in FindResult.sords. This functionality can be combinded with a FindChildren object to return all ACLs used in a sub tree.
          See Also:
    • Class de.elo.ix.client.FindByAspectValue

      class FindByAspectValue extends Object implements Serializable
      serialVersionUID:
      651948392L
      • Serialized Fields

    • Class de.elo.ix.client.FindByFulltext

      class FindByFulltext extends ValueClass implements Serializable
      serialVersionUID:
      829543678L
      • Serialized Fields

        • term
          String term
          Deprecated.
          Search term to be located in the fulltext database. Can be a single word or a number of words. Wildcard * is allowed, it matches any number of characters. Term is interpreted based on the options given by FindOptions in FindInfo. Exception: FindOptionsC.ONE_TERM is not supported.
    • Class de.elo.ix.client.FindByFulltextCtrl

      class FindByFulltextCtrl extends Object implements Serializable
      serialVersionUID:
      96165507L
      • Serialized Fields

        • endTStamp
          String endTStamp
          Find objects from this date or older. If the value is null or empty, the time range has no upper limit.
        • onlyDocs
          boolean onlyDocs
          Find next documents for textreader.
          Since:
          9.00.040.002
        • profileKeyPrefix
          String profileKeyPrefix
          Key prefix for loop state.
          Since:
          9.00.040.002
        • reindex
          boolean reindex
          Re-index processing. If this member is true, a search returns objects from the largest object ID to 2. If this member is false, a search returns the next objects in a timestamp interval.
          Since:
          10.00.000.006
        • startTStamp
          String startTStamp
          Find objects from this date or newer. This value can be null or empty in which case the time range has no lower limit.
    • Class de.elo.ix.client.FindByFulltextCtrlC

      class FindByFulltextCtrlC extends Object implements Serializable
      serialVersionUID:
      96165508L
    • Class de.elo.ix.client.FindByFulltextCtrlResultItem

      class FindByFulltextCtrlResultItem extends Object implements Serializable
      serialVersionUID:
      1755682788L
      • Serialized Fields

        • note
          Note note
          Note object. If this member is set, member sord can be ignored.
          Since:
          8.00.000.003
        • selectType
          int selectType
          Corresponds to the table from which the Sord/ Note was selected.

          Note: For internal use only.

          Since:
          12.00.000.037
        • sord
          Sord sord
          Sord object. Same as in findResult.sords[.]
        • TStamp
          String TStamp
          Timestamp of the last change of either indexing information, note data, fulltext content or attachment fulltext content.
    • Class de.elo.ix.client.FindByFulltextResultItem

      class FindByFulltextResultItem extends Object implements Serializable
      serialVersionUID:
      709720021L
      • Serialized Fields

        • fieldNames
          String[] fieldNames
          List of index field names that contain the query text.
        • relevance
          int relevance
          Relevance in per mill.
        • resultFields
          ArrayList<SearchFieldE> resultFields
          List of fields where a query matched.
          See SearchFieldC
          Since:
          10.99.999.005
        • sord
          Sord sord
          Sord object.
        • summaryDesc
          String summaryDesc
          Textpart from memo text.
        • summaryFulltext
          String summaryFulltext
          Textpart from document.
    • Class de.elo.ix.client.FindByIndex

      class FindByIndex extends ValueClass implements Serializable
      serialVersionUID:
      1985205034L
      • Serialized Fields

        • acl
          String acl
          Constrain results to objects with this access control list.
          Since:
          7.00.000.010
        • aspects
          Map<String,FindByAspectValue> aspects
          Find objects according to this filter for aspect objects. The filter is a map of lists that uses a String as key and List of IndexSearchValue as value. To match an object all operations in IndexSearchValue must be fulfilled for the respective key. If you want to filter for different, non-overlapping values, then use the List of IndexSearchValues in FindByAspectValue.

          To give an example, lets take an aspect called "asp" which is associated under the name "a" to a mask. That aspect has a line called "aspl1" and another one called "aspl2". The type of "apsl1" is an Integer and we want all values that ranges between 5 and 20 or between 105 and 120. Then your code to create such a filter would look like this:
           var integerRange1 = new IndexSearchValue();
           integerRange1.intValues =
               List.of(new IndexSearchIntegerValue(IndexSearchOperator.GREATER_THAN, 5),
                   new IndexSearchIntegerValue(IndexSearchOperator.LOWER_THAN, 20));
          
           var integerRange2 = new IndexSearchValue();
           integerRange2.intValues =
               List.of(new IndexSearchIntegerValue(IndexSearchOperator.GREATER_THAN, 105),
                   new IndexSearchIntegerValue(IndexSearchOperator.LOWER_THAN, 120));
          
           var filterKeyAspl1 = "a¶asp¶aspl1";
          
           var filter = new HashMap<String, FindByAspectValue>();
           filter.put(filterKeyAspl1, new FindByAspectValue(integerRange1, integerRange2));
           
          Now there is need for an additional restriction: The index line "aspl2" (of type text) must be "hello world" in both of the above cases. We support this requirement by adding the appropriate key and IndexSearchValue to the filter object:
           var filterKeyAspl2 = "a¶asp¶aspl2";
           var stringRestriction = new IndexSearchValue();
           stringRestriction.stringValue =
               new IndexSearchStringValue(IndexSearchOperator.EQUALS, "hello world");
           filter.put(filterKeyAspl2, new FindByAspectValue(stringRestriction));
           
          As you can see in the code above the key in the map is composed of the AspectAssoc.name, the Aspect.name's name (or Aspect.id/ Aspect.guid), and the AspectLine.key. The separator must be the pilcrow symbol and there must always be two pilcrow symbols. A single pilcrow symbol will get treated as an input error as well as three pilcrow symbols. Escaping of pilcrow symbols is right out.

          You can leave some or all of the fields in the key blank as long as the separator symbols are present. The server treats an empty field as a wildcard. To give an example lets consider you have the same Aspect assigned multiple times to the same DocMask using different AspectAssocs (obviously). You want to search for value in all aspect objects regardless of there assiciation to a mask. To achieve this goal you simply do not set a value for AspectAssoc.name and the server will search the value in every aspect object data that matches the name of the Aspect and the key of the AspectLine.

          Please note that you can leave all the fields blank. This will lead to a search in all fields of every aspect table which in turn will lead to heavy load on the database server as it will perform a full table scan on every aspect table. So be strongly advised to not execute such searches in a regular manner.
          Even if you leave the AspectLine.key part blank there are some restrictions still: in case your condition is of type IndexSearchStringValue, the server will not look for the given filters in fields that cannot be converted from strings. Currently these are AspectLines of the types AspectLineC.TYPE_INTEGER and AspectLineC.TYPE_DOUBLE. Accordingly the Indexserver will not look in AspectLines of AspectLineC.TYPE_INTEGER if you specify a AspectLineC.TYPE_DOUBLE as search term.

          In case you specify SearchModeC.OR at FindOptions.searchMode only the junction mode of the FindByAspectValues changes to a disjunction. The conditions you define inside FindByAspectValue will be treated as stated in the documentation.
          Since:
          21.03.000.003
        • aspectSortOrder
          List<FindResultSortSpecification> aspectSortOrder
          This parameter controls an aspect-search's sorting of its results. You can leave this parameter empty or null to get the results from the database's default ordering. Please note that sorting the result leads to higher computational requirements and therefor lower performance.
          Since:
          21.04.000.000
        • delDateIso
          String delDateIso
          Find objects with this due date. It is a single date value or a date range in ISO format.
          See Also:
        • deleteDateIso
          String deleteDateIso
          Find objects with this delete date. It is a single date value or a date range in ISO format.
          Since:
          10.00.020.014
          See Also:
        • deleteUser
          String deleteUser
          Find objects deleted by the user with this user ID or name. If the deleted user is to be ignored this value must be set to null.
          Since:
          10.00.020.014
        • desc
          String desc
          Find objects with this term included in the description of the object (case insensitive). This value can be a list of terms separated by blanks. The terms are concatinated with the operator specified by FindOptions.searchMode. The wildcard * is allowed, it matches any number of characters. If desc is to be ignored this value must be set to null.
        • exactName
          boolean exactName
          If this option is false, all objects are found that contain the term specified in name anywhere in their short description (Sord.name). In other words: a search by *name* is executed. Set this option true, if wildcards should not added implicitly to the search term.
          Since:
          7.00.000.035
        • iDateIso
          String iDateIso
          Find objects with this internal date. It is a single date value or a date range in ISO format.
          See Also:
        • includeChildMasks
          boolean includeChildMasks
          Set this flag to true if you want to include masks that inherit from the specified masks in FindByIndex.maskId and FindByIndex.maskIds.
          Since:
          21.04.000.011
        • kind
          String kind
          Colour. If the colour is to be ignored this value must be set to null.
          Since:
          8.00.030.003
        • lockId
          String lockId
          Set this value to an user's id or name to search for objects currently locked by that user. To ignore this option, set this value to null (default).
          Since:
          9.00.000.031
        • maskId
          String maskId
          Find objects related to this mask ID or name. If the mask relation is to be ignored this value must be set to an empty string or null.
          See Also:
        • maskIds
          String[] maskIds
          Array of maskIds. Find objects associated to one of this keywording forms.
          Since:
          9.00.040.003
          See Also:
        • name
          String name
          Find objects with this term(s) included in the name of the object (case insensitive). This value can be a list of terms separated with blanks. They are concatinated with the operator specified by FindOptions.searchMode. The wildcard * is allowed, it matches any number of characters. If name is to be ignored this value must be set to null.
          See Also:
        • objKeys
          ObjKey[] objKeys
          Find objects with this indexing attributes. The values of the attributes can contain a value range. The wildcard * is allowed in ObjKey.name and ObjKey.data[], it matches any number of characters. If objKeys is to be ignored this value must be set to null. The ObjKey.id is ignored, if ObjKey.name is not empty or ObjKey.id is 0. Searching over ObjKey.id can only handle one element in ObjKey.data.
        • ownerId
          String ownerId
          Find objects owned by the user with this user ID or name. If the owner is to be ignored this value must be set to null.
          See Also:
        • pathId
          String pathId
          Storage path ID or name
          Since:
          7.00.000.045
        • spaceGuids
          List<String> spaceGuids
          List of spaceGuids. Find objects that contain these spaceGuids.
          Since:
          21.03.000.012
        • xDateIso
          String xDateIso
          Find objects with this external date. It is a single date value or a date range in ISO format.

          IX versions from 9.00.060 support relative date values. Relative date values give an offset to the current date and use a format similar to ISO format: "{+|-}YYYY-MM-DD hh:mm:ss", whereby the separator characters can be omitted: "{+|-}YYYYMMDDhhmmss". A relative date has to be prefixed by + (date is added) or - (date is subtracted).

          Examples, assuming the current date is 2016-06-24 16:29:00
          Relative date Resulting absolute date Remark
          +0001-00-00 00:00:00 2017-06-24 16:29 Next year, same month etc.
          -0000-01-00 00:00:00 2016-05-24 16:29 Previous month, same day etc.
          +0000 2016-01-01 00:00...2016-12-31 23:59 Search documents of this year. Incomplete relative dates are automatically expanded to a date range.
          +0000-00 2016-06-01 00:00...2016-06-30 23:59 Search documents of this month.
          -0000-01 2016-05-01 00:00...2016-05-31 23:59 Search documents of the last month.
          -0000-00-10...+0000-00-00 00:00:00 2016-06-14 00:00...2016-06-24 16:29 Search documents from the last 10 days.
          -0001... 2015-01-01 00:00... Search documents from last year or newer.

          Hint: Only relative date values are allowed that could also be an absolute date. E.g. a relative date of 100 days or 13 months cannot be specified.

          See Also:
    • Class de.elo.ix.client.FindByNotes

      class FindByNotes extends ValueClass implements Serializable
      serialVersionUID:
      735083434L
      • Serialized Fields

        • term
          String term
          The search term to be found within the notes.
        • type
          int type
          Find notes of this type. Use TYPE_NONE (=0) to find all notes.
          See Also:
    • Class de.elo.ix.client.FindByPreviewCtrl

      class FindByPreviewCtrl extends Object implements Serializable
      serialVersionUID:
      78436038L
      • Serialized Fields

        • fileExtensions
          String[] fileExtensions
          Select only those documents with one of this extension.
          Since:
          7.00.040.010
        • previewAvailable
          boolean previewAvailable
          Finds all documents with previews.
        • previewError
          boolean previewError
          Finds all documents for which the preview generation failed.
    • Class de.elo.ix.client.FindByRegisteredFunction

      class FindByRegisteredFunction extends ValueClass implements Serializable
      serialVersionUID:
      700871698L
      • Serialized Fields

        • args
          Any args
        • functionName
          String functionName
    • Class de.elo.ix.client.FindBySordHist

      class FindBySordHist extends ValueClass implements Serializable
      serialVersionUID:
      2098788325L
    • Class de.elo.ix.client.FindByType

      class FindByType extends ValueClass implements Serializable
      serialVersionUID:
      151307616L
      • Serialized Fields

        • typeDocuments
          boolean typeDocuments
          Include all document types
        • typeExtensions
          String[] typeExtensions
          Associated document extensions; must be resolved to typeIDs
        • typeIDs
          int[] typeIDs
          Type identifiers; a direct mapping of objtype
        • typeNames
          String[] typeNames
          Type names; must be resolved to typeIDs
        • typeStructures
          boolean typeStructures
          Include all structure elements
    • Class de.elo.ix.client.FindByVersion

      class FindByVersion extends ValueClass implements Serializable
      serialVersionUID:
      925953882L
      • Serialized Fields

        • versionComment
          String versionComment
          User defined version description. The wildcard * is allowed, it matches any number of characters.
        • versionMD5
          String versionMD5
          The md5 Hash value for the file.
        • versionNumber
          String versionNumber
          User defined version number or version id. The wildcard * is allowed, it matches any number of characters.
        • workVersionOnly
          boolean workVersionOnly
          Optional flag to restrict the search to active versions only.
    • Class de.elo.ix.client.FindChildren

      class FindChildren extends ValueClass implements Serializable
      serialVersionUID:
      752202075L
      • Serialized Fields

        • endLevel
          int endLevel
          Search child objects up to this level below parentId. A value of 0 or 1 means, that only the sub entries directly under the parent are included. Set this value to -1, to search over all levels. In this case the level is internally constrained to 32 to avoid an endless loop, if the tree under the parent contains recursive references.
          Since:
          7.00.000.010
        • mainParent
          boolean mainParent
          Include only main parent relations.
        • parentId
          String parentId
          Search child objects of the parent entry with this object ID or GUID.
    • Class de.elo.ix.client.FindConfigFileInfo

      class FindConfigFileInfo extends ValueClass implements Serializable
      serialVersionUID:
      1887106523L
      • Serialized Fields

        • inclDeputy
          boolean inclDeputy
          Find files in the in-tray folder of all deputized users. This member is ignored, if names is set.
          See Also:
        • names
          String[] names
          Find files with this names or in this directory. To specify a directory, put the directory name into names[.] and append "/*". If this member is set, inclDeputy and postboxUserId is ignored.
          See Also:
        • postboxUserId
          String postboxUserId
          Find files in the in-tray of the user specified by ID or name. This member is ignored, if names is set. If neither names nor postboxUserId is set, the in-tray of the current user is listed.
          See Also:
    • Class de.elo.ix.client.FindDirect

      class FindDirect extends Object implements Serializable
      serialVersionUID:
      1028007046L
      • Serialized Fields

        • query
          String query
          Deprecated.
          Search query.
        • searchInFulltext
          boolean searchInFulltext
          Deprecated.
        • searchInIndex
          boolean searchInIndex
          Deprecated.
        • searchInMemo
          boolean searchInMemo
          Deprecated.
          Is ignored, reserved for future use
        • searchInNotes
          boolean searchInNotes
          Deprecated.
          Is ignored, reserved for future use
        • searchInSordName
          boolean searchInSordName
          Deprecated.
        • searchInVersions
          boolean searchInVersions
          Deprecated.
    • Class de.elo.ix.client.FindDirectC

      class FindDirectC extends Object implements Serializable
      serialVersionUID:
      627433249L
      • Serialized Fields

        • FIELD_DELDATE
          String FIELD_DELDATE
          ELO iSearch field: ISO formatted delete date, UTC (Sord.delDateIso)
        • FIELD_DELDATE_MONTH
          String FIELD_DELDATE_MONTH
          ELO iSearch field: Month of delete date, UTC (Sord.delDateIso), always 2 characters, e.g. 01 for January.
        • FIELD_DELDATE_YEAR
          String FIELD_DELDATE_YEAR
          ELO iSearch field: Year of delete date, UTC (Sord.delDateIso)
        • FIELD_DESC
          String FIELD_DESC
          ELO iSearch field: descripton (memo text, Sord.desc)
        • FIELD_DOC_SIZE
          String FIELD_DOC_SIZE
          Document size
          Since:
          10.00.020.018
        • FIELD_EXT
          String FIELD_EXT
          ELO iSearch field: document file extension without leading dot (DocVersion.ext)
        • FIELD_GUID
          String FIELD_GUID
          ELO iSearch field: GUID (Sord.guid)
        • FIELD_ID
          String FIELD_ID
          ELO iSearch field: ID (Sord.id)
        • FIELD_IDATE
          String FIELD_IDATE
          ELO iSearch field: ISO formatted archiving date, UTC (Sord.iDateIso)
        • FIELD_IDATE_MONTH
          String FIELD_IDATE_MONTH
          ELO iSearch field: Month of archiving date, UTC (Sord.iDateIso), always 2 characters, e.g. 01 for January.
        • FIELD_IDATE_YEAR
          String FIELD_IDATE_YEAR
          ELO iSearch field: Year of archiving date, UTC (Sord.iDateIso)
        • FIELD_MASK_ID
          String FIELD_MASK_ID
          ELO iSearch field: Keywording form ID, (Sord.mask)
        • FIELD_MASK_NAME
          String FIELD_MASK_NAME
          ELO iSearch field: Keywording form name, (Sord.maskName)
        • FIELD_NAME
          String FIELD_NAME
          ELO iSearch field: short description (Sord.name)
        • FIELD_OBJ_KEY
          String FIELD_OBJ_KEY
          ELO iSearch field: group name of index field (Sord.objKey[.].name, DocMask.line[.].key)
        • FIELD_OBJ_KEY_DATE
          String FIELD_OBJ_KEY_DATE
          Date Indexfields (dLINE)
          Since:
          10.00.020.018
        • FIELD_OBJ_KEY_NUMERIC
          String FIELD_OBJ_KEY_NUMERIC
          Numeric Indexfields (nLINE)
          Since:
          10.00.020.018
        • FIELD_OBJ_KEY_TOKENIZED
          String FIELD_OBJ_KEY_TOKENIZED
          ELO iSearch field: group name of index field (Sord.objKey[.].name, DocMask.line[.].key) This field contains tokenized content (linguistic processing applied)
        • FIELD_OWNER
          String FIELD_OWNER
          ELO iSearch field: owner name (Sord.ownerName)
        • FIELD_OWNER_ID
          String FIELD_OWNER_ID
          ELO iSearch field: owner ID (Sord.ownerId)
        • FIELD_TSTAMP
          String FIELD_TSTAMP
          ELO iSearch field: last modified time stamp, UTC (Sord.tStamp)
        • FIELD_TYPE
          String FIELD_TYPE
          ELO iSearch field: folder or document type (Sord.type)
        • FIELD_VERSION_COMMENT
          String FIELD_VERSION_COMMENT
          DocVersion.comment
          Since:
          10.00.020.019
        • FIELD_VERSION_NUMBER
          String FIELD_VERSION_NUMBER
          DocVersion.version
          Since:
          10.00.020.019
        • FIELD_VERSION_OWNER
          String FIELD_VERSION_OWNER
          DocVersion.ownerId
          Since:
          10.00.020.019
        • FIELD_XDATE
          String FIELD_XDATE
          ELO iSearch field: ISO formatted document date, UTC (Sord.xDateIso)
        • FIELD_XDATE_MONTH
          String FIELD_XDATE_MONTH
          ELO iSearch field: Month of document date, UTC (Sord.xDateIso), always 2 characters, e.g. 01 for January.
        • FIELD_XDATE_YEAR
          String FIELD_XDATE_YEAR
          ELO iSearch field: Year of document date, UTC (Sord.xDateIso)
    • Class de.elo.ix.client.FindForKeywordingRelation

      class FindForKeywordingRelation extends ValueClass implements Serializable
      serialVersionUID:
      1250305402L
    • Class de.elo.ix.client.FindInfo

      class FindInfo extends ValueClass implements Serializable
      serialVersionUID:
      1017838205L
      • Serialized Fields

        • findByAcl
          FindByAcl findByAcl
          Find sords by ACL.
          Since:
          7.00.000.011
        • findByESearch
          FindByESearch findByESearch
          If not null, the new ElasticSearch API (as of ELO 11) is used.
          Since:
          11.00.000.009
        • findByFulltext
          FindByFulltext findByFulltext
          If not null the results are constrained to documents including this fulltext term (or terms).
        • findByFulltextCtrl
          FindByFulltextCtrl findByFulltextCtrl
          Find the sords that have to be indexed by the fulltext engine.
          Since:
          7.00.040.006
        • findByIndex
          FindByIndex findByIndex
          If not null the function searches through the indexing information.
        • findByNotes
          FindByNotes findByNotes
          If not null the function searches through the notes. (NOT CURRENTLY IMPLEMENTED!)
        • findByPreviewCtrl
          FindByPreviewCtrl findByPreviewCtrl
          Find sords by preview control information.
          Since:
          7.00.026.001
        • findByRegisteredFunction
          FindByRegisteredFunction findByRegisteredFunction
          Since:
          7.00.040.020
        • findBySordHist
          FindBySordHist findBySordHist
          If not null the function searches in versioning history of indexing information.
        • findByType
          FindByType findByType
          If not null the function searches using objtype.
        • findByVersion
          FindByVersion findByVersion
          If not null the function searches using histversion and histcomment.
        • findChildren
          FindChildren findChildren
          If not null, the results are constrained to child entries of the specified parent in this object. To retrieve child lists for an archive entry this member must be set with the related parent ID and all others members in this class must be null.
        • findDirect
          FindDirect findDirect
          Terms for google-like search in Java-Client.
          Since:
          6.00.092
        • findForKeywordingRelation
          FindForKeywordingRelation findForKeywordingRelation
          Find Sord objects to be used in keywording relation.
          Since:
          12.00.000.024
          See Also:
        • findLinks
          FindLinks findLinks
          If not null, the results are constrained to entries linked to the specified object in findLinks.
          Since:
          9.00.000.028
        • findOptions
          FindOptions findOptions
          This member controls several options, e. g. sorting, time limitation.
    • Class de.elo.ix.client.FindInfoAsInternalSQL

      class FindInfoAsInternalSQL extends Object implements Serializable
      serialVersionUID:
      2003160309L
      • Serialized Fields

        • fromTables
          String fromTables
          Comma separated list of table names.
        • groupByClause
          String groupByClause
          SQL GROUP BY clause.
        • orderByClause
          String orderByClause
          SQL ORDER BY clause.
        • whereClause
          String whereClause
          SQL WHERE clause.
    • Class de.elo.ix.client.FindOptions

      class FindOptions extends ValueClass implements Serializable
      serialVersionUID:
      1371440255L
      • Serialized Fields

        • docMaskZ
          DocMaskZ docMaskZ
          Since:
          12.00.000.024
        • escapeChar
          String escapeChar
          SQL escape character. Overwrites the character that can be specified by setSessionOptions.
          See Also:
        • evalCount
          boolean evalCount
          Compute the number of results. The number of results are returned in FindResult.count. Be aware of the fact that this option needs to read all database result rows and check user access before findFirstSords returns.
          See Also:
        • excludeSummary
          boolean excludeSummary
          Do not generate summary information. Retrieving summaries is very expensive for the iSearch module.
          Since:
          8.00.026.000
        • findResultAccessMode
          FindResultAccessMode findResultAccessMode
          Describes how the client application will access the results.
          Since:
          11.00.000.033
        • inclDeleted
          boolean inclDeleted
          Include logically deleted objects.
          See Also:
        • lockZ
          LockZ lockZ
          Lock all result Sords. If at least one of the sords cannot be locked, an exception is thrown from findFirstSords. Be aware of the fact that this option needs to read all database result rows and check user access. The objects are unlocked by a call to findClose.
          Since:
          7.00.022.004
        • objIds
          String[] objIds
          Restricts the results to objects with these IDs or GUIDs.
        • onlyDeleted
          boolean onlyDeleted
          Only logically deleted objects. If this member is true, inclDeleted is ignored.
          Since:
          7.00.000.022
          See Also:
        • orderBy
          String orderBy
          An SQL ORDER BY clause can be provided here, if required.
        • rangeDelimiter
          String rangeDelimiter
          Range values can be used to search many index and date attribute values. The delimiter between the lower limit and upper limit value is defined by rangeDelimiter. The default rangeDelimiter is "...".
        • replSet
          ReplSet replSet
          Results are returned only for objects that reside in this replication set.
        • reserved
          long reserved
          This value is reserved for internal testing purposes and must be set to 0 in all cases.
        • searchId
          String searchId
          Restricts the results to objects returned by a previous search.
        • searchLifetimeSeconds
          int searchLifetimeSeconds
          Lifetime of cached search results. This value overrides the ELOix configuration option searchLifetimeSeconds. The value determines the time in seconds, how long the search results are cached. As long the results are valid, they can be read by findNext-functions of the API.
          Since:
          8.00.026.000
          See Also:
        • searchMode
          SearchModeZ searchMode
          The searchMode describes how search terms are concatinated with the boolean operators AND or OR.
        • sortOrder
          int sortOrder
          Defines the sort order of the results. If sortOrder is 0 and the search process searches for child objects (FindInfo.findChildren!=null), the objects are sorted by the sort flags of the parent. If sortOrder is 0 and the search uses FindInfo.findByIndex, the objects are sorted alphabetically.
          See Also:
        • timeoutSeconds
          int timeoutSeconds
          Specifies the time limit for the search. If the limit is exceeded, the search is interruped. If the search is not to have a time limit timeoutSeconds=0 must be used.
        • totalCount
          int totalCount
          The search is terminated if this number of objects are found. If the number of results should not be constrained, set this value to 2^32-1 = 2147483647 (maximum value of a positive 32bit integer minus 1). If totalCount is not set, the Indexserver option totalCount is used, which is 10000 by default. If this value is set to 1, findFirstSords will not generate a report entry ReportInfoC.ACT_CLIENT_SEARCH.
        • TStamp
          String TStamp
          Return objects that were last modified at this time or in this time range. The time stamp is an ISO formatted value in the UTC timezone. It might include dots to separate the date and time elements. A time range is separated by the rangeDelimiter. The selection includes the range limits. Because the FindOptions cannot be the only criteria in FindInfo, use FindByIndex.name="*" to select over the entire archive.
          Since:
          7.00.006.001
        • wildcards
          String wildcards
          This characters are used as wildcards in search terms. The first wildcard is used for zero or more characters. The second wildcard is used for exactly one character. By default (if this member is null or empty), only the first wildcard is defined: *.
          Since:
          7.00.022.002
          See Also:
    • Class de.elo.ix.client.FindReportInfo

      class FindReportInfo extends ValueClass implements Serializable
      serialVersionUID:
      504724737L
      • Serialized Fields

        • endDateIso
          String endDateIso
          End date (UTC)
        • erpCodes
          int[] erpCodes
          Constrained to this ERP codes.
          See Also:
        • extra1
          String extra1
          Specifies the extra1 value. Only Integer values are allowed for this element.
          Since:
          9.00.016.004
        • findLastEntryBeforeEndDate
          boolean findLastEntryBeforeEndDate
          Find the last entry before the given FindReportInfo.endDateIso. This option e.g. allows to find the user permissions at the given FindReportInfo.endDateIso. Therefore, set erpCodes = new int[] { ReportOptionsC.ERP_LOGOPENARC, ReportOptionsC.ERP_LOGUSERDATA };.
          Since:
          9.00.016.004
        • objId
          String objId
          Object ID or GUID
        • orderBy
          String orderBy
          Deprecated.
          This member is ignored since 9.00.016 for security reasons. The sort order is always descending by time.
          Can contain an SQL ORDER BY clause.
        • searchId
          String searchId
          reserved.
        • startDateIso
          String startDateIso
          Start date (UTC)
        • timeoutSeconds
          int timeoutSeconds
          Specifies the time limit for the search. If the limit is exceeded, the search is interruped. timeoutSeconds=0 means that the search has no time limit.
        • totalCount
          int totalCount
          The search is ended once this number of objects have been found. A value of 0 sets no constraint to the number of objects.
        • userId
          String userId
          User ID or name.
    • Class de.elo.ix.client.FindResult

      class FindResult extends ValueClass implements Serializable
      serialVersionUID:
      1301335819L
    • Class de.elo.ix.client.FindResultSortSpecification

      class FindResultSortSpecification extends Object implements Serializable
      serialVersionUID:
      6009823936517236403L
    • Class de.elo.ix.client.FindSubscriptionInfo

      class FindSubscriptionInfo extends ValueClass implements Serializable
      serialVersionUID:
      374754896782968872L
      • Serialized Fields

        • feedZ
          FeedZ feedZ
          Element selector for Feed objects. If this member is not null or empty, FindResult.feeds contains the Feed objects associated to FindResult.subscriptions.
          Since:
          9.00.014.005
        • sordZ
          SordZ sordZ
          Element selector for Sord objects. If this member is not null or empty, FindResult.sords contains the Sord objects associated to FindResult.subscriptions.
          Since:
          9.00.014.005
        • userId
          String userId
          Find subscriptions of this user. If this member is empty, the current users subscriptions are returned. This member is ignored for non-administrators. User ID, GUID or Name is accepted.
          Since:
          9.00.014.005
    • Class de.elo.ix.client.FindTasksInfo

      class FindTasksInfo extends ValueClass implements Serializable
      serialVersionUID:
      1489194452L
      • Serialized Fields

        • allUsers
          boolean allUsers
          Collect tasks from all users. This member is ignored, if the current user does not have administrator privileges AccessC.FLAG_ADMIN. If set to true, element FindTasksInfo.userIds is ignored and the tasks of all users are selected.
          Since:
          8.00.020.003
        • endDateIso
          String endDateIso
          Collect tasks up to this date.
        • findResultAccessMode
          FindResultAccessMode findResultAccessMode
          Describes how the client application will access the results.
          Since:
          11.00.000.033
        • highestPriority
          int highestPriority
          Collect tasks of this or lower priority.
          See Also:
        • inclActivities
          boolean inclActivities
          Collect activities.
        • inclActivityTypes
          List<String> inclActivityTypes
          Only select activities of the given types
          Since:
          9.00.000.003
        • inclDeleted
          boolean inclDeleted
          Select tasks for deleted folders and documents too.
          Since:
          8.00.012.005
        • inclDeputy
          boolean inclDeputy

          Collect tasks received from users for which the current user is a substitute.

          ELO 12+: FindTasksInfo.inclGroup must be set to true to enable this option.

        • inclGroup
          boolean inclGroup
          Collect tasks of the users groups.
        • inclHidden
          boolean inclHidden
          Inlcude hidden tasks. Currently this only affects workflows.
          Since:
          9.00.018.006
        • inclOverTimeForSuperior
          boolean inclOverTimeForSuperior
          Collect tasks for a superior as defined in the escalation options. When a workflow task exceeds its time limit, and the current user is assigned in the time limit options of this task, then the user receives this task from findFirstTasks/findNextTasks although she or he is not the owner of the task. If an entire workflow is over time, the user receives the start node of the workflow. This option applies to workflow tasks only.
          Since:
          8.00.010.006
        • inclReminders
          boolean inclReminders
          Collect reminders.
        • inclWorkflows
          boolean inclWorkflows
          Collect workflows.
        • lowestPriority
          int lowestPriority
          Collect tasks of this or higher priority.
          See Also:
        • objId
          String objId
          Collect tasks for this Sord (ID or GUID).
        • overTimeLimit
          boolean overTimeLimit
          Collect nodes that exceeded the time limit. Workflow only
          Since:
          6.00.098
        • sordZ
          SordZ sordZ
          Return the associated Sord objects to the selected Tasks. If this member is not null, the Sord objects to the selected Tasks are read from the database. The Sord objects can be found in FindResult.sords and in each UserTask.sord of the array FindResult.tasks. The Sord objects contain the elements defined in this element selector as valid members.
          Since:
          8.00.020.004
        • sortOrder
          UserTaskSortOrderZ sortOrder
          Controls the sort order or returned arrays. If null, PRIORITY_DATE_NAME is used.
          See Also:
        • startDateIso
          String startDateIso
          Collect tasks beginning at this date.
        • taskName
          String taskName
          Select tasks with this name. The task name of a Reminder is Reminder.name. The task name of an Activity is Activity.name. The task name of a workflow node is WFNode.name and WFCollectNode.nodeName. This element can contain wildcard characters. The underlying database column is by default not indexed. Thus, selecting only by taskName will result in a full table scan.
          Since:
          8.00.028.002
        • timeLimitBias
          int timeLimitBias
          Time limit bias. This value added to each WFNode.timeLimit before evaluating whether the node is over time. It is measured in minutes. Indexserver uses a timeLimitBias of 1min when looking for over-timed nodes to be forwarded automatically through a WFNodeMatrixC.IF_OVERTIME edge.
          Since:
          9.99.009.009
        • updateInUseDate
          boolean updateInUseDate
          Update WFNode.inUseDateIso for selected tasks.
          Since:
          9.00.000.025
        • userIds
          String[] userIds
          IDs of the users which tasks can be collected by the administrator. This member is ignored, if the current user does not have administrator privileges AccessC.FLAG_ADMIN. For administrators, this can be a list of user or groups which tasks should be selected. If the list is null or empty, The tasks of the administrator are collected. In order to collect all tasks from all users, set member FindTasksInfo.allUsers=true.
          Since:
          8.00.012.003
    • Class de.elo.ix.client.FindTranslateTermInfo

      class FindTranslateTermInfo extends Object implements Serializable
      serialVersionUID:
      986701599L
      • Serialized Fields

        • disableFallback
          boolean disableFallback
          Disable fallback to default language if a key in FindTranslateTermInfo.translationKeyPrefixes is not found. If there is no translation term associated to a key for a language in FindTranslateTermInfo.langs, an empty String is returned in the corresponding FindResult.translateTerms. EIX-3008
          Since:
          21.03.000.005
        • inclDeleted
          boolean inclDeleted
          Reserved - Find deleted terms too (currently not implemented).
        • inclToBeTranslated
          boolean inclToBeTranslated
          Return those terms too, that should be translated into other languages: e.g. Keywording form names (DocMask.name), index value lables (DocMaskLine.name) and Keywords.
          Since:
          7.00.000.031
        • langs
          String[] langs
          Return the terms specified by element terms for which translations exist in this languages. If a term is not found in one of the languages, an empty string is returned. The languages must be given in ISO 639 2-letter codes, e.g. "en" for English. The language at the first index specifies the language of the terms. This element is corresponding to TranslateTerm.termLangs: termLangs[i] is in language langs[i] If this element is null, terms in all available languages are returned.
          See Also:
        • level
          int level
          Find terms of this priority level. If 0 (default), return the terms with the highest level.
          Since:
          21.02.000.005
        • packageName
          String packageName
          Package GUID.
          Since:
          21.02.000.005
        • terms
          String[] terms
          Terms for which translations should be selected.

          The given terms have to be in the language specified in langs[0] object. If langs is null or empty, the terms are assumed to be in the system language. Set this element and FindTranslateTermInfo.translationKeyPrefixes to null or empty, if all terms should be returned.

          The terms also act as prefixes for keys stored in property files used for translation. Alternatively, member FindTranslateTermInfo.translationKeyPrefixes can be used to search over property files. To get the entire content of this files, set this member or FindTranslateTermInfo.translationKeyPrefixes to FindTranslateTermInfoC.ALL_TRANSLATIONS_FROM_PROPERY_FILES.

          See Also:
        • translationKeyPrefixes
          String[] translationKeyPrefixes
          Find terms by translation keys. Collect the localized text for all keys with the given prefixes in the database or in the localization property files.
          Since:
          21.02.000.005
    • Class de.elo.ix.client.FindUserInfo

      class FindUserInfo extends ValueClass implements Serializable
      serialVersionUID:
      -7739005172568861130L
      • Serialized Fields

        • checkoutUsersZ
          CheckoutUsersZ checkoutUsersZ
          Since:
          10.17.010.004
        • desc
          String desc
          Find by user description. Search over UserInfo.desc.
        • findResultAccessMode
          FindResultAccessMode findResultAccessMode
          Describes how the client application will access the results.
          Since:
          11.00.000.033
        • hasFlags
          int hasFlags
          Select only users that have all of this UserInfo.flags set. A value of 0 is ignored. The selected users are found by testing (UserInfo#flags & hasFlags) == hasFlags.
          Since:
          10.17.010.005
        • hasFlags2
          int hasFlags2
          Select only users that have all of this UserInfo.flags2 set. A value of 0 is ignored. The selected users are found by testing (UserInfo#flags2 & hasFlags2) == hasFlags2.
          Since:
          10.17.010.005
        • hasNotFlags
          int hasNotFlags
          Select only users that have non this UserInfo.flags set. The selected users are found by testing (UserInfo#flags & hasNotFlags) == 0.
          Since:
          10.17.010.005
        • hasNotFlags2
          int hasNotFlags2
          Select only users that have none this UserInfo.flags2 set. The selected users are found by testing (UserInfo#flags2 & hasNotFlags2) == 0.
          Since:
          10.17.010.005
        • ldapProperty
          KeyValue ldapProperty
          Find by a LDAP property. Search over all UserInfo.ldapProperties. The key element in property is the key in the map UserInfo.ldapProperties.
        • name
          String name
          Find by user name. Search over UserInfo.name.
        • onlyGroups
          boolean onlyGroups

          Search for groups only.

          If this member is set to true, flags provided by FindUserInfo.checkoutUsersZ are ignored.

        • onlyUsers
          boolean onlyUsers

          Search for users only.

          If this member is set to true, flags provided by FindUserInfo.checkoutUsersZ are ignored.

        • property
          KeyValue property
          Find by an user property. Search over all UserInfo.userProps. The key element in property is the index in the array UserInfo.userProps.
          Example:
            
           FindUserInfo findInfo = new FindUserInfo();
           KeyValue property = new KeyValue();
           property.setKey(Integer.toString(UserInfoC.PROP_NAME_EMAIL));
           property.setValue("maria.fritz@alpha.com");
           
           
        • returnUserInfoMap
          boolean returnUserInfoMap
          Return entire information about each user. If true, UserInfo objects are returned in FindResult.userInfos. If false, UserName objects are returned in FindResult.userNames. Additionally, FindResult#sortedResult returns a sorted list of either UserInfo or UserName objects.
          See Also:
        • sortOrder
          int sortOrder
          Specify how the results should be ordered. Valid values are SortOrderC.USERNAME and SortOrderC.IUSERNAME. Sorted results are returned in FindResult#sortedResult.
          Since:
          11.00.000.028
          See Also:
        • userIds
          String[] userIds
          User IDs related to FindUserInfo.checkoutUsersZ.
          Since:
          10.17.010.004
        • workspaceInfo
          String workspaceInfo
          Workspace related data.
          Since:
          21.02.000.017
    • Class de.elo.ix.client.FindWorkflowInfo

      class FindWorkflowInfo extends ValueClass implements Serializable
      serialVersionUID:
      1768797010L
      • Serialized Fields

        • activeUserIds
          String[] activeUserIds
          List with userIds. If not null and not empty only the workflows with this active users will be returned. ActiveUsers are the users of the active workflow node.
          Since:
          7.00.020.007
        • completionDateIso
          String completionDateIso
          Completion date. If not null and not empty, workflows completed at this date or in this date range are returned. Only valid if wfType=FINISHED. A time span can be specified by using "...".
          Since:
          6.00.098
          See Also:
        • excludeUserGroups
          boolean excludeUserGroups
          If true, only select workflows of the users. The group workflows are excluded.
          Since:
          10.00.000.001
        • findResultAccessMode
          FindResultAccessMode findResultAccessMode
          Describes how the client application will access the results.
          Since:
          11.00.000.033
        • inclDeleted
          boolean inclDeleted
          Only template workflows: include deleted templates.
          Since:
          6.00.098
        • inclHidden
          boolean inclHidden
          If true, include hidden/technical workflows with the result.
          Since:
          9.00.018.006
        • name
          String name
          Workflow name. If not null and not empty, it the search is restricted to workflows named like this value. It may contain wildcards, e. g. *bill*.
          Since:
          6.00.098
        • objId
          String objId
          Object ID. Active and finished workflows only. If not null and not empty, only workflows assigned to this object are returned.
          Since:
          6.00.098
        • overTimeLimit
          boolean overTimeLimit
          Collect only WFs that exceeded the time limit. The entire WF or one of its nodes must be over time.
          Since:
          6.00.098
        • ownerIds
          String[] ownerIds
          List with ownerIds. If not null and not empty only the workflows with these owners will be returned.
          Since:
          7.00.020.007
        • sordZ
          SordZ sordZ
          Return the associated Sord objects to the selected workflows. If this member is not null, the Sord objects to the selected workflows are read from the database. The Sord objects can be found in FindResult.sords in a random order. A Sord object is returned only once, even if there are more workflows assigned to the Sord. The Sord objects contain the elements defined in this element selector as valid members.
          Since:
          9.99.009.007
        • startDateIso
          String startDateIso
          Start date. If not null and not empty, workflows started at this date or in this date range are returned. It can be a single date value or a time span of two ISO dates separated by "...". To return workflows with a start date up to a given time, set startDateIso="..."+time (the first time value can be omitted).
          Since:
          6.00.098
        • templateId
          String templateId
          Workflow template ID or name. If not null and not empty, the result is constrained to workflows based on this workflow template.
          Since:
          6.00.098
          See Also:
        • type
          WFTypeZ type
          Workflow type. 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.
          Since:
          6.00.098
        • userIds
          String[] userIds
          Collect workflows for this users. For every given user or group in this list, those workflows are returned where the user or her or his groups or her or his substituted users has any node assigned. If this value is null or empty and the current user is a workflow administrator, the returned list of workflows is not constrained to any user ID. If this value is null or empty and the current user is not a workflow administrator, workflows for the current user inclusive her or his groups and inclusive her or his substituted users are returned. A Workflow administrator (privilege AccessC.FLAG_EDITWF) can specify any user or group ID here. Another user can only specify her or his user ID or her or his groups or her or his substituted users.
    • Class de.elo.ix.client.FontInfo

      class FontInfo extends Object implements Serializable
      serialVersionUID:
      1478273890L
      • Serialized Fields

        • bold
          boolean bold
          Bold
        • escapement
          int escapement
          Specifies the angle, in tenths of degrees, between the escapement vector and the x-axis of the device. The escapement vector is parallel to the base line of a row of text.
        • faceName
          String faceName
          Font face name
        • height
          int height
          Font heigth.
        • heightPerCell
          boolean heightPerCell
          The font height is related to the cell height of the font rather than the character heigth.
        • italic
          boolean italic
          Italic
        • RGB
          int RGB
          Read-green-blue value. On byte each color. Read is at the lowest significant byte.
        • strikeOut
          boolean strikeOut
          Strike out
        • underline
          boolean underline
          Underline
    • Class de.elo.ix.client.ForwardWorkflowNodeInfo

      class ForwardWorkflowNodeInfo extends ValueClass implements Serializable
      serialVersionUID:
      2096916840326993234L
    • Class de.elo.ix.client.ForwardWorkflowNodeResult

      class ForwardWorkflowNodeResult extends ValueClass implements Serializable
      serialVersionUID:
      7738062871028690925L
    • Class de.elo.ix.client.FulltextConfig

      class FulltextConfig extends ValueClass implements Serializable
      serialVersionUID:
      239574905L
      • Serialized Fields

        • flags
          int flags
          A combination of FulltextConfigC.FLAG_* constants.
          See Also:
        • indexerConfig
          SearchIndexerConfig indexerConfig
          Since:
          9.99.009.010
        • knowlegeMapUrl
          String knowlegeMapUrl
          URL of the Knowlege Map service. Only valid for iSearch.
        • source
          int source
          One of the FulltextConfigC.SOURCE_* constants.
          See Also:
    • Class de.elo.ix.client.FulltextConfigC

      class FulltextConfigC extends Object implements Serializable
      serialVersionUID:
      2025824562L
    • Class de.elo.ix.client.GetWebDAVPathOptions

      class GetWebDAVPathOptions extends ValueClass implements Serializable
      serialVersionUID:
      4582675474258512716L
      • Serialized Fields

        • objId
          String objId
          ObjectId or GUID of the sord to get the path.
        • tickketInPath
          boolean tickketInPath
          If true, the ticket is inserted in the path.
        • useShortPath
          boolean useShortPath
          Deprecated.
          From now on the option is no longer considered and is implicitly evaluated as true.
          Since:
          12.02.001.002
    • Class de.elo.ix.client.GetWebDAVPathResult

      class GetWebDAVPathResult extends ValueClass implements Serializable
      serialVersionUID:
      -1854751366436951687L
      • Serialized Fields

        • path
          String path
          The generated WEBDAV path.
    • Class de.elo.ix.client.HttpRequestInfo

      class HttpRequestInfo extends ValueClass implements Serializable
      serialVersionUID:
      1892343155L
      • Serialized Fields

        • cookies
          KeyValue[] cookies
          HTTP Cookies
        • headers
          KeyValue[] headers
          HTTP Headers
        • requestParams
          KeyValue[] requestParams
          Request parameters.
        • requestURI
          String requestURI
          Value of the request URI. HttpServletRequest.getRequestURI()
        • requestURL
          String requestURL
          Value of the request URL. HttpServletRequest.getRequestURL()
    • Class de.elo.ix.client.HttpResponseInfo

      class HttpResponseInfo extends ValueClass implements Serializable
      serialVersionUID:
      1552189905L
      • Serialized Fields

        • contentType
          String contentType
          Content type header. HttpServletResponse.setContentType()
        • responseString
          String responseString
          Response text. Written to HttpServletResponse.getOutputStream()
    • Class de.elo.ix.client.IdName

      class IdName extends ValueClass implements Serializable
      serialVersionUID:
      381683845L
      • Serialized Fields

        • displayName
          String displayName
          Localized name.
          Since:
          21.02.000.006
        • guid
          String guid
          GUID.
        • id
          int id
          Numeric ID.
        • name
          String name
          Name.
    • Class de.elo.ix.client.ImportOptionsC

      class ImportOptionsC extends Object implements Serializable
      serialVersionUID:
      1908370444L
    • Class de.elo.ix.client.IndexSearchDoubleValue

      class IndexSearchDoubleValue extends Object implements Serializable
      serialVersionUID:
      1939887333L
      • Serialized Fields

        • operand
          double operand
          Value on the right side of the operation. The left side implicitly is the value in the database.
        • operator
          IndexSearchOperator operator
          Operator for this search condition
    • Class de.elo.ix.client.IndexSearchIntegerValue

      class IndexSearchIntegerValue extends Object implements Serializable
      serialVersionUID:
      1640309978L
      • Serialized Fields

        • operand
          int operand
          Value on the right side of the operation. The left side implicitly is the value in the database.
        • operator
          IndexSearchOperator operator
          Operator for this search condition
    • Class de.elo.ix.client.IndexSearchStringValue

      class IndexSearchStringValue extends Object implements Serializable
      serialVersionUID:
      784706542L
      • Serialized Fields

        • operand
          String operand
          Value on the right side of the operation. The left side implicitly is the value in the database.
        • operator
          IndexSearchOperator operator
          Operator for this search condition
    • Class de.elo.ix.client.IndexSearchValue

      class IndexSearchValue extends Object implements Serializable
      serialVersionUID:
      2068840543L
    • Class de.elo.ix.client.IndexServerForArchive

      class IndexServerForArchive extends ValueClass implements Serializable
      serialVersionUID:
      145656220L
      • Serialized Fields

        • arcName
          String arcName
          Archive name.
        • url
          String url
          Index Server URL.
    • Class de.elo.ix.client.IndexValue

      class IndexValue extends ValueClass implements Serializable
      serialVersionUID:
      715821782L
    • Class de.elo.ix.client.IndexValueC

      class IndexValueC extends Object implements Serializable
      serialVersionUID:
      327780991L
    • Class de.elo.ix.client.InvalidateCacheC

      class InvalidateCacheC extends Object implements Serializable
      serialVersionUID:
      320503229L
    • Class de.elo.ix.client.InvalidateCacheInfo

      class InvalidateCacheInfo extends ValueClass implements Serializable
      serialVersionUID:
      1147029225382765900L
      • Serialized Fields

        • flags
          int flags
          A combination of bits defined in InvalidateCacheC.
          See Also:
        • guid
          String guid
          A GUID to specify the modified object.
          Since:
          12.00.000.023
        • id
          int id
          A numeric ID to specify an object, workflow etc. If flags contains InvalidateC.WORKFLOWS this element defines the ID of the active workflow to be updated in the cache.
        • parameters
          List<InvalidateCacheInfoParam> parameters
          Since:
          9.00.030.015
        • ticket
          String ticket
          Refresh options of this session.
          Since:
          20.00.000.003
        • value
          String value
          Optional value related to InvalidateCacheInfo.flags member. If flags specifies InvalidateCacheC.OBJKEY_DISPLAY_DATA, this value contains the
          Since:
          12.00.000.023
        • workflowCacheSyncInfos
          List<WFCacheSyncInfo> workflowCacheSyncInfos
          Data for workflow cache synchronisation.
          Since:
          12.02.001.000
    • Class de.elo.ix.client.InvalidateCacheInfoParam

      class InvalidateCacheInfoParam extends ValueClass implements Serializable
      serialVersionUID:
      7088144567762389324L
      • Serialized Fields

        • count
          int count
          Parameter, depends on the purpose of this object.

          In case of InvalidateCacheC.HASHTAGCOUNT:

          • Case 1: Increases count of corresponding Hashtag
          • Case -1: Decreases count of corresponding Hashtag
          • Any other number: Sets count of corresponding Hashtag this number

          In case of InvalidateCacheC.WORKFLOW: Hash code computed over WFDiagram members.

        • flag
          int flag
          Parameter, depends on the purpose of this object. Set flag to InvalidateCacheC.HASHTAGCOUNT to use for HashtagCountCache. In case of InvalidateCacheC.WORKFLOW: WFDiagram.id
        • guid
          String guid
          Parameter, depends on the purpose of this object.

          In case of InvalidateCacheC.HASHTAGCOUNT:

          • Related to HashtagGuid which is set according to count.
          • If guid is null or empty, the complete HashtagCountCache is rebuild from DB.

          In case of InvalidateCacheC.WORKFLOW: WFDiagram.tstamp

          In case of InvalidateCacheC.TRANSLATE_TERM: TranslateTerm.guid

        • objectValue
          ValueClass objectValue
          Modified object.
          Since:
          12.00.000.026
    • Class de.elo.ix.client.InvalidateCacheResult

      class InvalidateCacheResult extends ValueClass implements Serializable
      serialVersionUID:
      1305791669547883758L
    • Class de.elo.ix.client.IXConnIXServicePortIF_2_BYPS

      class IXConnIXServicePortIF_2_BYPS extends de.elo.ix.client.BStub_IXServicePortIF implements Serializable
      serialVersionUID:
      1795705954L
    • Class de.elo.ix.client.IXExceptionC

      class IXExceptionC extends Object implements Serializable
      serialVersionUID:
      1204588365L
    • Class de.elo.ix.client.IXExceptionData

      class IXExceptionData extends ValueClass implements Serializable
      serialVersionUID:
      784089396L
      • Serialized Fields

        • callId
          String callId
          String containing the ClientInfo.callId for the ClientInfo object. This is given to the function which triggered/caused the error.
        • details
          String details
          Detail text for the exception.
        • exceptionType
          int exceptionType
          This is the type of exception. This is one of the constants from IXExceptionC.
          See Also:
        • message
          String message
          The error message text for the exception.
        • ticket
          String ticket
          Ticket given to the function.
    • Class de.elo.ix.client.IXProperties

      class IXProperties extends Properties implements Serializable
      serialVersionUID:
      -2326069411443978585L
      • Serialized Fields

    • Class de.elo.ix.client.IXServerEventsC

      class IXServerEventsC extends Object implements Serializable
      serialVersionUID:
      1963572851L
    • Class de.elo.ix.client.IXServerEventsContext

      class IXServerEventsContext extends ValueClass implements Serializable
      serialVersionUID:
      956691491L
    • Class de.elo.ix.client.IXServicePortC

      class IXServicePortC extends Object implements Serializable
      serialVersionUID:
      1264954948L
    • Class de.elo.ix.client.JobState

      class JobState extends ValueClass implements Serializable
      serialVersionUID:
      1436376940L
      • Serialized Fields

        • countErrors
          long countErrors
          Error status information.
        • countEstimatedMax
          long countEstimatedMax
          Estimated maximum amount.
        • countProcessed
          long countProcessed
          Progress status information.
        • countResult
          CountResult countResult
          Result of the count process.
          Since:
          7.00.000.000
        • doCancelJob
          boolean doCancelJob
          Tell the Indexserver to cancel the job.
          Since:
          8.00.036.000
        • expires
          long expires
          When the information expires (milliseconds): (jobEnd + expires < current-date).
        • jobEnd
          String jobEnd
          End or termination of the job.
        • jobGuid
          String jobGuid
          Job identifier.
        • jobName
          String jobName
          Thread name.
        • jobRunning
          boolean jobRunning
          Set to true while the job is being executed.
        • jobStart
          String jobStart
          Start of job.
        • lastGuid
          String lastGuid
          Status information for GUIDs.
        • lastID
          int lastID
          Status information for integer IDs.
        • procInfo
          ProcessInfo procInfo
          The standard process-by-SORD job list.
        • strMsg
          String strMsg
          Job-defined message string.
    • Class de.elo.ix.client.KeyInfo

      class KeyInfo extends ValueClass implements Serializable
      serialVersionUID:
      1537059480L
      • Serialized Fields

        • id
          int id
          Key ID.
        • name
          String name
          Key name.
    • Class de.elo.ix.client.KeyValue

      class KeyValue extends ValueClass implements Serializable
      serialVersionUID:
      516301248L
      • Serialized Fields

        • key
          String key
          Key or identifying name.
        • value
          String value
          Associated value.
    • Class de.elo.ix.client.Keyword

      class Keyword extends ValueClass implements Serializable
      serialVersionUID:
      1426243550L
      • Serialized Fields

        • add
          boolean add

          Prefix the text of a child keyword with the text of this keyword. This member is interpreted in cookKeywords. The following relationship exists between the members enabled, add, raw

          Member relationships
          condition conclusion
          add=true enabled=false, raw=true
          enabled=true add=false, raw=any
          See Also:
        • children
          Keyword[] children
          Child array.
        • displayValue
          String displayValue
          Only used in keywords for aspect lines with type = AspectLineC.TYPE_STATUS. This field contains the translated text of the status value (field Keyword.text) into user's language.
          Since:
          21.00.000.010
        • enabled
          boolean enabled
          If true, this keyword can be used as a value for an index property. Otherwise its only purpose is to structure the keyword hierachy.
          See Also:
        • id
          String id
          Keyword ID. Consists of: groupid + orderid, orderid begins with a ".".
        • raw
          boolean raw
          The function cookKeyword() must be called for this keyword in order to use it for an index property. This is because it contains placeholders that must be substituted or one of the parent keywords should be added.
          See Also:
        • text
          String text
          Keyword text. This term is assigned to an index property. The member raw should be checked before this term is used. This text can be translated into reps. from the users language: set SessionOptionsC.TRANSLATE_TERM.
          See Also:
        • textTranslationKey
          String textTranslationKey
          Translation key for text.
          Since:
          21.03.000.011
    • Class de.elo.ix.client.KeywordC

      class KeywordC extends Object implements Serializable
      serialVersionUID:
      1338796818L
      • Serialized Fields

        • lnId
          int lnId
          Maximum length of keyword ID.
        • lnRootId
          int lnRootId
          Maximum length of a root keyword ID. If a new keyword list is checked in, the ID of the root keyword must not exceed this length.
        • lnText
          int lnText
          Maximum length of keyword text.
    • Class de.elo.ix.client.KeywordList

      class KeywordList extends ValueClass implements Serializable
      serialVersionUID:
      1495731174L
      • Serialized Fields

        • children
          Keyword[] children
          The keyword list entries.
        • deleted
          boolean deleted
          RESERVED
        • displayName
          String displayName
          The display name of the keyword. This value is displayed in the label before the edit field. It can be translated into reps. from the users language: set SessionOptionsC.TRANSLATE_TERM.
          Since:
          21.03.000.011
          See Also:
        • guid
          String guid
          GUID
        • id
          String id
          ID
        • lockId
          int lockId
          ID of the user who holds a lock on the keyword list.
          Since:
          8.00.010.004
        • nameTranslationKey
          String nameTranslationKey
          Translation-keyword for KeywordList.displayName.
          Since:
          21.03.000.002
        • packageName
          String packageName
          Package name of KeywordList
          Since:
          20.00.000.009
        • tStamp
          String tStamp
          Last modified, ISO - UTC Read-only.
        • TStampSync
          String TStampSync
          Timestamp of this object's last export by the replication.
          Since:
          9.99.009.001
        • userId
          int userId
          ID of the user that has written the keyword list at last. Read-only.
        • userName
          String userName
          Name of the user that has written the keyword list at last. Read-only.
    • Class de.elo.ix.client.KeywordListC

      class KeywordListC extends Object implements Serializable
      serialVersionUID:
      1333073168L
      • Serialized Fields

        • lnDisplayName
          int lnDisplayName
          Column length: The display name of the keyword. This value is displayed in the label before the edit field. It DB column: swldisplayname
          Since:
          21.03.000.011
        • lnGuid
          int lnGuid
          Column length: GUID DB column: swlguid
        • lnId
          int lnId
          Column length: ID DB column: swlgroupid
        • lnNameTranslationKey
          int lnNameTranslationKey
          Column length: Translation-keyword for KeywordList.displayName. DB column: swlnametrkey
          Since:
          21.03.000.002
        • lnPackageName
          int lnPackageName
          Column length: Package name of KeywordList DB column: packagename
          Since:
          20.00.000.009
        • lnTStamp
          int lnTStamp
          Column length: Last modified, ISO - UTC Read-only. DB column: swltstamp
        • lnTStampSync
          int lnTStampSync
          Column length: Timestamp of this object's last export by the replication. DB column: swltstampsync
          Since:
          9.99.009.001
    • Class de.elo.ix.client.KeywordsDynamicInfo

      class KeywordsDynamicInfo extends ValueClass implements Serializable
      serialVersionUID:
      2008405893L
      • Serialized Fields

        • aspectAssocFocus
          AspectAssoc aspectAssocFocus

          Only for sords with data organization based on aspects. At the client, set this value to the aspect association being currently in focus. This value determines (together with field aspectLineFocus) the server script to be executed. The server only reads the members aspectId and name and determines the mask this aspect association is contained in. For the server-side processing necessary residual values are read from the database.

          The focused aspect association is passed to the script to execute. Ignoring this value in the script is a valid use case.

          Since:
          21.00.000.004
        • aspectLineFocus
          AspectLine aspectLineFocus

          Only for sords with data organization based on aspects. At the client, set this value to the aspect line being currently in focus. This value determines (together with field aspectAssocFocus) the server script to be executed. The server only reads the members aspectId and key. For the server-side processing necessary residual values are read from the database.

          The focused aspect line is passed to the script to execute. Ignoring this value in the script is a valid use case.

          Since:
          21.00.000.004
        • mapData
          Map<String,String> mapData
          Represents the input data of a form.

          The script to execute uses the values in this map to filter the resulting data set.

          Since:
          9.00.014.011
          See Also:
        • mapLineFocus
          String mapLineFocus
          Represents the id of a field in a form.
          Since:
          9.00.014.011
          See Also:
        • mapScriptName
          String mapScriptName
          Determines the script to execute.

          This value has only an effect if sord and maskLineFocus are set to null. Setting this value requires to set the values mapLineFocus and mapData also.

          Since:
          9.00.014.011
        • maskLineFocus
          DocMaskLine maskLineFocus

          Only for sords with data organization based on objkeys. At the client, set this value to the mask line that currently has the focus. This value determines the server script to be executed. The server only reads the members maskId and id. For the server-side processing necessary residual values are read from the database.

          The focused mask line is passed to the script to execute. Ignoring this value in the script is a valid use case.

        • ordinalFocus
          int ordinalFocus

          Only for sords with data organization based on aspects. If aspectAssocFocus has a cardinality of Cardinality.MANDATORY_MANY or Cardinality.OPTIONAL_MANY, this value can optionally be given to set the focus to a particular number within the aspectObjects regarding to the index within the sords aspectObjectArray of the given aspect association.

          If this value is positive or equals to zero, this value is passed to the script to execute. Ignoring this value in the script is a valid use case. This value defaults to -1 which means "no focus on a particular number".

          Since:
          21.00.000.004
        • sord
          Sord sord

          This value contains data gathered by the client. The contents of sord will be given to the script to execute.

    • Class de.elo.ix.client.KeywordsDynamicResult

      class KeywordsDynamicResult extends ValueClass implements Serializable
      serialVersionUID:
      926568139725169535L
      • Serialized Fields

        • columnProperties
          List<Map<String,String>> columnProperties

          List of column properties. The size of this list equals to header. If the value at position i is null, the client will use a default value for the properties of column i.

          Since:
          9.00.016.018
        • header
          List<String> header

          This list contains the column descriptions to be displayed as the header of the table at the client. The size of this list matches the amount of columns in table. The value at index i represents the column description of the column i. The first column index is 0. Columns without a header value must be represented by an empty or undefined string.

        • keyNames
          List<String> keyNames

          List of key names. The size of this list equals to header. In this list, columns without a key name are represented by null or an empty String.

        • message
          String message

          The executed script may provide additional informations to the client such as "Please fill field XYZ". Such informations are stored in the value message. The script has to provide the translation to the client's language.

        • moreResults
          boolean moreResults

          Is true if there are more results.

        • table
          List<List<String>> table

          This value contains the result set as a table. Each entry of the outer list represents a row in the table. Thus, the entry i of an inner list represents the value of the i. column of the actual row. The length of each inner list is identical to the total amount of columns. Entries without a value are represented by an empty string.

        • title
          String title

          A brief and succinctly description about the represented data. The script developer must provide a title, otherwise an exception is thrown.

          Since:
          9.00.000.010
    • Class de.elo.ix.client.KeywordZ

      class KeywordZ extends ValueClass implements Serializable
      serialVersionUID:
      450335637L
      • Serialized Fields

        • bset
          long bset
          Bitset field for constants from KeywordC class.
    • Class de.elo.ix.client.License

      class License extends ValueClass implements Serializable
      serialVersionUID:
      1330120264L
      • Serialized Fields

        • backup
          boolean backup
          Backup enabled.
        • cold
          boolean cold
          COLD
        • demoVersion
          boolean demoVersion
          Demo version.
        • dispatchFolder
          boolean dispatchFolder
          Dispatch folder (Versendemappe)
        • domea
          boolean domea
          DOMEA
        • emailOnly
          boolean emailOnly
          EMail
        • features
          int[] features
          Binary coded license information
        • fultext
          boolean fultext
          Fulltext enabled.
        • httpServer
          boolean httpServer
          HTTP DocServer
        • indexServer
          boolean indexServer
          Indexserver
        • licenseFileContent
          String licenseFileContent
          License file content.
          Since:
          12.00.000.038
        • licenseOptions
          Map<String,String> licenseOptions
          License options as name-value pairs.
          Since:
          12.00.000.038
        • licenseValid
          boolean licenseValid
          True, if license is valid.
          Since:
          12.00.000.038
        • limitedIg
          boolean limitedIg
          Limited Internet Gateway
        • limitedVersion
          boolean limitedVersion
          Limited version.
        • nbOfFulltextLangs
          int nbOfFulltextLangs
          Number of languages for which linguistic processing can be used during fulltext indexing.
          Since:
          8.00.024.001
        • nbOfIgLicenses
          int nbOfIgLicenses
          Number of ELO Internet Gateway users.
        • nbOfServerLicenses
          int nbOfServerLicenses
          Number of server licenses.
        • professional
          boolean professional
          True for ELOprofessional
        • publicLicenseKey
          String publicLicenseKey
          Public part of key pair supplied for license download.
          Since:
          21.03.000.016
        • replication
          boolean replication
          Replication enabled.
        • sapALink
          boolean sapALink
          SAPALINK interface
        • serno
          String serno
          License key.
        • signature
          boolean signature
          SIGNATURE
        • stack
          boolean stack
          STACK
        • tobid
          boolean tobid
          Tobit
        • validityDate
          Date validityDate
          License is valid until this date. This valid is null if the license does not expire.
          Since:
          12.00.000.038
        • xmlImport
          boolean xmlImport
          XML-Import
    • Class de.elo.ix.client.LicenseInfo

      class LicenseInfo extends ValueClass implements Serializable
      serialVersionUID:
      -963420085124837666L
      • Serialized Fields

        • customerName
          String customerName
          Customer name.
        • licenseKey
          String licenseKey
          License key.
        • moduleName
          String moduleName
          Module name.
    • Class de.elo.ix.client.LicenseResult

      class LicenseResult extends ValueClass implements Serializable
      serialVersionUID:
      8594301554231204611L
    • Class de.elo.ix.client.LinkSordC

      class LinkSordC extends Object implements Serializable
      serialVersionUID:
      4981037L
    • Class de.elo.ix.client.LinkSordInfo

      class LinkSordInfo extends Object implements Serializable
      serialVersionUID:
      8690734834459924255L
      • Serialized Fields

        • linkPermanent
          boolean linkPermanent
          If true, Sords will be linked permanently. The new links between the provided Sords cannot be deleted.
    • Class de.elo.ix.client.LinkSordZ

      class LinkSordZ extends ValueClass implements Serializable
      serialVersionUID:
      1473512051L
      • Serialized Fields

        • bset
          long bset
          Bitset field for constants from the LinkSordC class.
    • Class de.elo.ix.client.LockC

      class LockC extends Object implements Serializable
      serialVersionUID:
      837669511L
    • Class de.elo.ix.client.LockZ

      class LockZ extends ValueClass implements Serializable
      serialVersionUID:
      1407753312L
      • Serialized Fields

        • bset
          long bset
          Bitset field for constants from the LockC class.
    • Class de.elo.ix.client.LoginResult

      class LoginResult extends ValueClass implements Serializable
      serialVersionUID:
      777531606L
      • Serialized Fields

        • activeSubstitutions
          List<Substitution> activeSubstitutions
          The current user's active substitution rules. This list contains substitution rules where the user substitutes someone as well as those where the user is substituted by someone.
          Since:
          20.00.000.008
        • clientInfo
          ClientInfo clientInfo

          ClientInfo object returned by the IX when the login is carried out. Contains information about the client settings.

        • ticketLifetime
          int ticketLifetime

          Contains the lifetime of the ticket in seconds. The connection is terminated once this lifetime has expired.

        • user
          UserInfo user

          Contains the data detailling the user used to login to the IX.

    • Class de.elo.ix.client.LoginScriptOptions

      class LoginScriptOptions extends ValueClass implements Serializable
      serialVersionUID:
      1074954672761146963L
      • Serialized Fields

        • clientName
          String clientName
          Unified Name for the client application. The value of this field must be one value of {LoginScriptOptionsC.CLIENT_NAME_*}.
        • techUser
          String techUser
          User name used for authentication. This member is only valid for run-as logins. It contains the name of the technical user used for authentication.
          Since:
          10.17.059.004
    • Class de.elo.ix.client.LoginScriptOptionsC

      class LoginScriptOptionsC extends Object implements Serializable
      serialVersionUID:
      1002222217L
    • Class de.elo.ix.client.MapData

      class MapData extends ValueClass implements Serializable
      serialVersionUID:
      2011132580L
      • Serialized Fields

        • domainName
          String domainName
          Map domain name. An arbitary name or one of the predefined names in MapDomainC.
          See Also:
        • guid
          String guid
          GUID
          Since:
          8.00.024.002
        • id
          String id
          Map ID. If the map belongs to a Sord ID, this value is equal to the member objId.
          See Also:
        • items
          KeyValue[] items
          Map items. Since stream version 10.00.020.007, the items of this array can be cased to MapValue, in order to access BLOB data.
          See Also:
        • lockId
          int lockId
          User ID of the user that owns the lock on the map. If the map is not locked, this value is -1.
        • lockName
          String lockName
          User name of the user that owns the lock no the map. If the map is not locked, this value is an empty string.
        • mapItems
          Map<String,MapValue> mapItems
          Map items represented by class MapValue which gives access to BLOB values.
          Since:
          10.00.020.007
          See Also:
        • objId
          int objId
          Object ID. The ID of the associated Sord object or 0, if the map does not belong to a Sord object.
          See Also:
        • TStamp
          String TStamp
          Timestamp
        • TStampSync
          String TStampSync
          EIX-3097 TimestampSync
          Since:
          21.3.0.15
    • Class de.elo.ix.client.MapDataC

      class MapDataC extends Object implements Serializable
      serialVersionUID:
      6093548014266150741L
      • Serialized Fields

        • lnBlob
          int lnBlob
          Maximum length of blob value. 1048576 Bytes
          Since:
          10.00.020.007
        • lnId
          int lnId
          Maximum length of map id.
        • lnKey
          int lnKey
          Maximum length of map item key.
        • lnValue
          int lnValue
          Maximum length of map item value.
    • Class de.elo.ix.client.MapDomain

      class MapDomain extends ValueClass implements Serializable
      serialVersionUID:
      42339713L
      • Serialized Fields

        • copy
          boolean copy
          This value is true, if the map items should be copied when the associated Sord object is copied.
        • history
          boolean history
          This value is true, if a history should be maintained for map items. A history is always available for MapDomainC.DOMAIN_SORD and MapDomainC.DOMAIN_WORKFLOW_ACTIVE.
          Since:
          8.00.024.002
          See Also:
        • name
          String name
          Map domain name. This can be a user definined name or one of the predefined names in MapDomainC. The value is internally used as part of a database table name. Thus only alphanumeric characters are allowed.
          See Also:
        • replicate
          boolean replicate
          This value is true, if the map items should be replicated with the associated Sord object.
    • Class de.elo.ix.client.MapDomainC

      class MapDomainC extends MapDomainDataC implements Serializable
      serialVersionUID:
      47433043L
    • Class de.elo.ix.client.MapDomainDataC

      class MapDomainDataC extends Object implements Serializable
      serialVersionUID:
      915355095L
      • Serialized Fields

        • lnName
          int lnName
          DB column: mapdname
    • Class de.elo.ix.client.MapHead

      class MapHead extends ValueClass implements Serializable
      serialVersionUID:
      1379783697L
      • Serialized Fields

        • guid
          String guid
          GUID.
          Since:
          7.00.040.013
        • id
          String id
          Map id.
        • lockId
          int lockId
          Lock status. -1: unlocked, >=0 user-ID.
        • objId
          int objId
          Associated object ID or 0.
        • TStamp
          String TStamp
          Timestamp.
        • TStampSync
          String TStampSync
          EIX-3097: TimeStampSync
          Since:
          21.3.0.15
    • Class de.elo.ix.client.MapHeadC

      class MapHeadC extends Object implements Serializable
      serialVersionUID:
      812078539L
      • Serialized Fields

        • lnGuid
          int lnGuid
          DB column: mapguid
        • lnId
          int lnId
          DB column: mapid
        • lnTStamp
          int lnTStamp
          DB column: maptstamp
        • lnTStampSync
          int lnTStampSync
          Column length: EIX-3097: TimeStampSync DB column: maptstampsync
          Since:
          21.3.0.15
    • Class de.elo.ix.client.MapHist

      class MapHist extends ValueClass implements Serializable
      serialVersionUID:
      303505086L
      • Serialized Fields

        • histGuid
          String histGuid
          GUID of the SordHist object.
        • histItems
          MapHistItem[] histItems
          An array of the keywording changes.
        • histSource
          int histSource
          Identifies the application with which changes were made to the keywording.
        • mapGuid
          String mapGuid
          GUID of the map object.
        • mapId
          String mapId
          ID of the map object.
        • timeStampLocal
          String timeStampLocal
          Timestamp of the change in the timezone of the client. The format is JJJJ.MM.DD.hh.mm.ss
        • timeStampUTC
          String timeStampUTC
          Timestamp of the change in the timezone of the client, in UTC form. The format is JJJJ.MM.DD.hh.mm.ss
        • userId
          int userId
          The user who carried out the changes.
        • userName
          String userName
          The name of the user who carried out the changes.
        • workStation
          String workStation
          The name of the computer from which the change was carried out. This is the parameter clientComputer which is provided by the ix.login function.
    • Class de.elo.ix.client.MapHistC

      class MapHistC extends MapHistHeadC implements Serializable
      serialVersionUID:
      379654790L
    • Class de.elo.ix.client.MapHistHeadC

      class MapHistHeadC extends Object implements Serializable
      serialVersionUID:
      812099209L
      • Serialized Fields

        • lnHistGuid
          int lnHistGuid
          Column length: Serialisation version ID DB column: maphistguid
        • lnMapGuid
          int lnMapGuid
          DB column: mapguid
        • lnTimeStampLocal
          int lnTimeStampLocal
          DB column: maphistlocts
        • lnTimeStampUTC
          int lnTimeStampUTC
          DB column: maphistts
        • lnUserName
          int lnUserName
          DB column: mapusername
        • lnWorkStation
          int lnWorkStation
          DB column: maphistwks
    • Class de.elo.ix.client.MapHistItem

      class MapHistItem extends ValueClass implements Serializable
      serialVersionUID:
      342049067L
      • Serialized Fields

        • blobValue
          FileData blobValue
          BLOB value.
          Since:
          10.00.020.011
        • histGuid
          String histGuid
          GUID of the assigned SordHist object.
        • key
          String key
          Map key.
        • value
          String value
          Map value. An empty value means, that the map item has been deleted.
    • Class de.elo.ix.client.MapHistItemC

      class MapHistItemC extends Object implements Serializable
      serialVersionUID:
      1314989638L
      • Serialized Fields

        • lnBlobData
          int lnBlobData
          DB column: mapblob
          Since:
          10.00.020.011
        • lnContentType
          int lnContentType
          DB column: mapcontenttype
          Since:
          10.00.020.011
        • lnHistGuid
          int lnHistGuid
          Column length: Serialisation version ID DB column: maphistguid
        • lnKey
          int lnKey
          DB column: mapkey
        • lnValue
          int lnValue
          DB column: mapvalue
    • Class de.elo.ix.client.MapHistZ

      class MapHistZ extends ValueClass implements Serializable
      serialVersionUID:
      1505340976L
      • Serialized Fields

        • bset
          long bset
    • Class de.elo.ix.client.MapItem

      class MapItem extends ValueClass implements Serializable
      serialVersionUID:
      1461301521L
      • Serialized Fields

        • blobData
          InputStream blobData
          Blob data.
          Since:
          10.00.020.005
        • contentType
          String contentType
          Content Type.
        • id
          String id
          Map id.
        • key
          String key
          Map key.
        • value
          String value
          Map value.
    • Class de.elo.ix.client.MapItemC

      class MapItemC extends Object implements Serializable
      serialVersionUID:
      812006040L
      • Serialized Fields

        • lnBlobData
          int lnBlobData
          Column length: Blob data. DB column: mapblob
          Since:
          10.00.020.005
        • lnContentType
          int lnContentType
          Column length: Content Type. DB column: mapcontenttype
        • lnId
          int lnId
          DB column: mapid
        • lnKey
          int lnKey
          DB column: mapkey
        • lnValue
          int lnValue
          DB column: mapvalue
    • Class de.elo.ix.client.MapValue

      class MapValue extends KeyValue implements Serializable
      serialVersionUID:
      5276979961974415978L
      • Serialized Fields

        • blobValue
          FileData blobValue
          BLOB value.
    • Class de.elo.ix.client.MaskName

      class MaskName extends ValueClass implements Serializable
      serialVersionUID:
      458953805L
      • Serialized Fields

        • access
          int access
          Access mode for the current user. A combination of AccessC.LUR_* constants.
          Since:
          7.00.000.042
          See Also:
        • barcodeMask
          boolean barcodeMask
          Mask has a barcode definition.
          Since:
          8.00.036.001
        • dataOrganisation
          int dataOrganisation
          This member specifies how the index values are stored in database.
          Since:
          21.00.000.014
          See Also:
        • displayName
          String displayName
          Translated name of this mask. This value is read-only and therefore ignored when changed and checked-in. Furthermore, the Indexserver always translates this value into the client language regardless whether the translation settings is enabled or not.
          Since:
          21.01.000.000
        • documentMask
          boolean documentMask
          Mask can be used as storage mask for indexing.
        • folderMask
          boolean folderMask
          Mask can be used as storage mask for folders.
          Since:
          7.00.000.000
        • guid
          String guid
          GUID
          Since:
          7.00.000.004
        • id
          int id
          Mask ID.
        • keywordingRelationAllowed
          boolean keywordingRelationAllowed
          Mask can be referenced from a DocMaskLine of type DocMaskLineC.TYPE_RELATION.
          If this mask has a data organisation DocMaskC.DATA_ORGANISATION_ASPECT the value determines if it can be referenced by an AspectLine of type AspectLineC.TYPE_RELATION.
          Since:
          21.02.000.015
          See Also:
        • name
          String name
          Mask name.
        • nameTranslationKey
          String nameTranslationKey
          Translation-keyword for MaskName.name.
          Since:
          9.00.022.007
        • packageName
          String packageName
          Package name.
          Since:
          21.00.000.023
        • region
          boolean region
          Sords of this mask establish a region within the repository tree.
          This flag is only valid for masks of data organisation DocMaskC.DATA_ORGANISATION_ASPECT.
          Since:
          21.04.000.003
        • searchMask
          boolean searchMask
          Mask can be used for searching.
    • Class de.elo.ix.client.MoveDocumentsInfo

      class MoveDocumentsInfo extends ValueClass implements Serializable
      serialVersionUID:
      -1685883070933203195L
      • Serialized Fields

        • endDate
          String endDate
          End date.
          Since:
          10.17.059.005
        • sourcePathId
          String sourcePathId
          ID of the source storage path.
        • startDate
          String startDate
          Start date.
          Since:
          10.17.059.005
        • targetPathId
          String targetPathId
          ID of the target storage path.
    • Class de.elo.ix.client.NavigationInfo

      class NavigationInfo extends ValueClass implements Serializable
      serialVersionUID:
      1953181452L
      • Serialized Fields

        • findInfo
          FindInfo findInfo
          Specify additional filters for the tree walk.

          Please note that specifying a custom findInfo always leads to a second search for each directory decreasing the overall performance. Use this only if processFindResult is not suitable.

          Then, not every feature is supported which findInfo offers. Firstly, the member findChildren will be overwritten during the tree walk. Secondly, as a fulltext or direct search respectively influence the search for children, they are unsupported also.

          Since:
          9.00.014.007
        • ignoreDocuments
          boolean ignoreDocuments
          ignore the navigation of documents
        • maxCount
          int maxCount
          maxCount is the overall maximum amount of visited nodes and is independent of successful processing. maxCount does not depend on successful processing to be incremented, and it can stop the traversal before any of the other limits have been reached. Passing maxCount < 1 will turn off this limit.
        • maxDepth
          int maxDepth
          The maximum depth of the tree walk. Passing maxDepth < 1 turns off this limit.
        • maxSiblings
          int maxSiblings
          The maximum number of siblings for one tree level. This limit is most useful for ignoring the contents of large folders. Passing maxSiblings < 1 will turn the limit off.
        • startIDs
          String[] startIDs
          The starting points for the tree walk. Interdepending nodes will only be traversed once. Providing null causes an invalid parameter exception, while unresolvable IDs or GUIDs will simply be ignored.
    • Class de.elo.ix.client.NavigationInfoC

      class NavigationInfoC extends Object implements Serializable
      serialVersionUID:
      1520348158L
    • Class de.elo.ix.client.Note

      class Note extends ValueClass implements Serializable
      serialVersionUID:
      937420667L
      • Serialized Fields

        • access
          int access
          Access rights for the current user. Read-only.
          Since:
          7.00.000.026
        • acl
          String acl
          Access control list. Only used for notes of type TYPE_ANNOTATION_MARKER. Set member aclItems=null on check in otherwise it is ignored.
        • aclItems
          AclItem[] aclItems
          Access control list as item array. Only used for notes of type TYPE_ANNOTATION_MARKER. If this member is not null, member acl is ignored on check in.
        • color
          int color
          RGB value. Undefined for notes of type TYPE_ANNOTATION_STAMP and TYPE_ANNOTATION_NOTE_WITHFONT.
          Since:
          6.00.087
          See Also:
        • createDateIso
          String createDateIso
          ISO encoded external (user defined) date.
        • deleted
          boolean deleted
          True if the note is deleted, otherwise false.
        • deleteDateIso
          String deleteDateIso
          The Note is deleted at this date. ClientInfo determines the Timezone.

          Is undefined if isDeleted() returns false.

          Since:
          9.00.000.000
        • desc
          String desc
          The text for the note.
          See Also:
        • guid
          String guid
          The GUID for the note.
        • height
          int height
          The height of the note (y axis), when displayed on a document in ELO.
          See Also:
        • id
          int id
          The unique id for the note.
        • lockId
          int lockId
          The ID of the user that holds the lock or -1, if the note is not locked.
        • lockName
          String lockName
          The user name that holds the lock or an empty string if the note is not locked.
        • noteFreehand
          NoteFreehand noteFreehand
          Point information for a freehand line. Valid only for notes of type TYPE_ANNOTATION_FREEHAND and TYPE_ANNOTATION_HORIZONTAL_LINE. Either desc, noteText, noteImage or noteFreehand can be set.
          Since:
          7.00.000.023
          See Also:
        • noteImage
          NoteImage noteImage
          Additional information for image stamps. Valid only for notes of type TYPE_ANNOTATION_STAMP. Either desc, noteText, noteImage or noteFreehand can be set.
          Since:
          7.00.000.023
          See Also:
        • noteText
          NoteText noteText
          Additional information for textual stamps. Valid only for notes of type TYPE_ANNOTATION_NOTE, TYPE_ANNOTATION_STAMP and TYPE_ANNOTATION_NOTE_WITHFONT. Either desc, noteText, noteImage or noteFreehand can be set.
          Since:
          7.00.000.023
          See Also:
        • objId
          String objId
          Object ID of the associated Sord object or any of the ID specifiers that are valid for checkoutSord too. Functions createNote and checkoutNotes return only numerical object IDs.
        • ownerId
          int ownerId
          The ID of the user who created the note. Administrators can set the ownerId to an arbitary user ID in checkinNotes. Set ownerName="" in this case.
        • ownerName
          String ownerName
          The name of the user that has created the note. Administrators can set the ownerName to an arbitary user name in checkinNotes. Set ownerId=-1 in this case.
        • pageNo
          int pageNo
          The page number to which the note is attached.
        • TStamp
          String TStamp
          Timestamp of the last change to the note. The format is JJJJ.MM.DD.hh.mm.ss
        • TStampSync
          String TStampSync
          Timestamp of this object's last export by the replication.
          Since:
          9.99.009.001
        • type
          int type
          The note type.
          See Also:
        • width
          int width
          Width ( x axis) of the note when displayed on a document in ELO.
          See Also:
        • XPos
          int XPos
          The position in the x axis when the note is displayed on a document in ELO. Taken from the top left corner of the document.

          For NoteC.TYPE_ANNOTATION_FREEHAND and NoteC.TYPE_ANNOTATION_HORIZONTAL_LINE the values XPos, YPos, Width, Height describe the enveloping rectangle of the line including the line width. This values are computed by the Indexserver if the note is stored.

        • YPos
          int YPos
          The position in the Y axis when the note is displayed on a document in ELO. Taken from the top left corner of the document.
          See Also:
    • Class de.elo.ix.client.NoteC

      class NoteC extends NoteDataC implements Serializable
      serialVersionUID:
      1319955249L
    • Class de.elo.ix.client.NoteDataC

      class NoteDataC extends Object implements Serializable
      serialVersionUID:
      1521483547L
      • Serialized Fields

        • lnAcl
          int lnAcl
          DB column: noteacl
        • lnDesc
          int lnDesc
          DB column: pidesc
        • lnGuid
          int lnGuid
          DB column: noteguid
        • lnTStamp
          int lnTStamp
          DB column: notetstamp
        • lnTStampSync
          int lnTStampSync
          Column length: Timestamp of this object's last export by the replication. DB column: notetstampsync
          Since:
          9.99.009.001
    • Class de.elo.ix.client.NoteFreehand

      class NoteFreehand extends Object implements Serializable
      serialVersionUID:
      611837980L
      • Serialized Fields

        • points
          PointInfo[] points
          Points.
          See Also:
        • strikeoutColor
          int strikeoutColor
          Color for strikeout pen (only TYPE_ANNOTATION_STRIKEOUT).
          Since:
          7.00.000.039
        • strikeoutWidth
          int strikeoutWidth
          Line width for strikeout pen (only TYPE_ANNOTATION_STRIKEOUT).
          Since:
          7.00.000.039
        • width
          int width
          Line width.
    • Class de.elo.ix.client.NoteFreehandC

      class NoteFreehandC extends Object implements Serializable
      serialVersionUID:
      1034219603L
    • Class de.elo.ix.client.NoteImage

      class NoteImage extends Object implements Serializable
      serialVersionUID:
      1753613701L
      • Serialized Fields

        • fileData
          FileData fileData
          Image file content. Read only.
        • fileName
          String fileName
          Image file name.
    • Class de.elo.ix.client.NoteTemplate

      class NoteTemplate extends ValueClass implements Serializable
      serialVersionUID:
      1995912373L
      • Serialized Fields

        • acl
          String acl
          ACL. Member aclItems has preceedence on checkin.
          Since:
          7.00.000.040
          See Also:
        • aclItems
          AclItem[] aclItems
          ACL as an array of AclItem objects.
          Since:
          7.00.000.040
          See Also:
        • id
          int id
          Stamp ID.
        • name
          String name
          Stamp name.
        • noteImage
          NoteImage noteImage
          Image information, if this is stamp is an image. Either noteText or noteImage can be set.
          See Also:
        • noteText
          NoteText noteText
          Text information, if this is a textual stamp. The text information can contain the placeholders defined in NoteTemplateC. Either noteText or noteImage can be set. class NoteTemplateC
          See Also:
        • userId
          String userId
          User ID or name. NoteTemplate objects can be defined for all users and for a specific user.
          See Also:
    • Class de.elo.ix.client.NoteTemplateC

      class NoteTemplateC extends Object implements Serializable
      serialVersionUID:
      240897408L
      • Serialized Fields

        • lnName
          int lnName
          Length of note template name.
          See Also:
        • lnText
          int lnText
          Length of text in class NoteText.
          See Also:
    • Class de.elo.ix.client.NoteTemplateDataC

      class NoteTemplateDataC extends Object implements Serializable
      serialVersionUID:
      1775437403L
      • Serialized Fields

        • lnOptKey
          int lnOptKey
          DB column: optkey
        • lnOptValue
          int lnOptValue
          DB column: optvalue
    • Class de.elo.ix.client.NoteTemplateZ

      class NoteTemplateZ extends Object implements Serializable
      serialVersionUID:
      1483878971L
      • Serialized Fields

        • bset
          long bset
    • Class de.elo.ix.client.NoteText

      class NoteText extends Object implements Serializable
      serialVersionUID:
      669464920L
    • Class de.elo.ix.client.NoteZ

      class NoteZ extends ValueClass implements Serializable
      serialVersionUID:
      2137405429L
      • Serialized Fields

        • bset
          long bset
          Bitset field for constants from the NoteC class.
    • Class de.elo.ix.client.Notification

      class Notification extends ValueClass implements Serializable
      serialVersionUID:
      -5984788378871453677L
      • Serialized Fields

        • createDateIso
          String createDateIso
          Create date of the notification.
        • prio
          int prio
          Indicates if the Notification is marked as important
          Since:
          9.00.022.003
        • userGuid
          String userGuid
          GUID of user who should receive this notification.
        • watchGuid
          String watchGuid
          GUID of changed Object.
        • what
          int what
          Indicates the type of the watched Element. 0 - Action. 1 - HashTag.
          Since:
          9.00.030.001
    • Class de.elo.ix.client.NotificationC

      class NotificationC extends NotificationDataC implements Serializable
      serialVersionUID:
      -1371664447766726861L
    • Class de.elo.ix.client.NotificationDataC

      class NotificationDataC extends Object implements Serializable
      serialVersionUID:
      2010056196L
      • Serialized Fields

        • lnCreateDateIso
          int lnCreateDateIso
          Column length: Create date of the notification. DB column: createdateiso
        • lnUserGuid
          int lnUserGuid
          Column length: GUID of user who should receive this notification. DB column: userguid
        • lnWatchGuid
          int lnWatchGuid
          Column length: GUID of changed Object. DB column: watchguid
    • Class de.elo.ix.client.NotificationZ

      class NotificationZ extends ValueClass implements Serializable
      serialVersionUID:
      -6771325712888579913L
      • Serialized Fields

        • bset
          long bset
          Bitset field for constants from the NotificationC class.
    • Class de.elo.ix.client.NotifyServerInfo

      class NotifyServerInfo extends ValueClass implements Serializable
      serialVersionUID:
      539899885L
      • Serialized Fields

        • ocrCount
          int ocrCount
          The number of documents for which OCR was processed.
        • reserved
          String reserved
          Reserved for internal usage. EIX-2770
          Since:
          21.02.000.010
        • scanCount
          int scanCount
          The number of scanned documents.
    • Class de.elo.ix.client.NotifyServerResult

      class NotifyServerResult extends ValueClass implements Serializable
      serialVersionUID:
      810727301L
    • Class de.elo.ix.client.ObjChange

      class ObjChange extends ValueClass implements Serializable
      serialVersionUID:
      753146L
      • Serialized Fields

        • code
          int code
          DB column: chgcode
        • objId
          String objId
          DB column: chgobjid
        • param
          int param
          DB column: chgparam
        • param2
          String param2
          DB column: chgparam2
        • tStamp
          String tStamp
          DB column: chgtstamp
        • user
          int user
          DB column: chguser
    • Class de.elo.ix.client.ObjChangeC

      class ObjChangeC extends Object implements Serializable
      serialVersionUID:
      1100272528L
      • Serialized Fields

        • lnObjId
          int lnObjId
          DB column: chgobjid
        • lnParam2
          int lnParam2
          DB column: chgparam2
        • lnTStamp
          int lnTStamp
          DB column: chgtstamp
    • Class de.elo.ix.client.ObjDataC

      class ObjDataC extends Object implements Serializable
      serialVersionUID:
      1521332903L
      • Serialized Fields

        • lnAcl
          int lnAcl
          DB column: objacl
        • lnGuid
          int lnGuid
          DB column: objguid
        • lnInternalDesc
          int lnInternalDesc
          DB column: objdesc
        • lnName
          int lnName
          DB column: objshort
        • lnPackageName
          int lnPackageName
          Column length: Package name of sord DB column: packagename
          Since:
          21.03.000.013
        • lnSDesc
          int lnSDesc
          DB column: objsdesc_off
        • lnSName
          int lnSName
          DB column: objsdata_off
        • lnSpaceGuid
          int lnSpaceGuid
          Column length: If the sord belongs to a workspace, this value contains the GUID of that workspace. DB column: spaceguid
          Since:
          21.00.000.003
        • lnSReg
          int lnSReg
          DB column: objsreg
        • lnTStamp
          int lnTStamp
          DB column: objtstamp
        • lnTStampAcl
          int lnTStampAcl
          Column length: Timestamp of the last ACL change. The format is JJJJ.MM.DD.hh.mm.ss DB column: objtstampacl
          Since:
          9.99.009.001
        • lnTStampAclSync
          int lnTStampAclSync
          Column length: Timestamp of this object's ACLs last export by the replication. DB column: objtstampaclsync
          Since:
          9.99.009.001
        • lnTStampLocal
          int lnTStampLocal
          Column length: Timestamp that indicates the next iSearch Index run The format is JJJJ.MM.DD.hh.mm.ss DB column: objtstamplocal
          Since:
          21.02.000.004
        • lnTStampSync
          int lnTStampSync
          Column length: Timestamp of this object's last export by the replication. DB column: objtstampsync
          Since:
          9.99.009.001
    • Class de.elo.ix.client.ObjHistC

      class ObjHistC extends Object implements Serializable
      serialVersionUID:
      1015803641L
      • Serialized Fields

        • lnHistGuid
          int lnHistGuid
          Column length: Serialisation version ID DB column: objhistguid
        • lnObjGuid
          int lnObjGuid
          DB column: objguid
        • lnTimeStampLocal
          int lnTimeStampLocal
          DB column: objhistlocts
        • lnTimeStampUTC
          int lnTimeStampUTC
          DB column: objhistts
        • lnUserName
          int lnUserName
          DB column: username
        • lnWorkStation
          int lnWorkStation
          DB column: objhistwks
    • Class de.elo.ix.client.ObjHistKeyC

      class ObjHistKeyC extends Object implements Serializable
      serialVersionUID:
      1013854536L
      • Serialized Fields

        • lnHistGuid
          int lnHistGuid
          Column length: Serialisation version ID DB column: objhistguid
        • lnKeyData
          int lnKeyData
          DB column: okeydata
        • lnKeyDataDesc
          int lnKeyDataDesc
          Column length: Internal helper column for memo text. DB column: objdesc
          Since:
          7.00.000.018
        • lnKeyName
          int lnKeyName
          DB column: okeyname
    • Class de.elo.ix.client.ObjKey

      class ObjKey extends ValueClass implements Serializable
      serialVersionUID:
      237417996L
      • Serialized Fields

        • data
          String[] data
          Data array. The values can be translated into resp. from the system language, if SessionOptionsC.TRANSLATE_TERMS is set and the corresponding DocMaskLine has set the property translate.
          See Also:
        • displayData
          String[] displayData
          Human readable representation of ObjKey.data. This member is read-only and might not be set in server-side events. For index lines of type DocMaskLineC.TYPE_RELATION, this member contains the Sord.name of the referenced Sord.
          Since:
          12.00.000.023
        • id
          int id
          ID of the index line
        • name
          String name
          The group name of the index line
        • objId
          int objId
          The ELO object ID this object belongs to
    • Class de.elo.ix.client.ObjKeyC

      class ObjKeyC extends ObjKeyDataC implements Serializable
      serialVersionUID:
      711473895L
    • Class de.elo.ix.client.ObjKeyData

      class ObjKeyData extends ValueClass implements Serializable
      serialVersionUID:
      1508164560L
      • Serialized Fields

        • data
          String data
          DB column: okeydata
        • id
          int id
          DB column: okeyno
        • name
          String name
          DB column: okeyname
        • objId
          int objId
          DB column: parentid
        • odouble
          double odouble
          DB column: odouble
          Since:
          9.00.000.021
        • sdata
          String sdata
          Deprecated.
          This member is ignored since 9.0
          DB column: okeysdata
        • udata
          String udata
          DB column: okeyudata
    • Class de.elo.ix.client.ObjKeyDataC

      class ObjKeyDataC extends Object implements Serializable
      serialVersionUID:
      2463451L
      • Serialized Fields

        • lnData
          int lnData
          DB column: okeydata
        • lnName
          int lnName
          DB column: okeyname
        • lnOdouble
          int lnOdouble
          Column length: DB column: odouble DB column: okeydouble
          Since:
          9.00.000.021
        • lnSdata
          int lnSdata
          DB column: okeysdata_off
        • lnUdata
          int lnUdata
          DB column: okeyudata
    • Class de.elo.ix.client.ObjLinkC

      class ObjLinkC extends Object implements Serializable
      serialVersionUID:
      1015668161L
      • Serialized Fields

        • lnId
          int lnId
          DB column: objguidtarget
        • lnLinkId
          int lnLinkId
          DB column: linkguid
        • lnParentId
          int lnParentId
          DB column: objguidparent
        • lnTStamp
          int lnTStamp
          DB column: linktstamp
    • Class de.elo.ix.client.OcrInfo

      class OcrInfo extends ValueClass implements Serializable
      serialVersionUID:
      1803060225L
      • Serialized Fields

        • busId
          long busId
          Return OCR result over this event bus. If the OCR request should be performed asynchronously, this value must contain the event bus ID on which the result event is sent. If this value is 0, the OCR request is performed synchronously.
        • eventId
          long eventId
          OCR result should be sent in an event with this event ID. This member helps to map the OCR request to the OCR result. Optional.
        • messagesLanguage
          int messagesLanguage
          Language of error messages produced by the OCR engine. One of the OcrInfoC.MESSAGES_LANGUAGE_ constants. Optional.
        • queryLanguages
          OcrInfoQueryLanguages queryLanguages
          This member is set in order to query the languages supported by the OCR engine. Optional.
        • recognizeFile
          OcrInfoRecognizeFile recognizeFile
          Recognize file information. Set this member in order to process OCR on a file or an archive document. Optional.
    • Class de.elo.ix.client.OcrInfoC

      class OcrInfoC extends Object implements Serializable
      serialVersionUID:
      1068350778L
    • Class de.elo.ix.client.OcrInfoQueryLanguages

      class OcrInfoQueryLanguages extends ValueClass implements Serializable
      serialVersionUID:
      648095775L
      • Serialized Fields

        • ctrl
          int ctrl
          Reserved.
    • Class de.elo.ix.client.OcrInfoRecognizeFile

      class OcrInfoRecognizeFile extends ValueClass implements Serializable
      serialVersionUID:
      701419851L
      • Serialized Fields

        • accuracy
          int accuracy
          Recognition accuracy. A value of 0 activates the fast mode, a value of 1 activates the exact mode.
        • encoding
          int encoding
          OcrInfoC.ENCODING_UTF8 / _UTF16 / _UTF16LE
          Since:
          10.17.080.003
        • imageData
          FileData imageData
          Image file content. Either imageData or objId must be set.
        • minCharConfidence
          int minCharConfidence
          Minimum confidence of character recognition in percent. Characters that are recognized with a lower confidence are replaced by OcrInfoRecognizeFile.replaceChar. Optional.
        • objId
          String objId
          Object ID of an archived document to be analyzed. Either imageData or objId must be set.
        • originalFileName
          String originalFileName
          Original Filename. allows tracking through the log files of the different modules.
          Since:
          11.00.000.058
        • outputFormat
          int outputFormat
        • pageNo
          int pageNo
          Page number. The first page number is 0. If all pages should be analyzed, set pageNo = -1.
        • pageNumbers
          int[] pageNumbers
          Array of page numbers which should be analysed by the OCR. The first page number is 0. The following constants can be used: OcrInfoC.ALL_PAGES, OcrInfoC.EVEN_PAGES, OcrInfoC.ODD_PAGES
          Since:
          9.00.030.027
        • pageTimeout
          int pageTimeout
          Recognition timeout for a single page. Cancel recognition if it least longer than this number of seconds. Optional.
          Since:
          9.00.030.028
        • pdfCompliance
          int pdfCompliance
          OcrInfoC.COMPLIANCE_PDFA_3U / _3A / _2U / _2A / _1B / _1A / _NONE
          Since:
          11.00.000.057
        • pdfQuality
          int pdfQuality
          OcrInfoC.PDF_QUALITY_MAXQUALITY / _BALANCED / _MINSIZE / _MAXSPEED
          Since:
          11.00.000.057
        • recognizeLangs
          String[] recognizeLangs
          The image data is of this language(s). The supported languages can be requested by a call to IXServicePortIF.processOcr(ClientInfo, OcrInfo). The OcrInfo parameter must have member OcrInfo.queryLanguages set. Use the internal languages returned in OcrResult.queryLanguages for this member. At least one language must be set. The String is case sensitive.
        • recognizeRects
          OcrRect[] recognizeRects
          Constrain recognition to this rectangles. Optional.
        • rectUnit
          int rectUnit
          Rectangle coordinates are based on this unit. Use on of the constants OcrInfoC.UNIT_*. Optional.
          See Also:
        • replaceChar
          int replaceChar
          Replacement for characters. Characters that are recognized with a lower confidence than OcrInfoRecognizeFile.minCharConfidence are replaced this character. Optional.
        • singleColumnMode
          boolean singleColumnMode
          Disable table recognition. Set this member to true, if the OCR should not try to recognized columns and rows of tables. Optional.
        • spaces
          int spaces
          OcrInfoC.NORMAL/TWOSPACES/EXACT
          Since:
          10.17.069.001
        • timeoutSeconds
          int timeoutSeconds
          Recognition timeout. Cancel recognition if it least longer than this number of seconds. Optional.
        • whitespace
          int whitespace
          OCR returns whitespace characters. Must be one of the following: OcrInfoC.WHITESPACE_DEFAULT, OcrInfoC.WHITESPACE_REPLACE
          Since:
          12.00.000.041
    • Class de.elo.ix.client.OcrRect

      class OcrRect extends ValueClass implements Serializable
      serialVersionUID:
      1044855049L
      • Serialized Fields

        • bottom
          int bottom
        • left
          int left
        • right
          int right
        • top
          int top
    • Class de.elo.ix.client.OcrResult

      class OcrResult extends ValueClass implements Serializable
      serialVersionUID:
      998509414L
      • Serialized Fields

        • eventId
          long eventId
          Event ID. The same value as submitted in OcrInfo.eventId.
        • exception
          String exception
          Error message. Null or empty, if no error has occurred. This value is used only in asynchronous processing in order to inform the client application, that an error has occured. In synchronous processing, the error is thrown as an exception.
        • exceptionID
          int exceptionID
          Error id. 0, if no error has occurred
          Since:
          9.00.040.004
        • queryLanguages
          OcrResultQueryLanguages queryLanguages
          Supported languages. This member is returned, if OcrInfo.queryLanguages was set.
        • recognizeFile
          OcrResultRecognizeFile recognizeFile
          Recognize file result. This member is returned, if OcrInfo.recognizeFile was set.
    • Class de.elo.ix.client.OcrResultQueryLanguages

      class OcrResultQueryLanguages extends ValueClass implements Serializable
      serialVersionUID:
      916614291L
      • Serialized Fields

        • externalLangs
          String[] externalLangs
        • internalLangs
          String[] internalLangs
    • Class de.elo.ix.client.OcrResultRecognizeFile

      class OcrResultRecognizeFile extends ValueClass implements Serializable
      serialVersionUID:
      1533562699L
    • Class de.elo.ix.client.OcrWorker

      class OcrWorker extends ValueClass implements Serializable
      serialVersionUID:
      730157667L
      • Serialized Fields

        • busId
          long busId
          The worker process listens on this bus ID for events of type EventBusC.EVENT_OCR_REQUEST.
        • lastUsed
          long lastUsed
          Reserved.
        • reserved
          long reserved
          Reserved.
          Since:
          10.17.010.006
        • state
          int state
          Worker state.
          See Also:
        • subsId
          long subsId
          The worker process is identified by this subscriber ID on the event bus.
    • Class de.elo.ix.client.OcrWorkerC

      class OcrWorkerC extends Object implements Serializable
      serialVersionUID:
      45899817L
    • Class de.elo.ix.client.OrgUnitInfo

      class OrgUnitInfo extends ValueClass implements Serializable
      serialVersionUID:
      413918850L
      • Serialized Fields

        • desc
          String desc
          OU description.
        • guid
          String guid
          GUID
        • id
          int id
          OU identifier
        • name
          String name
          OU name
        • ouProps
          String[] ouProps
          Additional OU properties Index this array with constants named PROP_* in class OrgUnitInfoC.
          See Also:
        • tStamp
          String tStamp
          Timestamp The format is JJJJ.MM.DD.hh.mm.ss
    • Class de.elo.ix.client.OrgUnitInfoC

      class OrgUnitInfoC extends Object implements Serializable
      serialVersionUID:
      864257789L
      • Serialized Fields

        • lnDesc
          int lnDesc
          Maximum OU desc length
        • lnName
          int lnName
          Maximum OU name length
        • lnOuProp
          int lnOuProp
          Maximum OU property length
    • Class de.elo.ix.client.OrgUnitName

      class OrgUnitName extends ValueClass implements Serializable
      serialVersionUID:
      427676481L
      • Serialized Fields

        • id
          int id
          OU identifier
        • name
          String name
          OU name
    • Class de.elo.ix.client.PackageC

      class PackageC extends PackageDataC implements Serializable
      serialVersionUID:
      -6183384427702216879L
      • Serialized Fields

        • defaultGuid
          String defaultGuid
          Package default guid.
          Since:
          21.02.000.009
    • Class de.elo.ix.client.PackageCheckoutInfo

      class PackageCheckoutInfo extends Object implements Serializable
      serialVersionUID:
      8464124257740845666L
      • Serialized Fields

        • nameOrGuids
          List<String> nameOrGuids
          List of names or GUIDs of packages to checkout. If the list is null or empty, all packages will be checkout.
    • Class de.elo.ix.client.PackageContent

      class PackageContent extends Object implements Serializable
      serialVersionUID:
      6052669951999935585L
      • Serialized Fields

        • contents
          List<Object> contents
          All objects belonged to the expected packages. EIX-2118
          Since:
          21.00.000.013
    • Class de.elo.ix.client.PackageData

      class PackageData extends ValueClass implements Serializable
      serialVersionUID:
      -5678384149936790313L
      • Serialized Fields

        • contentType
          String contentType
          Content type of the icon
          Since:
          21.00.000.019
        • description
          String description
          Package description.
        • guid
          String guid
          Package GUID.
        • icon
          FileData icon
          Icon of package.
        • levels
          List<PackageLevelData> levels
          Since:
          21.02.000.008
        • lockId
          int lockId
          The ID of the user that holds the lock or -1, if the note is not locked.
        • lockName
          String lockName
          The user name that holds the lock or an empty string if the note is not locked.
        • maintainer
          String maintainer
          Maintainer of package
          Since:
          21.00.000.019
        • name
          String name
          Name of the package, which is displayed.
        • namespace
          String namespace
          Name of the package, which can be used (as technical name).
          Since:
          21.00.000.022
        • tStamp
          String tStamp
          Timestamp of last modification.
    • Class de.elo.ix.client.PackageDataC

      class PackageDataC extends Object implements Serializable
      serialVersionUID:
      1023051783L
      • Serialized Fields

        • lnContentType
          int lnContentType
          Column length: Content type of the icon DB column: contenttype
          Since:
          21.00.000.019
        • lnDescription
          int lnDescription
          Column length: Package description. DB column: pkdesc
        • lnGuid
          int lnGuid
          Column length: Package GUID. DB column: pkguid
        • lnIconData
          int lnIconData
          Column length: Icon of package. DB column: icon
        • lnMaintainer
          int lnMaintainer
          Column length: Maintainer of package DB column: maintainer
          Since:
          21.00.000.019
        • lnName
          int lnName
          Column length: Name of the package, which is displayed. DB column: pkname
        • lnNamespace
          int lnNamespace
          Column length: Name of the package, which can be used (as technical name). DB column: namespace
          Since:
          21.00.000.022
        • lnTStamp
          int lnTStamp
          Column length: Timestamp of last modification. DB column: pktstamp
    • Class de.elo.ix.client.PackageDataZ

      class PackageDataZ extends Object implements Serializable
      serialVersionUID:
      7825191353761244476L
      • Serialized Fields

        • bset
          long bset
    • Class de.elo.ix.client.PackageDeleteInfo

      class PackageDeleteInfo extends Object implements Serializable
      serialVersionUID:
      5915449228473865372L
      • Serialized Fields

        • deletePackageContent
          boolean deletePackageContent
          if true then archive elements belonging to that package will be deleted as well
          Since:
          21.01.000.001
        • nameOrGuids
          List<String> nameOrGuids
          List of names or GUIDs of packages to be deleted. It must be filled with at least one value.
    • Class de.elo.ix.client.PackageExportInfo

      class PackageExportInfo extends Object implements Serializable
      serialVersionUID:
      -6642140169481699719L
      • Serialized Fields

        • nameOrGuids
          List<String> nameOrGuids
          List of names or GUIDs of packages to export.
    • Class de.elo.ix.client.PackageImportEventInfo

      class PackageImportEventInfo extends ValueClass implements Serializable
      serialVersionUID:
      1464967444L
      • Serialized Fields

    • Class de.elo.ix.client.PackageLevelData

      class PackageLevelData extends ValueClass implements Serializable
      serialVersionUID:
      -217396627057561430L
      • Serialized Fields

        • guid
          String guid
          Level GUID.
        • level
          int level
          The level.
          Since:
          21.02.000.009
        • name
          String name
          Level name.
        • packageGuid
          String packageGuid
          Package GUID.
    • Class de.elo.ix.client.PackageLevelDataC

      class PackageLevelDataC extends Object implements Serializable
      serialVersionUID:
      2117345087L
      • Serialized Fields

        • lnGuid
          int lnGuid
          Column length: Level GUID. DB column: guid
        • lnName
          int lnName
          Column length: Level name. DB column: name
        • lnPackageGuid
          int lnPackageGuid
          Column length: Package GUID. DB column: pkguid
    • Class de.elo.ix.client.PackageResult

      class PackageResult extends Object implements Serializable
      serialVersionUID:
      -2585277804475160016L
      • Serialized Fields

        • packageDataList
          List<PackageData> packageDataList
          List of PackageData objects.
    • Class de.elo.ix.client.PhysDel

      class PhysDel extends ValueClass implements Serializable
      serialVersionUID:
      124345500L
      • Serialized Fields

        • guid
          String guid
          GUID of deleted object.
        • TStamp
          String TStamp
          The object is deleted at this timestamp. Measured in the UTC time-zone.
        • TStampSync
          String TStampSync
          Timestamp of this object's last export by the replication.
          Since:
          9.99.009.001
        • type
          int type
          Type of deleted object.
          See Also:
    • Class de.elo.ix.client.PhysDelC

      class PhysDelC extends PhysDelDataC implements Serializable
      serialVersionUID:
      278631137L
    • Class de.elo.ix.client.PhysDelDataC

      class PhysDelDataC extends Object implements Serializable
      serialVersionUID:
      448931954L
      • Serialized Fields

        • lnGuid
          int lnGuid
          DB column: pdguid
        • lnTStamp
          int lnTStamp
          DB column: pdtstamp
        • lnTStampSync
          int lnTStampSync
          Column length: Timestamp of this object's last export by the replication. DB column: tstampsync
          Since:
          9.99.009.001
    • Class de.elo.ix.client.PhysDelDocs

      class PhysDelDocs extends ValueClass implements Serializable
      serialVersionUID:
      855528761L
      • Serialized Fields

        • objId
          int objId
          DB column: objid
    • Class de.elo.ix.client.PhysDelDocsC

      class PhysDelDocsC extends Object implements Serializable
      serialVersionUID:
      434896477L
    • Class de.elo.ix.client.PointInfo

      class PointInfo extends Object implements Serializable
      serialVersionUID:
      1225068828L
      • Serialized Fields

        • x
          int x
          X coordinate
        • y
          int y
          Y coordinate
    • Class de.elo.ix.client.PreviewImageInfo

      class PreviewImageInfo extends ValueClass implements Serializable
      serialVersionUID:
      7987162050708573661L
      • Serialized Fields

        • documentId
          String documentId

          Id of the document(-version) to query preview images for. If set, objectId is ignored.

        • endPage
          int endPage

          Last page number of the document to process a preview image for. If this value is ≤ 0, all pages of the document ≥ startPage are process. If 0 < endPage ≤ startPage holds, only the startPage will be processed.

        • objectId
          String objectId

          ID of the objects to query preview images for. The ID must point to a document. Otherwise, an exception is thrown.

        • previewSize
          int previewSize
          Desired size of the preview images. Valid values are defined in PreviewImageInfoC.
        • processDocument
          boolean processDocument

          If processDocument is true, not only the URLs for each page are generated but also preview images are processed for the pages (startPage+1) to endPage in the background.

        • renderAnnotations
          boolean renderAnnotations

          Enables rendering of annotations. If renderAnnotations is true, the preview images will also contain the annotations. If the preview images should contain the annotations but not the preview of the document page itself, also set renderOnlyAnnotations to true.

        • renderAnnotationsData
          boolean renderAnnotationsData

          Does only has an effect, if renderAnnotations is true. If set to true there will be details rendered near the annotations. Details are the annotation's author and create date.

        • renderAnnotationsOnly
          boolean renderAnnotationsOnly

          Does only has an effect, if renderAnnotations is true. If set to true the annotations will be rendered but the rendering of document pages will be omitted.

        • startPage
          int startPage

          First page number of the document to process a preview image for. The number of the first page of a document is 1. If this value is ≤ 0, 1 is assumed.

    • Class de.elo.ix.client.PreviewImageInfoC

      class PreviewImageInfoC extends Object implements Serializable
      serialVersionUID:
      407268655L
    • Class de.elo.ix.client.PreviewImageResult

      class PreviewImageResult extends Object implements Serializable
      serialVersionUID:
      661820173L
      • Serialized Fields

        • dimensionHeight
          int dimensionHeight
          Height of the first page. Please consider the hints at PreviewImageResult.dimensionWidth with respect to multi-page documents.
        • dimensionWidth
          int dimensionWidth
          Width of first page. Use this value to get an idea about the dimensions of the preview image in general. While this value is exact for the first page, following pages may have different dimension (e.g. different orientation, image as a whole page in a PDF document, ...)
        • dpi
          int dpi
          Dots per inch of the requested preview images. If the document source is a multi-page file, this value holds for every requested pages.
        • pages
          int pages
          Number of pages.
        • progress
          int progress
          Current progress of processing at the server. Processing is finished at server side when this value equals PreviewImageResult.progressMax.
        • progressMax
          int progressMax
          Estimated value about the workload at the server. There is a chance that the server is finished with the processing of the request when progress reaches this estimated value. In repeated requests progresMax can increase in comparison to calls in earlier times.
        • statusMessage
          String statusMessage
          Status message about the current processing of preview images at the server.
        • urls
          List<String> urls
          List of URLs pointing to the requested preview images. The URL at the first index in the list points to the lexicographic ordered first requested page.
    • Class de.elo.ix.client.ProcessAcl

      class ProcessAcl extends ValueClass implements Serializable
      serialVersionUID:
      402225782L
      • Serialized Fields

        • addAcl
          String addAcl
          ACL to be added in raw database format. Ignored, if addAclItems is not null.
          Since:
          7.00.020.008
          See Also:
        • addAclItems
          AclItem[] addAclItems
          ACL to be added.
        • andAcl
          String andAcl
          ACL to be added in raw database format. Ignored, if andAclItems is not null.
          Since:
          7.00.020.008
          See Also:
        • andAclItems
          AclItem[] andAclItems
          ACL to be intersected with.
        • setAcl
          String setAcl
          ACL to be added in raw database format. Ignored, if setAclItems is not null.
          Since:
          7.00.020.008
          See Also:
        • setAclItems
          AclItem[] setAclItems
          ACL to be set directly overriding any former settings.
        • subAcl
          String subAcl
          ACL to be added in raw database format. Ignored, if subAclItems is not null.
          Since:
          7.00.020.008
          See Also:
        • subAclItems
          AclItem[] subAclItems
          ACL to be subtracted.
    • Class de.elo.ix.client.ProcessCopyElements

      class ProcessCopyElements extends ValueClass implements Serializable
      serialVersionUID:
      147051188L
      • Serialized Fields

        • copyOptions
          CopyOptions copyOptions
          Options for the copy-process
        • copyResult
          CopyResult copyResult
          Result of copy process.
          Since:
          9.00.014.004
        • createMapping
          boolean createMapping
          If createMapping is true, at the copyResult, the maps source-id to copy-id will be filled. Defaults to false.
          Since:
          9.00.014.004
    • Class de.elo.ix.client.ProcessCountElements

      class ProcessCountElements extends ValueClass implements Serializable
      serialVersionUID:
      1130489422L
      • Serialized Fields

        • countResult
          CountResult countResult
          Result of the countprocess.
    • Class de.elo.ix.client.ProcessFulltext

      class ProcessFulltext extends ValueClass implements Serializable
      serialVersionUID:
      1125907212L
      • Serialized Fields

        • addToFulltext
          boolean addToFulltext
          Add to the fulltext-service
    • Class de.elo.ix.client.ProcessInfo

      class ProcessInfo extends ValueClass implements Serializable
      serialVersionUID:
      1037318967L
      • Serialized Fields

        • delStatus
          int delStatus
          pass 0 for valid (undeleted) nodes, >0 otherwise.
        • desc
          String desc
          Holds the user defined description of a specific call. This member must not be null or empty.
        • errorMode
          int errorMode
          From ProcessInfoC: ERRORMODE_ALL, ERRORMODE_SKIP_SUBTREE, ERRORMODE_SKIP_PROCINFO or ERRORMODE_CRITICAL_ONLY.
        • forceOperation
          boolean forceOperation
          Defines, if the data allways have to be written
          Since:
          7.00.000.038
        • ignoreDocuments
          boolean ignoreDocuments
          processing flag for documents.
        • ignoreStructures
          boolean ignoreStructures
          processing flag for structure elements.
        • inclReferences
          boolean inclReferences
          Process references (logical copies) too.
          Since:
          8.00.000.004
        • lockZ
          LockZ lockZ
          Use this parameter to access potentially locked nodes.
        • procAcl
          ProcessAcl procAcl
          Prefix processing, valid ProcessAcl data.
        • procCopyElements
          ProcessCopyElements procCopyElements
          Copy the elements into other archive location.
          Since:
          7.00.020.001
        • procCountElem
          ProcessCountElements procCountElem
          Prefix processing count all elements
          Since:
          7.00.000.000
        • procFulltext
          ProcessFulltext procFulltext
          Prefix processing, valid ProcessFulltext data.
          Since:
          6.00.099
        • procInheritKeywording
          ProcessInheritKeywording procInheritKeywording
          Inherit keywording.
          Since:
          10.17.040.001
        • procMoveDocumentsToStoragePath
          ProcessMoveDocumentsToStoragePath procMoveDocumentsToStoragePath
          Move documents to storage path.
          Since:
          7.00.000.045
        • procMsgMax
          int procMsgMax
          Maximum amount of recorded errors in procMsgs; from ProcessInfoC: PROCMSGMAX.
        • procMsgs
          String[] procMsgs
          Recorded error messages; specify their amount using procMsgMax.
        • procRegion
          ProcessRegion procRegion
          Process region of sub-trees.
          Since:
          21.04.000.012
        • procReleaseLock
          ProcessReleaseLock procReleaseLock
          Release the locks on processed elements.
          Since:
          9.00.000.031
        • procReplSet
          ProcessReplSet procReplSet
          Prefix processing, valid ProcessReplSet data.
        • procScript
          ProcessScript procScript
          Either prefix or postfix processing.
        • procSpaceGuid
          ProcessSpaceGuid procSpaceGuid
          Workspace GUID processing.
          Since:
          21.00.000.016
    • Class de.elo.ix.client.ProcessInfoC

      class ProcessInfoC extends Object implements Serializable
      serialVersionUID:
      659513392L
    • Class de.elo.ix.client.ProcessInheritKeywording

      class ProcessInheritKeywording extends ValueClass implements Serializable
      serialVersionUID:
      1130489423L
    • Class de.elo.ix.client.ProcessMoveDocumentsToStoragePath

      class ProcessMoveDocumentsToStoragePath extends ValueClass implements Serializable
      serialVersionUID:
      3376635L
      • Serialized Fields

        • pathId
          String pathId
          Name or ID of the storage path
    • Class de.elo.ix.client.ProcessRegion

      class ProcessRegion extends ValueClass implements Serializable
      serialVersionUID:
      929297025L
      • Serialized Fields

        • isNewRegion
          boolean isNewRegion
          Determines if the root sord has changed from "is no region" to "is region". This can only happen during checkin of a sord (flag SordDetails.isRegion() and never when a sord is moved.
        • regionId
          int regionId
          The resulting regionId of the root sord which has to be passed to its sub-tree.
        • rootObjId
          int rootObjId
          The id of the root sord for which its sub-tree has to be adapted according to its region.
    • Class de.elo.ix.client.ProcessReleaseLock

      class ProcessReleaseLock extends ValueClass implements Serializable
      serialVersionUID:
      1392653467805346500L
    • Class de.elo.ix.client.ProcessReplSet

      class ProcessReplSet extends ValueClass implements Serializable
      serialVersionUID:
      712209598L
      • Serialized Fields

        • addReplSets
          IdName[] addReplSets
          Replication sets to be added.
        • andReplSets
          IdName[] andReplSets
          Replication sets to be intersected with.
        • setReplSets
          IdName[] setReplSets
          Replication sets to be set directly overriding any former settings.
        • subReplSets
          IdName[] subReplSets
          Replication sets to be subtracted.
    • Class de.elo.ix.client.ProcessScript

      class ProcessScript extends ValueClass implements Serializable
      serialVersionUID:
      1122555546L
      • Serialized Fields

        • name
          String name
          Script name.
        • processPostfix
          boolean processPostfix
          execution position in tree walks.
        • tag
          String tag
          user defined tag.
    • Class de.elo.ix.client.ProcessSpaceGuid

      class ProcessSpaceGuid extends ValueClass implements Serializable
      serialVersionUID:
      -9152348933061363909L
      • Serialized Fields

        • spaceGuid
          String spaceGuid
          New spaceGuid
        • spaceGuids
          List<String> spaceGuids
          New spaceGuids
          Since:
          21.0.0.21
    • Class de.elo.ix.client.PublicDownload

      class PublicDownload extends ValueClass implements Serializable
      serialVersionUID:
      8397262249495117428L
      • Serialized Fields

        • attachmentCode
          String attachmentCode
          Indicates whether the download is inline or as attachment. this field is ignored in ELO 11.03 and ongoing versions.
          Since:
          9.00.030.030
        • docId
          int docId
          The document ID.
        • expiration
          String expiration
          The expired time.
        • fileName
          String fileName
          The fileName in the download url. It is readonly.
          Since:
          9.00.030.030
        • id
          String id
          The download ID.
        • objId
          int objId
          The object ID.
          Since:
          9.00.000.028
        • remaining
          int remaining
          The download count.
        • timeStamp
          String timeStamp
          The time stamp.
        • url
          String url
          The download URL
          Since:
          9.00.014.002
        • userId
          int userId
          The user ID.
    • Class de.elo.ix.client.PublicDownloadC

      class PublicDownloadC extends PublicDownloadDataC implements Serializable
      serialVersionUID:
      -7237521763064317733L
    • Class de.elo.ix.client.PublicDownloadDataC

      class PublicDownloadDataC extends Object implements Serializable
      serialVersionUID:
      1639180602L
      • Serialized Fields

        • lnAttachmentCode
          int lnAttachmentCode
          Column length: Indicates whether the download is inline or as attachment. this field is ignored in ELO 11.03 DB column: acode
          Since:
          9.00.030.030
        • lnExpiration
          int lnExpiration
          DB column: expiration
        • lnFileName
          int lnFileName
          Column length: The fileName in the download url. It is readonly. DB column: fname
          Since:
          9.00.030.030
        • lnId
          int lnId
          DB column: guid
        • lnTimeStamp
          int lnTimeStamp
          DB column: tstamp
    • Class de.elo.ix.client.PublicDownloadOptions

      class PublicDownloadOptions extends ValueClass implements Serializable
      serialVersionUID:
      -7252795602590614452L
      • Serialized Fields

        • contentDispositionAttachment
          boolean contentDispositionAttachment
          If true, the document is downloaded as an attachment. Otherwise it content is shown in-line in the browser.
          Since:
          9.00.014.008
        • docId
          String docId
          The doc id.
          Since:
          9.00.012.004
        • downloadIds
          String[] downloadIds
          The download IDs to retrieve the public downloads.
        • expiration
          String expiration
          The expired time.
          Since:
          9.00.012.003
        • fileNameFromSordName
          boolean fileNameFromSordName
          If true, the short description of the sord is used as file name in the download URL. Otherwise the original file name is used.
          Since:
          9.00.014.008
        • objId
          String objId
          The obj id.
          Since:
          9.00.012.004
        • remaining
          int remaining
          The remaining download.
          Since:
          9.00.012.003
    • Class de.elo.ix.client.PurgeSettings

      class PurgeSettings extends ValueClass implements Serializable
      serialVersionUID:
      1576340510L
      • Serialized Fields

        • dayLimit
          int dayLimit
          Original documents older than the specified number of days are deleted (0 or higher), e.g. 0 for no limit, 1 for 24 hours, 365 for a year
        • excludePathIds
          List<Integer> excludePathIds
          List of path ids to exclude from purging if pathId=0 is set.
          Since:
          9.00.000.027
        • fileCheckMode
          int fileCheckMode
          The original and the backup document can be compared before cleanup. Possible values (1 to 3) are defined in PurgeSettingsC.
        • pathId
          int pathId
          Possible path restriction for filing paths:
          0: include all paths
          1 and higher: only include a path with this ID where documents should be deleted
        • startHour
          int startHour
          When processing should take place:
          START_EVERY_HOUR: when the purge task is starting and then every 60 minutes
          0 to 23: hour of the day, such as 8:00 p.m.
    • Class de.elo.ix.client.PurgeSettingsC

      class PurgeSettingsC extends ValueClass implements Serializable
      serialVersionUID:
      1865968564L
    • Class de.elo.ix.client.PurgeStatus

      class PurgeStatus extends ValueClass implements Serializable
      serialVersionUID:
      2053888643L
      • Serialized Fields

        • errorMessage
          String errorMessage
          an error message, if an error occured, else an empty String
        • isRunning
          boolean isRunning
          if the ELOdm purge task is running (it can only run in combination with the backup task)
        • lastPurgeTime
          String lastPurgeTime
          last purge work time (ISO UTC date and time without dots) If no purge has been done yet, the variable is empty.
        • numberOfDocsPurged
          int numberOfDocsPurged
          number of purged documents
    • Class de.elo.ix.client.QueryJobProtocolC

      class QueryJobProtocolC extends Object implements Serializable
      serialVersionUID:
      3447703175206950883L
    • Class de.elo.ix.client.QueryJobProtocolEvent

      class QueryJobProtocolEvent extends ValueClass implements Serializable
      serialVersionUID:
      1366333632959138034L
      • Serialized Fields

        • date
          String date
          The time of generating this event.
        • eventId
          int eventId
          The id of this QueryJobProtocolEvent. The eventId's value is unique for one background thread. The value of a background thread's first eventId is 0. The second one is 1 and so on.
          Since:
          9.00.000.026
        • level
          int level
          The level of log messages to query. Use the | operator to select multiple levels.
          See Also:
        • message
          String message
          Message of this LogRow.
        • objId
          int objId
          The id of the object currently being processed at the time of this events creation. If the objId is not known/available, its value is set to QueryJobProtocolC.OBJID_NOT_SET.
    • Class de.elo.ix.client.QueryJobProtocolInfo

      class QueryJobProtocolInfo extends ValueClass implements Serializable
      serialVersionUID:
      2117539193209501070L
      • Serialized Fields

    • Class de.elo.ix.client.QueryJobProtocolResult

      class QueryJobProtocolResult extends ValueClass implements Serializable
      serialVersionUID:
      6709103054639223824L
      • Serialized Fields

        • downloadUrl
          String downloadUrl
          This String contains a URL where the whole protocol can be downloaded. Empty, if no protocol file exists.
        • events
          QueryJobProtocolEvent[] events
          Contains the all events by a background job that are cached at the Indexserver.
    • Class de.elo.ix.client.Relation

      class Relation extends ValueClass implements Serializable
      serialVersionUID:
      837810375L
      • Serialized Fields

        • deleteDateIso
          String deleteDateIso
          The Relation is deleted at this date. ClientInfo determines the Timezone.

          Is undefined if status==0.

          Since:
          9.00.000.002
        • guid
          String guid
          GUID
          Since:
          7.00.000.004
        • mainRelation
          boolean mainRelation
          This Relation represents the main relation of an object, if this value is true.
          Since:
          9.99.009.001
        • objGuid
          String objGuid
          GUID of the child object.
          Since:
          11.00.000.045
        • objId
          int objId
          DB column: objectid
        • ordinal
          int ordinal
          DB column: ordinal
        • parentGuid
          String parentGuid
          GUID of the parent object.
          Since:
          11.00.000.045
        • parentId
          int parentId
          DB column: parentid
        • status
          int status
          DB column: relstatus
        • tStamp
          String tStamp
          DB column: reltstamp
        • TStampSync
          String TStampSync
          Timestamp of this object's last export by the replication.
          Since:
          9.99.009.001
    • Class de.elo.ix.client.RelationC

      class RelationC extends Object implements Serializable
      serialVersionUID:
      1203469035L
      • Serialized Fields

        • lnGuid
          int lnGuid
          Column length: GUID DB column: relguid
          Since:
          7.00.000.004
        • lnTStamp
          int lnTStamp
          DB column: reltstamp
        • lnTStampSync
          int lnTStampSync
          Column length: Timestamp of this object's last export by the replication. DB column: reltstampsync
          Since:
          9.99.009.001
    • Class de.elo.ix.client.Reminder

      class Reminder extends ValueClass implements Serializable
      serialVersionUID:
      256674679L
      • Serialized Fields

        • createDateIso
          String createDateIso
          Reminder was created at this date.
        • deleted
          boolean deleted
          Reminder is deleted logically if set. Read-only.
        • desc
          String desc
          Memo text
        • dueDateIso
          String dueDateIso
          On this date the receiver has seen the reminder.
        • id
          int id
          Reminder ID
        • lockId
          int lockId
          ID of user who has locked the reminder record in DB
        • lockName
          String lockName
          Reminder is locked by this user.
        • name
          String name
          Short description visible in the task list.
        • notifyOnDelete
          boolean notifyOnDelete
          Notify sender if receiver deletes the reminder.
        • notifyOnView
          boolean notifyOnView
          Notify sender if receiver views the reminder.
        • objGuid
          String objGuid
          Sord GUID.
        • objId
          int objId
          Reminder is linked to this Sord.
        • objType
          int objType
          Sord type.
        • prio
          int prio
          Priority: 0...high, 1...medium, 2...low
        • promptDateIso
          String promptDateIso
          At this Date the reminder should be made visible to the receiver.
        • receiverId
          int receiverId
          Reminder was created for this user.
        • receiverName
          String receiverName
          Reminder was created for this user.
        • senderId
          int senderId
          Reminder was created by this user.
        • senderName
          String senderName
          Reminder was created by this user.
    • Class de.elo.ix.client.ReminderC

      class ReminderC extends ReminderDataC implements Serializable
      serialVersionUID:
      1431555044L
    • Class de.elo.ix.client.ReminderDataC

      class ReminderDataC extends Object implements Serializable
      serialVersionUID:
      1099169893L
      • Serialized Fields

        • lnDesc
          int lnDesc
          DB column: wvdesc
        • lnName
          int lnName
          DB column: short
    • Class de.elo.ix.client.ReplCode

      class ReplCode extends Object implements Serializable
      serialVersionUID:
      1235558040L
    • Class de.elo.ix.client.RepliHist

      class RepliHist extends ValueClass implements Serializable
      serialVersionUID:
      899503054L
      • Serialized Fields

        • arcDesc
          String arcDesc
          DB column: rharcdesc
        • arcGuid
          String arcGuid
          DB column: rharcguid
        • arcPriorityLocal
          int arcPriorityLocal
          Since:
          9.99.009.001
        • arcPriorityRemote
          int arcPriorityRemote
          Since:
          9.99.009.001
        • arcShort
          String arcShort
          DB column: rharcshort
        • id
          int id
          DB column: rhrowid
        • imEx
          int imEx
          DB column: rhimex
        • succ
          int succ
          DB column: rhsucc
        • tSBegin
          String tSBegin
          DB column: rhtsbegin
        • tSDate
          String tSDate
          DB column: rhtsdate
        • tSEnd
          String tSEnd
          DB column: rhtsend
    • Class de.elo.ix.client.RepliHistC

      class RepliHistC extends Object implements Serializable
      serialVersionUID:
      104551413L
      • Serialized Fields

        • lnArcDesc
          int lnArcDesc
          DB column: rharcdesc
        • lnArcGuid
          int lnArcGuid
          DB column: rharcguid
        • lnArcShort
          int lnArcShort
          DB column: rharcshort
        • lnTSBegin
          int lnTSBegin
          DB column: rhtsbegin
        • lnTSDate
          int lnTSDate
          DB column: rhtsdate
        • lnTSEnd
          int lnTSEnd
          DB column: rhtsend
    • Class de.elo.ix.client.ReplSet

      class ReplSet extends ValueClass implements Serializable
      serialVersionUID:
      1124529321L
      • Serialized Fields

        • combiGuid
          String combiGuid
          Since:
          11.00.000.005
        • dw
          int[] dw
          Bitset of replication IDs.
        • dwSync
          int[] dwSync
          Bitset of synchronized replication IDs.
          Since:
          12.02.001.001
        • objId
          int objId
          This replication information belongs to the archive entry with ID objId
        • TStamp
          String TStamp
          Timestamp of the last alteration of replication sets for the corresponding archive entry. The format is JJJJ.MM.DD.hh.mm.ss
          Since:
          9.99.009.001
        • TStampSync
          String TStampSync
          Timestamp of this object's last export by the replication.
          Since:
          9.99.009.001
    • Class de.elo.ix.client.ReplSetCombination

      class ReplSetCombination extends ValueClass implements Serializable
      serialVersionUID:
      6035096705624502137L
      • Serialized Fields

        • combi
          byte[] combi
        • guid
          String guid
    • Class de.elo.ix.client.ReplSetCombinationC

      class ReplSetCombinationC extends Object implements Serializable
      serialVersionUID:
      897151349L
      • Serialized Fields

        • lnCombi
          int lnCombi
          DB column: dw
        • lnCombiGuid
          int lnCombiGuid
          DB column: combiid
          Since:
          9.99.009.001
    • Class de.elo.ix.client.ReplSetName

      class ReplSetName extends ValueClass implements Serializable
      serialVersionUID:
      755067340L
      • Serialized Fields

        • desc
          String desc
          Descriptive text for the replication set.
        • id
          int id
          Identifier for the replication set.
        • image
          int image
          Image used for the replication set in list function in the client application.
        • mobile
          int mobile
          Replication set is used for archive synchronisation(ELO MOBIL).
        • name
          String name
          Name of the replication set.
        • priority
          int priority
          Priority of this replication set.
          Since:
          9.99.009.001
        • TStamp
          String TStamp
          Timestamp of the last change. The format is JJJJ.MM.DD.hh.mm.ss
        • TStampSync
          String TStampSync
          Timestamp of this object's last export by the replication.
          Since:
          9.99.009.001
    • Class de.elo.ix.client.ReplSetNameC

      class ReplSetNameC extends Object implements Serializable
      serialVersionUID:
      969246601L
      • Serialized Fields

        • lnDesc
          int lnDesc
          DB column: rsdesc
        • lnName
          int lnName
          DB column: rsname
        • lnTStamp
          int lnTStamp
          DB column: rststamp
        • lnTStampSync
          int lnTStampSync
          Column length: Timestamp of this object's last export by the replication. DB column: rststampsync
          Since:
          9.99.009.001
    • Class de.elo.ix.client.ReportC

      class ReportC extends Object implements Serializable
      serialVersionUID:
      1285453013L
      • Serialized Fields

        • lnExtra3
          int lnExtra3
          Column length: Reserved. DB column: extra3
          Since:
          9.00.016.001
        • lnId
          int lnId
          DB column: reportid
        • lnText
          int lnText
          DB column: addtext
    • Class de.elo.ix.client.ReportErpCode

      class ReportErpCode extends ValueClass implements Serializable
      serialVersionUID:
      508806040L
      • Serialized Fields

        • id
          int id
          ERP code
        • limited
          boolean limited
          This code is wirtten in limited report
        • name
          String name
          ERP name
        • verbose
          boolean verbose
          This code is written in verbose report
    • Class de.elo.ix.client.ReportInfo

      class ReportInfo extends ValueClass implements Serializable
      serialVersionUID:
      1280848136L
      • Serialized Fields

        • action
          String action
          ActionNo as name.
        • actionNo
          int actionNo
          Action number in numeric form.
        • actTime
          int actTime
          Reserved - internal function.
        • actTimeISO
          String actTimeISO
          Time of the action in ISO format.
        • comment
          String comment
          Descriptive text or details.
        • extra1
          int extra1
          Reserved - internal, dependant on actionNo.
        • extra2
          int extra2
          Reserved - internal, dependant on actionNo
        • extra3
          String extra3
          Reserved.
          Since:
          9.00.016.001
        • extraInfo
          Object extraInfo
          Extra information. This member is always null for report entries written by Windows-Client or by ELOix versions older than 9.00.016. The type of data depends on ReportInfo.actionNo as shown in the following table:
          actionNo values
          ReportInfoC.ACT_LOGIN_IX ReportInfoUserProps object, member userInfo is set to the user logged on.
          ReportInfoC.ACT_IX_CREATE_USER ReportInfoUserModified object, member newProps is set to the new user.
          ReportInfoC.ACT_IX_DELETE_USER ReportInfoUserModified object, member newProps is set to deleted user.
          ReportInfoC.ACT_IX_CHECKIN_USER ReportInfoUserModified object, member newProps is set to the modified values. Member oldProps is set to the values before modification.
          Since:
          9.00.016.001
        • id
          String id
          Identifier
        • objId
          int objId
          Id of the object for which the action is entered in the protocoll.
        • sessionNo
          int sessionNo
          Id of the session which carried out the action.
        • text
          String text
          Reserved - internal, dependant on actionNo
        • userId
          int userId
          Id of the user who carried out the action.
        • userName
          String userName
          Name of the user who carried out the action.
    • Class de.elo.ix.client.ReportInfoC

      class ReportInfoC extends ReportC implements Serializable
      serialVersionUID:
      1071192839L
    • Class de.elo.ix.client.ReportInfoUserModified

      class ReportInfoUserModified extends ValueClass implements Serializable
      serialVersionUID:
      -7501666205555778909L
      • Serialized Fields

    • Class de.elo.ix.client.ReportInfoUserProps

      class ReportInfoUserProps extends ValueClass implements Serializable
      serialVersionUID:
      -5735962225828014662L
    • Class de.elo.ix.client.ReportModeC

      class ReportModeC extends Object implements Serializable
      serialVersionUID:
      1594659914L
    • Class de.elo.ix.client.ReportModeZ

      class ReportModeZ extends ValueClass implements Serializable
      serialVersionUID:
      1248158950L
      • Serialized Fields

        • bset
          long bset
          Bitset field for constants from ReportModeC class.
    • Class de.elo.ix.client.ReportOptions

      class ReportOptions extends ValueClass implements Serializable
      serialVersionUID:
      1057373949L
    • Class de.elo.ix.client.ReportOptionsC

      class ReportOptionsC extends Object implements Serializable
      serialVersionUID:
      2081332891L
    • Class de.elo.ix.client.ResolveRightsInfo

      class ResolveRightsInfo extends Object implements Serializable
      serialVersionUID:
      -2057023210536179954L
    • Class de.elo.ix.client.ResolveRightsResult

      class ResolveRightsResult extends Object implements Serializable
      serialVersionUID:
      -4034394708669952069L
    • Class de.elo.ix.client.ResolveRightsResultC

      class ResolveRightsResultC extends Object implements Serializable
      serialVersionUID:
      2324834030921636792L
    • Class de.elo.ix.client.RestoreOptions

      class RestoreOptions extends ValueClass implements Serializable
      serialVersionUID:
      378110234L
      • Serialized Fields

        • minDeleteDate
          String minDeleteDate

          Restore only document versions that are deleted after minDeleteDate. Its String representation is the ISO format in the client's time zone.

          Since:
          9.00.000.000
        • minIDate
          String minIDate

          minIDate ist the ISO representation of the local date used to mark the lower limit for restoring.

        • parentId
          String parentId

          Since references also got a delete date, they can be restored independently from their main reference. To restore a reference selectively, set parentId to the references' parentId. Restoring a reference does not affect the delete status of its main reference.

          Setting parentId implies singleObject=true.

          Since:
          9.00.000.002
        • singleObject
          boolean singleObject

          singleObject=true restricts the operation to the specified object not traversing sub trees.

    • Class de.elo.ix.client.SearchModeC

      class SearchModeC extends Object implements Serializable
      serialVersionUID:
      1758444419L
    • Class de.elo.ix.client.SearchModeZ

      class SearchModeZ extends ValueClass implements Serializable
      serialVersionUID:
      424689505L
      • Serialized Fields

        • bset
          long bset
          Bitset field for constants from SearchModeC class.
    • Class de.elo.ix.client.SearchTermsC

      class SearchTermsC extends Object implements Serializable
      serialVersionUID:
      334358315L
    • Class de.elo.ix.client.ServerInfo

      class ServerInfo extends ValueClass implements Serializable
      serialVersionUID:
      1701204890L
      • Serialized Fields

        • databaseEngine
          String databaseEngine
          Database engine name. E. g. MSSQL, ORACLE, DB2 If connected to DB2, the character set UTF-8 is assumed for database columns that store Strings. In this case the length members of the constant classes (e.g. SordC.lnName resp. CONST.SORD.lnName) contain the column widths in bytes rather than characters. Use the IXConnection.truncate function to truncate a String value to fit the corresponding database column.
          Since:
          8.00.000.002
          See Also:
        • indexServers
          IndexServerForArchive[] indexServers
          List of other Index Servers. Read only.
        • instanceName
          String instanceName
          Indexserver name. This is the name configured in config.xml or web.xml as "ixid".
          Since:
          8.00.012.004
        • license
          License license
          License key for the Index Server. Read only.
        • postboxDisabled
          boolean postboxDisabled
          Serverside inbox is disabled. The serverside inbox is disabled in cloud installations.
          Since:
          21.04.000.010
        • replProcessOnServerId
          String replProcessOnServerId
          This value defines the local replication server ID. It must match to an existing ReplSetName.name in the replication configuration. It is also used in WFDiagram.processOnServerId to determine on which replication server a workflow is allowed to be continued.
          Since:
          7.00.000.015
          See Also:
        • serverStreamVersion
          String serverStreamVersion
          API stream version. EIX-2519
          Since:
          21.02.000.001
        • serverTime
          Date serverTime
          Server time. EIX-2519
          Since:
          21.02.000.001
        • version
          String version
          The version of the Index Server. Read only.
    • Class de.elo.ix.client.ServerInfoDM

      class ServerInfoDM extends ValueClass implements Serializable
      serialVersionUID:
      1425760760L
      • Serialized Fields

        • backupStoreIds
          int[] backupStoreIds
          reserved.
        • basisStoreIds
          int[] basisStoreIds
          IDs of the paths to be used for filing docments. The first path ID is the ID of the default filing path. This array can contain up to 4 elements.
        • blackeningEnabled
          boolean blackeningEnabled
          DM is enabled for blackening of document parts.
          See Also:
        • proxyMode
          int proxyMode
          DM proxy mode. Read-only.
          Values
          -1 Proxy mode is not active
          0 Main instance
          >0 Branch instance
        • restoreStoreId
          int restoreStoreId
          ID of restore path.
        • storeMode
          int storeMode
          Mode to be used to fill the filing paths. This value is a bitset of the ServerInfoDMC.STOREMODE_* constants.
          See Also:
    • Class de.elo.ix.client.ServerInfoDMC

      class ServerInfoDMC extends Object implements Serializable
      serialVersionUID:
      287365821L
    • Class de.elo.ix.client.ServerState

      class ServerState extends ValueClass implements Serializable
      serialVersionUID:
      1076606418L
      • Serialized Fields

        • action
          String action
          DB column: action
        • actionId
          int actionId
          DB column: actionid
        • subKey
          int subKey
          DB column: subkey
    • Class de.elo.ix.client.ServerStateC

      class ServerStateC extends Object implements Serializable
      serialVersionUID:
      1862501863L
      • Serialized Fields

        • lnAction
          int lnAction
          DB column: action
    • Class de.elo.ix.client.SessionInfo

      class SessionInfo extends ValueClass implements Serializable
      serialVersionUID:
      866689803L
      • Serialized Fields

        • appName
          String appName
          The name of the client's application connected with the Index Server.
          Since:
          8.00.032.006
        • appType
          String appType
          The type of the client's application connected with the Index Server.
          Since:
          8.00.032.006
        • appVersion
          String appVersion
          The version of the client's application connected with the Index Server.
          Since:
          8.00.032.006
        • bestBefore
          String bestBefore
          The time stamp of the session best before date.
          Since:
          8.00.032.006
        • clientComputer
          String clientComputer
          The client computer connected with the Index Server.
        • loginName
          String loginName
          Deprecated.
          The name of the user who initialized the runAs connection
          Since:
          9.00.022.005
        • runAs
          String runAs
          Deprecated.
          Session is constrained to this account
          Since:
          8.00.032.006
        • sessionOptions
          Map<String,String> sessionOptions
          Since:
          20.00.000.004
        • ticket
          String ticket
          The ticket of this session within the Index Server.
          Since:
          8.00.032.006
        • userId
          int userId
          The id of the user used for the connection.
        • userName
          String userName
          The name of the user used for the connection.
          Since:
          8.00.032.006
        • validSeconds
          int validSeconds
          The length of time the connection is valid for.
    • Class de.elo.ix.client.SessionInfoParams

      class SessionInfoParams extends ValueClass implements Serializable
      serialVersionUID:
      2013576169L
    • Class de.elo.ix.client.SessionOptions

      class SessionOptions extends ValueClass implements Serializable
      serialVersionUID:
      1197100286L
      • Serialized Fields

    • Class de.elo.ix.client.SessionOptionsC

      class SessionOptionsC extends Object implements Serializable
      serialVersionUID:
      2000345779L
    • Class de.elo.ix.client.Sord

      class Sord extends ValueClass implements Serializable
      serialVersionUID:
      1576327931L
      • Serialized Fields

        • access
          int access
          The current users access rights for this Sord. Returns a combination of AccessC.LUR_ constants. Read-only. Is returned when SordC.mbAcl is set in checkoutSord.
        • acl
          String acl
          Access control language in coded form. The checkInSord method must set either acl or aclItems. aclItems has priority.
        • aclItems
          AclItem[] aclItems
          This is the access control list as an array of AclItem objects.
          See Also:
        • aspects
          Map<String,List<Map<String,IndexValue>>> aspects
          Index values. This member is only valid, if the associated keywording form DocMask is organized as DocMask.dataOrganisation = DocMaskC.DATA_ORGANISATION_ASPECT.
          The outer key is the name of an AspectAssoc. The value is a list of maps.
          This list can contain more than one element according to cardinality of the aspect association.
          The inner maps are aspect objects, i.e. maps from lineKey of the corresponding aspect to an object of class IndexValue which holds the actual data for an aspect line.
          Since:
          20.00.000.100
        • att
          int att
          Id of the current attachment version. Read-only.
        • attVersion
          DocVersion attVersion
          Work version of the attachment.
          Since:
          7.00.040.007
        • childCount
          int childCount
          Estimated sum of the sub-entries in a directory. This does not take account of any access rights assigned to the entries. This property should only be used to determine whether the directory has additional entries. Read-only.
        • delDateIso
          String delDateIso
          ISO encoded expiry date. Only users having right AccessC.FLAG_EDITDUEDATE are allowed to set the expiry date. Once the expiry date is set, it cannot be set to a date before the original expiry date.
        • deleted
          boolean deleted
          Indicates whether the sord has been deleted or not.
        • deleteDateIso
          String deleteDateIso
          The Sord is deleted at this date. ClientInfo determines the Timezone.

          Is undefined if isDeleted() returns false.

          Since:
          9.00.000.000
        • deleteUser
          int deleteUser
          The Sord is deleted at this user.

          Is undefined if isDeleted() returns false.

          Since:
          10.00.020.012
        • desc
          String desc
          The (visible) memo text. If the value starts with a "!" this member can define a dynamic folder. This is a folder which contents are filled by an arbitrary SQL statement.
        • details
          SordDetails details
          Object encapsulates flags.
        • doc
          int doc
          Read-only. Id of the current document version.
        • docVersion
          DocVersion docVersion
          Version information of current document work version. Read-only.
        • guid
          String guid
          GUID.
        • hiddenText
          String hiddenText
          Hidden text that must not be displayed to the user.
        • histCount
          int histCount
          Number of document versions.
        • id
          int id
          Numeric ID.
        • IDateIso
          String IDateIso
          ISO encoded internal (archive defined) date.
        • info
          int info
          RESERVED
        • key
          int key
          RESERVED
        • kind
          int kind
          Colour
        • linksComeIn
          SordLink[] linksComeIn
          Links pointing from other archive entries to this. Read-only.
        • linksGoOut
          SordLink[] linksGoOut
          Links starting from this to other archive entries. Read-only.
          See Also:
        • lockId
          int lockId
          This is the id of the user who has a lock on the object. To know whether the Sord or the Document is locked, see lockIdSord or lockIdDoc respectively. The object is locked using checkoutSord with the LOCK.YES, LOCK.SORD or LOCK.DOC parameter. Read-only.
        • lockIdDoc
          int lockIdDoc
          This is the id of the user who has a lock on the document (not the object). The object is locked using checkoutSord with the LOCK.DOC parameter. Read-only.
          Since:
          9.99.009.001
        • lockIdSord
          int lockIdSord
          This is the id of the user who has a lock on the object (not the document). The object is locked using checkoutSord with the LOCK.SORD parameter. Read-only.
          Since:
          9.99.009.001
        • lockName
          String lockName
          The name of the user who has locked the object. Read-only.
          See Also:
        • lockNameDoc
          String lockNameDoc
          The name of the user who has locked the document. Read-only.
          Since:
          9.99.009.001
        • lockNameSord
          String lockNameSord
          The name of the user who has locked the object. Read-only.
          Since:
          9.99.009.001
        • mask
          int mask
          The id of the filing mask used to archive the sord. Read-only.
        • maskName
          String maskName
          Name of keywording form. This value is translated into the language given by ClientInfo.language. It cannot be used as a parameter in Indexserver API functions. Use Sord.getMask() to specify the Keywording form in API functions. Read-only.
          Since:
          7.00.000.028
          See Also:
        • name
          String name
          The short description/name for the object.
        • objKeys
          ObjKey[] objKeys
          Index values. This array is only valid, if the associated keywording form DocMask is organized as DocMask.dataOrganisation = DocMaskC.DATA_ORGANISATION_OBJKEYS or DocMaskC.DATA_ORGANISATION_TABLE.
          See Also:
        • ownerId
          int ownerId
          The id of the owner of the object. Main-administrators can assign an owner ID for new Sords in IXServicePortIF.checkinSord(ClientInfo, Sord, SordZ, LockZ) and IXServicePortIF.checkinSordPath(ClientInfo, String, Sord[], SordZ). This member is read-only for Non-adminstrators or existing Sords.
        • ownerName
          String ownerName
          Name of the owner (read-only).
        • packageName
          String packageName
          Package name of sord
          Since:
          21.03.000.013
        • parentId
          int parentId
          Id of the parent object(archive heirachy) of the sord object. Read-only
        • parentIds
          String[] parentIds
          GUIDs of archive entries that contain a reference to this. The first element of the array is the GUID of the main parent, where this is physically placed. Read-only.
          See Also:
        • path
          int path
          Filing path for the document manager. Only valid for documents. Read-only.

          If this Sord object is obtained by a call to checkoutSord or checkoutDoc with a database lock (e.g. LockC.IF_FREE), this member contains the storage path specified in the associated keywording form (DocMask.DPath). If the keywording form does not define a path, the default storage path is returned (ServerInfoDM.basisStoreIds[0]). Hence, the current value of the database column objekte.objpath is not used as default for new versions anymore.

          If this Sord object is obtained by a call without a lock, e.g. from findFirstSords, this value should not be used anymore. The storage path of the work version should be used instead, which can be found in Sord.docVersion.pathId.

          See Also:
        • refPaths
          ArcPath[] refPaths
          Archive paths to this Sord. The first path, refPaths[0], contains the path to the original Sord. The other paths contain references to this Sord. The paths do not include an entry for the archive and for this Sord. Since 10.18.021, TTS005149: If the user does not have read access to at least one element in a reference path, this path is excluded from the list. An exception applies to the original path. If the user does not have read access to at least one element in the original path, the ArcPath object at refPaths[0] is empty: refPaths[0].path.length == 0, refPaths[0].pathAsString = "¶". In contrast to refPaths, the array Sord.parentIds is not checked for read access.
        • regionId
          int regionId
          This is a RESERVED field for future use. Do not use.
          The region id of a sord.
          If the sord is contained in a region (i.e. lies below an object in archive tree that has an associated keywording form which defines a region), this value contains the numeric Id of that region sord. Thus, this field defines the membership of this sord object to the region specified by this value.

          Although the sord defining the region is always associated to a keywording form DocMask which is organized as DocMaskC.DATA_ORGANISATION_ASPECT, this sord belonging to a region can be of any type of data organisation (objkey, table or aspect).
          Since:
          20.00.000.100
        • replNames
          ReplSetName[] replNames
          Replication set names. The replication set information of an object is binary encoded in the database. The Class ReplNameMap provides functions to convert from the binary format into a list of replication set names and vice versa. Both replNames and replSet contain the information in which replications set the object is contain in. replNames has priority when checking the object in.
          See Also:
        • replSet
          ReplSet replSet
          Replication sets. Binary encoded information. Both replNames and replSet contain the information determining in which replications sets the object is contain in. replNames has priority when checking the object in.
          See Also:
        • spaceGuid
          String spaceGuid
          If the sord belongs to a workspace, this value contains the GUID of that workspace.
          Since:
          21.00.000.003
        • spaceGuids
          List<String> spaceGuids
          If the sord belongs to a workspace, this value contains the GUIDs of parent workspaces.
          Since:
          21.00.000.021
        • SReg
          String SReg
          Version numer of the current work version.
        • TStamp
          String TStamp
          Timestamp of the last change. The format is JJJJ.MM.DD.hh.mm.ss
        • TStampAcl
          String TStampAcl
          Timestamp of the last ACL change. The format is JJJJ.MM.DD.hh.mm.ss
          Since:
          9.99.009.001
        • TStampAclSync
          String TStampAclSync
          Timestamp of this object's ACLs last export by the replication.
          Since:
          9.99.009.001
        • TStampLocal
          String TStampLocal
          Timestamp that indicates the next iSearch Index run The format is JJJJ.MM.DD.hh.mm.ss
          Since:
          21.02.000.004
        • TStampSync
          String TStampSync
          Timestamp of this object's last export by the replication.
          Since:
          9.99.009.001
        • type
          int type
          The type of sord object. Folder objects: 0 < type < LBT_DOCUMENT Document objects: LBT_DOCUMENT <= type < LBT_DOCUMENT_MAX
          See Also:
        • vtRep
          int vtRep
          RESERVED
        • XDateIso
          String XDateIso
          ISO encoded external (user defined) date.
    • Class de.elo.ix.client.SordC

      class SordC extends ObjDataC implements Serializable
      serialVersionUID:
      1553100003L
      • Serialized Fields

        • ELOINDEX_USER_FOLDER_DATA
          String ELOINDEX_USER_FOLDER_DATA
          Index value ELOINDEX of sub-folder "data" of a users folder. The "data" sub-folder of a user folder can be read as follows: String objId = "OKEY:ELOINDEX=" + ELOINDEX_USER_FOLDER_DATA + user-guid EditInfo ed = conn.ix().checkoutSord(objId, ...)
          Since:
          9.00.000.032
        • ELOINDEX_USER_FOLDER_DATA_PROFILE
          String ELOINDEX_USER_FOLDER_DATA_PROFILE
          Index value ELOINDEX of sub-folder "data/elo.profile" of a users folder.
          Since:
          9.00.000.032
          See Also:
        • ELOINDEX_USER_FOLDER_INBOX
          String ELOINDEX_USER_FOLDER_INBOX
          Index value ELOINDEX of sub-folder "inbox" of a users folder.
          Since:
          9.00.000.032
          See Also:
        • ELOINDEX_USER_FOLDER_PRIVATE
          String ELOINDEX_USER_FOLDER_PRIVATE
          Index value ELOINDEX of sub-folder "private" of a users folder.
          Since:
          9.00.000.032
          See Also:
        • GUID_ADMINISTRATION_BASE
          String GUID_ADMINISTRATION_BASE
          GUID of folder "Administration". This folder contains "Replication Base", "Scripting Base" etc.
        • GUID_APPS_FOLDER
          String GUID_APPS_FOLDER
          GUID of folder "/Administration/ELO-Apps".
          Since:
          9.99.009.008
        • GUID_COLD_BACKGROUND_IMAGES
          String GUID_COLD_BACKGROUND_IMAGES
          Archive folder /Administration/COLD Background Images
          Since:
          7.00.022.001
        • GUID_IX_SCRIPTING_BASE
          String GUID_IX_SCRIPTING_BASE
          GUID of folder "IndexServer Scripting Base"
          Since:
          7.00.000.029
        • GUID_REPLICATION_BASE
          String GUID_REPLICATION_BASE
          GUID of folder "Replication Base"
        • GUID_SAP_SMART_LINK
          String GUID_SAP_SMART_LINK
          GUID of folder "/Administration/Smart Link Base", used for SAP integration
          Since:
          12.00.000.051
        • GUID_SCRIPTING_BASE
          String GUID_SCRIPTING_BASE
          GUID of folder "Scripting Base"
        • GUID_SPACE_ADMINISTRATION_FOLDER
          String GUID_SPACE_ADMINISTRATION_FOLDER
          GUID of administration folder for spaces. EIX-2987
          Since:
          21.03.000.010
        • GUID_SPACE_BASE_FOLDER
          String GUID_SPACE_BASE_FOLDER
          GUID of base folder for spaces. EIX-2987
          Since:
          21.03.000.010
        • GUID_TEAMROOM_BASE_FOLDER
          String GUID_TEAMROOM_BASE_FOLDER
          Deprecated.
          (use SordC.GUID_SPACE_BASE_FOLDER instead)
          GUID of base folder for team room folders. EIX-2138
          Since:
          21.00.000.013
        • GUID_TEXTREADER_FOLDER
          String GUID_TEXTREADER_FOLDER
          Object-GUID of ELO Textreader folder.
          Since:
          9.00.016.019
        • GUID_TRNOTCONV_FOLDER
          String GUID_TRNOTCONV_FOLDER
          Object-GUID of ELO Textreader not converted documents folder.
          Since:
          9.00.016.019
        • GUID_USERS_FOLDER
          String GUID_USERS_FOLDER
          Object-GUID of users folder.
          Since:
          9.00.000.011
        • GUID_WFNODE_ICON_BEGINNODE
          String GUID_WFNODE_ICON_BEGINNODE
          Object-GUID of icon file for begin node.
          Since:
          7.00.040.012
          See Also:
        • GUID_WFNODE_ICON_COLLECTNODE
          String GUID_WFNODE_ICON_COLLECTNODE
          Object-GUID of icon file for collect node.
          Since:
          7.00.040.012
          See Also:
        • GUID_WFNODE_ICON_CYCLE_BEGIN
          String GUID_WFNODE_ICON_CYCLE_BEGIN
          Object-GUID of icon file for cycle node.
          Since:
          7.00.040.012
          See Also:
        • GUID_WFNODE_ICON_CYCLE_END
          String GUID_WFNODE_ICON_CYCLE_END
          Object-GUID of icon file for cycle node.
          Since:
          7.00.040.012
          See Also:
        • GUID_WFNODE_ICON_IFNODE
          String GUID_WFNODE_ICON_IFNODE
          Object-GUID of icon file for decision node.
          Since:
          7.00.040.012
          See Also:
        • GUID_WFNODE_ICON_PERSONNODE
          String GUID_WFNODE_ICON_PERSONNODE
          Object-GUID of icon file for person node.
          Since:
          7.00.040.012
          See Also:
        • GUID_WFNODE_ICON_PLUGINNODE
          String GUID_WFNODE_ICON_PLUGINNODE
          Object-GUID of icon file for plugin node. This node is intended to trigger external events or to address external systems. OnEnter is handled synchronously. It waits for a result of the event. OnExit is handled asynchronously. The WF continues without waiting for the event. DB transaction is terminated before OnEnter is executed.
          Since:
          21.03.000.009
          See Also:
        • GUID_WFNODE_ICON_SET_SERVER_ID
          String GUID_WFNODE_ICON_SET_SERVER_ID
          Object-GUID of icon file for server node.
          Since:
          7.00.040.012
          See Also:
        • GUID_WFNODE_ICON_SPLITNODE
          String GUID_WFNODE_ICON_SPLITNODE
          Object-GUID of icon file for split node.
          Since:
          7.00.040.012
          See Also:
        • GUID_WFNODE_ICON_TERMINATE
          String GUID_WFNODE_ICON_TERMINATE
          reserved
          Since:
          7.00.040.012
        • GUID_WIN_SCRIPTING_BASE
          String GUID_WIN_SCRIPTING_BASE
          Archive folder /Administration/ELOscripts, VB scripts for Windows Client.
          Since:
          7.00.022.003
        • GUID_WORKFLOW_ICONS_BASE
          String GUID_WORKFLOW_ICONS_BASE
          Archive folder that contains the icons for the workflow nodes.
          Since:
          7.00.040.012
          See Also:
        • lnDesc
          int lnDesc
          Length of description + hidden text
    • Class de.elo.ix.client.SordDetails

      class SordDetails extends ValueClass implements Serializable
      serialVersionUID:
      1713693326L
      • Serialized Fields

        • archivingMode
          int archivingMode
          Archiving mode.
          The possible values are
          version controlled ArchivingModeC.VERSION
          read-only ArchivingModeC.READONLY
          read/write ArchivingModeC.READWRITE
          This value is only valid for document objects.
          See Also:
        • arcReplEnabled
          boolean arcReplEnabled
          True, if replication is enabled for this archive.
        • documentContainer
          boolean documentContainer
          Folders can be marked as a document container by this flag. If true, clients are advised to preview the first document in this folder on selection.
          Since:
          9.00.018.004
        • encryptionSet
          int encryptionSet
          Encryption set number.
        • fulltext
          boolean fulltext
          Document is or should be containted in the fultext database.
        • fulltextDone
          boolean fulltextDone
          Document is indexed in the fultext database.
        • incomplete
          boolean incomplete
          True, if a document or attachment version has been deleted.
          Since:
          8.00.026.001
        • inheritAclDisabled
          boolean inheritAclDisabled
          Do not inherit permissions from parent Sord.
          Since:
          11.00.000.055
        • limitedReleaseDocument
          boolean limitedReleaseDocument
          Documents using this mask may be used as release notes
          Since:
          8.00.032.007
        • linked
          boolean linked
          True, if this object has links to other Sords. This member is read-only and is ignored in checkinSord and checkinDocEnd.
          Since:
          7.00.000.046
          See Also:
        • linkedPermanent
          boolean linkedPermanent
          True, if this object has permanent links to other Sords. This member is read-only and is ignored in checkinSord and checkinDocEnd.
          Since:
          9.00.016.008
          See Also:
        • region
          boolean region
          If this sord is a folder, it establishes a region within the repository tree.
          This flag is only valid for sords with a mask of data organisation DocMaskC.DATA_ORGANISATION_ASPECT.
          Since:
          21.04.000.003
        • replRoot
          boolean replRoot
          True, if this object is a root folder for replication.
        • sortOrder
          int sortOrder
          Sort order of child entries. This value is only valid for folder objects.
          See Also:
        • translateSordName
          boolean translateSordName
          If true translate the sord's short description into or from the user language.
          Since:
          9.00.030.013
        • workspace
          boolean workspace
          If true the sord is a workspace folder.
          Since:
          21.00.000.015
    • Class de.elo.ix.client.SordHist

      class SordHist extends ValueClass implements Serializable
      serialVersionUID:
      2121567102L
      • Serialized Fields

        • aspectObjects
          Map<String,List<Map<String,IndexValue>>> aspectObjects
          Index values. This member is only valid, if the associated keywording form is organized as DocMask.dataOrganisation = DocMaskC.DATA_ORGANISATION_ASPECT.
          .
          Since:
          21.00.000.017
        • histGuid
          String histGuid
          GUID of the SordHist object.
        • histKeys
          SordHistKey[] histKeys
          An array of the keywording changes.
        • histSource
          int histSource
          Identifies the application with which changes were made to the keywording.
        • objGuid
          String objGuid
          GUID of the sord object.
        • timeStampLocal
          String timeStampLocal
          Timestamp of the change in the timezone of the client. The format is JJJJ.MM.DD.hh.mm.ss
        • timeStampUTC
          String timeStampUTC
          Timestamp of the change in the timezone of the client, in UTC form. The format is JJJJ.MM.DD.hh.mm.ss
        • userName
          String userName
          The name of the user who carried out the changes.
        • userNo
          int userNo
          The user who carried out the changes.
        • workStation
          String workStation
          The name of the computer from which the change was carried out. This is the parameter clientComputer which is provided by the ix.login function.
    • Class de.elo.ix.client.SordHistC

      class SordHistC extends ObjHistC implements Serializable
      serialVersionUID:
      520610723L
    • Class de.elo.ix.client.SordHistKey

      class SordHistKey extends ValueClass implements Serializable
      serialVersionUID:
      251810638L
      • Serialized Fields

        • histGuid
          String histGuid
          GUID of the assigned SordHist object.
        • keyData
          String keyData
          Value of dat of the attribute.
        • keyId
          int keyId
          External ID of the attribute, serves as an identifier for keyNames.
          Since:
          8.00.032.007
        • keyIndex
          int keyIndex
          Index of the attribute within an array of attributes.
          Since:
          8.00.032.007
        • keyName
          String keyName
          Name of the attribute.
        • keyNo
          int keyNo
          ID of the attribute.
    • Class de.elo.ix.client.SordHistKeyC

      class SordHistKeyC extends ObjHistKeyC implements Serializable
      serialVersionUID:
      762601968L
    • Class de.elo.ix.client.SordLinkC

      class SordLinkC extends ObjLinkC implements Serializable
      serialVersionUID:
      -6818073964723000259L
    • Class de.elo.ix.client.SordPath

      class SordPath extends Object implements Serializable
      serialVersionUID:
      7034751181901132469L
      • Serialized Fields

    • Class de.elo.ix.client.SordPaths

      class SordPaths extends Object implements Serializable
      serialVersionUID:
      3784557962813828950L
    • Class de.elo.ix.client.SordType

      class SordType extends ValueClass implements Serializable
      serialVersionUID:
      2065094749L
      • Serialized Fields

        • disabledIcon
          FileData disabledIcon
          File data of disabled icon.
        • extensions
          String[] extensions
          For document types, this array lists the associated file extensions.
        • guid
          String guid
          GUID of SordType EIX-2032
          Since:
          21.00.000.011
        • icon
          FileData icon
          File data of normal icon.
        • id
          int id
          Sord type ID.
        • name
          String name
          Type name.
        • packageName
          String packageName
          Package name of SordType
          Since:
          20.00.000.009
        • workflowIcon
          FileData workflowIcon
          File data of workflow icon.
    • Class de.elo.ix.client.SordTypeC

      class SordTypeC extends Object implements Serializable
      serialVersionUID:
      635922924L
      • Serialized Fields

        • GUID_ACCESS
          String GUID_ACCESS
          access
          Since:
          21.00.000.011
        • GUID_ADRESSE
          String GUID_ADRESSE
          adresse
          Since:
          21.00.000.011
        • GUID_AKTEN_SCHUBLADE
          String GUID_AKTEN_SCHUBLADE
          akten_schublade
          Since:
          21.00.000.011
        • GUID_AKTEN_SCHUBLADE_ROT
          String GUID_AKTEN_SCHUBLADE_ROT
          akten_schublade_rot
          Since:
          21.00.000.011
        • GUID_AKTENKOFFER
          String GUID_AKTENKOFFER
          aktenkoffer
          Since:
          21.00.000.011
        • GUID_AKTIVITAETEN
          String GUID_AKTIVITAETEN
          aktivitaeten
          Since:
          21.00.000.011
        • GUID_AUDIO
          String GUID_AUDIO
          audio
          Since:
          21.00.000.011
        • GUID_AUFTRAGSBEARBEITUNG
          String GUID_AUFTRAGSBEARBEITUNG
          auftragsbearbeitung
          Since:
          21.00.000.011
        • GUID_AUTOCAD_DWF
          String GUID_AUTOCAD_DWF
          autocad_dwf
          Since:
          21.00.000.011
        • GUID_AUTOCAD_DWG
          String GUID_AUTOCAD_DWG
          autocad_dwg
          Since:
          21.00.000.011
        • GUID_AUTOCAD_DXF
          String GUID_AUTOCAD_DXF
          autocad_dxf
          Since:
          21.00.000.011
        • GUID_BESUCHSBERICHTE
          String GUID_BESUCHSBERICHTE
          besuchsberichte
          Since:
          21.00.000.011
        • GUID_BILD
          String GUID_BILD
          bild
          Since:
          21.00.000.011
        • GUID_BMP
          String GUID_BMP
          bmp
          Since:
          21.00.000.011
        • GUID_CALC
          String GUID_CALC
          calc
          Since:
          21.00.000.011
        • GUID_CHM_HILFE
          String GUID_CHM_HILFE
          chm_hilfe
          Since:
          21.00.000.011
        • GUID_DOKUMENT
          String GUID_DOKUMENT
          dokument
          Since:
          21.00.000.011
        • GUID_DRAW
          String GUID_DRAW
          draw
          Since:
          21.00.000.011
        • GUID_EBENE_32
          String GUID_EBENE_32
          ebene_32
          Since:
          21.00.000.011
        • GUID_EBENE_4
          String GUID_EBENE_4
          ebene_4
          Since:
          21.00.000.011
        • GUID_EBENE_5
          String GUID_EBENE_5
          ebene_5
          Since:
          21.00.000.011
        • GUID_EBENE_6
          String GUID_EBENE_6
          ebene_6
          Since:
          21.00.000.011
        • GUID_EINZELPERSON
          String GUID_EINZELPERSON
          einzelperson
          Since:
          21.00.000.011
        • GUID_EMAIL
          String GUID_EMAIL
          EMAIL
          Since:
          21.00.000.011
        • GUID_EXCEL
          String GUID_EXCEL
          excel
          Since:
          21.00.000.011
        • GUID_FIRMA
          String GUID_FIRMA
          firma
          Since:
          21.00.000.011
        • GUID_FORMULARORDNER
          String GUID_FORMULARORDNER
          formularordner
          Since:
          21.00.000.011
        • GUID_GIF
          String GUID_GIF
          gif
          Since:
          21.00.000.011
        • GUID_IMPRESS
          String GUID_IMPRESS
          impress
          Since:
          21.00.000.011
        • GUID_JAVASCRIPT
          String GUID_JAVASCRIPT
          javascript
          Since:
          21.00.000.011
        • GUID_KUNDEN
          String GUID_KUNDEN
          kunden
          Since:
          21.00.000.011
        • GUID_KUNDENGRUPPE
          String GUID_KUNDENGRUPPE
          kundengruppe
          Since:
          21.00.000.011
        • GUID_ORDNER
          String GUID_ORDNER
          ordner
          Since:
          21.00.000.011
        • GUID_ORDNER_BLAU
          String GUID_ORDNER_BLAU
          ordner_blau
          Since:
          21.00.000.011
        • GUID_ORDNER_GELB
          String GUID_ORDNER_GELB
          ordner_gelb
          Since:
          21.00.000.011
        • GUID_ORDNER_GRUEN
          String GUID_ORDNER_GRUEN
          ordner_gruen
          Since:
          21.00.000.011
        • GUID_ORDNER_ROT
          String GUID_ORDNER_ROT
          ordner_rot
          Since:
          21.00.000.011
        • GUID_PDF
          String GUID_PDF
          pdf
          Since:
          21.00.000.011
        • GUID_PNG
          String GUID_PNG
          png
          Since:
          21.00.000.011
        • GUID_POWERPOINT
          String GUID_POWERPOINT
          powerpoint
          Since:
          21.00.000.011
        • GUID_PROJEKTARBEIT
          String GUID_PROJEKTARBEIT
          projektarbeit
          Since:
          21.00.000.011
        • GUID_REGISTER
          String GUID_REGISTER
          register
          Since:
          21.00.000.011
        • GUID_REGISTER_BLAU
          String GUID_REGISTER_BLAU
          register_blau
          Since:
          21.00.000.011
        • GUID_REGISTER_GELB
          String GUID_REGISTER_GELB
          register_gelb
          Since:
          21.00.000.011
        • GUID_REGISTER_GRUEN
          String GUID_REGISTER_GRUEN
          register_gruen
          Since:
          21.00.000.011
        • GUID_REGISTER_ROT
          String GUID_REGISTER_ROT
          register_rot
          Since:
          21.00.000.011
        • GUID_SCAN_DOKUMENT
          String GUID_SCAN_DOKUMENT
          scan_dokument
          Since:
          21.00.000.011
        • GUID_SCHRANK
          String GUID_SCHRANK
          schrank
          Since:
          21.00.000.011
        • GUID_SCHRIFTVERKEHR
          String GUID_SCHRIFTVERKEHR
          schriftverkehr
          Since:
          21.00.000.011
        • GUID_SUPPORT
          String GUID_SUPPORT
          support
          Since:
          21.00.000.011
        • GUID_TELEFON
          String GUID_TELEFON
          telefon
          Since:
          21.00.000.011
        • GUID_TXT
          String GUID_TXT
          txt
          Since:
          21.00.000.011
        • GUID_VIDEO
          String GUID_VIDEO
          video
          Since:
          21.00.000.011
        • GUID_VISIO
          String GUID_VISIO
          visio
          Since:
          21.00.000.011
        • GUID_WEB_ARCHIV
          String GUID_WEB_ARCHIV
          web_archiv
          Since:
          21.00.000.011
        • GUID_WEB_DOKUMENT
          String GUID_WEB_DOKUMENT
          web_dokument
          Since:
          21.00.000.011
        • GUID_WORD
          String GUID_WORD
          word
          Since:
          21.00.000.011
        • GUID_WORKFLOWORDNER
          String GUID_WORKFLOWORDNER
          workflowordner
          Since:
          21.00.000.011
        • GUID_WRITER
          String GUID_WRITER
          writer
          Since:
          21.00.000.011
        • GUID_XML
          String GUID_XML
          xml
          Since:
          21.00.000.011
        • GUID_ZIP
          String GUID_ZIP
          zip
          Since:
          21.00.000.011
    • Class de.elo.ix.client.SordTypeDataC

      class SordTypeDataC extends Object implements Serializable
      serialVersionUID:
      1015823617L
      • Serialized Fields

        • lnExtensions
          int lnExtensions
          DB column: extensions
        • lnGuid
          int lnGuid
          Column length: GUID of SordType EIX-2032 DB column: guid
          Since:
          21.00.000.011
        • lnName
          int lnName
          DB column: name
        • lnPackageName
          int lnPackageName
          Column length: Package name of SordType DB column: packagename
          Since:
          20.00.000.009
    • Class de.elo.ix.client.SordTypeZ

      class SordTypeZ extends ValueClass implements Serializable
      serialVersionUID:
      314474107L
      • Serialized Fields

        • bset
          long bset
          Bitset field for constants from SordTypeC class.
    • Class de.elo.ix.client.SordZ

      class SordZ extends ValueClass implements Serializable
      serialVersionUID:
      1441094282L
      • Serialized Fields

        • bset
          long bset
          Bitset field for constants from SordC class.
    • Class de.elo.ix.client.SortOrderC

      class SortOrderC extends Object implements Serializable
      serialVersionUID:
      1551556842L
    • Class de.elo.ix.client.StartAdHocWorkflowInfo

      class StartAdHocWorkflowInfo extends Object implements Serializable
      serialVersionUID:
      1587514612L
      • Serialized Fields

        • acceptMessage
          String acceptMessage
          This message is shown if the workflow is accepted by a person.
          Since:
          9.00.012.006
        • actionRejectMessage
          String actionRejectMessage
          This message is shown if the workflow is rejected.
          Since:
          9.00.014.006
        • breakWorkflowMessage
          String breakWorkflowMessage
          This message is send to the user who started the workflow if the workflow is canceled.
        • cancelMessage
          String cancelMessage
          The message that is send to the user specified with cancelUserId, if the workflow is canceled.
        • cancelUserId
          String cancelUserId
          If the workflow is canceled, this user receives a message, cancelMessage.
        • deactivateNodes
          boolean deactivateNodes
          If true, all person nodes are deactivated when the workflow is canceled. This option is only used for "parallel for validation" workflow. Otherwise this option is ignored.
          Since:
          9.00.012.004
        • finishedMessage
          String finishedMessage
          The message that is send to the user specified with finishedUserId, if the workflow is finished.
        • finishedScript
          String finishedScript
          This script is executed, when the workflow is finished.
        • finishedUserId
          String finishedUserId
          If the workflow is finished, this user receives a message, finishedMessage.
        • flags
          int flags
          Control flags for the node, a combination of WFNode.C.FLAG_* constants.
          Since:
          9.00.016.013
        • forValidation
          boolean forValidation
          If true, the workflow comes back to the user who started it.
        • nodeInfos
          List<ValueClass> nodeInfos
          The information of all nodes in the workflow.
          Since:
          10.00.000.008
        • nodeName
          String nodeName
          Start node name.
        • noticeMessage
          String noticeMessage
          This message is shown if the a person was informed about the workflow.
          Since:
          9.00.012.006
        • serialFlow
          boolean 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.
        • successMessage
          String successMessage
          This message is shown if the workflow is successfully processed.
          Since:
          9.00.014.006
        • timeLimit
          WFTimeLimit timeLimit
          Time-limit for the entire workflow.
          Since:
          9.00.016.009
          See Also:
        • timeLimitEscalations
          WFTimeLimit[] timeLimitEscalations
          Additional definitions for time limits.
          Since:
          9.00.016.009
          See Also:
        • userIdsToDeactivate
          String[] userIdsToDeactivate
          The list of the person nodes to be deactivated when the workflow is canceled. This option is only used for "parallel for validation" workflow. Otherwise this option is ignored.
          Since:
          9.00.012.004
        • workflowRepeatMessage
          String workflowRepeatMessage
          This message is send to the user who started the workflow if the workflow is repeated.
    • Class de.elo.ix.client.StartWorkflowInfo

      class StartWorkflowInfo extends ValueClass implements Serializable
      serialVersionUID:
      -3052800687290582950L
      • Serialized Fields

        • flowName
          String flowName
          Name of the new workflow.
        • flowOwner
          String flowOwner
          The flow owner ID.
        • templFlowId
          String templFlowId
          Name or ID of the workflow template.
    • Class de.elo.ix.client.StoreInfo

      class StoreInfo extends ValueClass implements Serializable
      serialVersionUID:
      964052256L
      • Serialized Fields

        • accessKey
          String accessKey
          AccessKey for Cloud Storage.
          Since:
          12.00.000.017
        • bucket
          String bucket
          Bucket name for Cloud Storage. Bucket names must be unique across all existing bucket names in Amazon S3.
          Since:
          12.00.000.032
        • cloudType
          int cloudType
          Type of Cloud Storage.
          Since:
          12.00.000.017
          See Also:
        • createDateISO
          String createDateISO
          Create date (UTC).
        • dir
          String dir
          Physical directory where the documents of this path are stored. Length of the field in database: 255byte.
        • encryptionKey
          String encryptionKey
          Encryption key for Cloud Storage.
          Since:
          12.00.000.050
        • endpoint
          String endpoint
          Endpoint (URL/IP/PORT) for Cloud Storage.
          Since:
          12.00.000.017
        • flags
          int flags
          Bitset of options.
          See Also:
        • fulltextDir
          String fulltextDir
          Physical directory where fulltext content is stored. Length of the field in database: 255byte.
          Since:
          8.00.010.001
        • id
          int id
          Path ID Set this value to -1 in order to create a new storage path.
        • name
          String name
          Path name. Length of the field in database: 16byte.
        • previewDir
          String previewDir
          Physical directory where previews stored. Length of the field in database: 255byte.
          Since:
          8.00.010.001
        • region
          String region
          Region for Amazon S3 Cloud Storage.
          Since:
          12.00.000.034
        • retentionMode
          int retentionMode
          RetentionMode for S3 Storage
          Since:
          21.2.0.8
        • scatter
          int scatter
          Granularity of subdirectories in the physical directory.
          See Also:
        • secretKey
          String secretKey
          SecretKey for Cloud Storage.
          Since:
          12.00.000.017
        • stdPath
          boolean stdPath
          standard path? read-only
        • updateDateISO
          String updateDateISO
          Update date (UTC).
    • Class de.elo.ix.client.StoreInfoC

      class StoreInfoC extends Object implements Serializable
      serialVersionUID:
      979653235L
    • Class de.elo.ix.client.Subscription

      class Subscription extends ValueClass implements Serializable
      serialVersionUID:
      2536688192355431591L
    • Class de.elo.ix.client.SubscriptionC

      class SubscriptionC extends SubscriptionDataC implements Serializable
      serialVersionUID:
      -2366745718638255267L
    • Class de.elo.ix.client.SubscriptionDataC

      class SubscriptionDataC extends Object implements Serializable
      serialVersionUID:
      1152087606L
      • Serialized Fields

        • lnCreateDateIso
          int lnCreateDateIso
          Column length: Create date of the subscription. DB column: createdateiso
        • lnUserGuid
          int lnUserGuid
          Column length: GUID of user who registered the subscription. DB column: userguid
        • lnWatchGuid
          int lnWatchGuid
          Column length: GUID of Object to be watched. DB column: watchguid
    • Class de.elo.ix.client.SubscriptionZ

      class SubscriptionZ extends Object implements Serializable
      serialVersionUID:
      956445237847304856L
      • Serialized Fields

        • bset
          long bset
          Bitset field for constants from the SubscriptionC class.
    • Class de.elo.ix.client.SubsInfo

      class SubsInfo extends ValueClass implements Serializable
      serialVersionUID:
      1910142939L
      • Serialized Fields

        • active
          boolean active
          Deprecated.
          The deputy relationship is applied if this member is true. If false, the deputy does not currently act as the user but may activate the relationship by themself.
        • inheritRights
          boolean inheritRights
          Deprecated.
          The deputy inherits the rights of the user if this member is true.
        • subsId
          int subsId
          Deprecated.
          Deputy: the user that deputizes userId.
        • subsName
          String subsName
          Deprecated.
          Deputy name. If this member is set subsId is ignored.
        • userId
          int userId
          Deprecated.
          The user that is being deputized by subsId
        • userName
          String userName
          Deprecated.
          User name. If this member is set userId is ignored.
    • Class de.elo.ix.client.Thesaurus

      class Thesaurus extends ValueClass implements Serializable
      serialVersionUID:
      1664944753L
      • Serialized Fields

        • compare
          String compare
          DB column: compare
        • data
          String data
          DB column: data
        • groupId
          int groupId
          DB column: groupid
        • listId
          int listId
          DB column: listid
        • prio
          int prio
          DB column: prio
    • Class de.elo.ix.client.ThesaurusC

      class ThesaurusC extends Object implements Serializable
      serialVersionUID:
      670698541L
      • Serialized Fields

        • lnCompare
          int lnCompare
          DB column: compare
        • lnData
          int lnData
          DB column: data
    • Class de.elo.ix.client.TranslateTerm

      class TranslateTerm extends ValueClass implements Serializable
      serialVersionUID:
      356302605L
      • Serialized Fields

        • deleted
          boolean deleted
          True, if this entry is logically deleted.
        • guid
          String guid
          GUID
        • langs
          String[] langs
          The languages of the terms in termLangs. Each of the items have to be a language tag of a registered language. Otherwise, the corresponding term in TranslateTerm.termLangs is ignored in IXServicePortIF.checkinTranslateTerms(ClientInfo, TranslateTerm[], LockZ). The constant TranslateTermC.DEFAULT_LANGUAGES contains the initially registered languages.

          To read all registered Languages:

           
           TranslateTerm ttR = conn.ix().checkoutTranslateTerms(new String[] {TranslateTermC.GUID_SYSTEM_LANGUAGES}, LockC.NO)[0];
           String[] langs = ttR.getLangs();
           
           

          The List of registered languages can be overwritten by:

           
           TranslateTerm tt = new TranslateTerm();
           tt.setGuid( TranslateTermC.GUID_SYSTEM_LANGUAGES );
           tt.setLangs( langs );
           conn.ix().checkinTranslateTerms( new TranslateTerm[] {tt}, LockC.NO );
           
           
          In an array of TranslateTerm objects returned in FindResult or returned by checkoutTranslateTerm, all objects share the same array langs.
          See Also:
        • level
          int level
          Priority level of this entry.
          Since:
          21.02.000.005
        • packageName
          String packageName
          Configuration package.
          Since:
          21.02.000.005
        • termLangs
          String[] termLangs
          Term in its languages. The Term termLangs[i] is in Language langs[i]. If a translation does not exist, the corresponding termLangs[.] is an empty string.
          See Also:
        • translationKey
          String translationKey
          Optional language independent translation key. This value must match the regular expression TranslateTermC.TRANSLATION_KEY_REGEX.
          Since:
          9.00.018.008
        • tStamp
          String tStamp
          Last modified. ISO date with seaparator "." measured in UTC.
        • tStampSync
          String tStampSync
          Timestamp of this object's last export by the replication.
          Since:
          9.99.009.001
    • Class de.elo.ix.client.TranslateTermC

      class TranslateTermC extends Object implements Serializable
      serialVersionUID:
      1212336284L
      • Serialized Fields

        • lnTermLang
          int lnTermLang
          Maximum term length;
    • Class de.elo.ix.client.TranslateTermData

      class TranslateTermData extends ValueClass implements Serializable
      serialVersionUID:
      486835904L
      • Serialized Fields

        • guid
          String guid
          GUID
        • lang1
          String lang1
          Language 1. System language.
        • lang10
          String lang10
          Language 10
          Since:
          21.04.000.006
        • lang11
          String lang11
          Language 11
          Since:
          21.04.000.006
        • lang12
          String lang12
          Language 12
          Since:
          21.04.000.006
        • lang13
          String lang13
          Language 13
          Since:
          21.04.000.006
        • lang14
          String lang14
          Language 14
          Since:
          21.04.000.006
        • lang15
          String lang15
          Language 15
          Since:
          21.04.000.006
        • lang16
          String lang16
          Language 16
          Since:
          21.04.000.006
        • lang17
          String lang17
          Language 17
          Since:
          21.04.000.006
        • lang18
          String lang18
          Language 18
          Since:
          21.04.000.006
        • lang19
          String lang19
          Language 19
          Since:
          21.04.000.006
        • lang2
          String lang2
          Language 2
        • lang20
          String lang20
          Language 20
          Since:
          21.04.000.006
        • lang21
          String lang21
          Language 21
          Since:
          21.04.000.006
        • lang22
          String lang22
          Language 22
          Since:
          21.04.000.006
        • lang23
          String lang23
          Language 23
          Since:
          21.04.000.006
        • lang24
          String lang24
          Language 24
          Since:
          21.04.000.006
        • lang25
          String lang25
          Language 25
          Since:
          21.04.000.006
        • lang26
          String lang26
          Language 26
          Since:
          21.04.000.006
        • lang27
          String lang27
          Language 27
          Since:
          21.04.000.006
        • lang28
          String lang28
          Language 28
          Since:
          21.04.000.006
        • lang29
          String lang29
          Language 29
          Since:
          21.04.000.006
        • lang3
          String lang3
          Language 3
        • lang30
          String lang30
          Language 30
          Since:
          21.04.000.006
        • lang4
          String lang4
          Language 4
        • lang5
          String lang5
          Language 5
        • lang6
          String lang6
          Language 6
        • lang7
          String lang7
          Language 7
        • lang8
          String lang8
          Language 8
        • lang9
          String lang9
          Language 9
        • level
          int level
          Priority level of this entry.
          Since:
          21.02.000.005
        • packageName
          String packageName
          Configuration package.
          Since:
          21.02.000.005
        • status
          int status
          Status. The object is not deleted, if status is -1.
        • translationKey
          String translationKey
          Language independent translation key.
          Since:
          21.02.000.005
        • TStamp
          String TStamp
          Timestamp. Last mofified time, ISO date with dots measured in UTC The format is JJJJ.MM.DD.hh.mm.ss
        • TStampSync
          String TStampSync
          Timestamp. Timestamp of this object's last export by the replication. The format is JJJJ.MM.DD.hh.mm.ss
          Since:
          9.99.009.001
    • Class de.elo.ix.client.TranslateTermDataC

      class TranslateTermDataC extends Object implements Serializable
      serialVersionUID:
      1699470707L
      • Serialized Fields

        • lnGuid
          int lnGuid
          Column length: GUID DB column: guid
        • lnLang1
          int lnLang1
          Column length: Language 1. System language. DB column: lang1
        • lnLang10
          int lnLang10
          Column length: Language 10 DB column: lang10
          Since:
          21.04.000.006
        • lnLang11
          int lnLang11
          Column length: Language 11 DB column: lang11
          Since:
          21.04.000.006
        • lnLang12
          int lnLang12
          Column length: Language 12 DB column: lang12
          Since:
          21.04.000.006
        • lnLang13
          int lnLang13
          Column length: Language 13 DB column: lang13
          Since:
          21.04.000.006
        • lnLang14
          int lnLang14
          Column length: Language 14 DB column: lang14
          Since:
          21.04.000.006
        • lnLang15
          int lnLang15
          Column length: Language 15 DB column: lang15
          Since:
          21.04.000.006
        • lnLang16
          int lnLang16
          Column length: Language 16 DB column: lang16
          Since:
          21.04.000.006
        • lnLang17
          int lnLang17
          Column length: Language 17 DB column: lang17
          Since:
          21.04.000.006
        • lnLang18
          int lnLang18
          Column length: Language 18 DB column: lang18
          Since:
          21.04.000.006
        • lnLang19
          int lnLang19
          Column length: Language 19 DB column: lang19
          Since:
          21.04.000.006
        • lnLang2
          int lnLang2
          Column length: Language 2 DB column: lang2
        • lnLang20
          int lnLang20
          Column length: Language 20 DB column: lang20
          Since:
          21.04.000.006
        • lnLang21
          int lnLang21
          Column length: Language 21 DB column: lang21
          Since:
          21.04.000.006
        • lnLang22
          int lnLang22
          Column length: Language 22 DB column: lang22
          Since:
          21.04.000.006
        • lnLang23
          int lnLang23
          Column length: Language 23 DB column: lang23
          Since:
          21.04.000.006
        • lnLang24
          int lnLang24
          Column length: Language 24 DB column: lang24
          Since:
          21.04.000.006
        • lnLang25
          int lnLang25
          Column length: Language 25 DB column: lang25
          Since:
          21.04.000.006
        • lnLang26
          int lnLang26
          Column length: Language 26 DB column: lang26
          Since:
          21.04.000.006
        • lnLang27
          int lnLang27
          Column length: Language 27 DB column: lang27
          Since:
          21.04.000.006
        • lnLang28
          int lnLang28
          Column length: Language 28 DB column: lang28
          Since:
          21.04.000.006
        • lnLang29
          int lnLang29
          Column length: Language 29 DB column: lang29
          Since:
          21.04.000.006
        • lnLang3
          int lnLang3
          Column length: Language 3 DB column: lang3
        • lnLang30
          int lnLang30
          Column length: Language 30 DB column: lang30
          Since:
          21.04.000.006
        • lnLang4
          int lnLang4
          Column length: Language 4 DB column: lang4
        • lnLang5
          int lnLang5
          Column length: Language 5 DB column: lang5
        • lnLang6
          int lnLang6
          Column length: Language 6 DB column: lang6
        • lnLang7
          int lnLang7
          Column length: Language 7 DB column: lang7
        • lnLang8
          int lnLang8
          Column length: Language 8 DB column: lang8
        • lnLang9
          int lnLang9
          Column length: Language 9 DB column: lang9
        • lnPackageName
          int lnPackageName
          Column length: Configuration package. DB column: pack
          Since:
          21.02.000.005
        • lnTranslationKey
          int lnTranslationKey
          Column length: Language independent translation key. DB column: trankey
          Since:
          21.02.000.005
        • lnTStamp
          int lnTStamp
          Column length: Timestamp. Last mofified time, ISO date with dots measured in UTC The format is DB column: tstamp
        • lnTStampSync
          int lnTStampSync
          Column length: Timestamp. Timestamp of this object's last export by the replication. The format is DB column: tstampsync
          Since:
          9.99.009.001
    • Exception de.elo.ix.client.UncheckedRemoteException

      class UncheckedRemoteException extends RuntimeException implements Serializable
      serialVersionUID:
      -5091977804897086219L
    • Class de.elo.ix.client.UrlParams

      class UrlParams extends ValueClass implements Serializable
      serialVersionUID:
      2007960901L
      • Serialized Fields

        • highlightTerms
          String highlightTerms
          Highlight this terms. This value is only valid for fulltext URLs. Many terms have to be separated by space character. Each term is enclosed in the HTML tags <b> term </b>
        • length
          long length
          Download only length bytes from the resource. Set this value to 0, if all bytes should be read.
        • offset
          long offset
          Download bytes beginning from this offset.
    • Class de.elo.ix.client.UserInfo

      class UserInfo extends ValueClass implements Serializable
      serialVersionUID:
      1485735592L
      • Serialized Fields

        • availableRoles
          List<UserName> availableRoles
          The user can activate this roles.
          Since:
          20.00.000.003
        • desc
          String desc
          User description.
        • flags
          int flags
          User rights. Possible values are combinations of AccessC.FLAG_* constants.
          See Also:
        • flags2
          int flags2
          Second bitset of user rights.
          Since:
          7.00.040.017
          See Also:
        • groupList
          int[] groupList
          The groups the user is a member of.

          It contains all groups the user inherits the rights because of active substitutions (groups which are set in Substitution.groupsToInheritRights).

          See Also:
        • guid
          String guid
          GUID
          Since:
          7.00.000.012
        • id
          int id
          User identifier
        • internalUser
          boolean internalUser
          The flag for a group which will not be removed by LDAP replication.
          Since:
          21.00.000.018
        • keylist
          int[] keylist
          Deprecated.
          User keys. Array of key access rights. Each item is a combination of the access constants AccessC.LUR_*. The key ID corresponds to the index of the key access item in the key array. A user owns a key, if at least one access constant is included in the key item. Keys do not distinguish between LUR_WRTE and LUR_LIST: LUR_WRITE implies LUR_LIST and v.v.
          See Also:
        • lastLoginIso
          String lastLoginIso
          Last login timestamp (in timezone UTC). This value is read-only and undefined for groups. Only the date part is valid.
          Since:
          7.00.040.011
        • ldapProperties
          Map<String,String> ldapProperties
          Reserved (LDAP user properties). Keys of this map named LDAP_PROP_* in class UserInfoC. All keys are lower case. Mandatory properties - For user: objectGUID, distinguishedName, displayName, sAMAccountName und UserPrincipalName - For group: objectGUID, distinguishedName, name und sAMAccountName
          Since:
          9.00.040.005
        • name
          String name
          User name
        • orgUnitIds
          int[] orgUnitIds
          Organisation unit IDs. A user or group can be assigned to at most one organization unit. But due to its group membership a user or group can actually belong to a list of organization units. When writing this UserInfo object, only the first organization unit in the array is taken into account. In order to remove the relationship, set an empty array.
          Since:
          9.00.000.009
        • packageName
          String packageName
          The package name of UserInfo
          Since:
          20.00.000.009
        • parent
          int parent
          User ID of the users parent (users adminstrator).
        • pwd
          String pwd
          User password
        • sessions
          SessionInfo[] sessions
          The currently active tickets for the user
        • superiorId
          int superiorId
          ID of the users superior. If the user does not have a superior, this value is equal to id.
          Since:
          7.00.040.017
        • tStamp
          String tStamp
          Timestamp The format is JJJJ.MM.DD.hh.mm.ss
          Since:
          7.00.000.013
        • tStampSync
          String tStampSync
          Timestamp of this object's last export by the replication.
          Since:
          12.01.001.000
        • type
          int type
          User type. TYPE_USER for user, TYPE_GROUP for group.
          See Also:
        • userProps
          String[] userProps
          Reserved (Additional user properties). Index this array with constants named PROP_* in class UserInfoC.
          See Also:
        • workspaceInfo
          String workspaceInfo
          Workspace related data.
          Since:
          21.02.000.017
    • Class de.elo.ix.client.UserInfoC

      class UserInfoC extends Object implements Serializable
      serialVersionUID:
      703234555L
      • Serialized Fields

        • GUID_ADMINISTRATOR
          String GUID_ADMINISTRATOR
          GUID of main administrator
          Since:
          7.00.000.012
          See Also:
        • GUID_ELOSERVICE
          String GUID_ELOSERVICE
          GUID of the default service user.
          Since:
          11.00.000.011
        • GUID_EVERYONE_GROUP
          String GUID_EVERYONE_GROUP
          GUID of group "Everybody"
          Since:
          7.00.000.012
          See Also:
        • lnDesc
          int lnDesc
          Maximum user desc length
          Since:
          6.00.103.001
        • lnLdapPropKey
          int lnLdapPropKey
          Maximum length of LDAP property key.
          Since:
          10.17.010.008
        • lnLdapPropValue
          int lnLdapPropValue
          Maximum length of LDAP property value.
          Since:
          10.17.010.008
        • lnName
          int lnName
          Maximum user name length
          Since:
          6.00.103.001
        • lnPwd
          int lnPwd
          Maximum user password length
          Since:
          6.00.103.001
        • lnUserProp
          int lnUserProp
          Maximum user property length
          Since:
          6.00.103.001
    • Class de.elo.ix.client.UserName

      class UserName extends ValueClass implements Serializable
      serialVersionUID:
      123879203L
    • Class de.elo.ix.client.UserNodeInfo

      class UserNodeInfo extends ValueClass implements Serializable
      serialVersionUID:
      -1169785863433446845L
      • Serialized Fields

        • flags
          int flags
          Control flags for the node, a combination of WFNode.C.FLAG_* constants.
          Since:
          9.00.016.013
        • nodeName
          String nodeName
        • timeLimit
          int timeLimit
          The time-limit to process the node. This member is only valid for person nodes.
          Since:
          9.00.016.009
        • timeLimitEscalations
          WFTimeLimit[] timeLimitEscalations
          Additional definitions for time limits. This member is only valid for person nodes.
          Since:
          9.00.016.009
          See Also:
        • timeLimitIso
          String timeLimitIso
          After this date the node exceeds the time-limit for processing. This member is only valid for person nodes.
          Since:
          9.00.016.009
        • userId
          String userId
    • Class de.elo.ix.client.UserProfile

      class UserProfile extends ValueClass implements Serializable
      serialVersionUID:
      1401065069L
      • Serialized Fields

        • defaultOptions
          KeyValue[] defaultOptions
          Options as name-value-pairs. This array contains the default options valid for all users. Read-only.
          Since:
          8.00.010.001
          See Also:
        • excludeDefaultValues
          boolean excludeDefaultValues
          Do not read values for all users. Only valid for checkoutUserProfile.
          Since:
          7.00.040.014
        • excludeGroupValues
          boolean excludeGroupValues
          Do not read values of option groups. Only valid for checkoutUserProfile.
          Since:
          7.00.040.014
        • groupId
          int groupId
          The users option group ID. This value is -1, if the user is not member of an option group. Read-only.
          Since:
          8.00.010.001
        • groupOptions
          KeyValue[] groupOptions
          Options as name-value-pairs. This array contains the options defined for the users option group. Read-only.
          Since:
          8.00.010.001
          See Also:
        • includeAllGroupAndDefaultOptions
          boolean includeAllGroupAndDefaultOptions
          Include all group and default options. Set this member as true, if all group and default options shall be returned. If the value is false, only those options are returned that are not particularly defined for the user.
          Since:
          10.17.040.004
        • options
          KeyValue[] options
          Options as name-value-pairs. This array contains the sum of default options, group options and user options.
          See Also:
        • userId
          String userId
          The user name or UserProfileC.USERID_ALL, if the options for all users are represented by this object. The values null or empty are equal to UserProfileC.USERID_ALL.
        • userOptions
          KeyValue[] userOptions
          Options as name-value-pairs. This array contains the options defined for the given user. Read-only.
          Since:
          8.00.010.001
          See Also:
    • Class de.elo.ix.client.UserProfileC

      class UserProfileC extends Object implements Serializable
      serialVersionUID:
      1968434410L
      • Serialized Fields

        • lnKey
          int lnKey
          Maximum length of key
          Since:
          7.00.000.036
        • lnValue
          int lnValue
          Maximum length of value
          Since:
          7.00.000.036
    • Class de.elo.ix.client.UserProfileData

      class UserProfileData extends ValueClass implements Serializable
      serialVersionUID:
      2015395180L
      • Serialized Fields

        • key
          String key
          Option key. DB column: optkey
        • user
          int user
          User ID. DB column: userid
        • value
          String value
          Option value. DB column: optvalue
    • Class de.elo.ix.client.UserProfileDataC

      class UserProfileDataC extends Object implements Serializable
      serialVersionUID:
      466121473L
      • Serialized Fields

        • lnKey
          int lnKey
          DB column: optkey
        • lnValue
          int lnValue
          DB column: optvalue
    • Class de.elo.ix.client.UserTask

      class UserTask extends ValueClass implements Serializable
      serialVersionUID:
      1484696239L
    • Class de.elo.ix.client.UserTaskPriorityC

      class UserTaskPriorityC extends Object implements Serializable
      serialVersionUID:
      260320342L
    • Class de.elo.ix.client.UserTaskSortOrderC

      class UserTaskSortOrderC extends Object implements Serializable
      serialVersionUID:
      854117900L
    • Class de.elo.ix.client.UserTaskSortOrderZ

      class UserTaskSortOrderZ extends ValueClass implements Serializable
      serialVersionUID:
      1199296467L
      • Serialized Fields

        • bset
          long bset
          Bitset field for constants from the UserTaskSortOrderC class.
    • Class de.elo.ix.client.ValueClass

      class ValueClass extends byps.BValueClass implements Serializable
      serialVersionUID:
      5546698309440724814L
    • Class de.elo.ix.client.ValuesOfObjKey

      class ValuesOfObjKey extends Object implements Serializable
      serialVersionUID:
      1153931872L
      • Serialized Fields

        • totalCount
          int totalCount
          The sum of all usageCounts.
        • usageCounts
          int[] usageCounts
          For each entry values[i] the corresponding usageCount[i] tells how often the value is used.
        • values
          String[] values
          ObjKey values.
    • Class de.elo.ix.client.ValuesOfObjKeyOptions

      class ValuesOfObjKeyOptions extends ValueClass implements Serializable
      serialVersionUID:
      958310068L
    • Class de.elo.ix.client.VtDoc

      class VtDoc extends ValueClass implements Serializable
      serialVersionUID:
      1935852595L
      • Serialized Fields

        • code
          int code
          DB column: vtcode
        • docId
          int docId
          DB column: objdoc
        • objId
          int objId
          DB column: objid
    • Class de.elo.ix.client.VtDocC

      class VtDocC extends Object implements Serializable
      serialVersionUID:
      1585149555L
    • Class de.elo.ix.client.WFCacheSyncInfo

      class WFCacheSyncInfo extends ValueClass implements Serializable
      serialVersionUID:
      255633440L
      • Serialized Fields

        • flowId
          int flowId
          Workflow ID.
        • hash
          int hash
          Checksum on workflow data.
        • tstamp
          String tstamp
          Workflow timestamp.
    • Class de.elo.ix.client.WFCollectNode

      class WFCollectNode extends ValueClass implements Serializable
      serialVersionUID:
      1492908819L
      • Serialized Fields

        • access
          int access
          Access rights to the active workflow for the current user. A combination of LUR_* constants. Read-only.
          Since:
          11.00.000.023
          See Also:
        • activateDateIso
          String activateDateIso
          Date the node was activated
        • activateDateWorkflowIso
          String activateDateWorkflowIso
          Workflow start date.
          Since:
          8.00.022.000
        • active
          boolean active
          Is the node active or not?
        • callNodeId
          int callNodeId
          The call node id of the main workflow, which call this sub workflow.
          Since:
          10.00.000.004
        • completionDateIso
          String completionDateIso
          Date the workfow was completed
          Since:
          6.00.098
        • designDepartmentId
          int designDepartmentId
          ID of the user that was assigned to the node when the workflow started.
          Since:
          7.00.020.006
        • designDepartmentName
          String designDepartmentName
          Name of the user that was assigned to the node when the workflow started.
          Since:
          7.00.020.006
        • flowId
          int flowId
          Workflow id
        • flowName
          String flowName
          Workflow name
        • flowNameTranslationKey
          String flowNameTranslationKey
          Translation-keyword for workflow name.
          Since:
          9.00.022.012
        • flowStatus
          String flowStatus
          Workflow status. This member is only valid when this object is returned by the findFirstTasks or findNextTasks functions.
          Since:
          7.00.000.019
        • formSpec
          String formSpec
          Since:
          8.00.024.000
        • hidden
          boolean hidden
          Indicates whether this workflow is hidden.
          Since:
          9.00.018.006
        • inUseDateIso
          String inUseDateIso
          Date the node was set to In Use
        • label
          String label
          Display name by forwarding
          Since:
          9.00.022.019
        • labelTranslationKey
          String labelTranslationKey
          Deprecated.
          Translation-keyword for WFCollectNode.label.
          Since:
          9.00.030.021
          See Also:
        • nodeComment
          String nodeComment
          Node description.
          Since:
          7.00.026.003
        • nodeCommentTranslationKey
          String nodeCommentTranslationKey
          Translation-keyword for nodeComment.
          Since:
          9.00.022.012
        • nodeId
          int nodeId
          Node identifier
        • nodeName
          String nodeName
          Description/processing instructions for the workflow node
        • nodeNameTranslationKey
          String nodeNameTranslationKey
          Translation-keyword for nodeName.
          Since:
          9.00.022.012
        • objGuid
          String objGuid
          Deprecated.
          Object GUID of the object for which the workflow is started. This member will be set only if a search is run via findFirstTasks or findNextTasks. In this case it is equal to the GUID of UserTask.sord.
        • objId
          int objId
          Object id of the object for which the workflow is started.
        • objName
          String objName
          Sord name.
          Since:
          7.00.026.003
        • objType
          int objType
          Object type of the object for which the workflow is started. (1 for cabinet, 2 for folder, etc.)
        • overTimeLimit
          boolean overTimeLimit
          True, if the node exceeds the time limit.
          Since:
          6.00.098
        • overTimeLimitAny
          boolean overTimeLimitAny
          Indicates whether the workflow is an escalation.
          Since:
          9.00.016.016
        • parentFlowId
          int parentFlowId
          ID of the parent workflow.
          Since:
          9.00.030.022
        • prio
          int prio
          Node priority
        • processOnServerId
          String processOnServerId
          Allows the clients to decide whether the workflow is editable or not without loading the WFDiagram.
          Since:
          21.03.000.014
        • properties
          String properties
          Node properties
          Since:
          9.00.022.018
        • terminateDateIso
          String terminateDateIso
          Date the node was completed/terminated
        • timeLimit
          int timeLimit
          Time limit in minutes.
          Since:
          8.00.010.002
        • timeLimitEscalations
          WFTimeLimit[] timeLimitEscalations
          Additional definitions for time limits.
          Since:
          7.00.000.019
          See Also:
        • timeLimitIso
          String timeLimitIso
          Node must be completed until this date. This member is only valid when this object is returned by the findFirstTasks or findNextTasks functions.
          Since:
          7.00.000.019
        • timeLimitsWorkflow
          WFTimeLimit[] timeLimitsWorkflow
          Time limits and time limit escalation of the entire workflow. This array holds 3 time limit states of the entire workflow. The first item is filled from WFDiagram.overTimeLimit, WFDiagram.timeLimit, WFDiagram.timeLimitIso, WFDiagram.timeLimitUserId and WFDiagram.timeLimitUserName. The second and third items are set to the two items in WFDiagram.timeLimitEscaltions.
          Since:
          8.00.022.000
        • timeLimitUserId
          int timeLimitUserId
          The ID of the user that should be informed, if the time-limit is exceeded. The Indexserver does not send any notification to the user. The client application is responsible for doing this.
          Since:
          8.00.010.002
        • timeLimitUserName
          String timeLimitUserName
          User name for timeLimitUserId; When writing a workflow with checkinWorkFlow, this value has preceedence before timeLimitUserId. Set timeLimitUserName to an empty string, if timeLimitUserId should be used.
          Since:
          8.00.010.002
        • userDelayDateIso
          String userDelayDateIso
          The workflow node is deferred until this date. Not valid for template workflows. Only valid for person nodes. ELO date format.
          Since:
          7.00.000.000
        • userId
          int userId
          User number of the user for whom the workflow node is intended.
        • userName
          String userName
          User name of the user for whom the workflow node is intended.
        • workflowOwnerId
          int workflowOwnerId
          Workflow owner ID. This member is only valid when this object is returned by the findFirstTasks or findNextTasks functions.
          Since:
          7.00.000.047
        • workflowOwnerName
          String workflowOwnerName
          Workflow owner name. This member is only valid when this object is returned by the findFirstTasks or findNextTasks functions.
          Since:
          7.00.000.047
    • Class de.elo.ix.client.WFDelegateNodeInfo

      class WFDelegateNodeInfo extends Object implements Serializable
      serialVersionUID:
      20892334L
      • Serialized Fields

        • backNodeComment
          String backNodeComment
          Description of the back node.
        • backNodeMoveX
          int backNodeMoveX
          Horizontal distance between the active node and the back node. Recommended value is 0.
        • backNodeMoveY
          int backNodeMoveY
          Vertical distance between the active node and the back node. Recommended value is 80.
        • backNodeName
          String backNodeName
          Name of the back node.
        • copyMembersToBackNodeZ
          WFNodeZ copyMembersToBackNodeZ
          This selector defines which members of the current node are copied to the node that leads back to the current user. If this value is null, the following members are copied by default: WFNodeC.mbFlags|WFNodeC.mbMoveCyclePosX|WFNodeC.mbObjKeyNames|WFNodeC.mbScriptNames|WFNodeC.mbTag|WFNodeC.mbTimeLimit|WFNodeC.mbTimeLimitEscalations. The members given or evaluated by backNodeName, backNodeComment, backNodeMoveX and backNodeMoveY overwrite the members copied due copyMembersToBackNodeZ. The following members are always copied from the current node: WFNode.userId, WFNode.userName, WFNode.designDepartment, WFNode.department2, WFNode.formSpec and need not to be included in copyMembersToBackNodeZ.
          Since:
          8.00.000.004
        • copyMembersToDelegateNodeZ
          WFNodeZ copyMembersToDelegateNodeZ
          This selector defines which members of the node specified by nodeId are copied to the delegated node. If this value is null, all node members are copied except the following: WFNodeC.mbId| WFNodeC.mbDelayDate|WFNodeC.mbDelayDateIso| WFNodeC.mbEnterDate|WFNodeC.mbEnterDateIso| WFNodeC.mbExitDate|WFNodeC.mbExitDateIso| WFNodeC.mbInUseDate|WFNodeC.mbInUseDateIso| WFNodeC.mbUserDelayDate|WFNodeC.mbUserDelayDateIso| WFNodeC.mbIsNext overwrite the members copied due copyMembersToDelegateNodeZ. The member WFNode.formSpec is always copied from the current node and need not to be included in copyMembersToDelegateNodeZ.
          Since:
          8.00.000.004
        • delegateNodeComment
          String delegateNodeComment
          Description of the new node
        • delegateNodeMoveX
          int delegateNodeMoveX
          Horizontal distance between the active node and the delegation node. Recommended value is 240.
        • delegateNodeMoveY
          int delegateNodeMoveY
          Vertical distance between the active node and the delegation node. Recommended value is 0.
        • delegateNodeName
          String delegateNodeName
          Name of the new node
        • delegateParallel
          boolean delegateParallel
          Delegate parallel or serial to the list of users. if WFDelegateNodeInfo.delegateToUserIds is not null or empty, this member describes how the nodes created for delegation are connected.

          Set this member as true, if all delegation nodes should be activated directly. The delegation returns, if at least one of the users forwards her/his node.

          Set this member as false, if the delegation nodes should be lined up one after another. The delegation returns, if all users have forwarded their nodes.

          Ignored, if WFDelegateNodeInfo.delegateToUserIds is null or empty.
          Since:
          10.00.020.008
        • delegateToUserId
          String delegateToUserId
          Name or ID of user or group to whom the workflow is delegated.
          See Also:
        • delegateToUserIds
          List<String> delegateToUserIds
          Names or IDs of users or groups to whom the workflow is delegated. The delegation nodes are organized serial or parallel as defined by member WFDelegateNodeInfo.delegateParallel.
          Since:
          10.00.020.008
          See Also:
        • flowId
          String flowId
          Workflow ID, GUID or name
        • nodeId
          int nodeId
          Node ID
    • Class de.elo.ix.client.WFDiagram

      class WFDiagram extends ValueClass implements Serializable
      serialVersionUID:
      1663767661L
      • Serialized Fields

        • access
          int access
          Access rights to the workflow template for the current user. A combination of LUR_* constants. Read-only.
          Since:
          7.00.000.007
          See Also:
        • acl
          String acl
          Access control list in the internal format. It defines who is able to edit the workflow. This member is only valid for workflow templates.
        • aclItems
          AclItem[] aclItems
          Access control list in a more convenient format than member acl. It defines who is able to edit the workflow. This member is only valid for workflow templates.
        • activeAcl
          String activeAcl
          Access control list in the internal format. It defines who is able to edit the workflow. This member is only valid for active workflows.
          Since:
          11.00.000.023
        • activeAclItems
          AclItem[] activeAclItems
          Access control list in a more convenient format than member acl. It defines who is able to edit the workflow. This member is only valid for active workflows
          Since:
          11.00.000.023
        • callNodeId
          int callNodeId
          The call node id of the main workflow, which call this sub workflow.
          Since:
          10.00.000.004
        • completionDateIso
          String completionDateIso
          Date of completion in ISO format.
        • deleted
          boolean deleted
          Flag that indicates whether the workflow template is deleted. Only valid for template workflows.
        • flags
          int flags
          Flags of the begin node. This value is a combination of the node flags suitable to begin nodes, e. g. WFNodeC.FLAG_WORKINGDAYS. To ensure compatibility with older client programs, the WFNode.flags of the start node are or-ed with the WFDiagram.flags.
          Since:
          6.00.098
          See Also:
        • guid
          String guid
          GUID
          Since:
          7.00.000.010
        • hidden
          boolean hidden
          Indicates whether this workflow is hidden.
          Since:
          9.00.018.006
        • id
          int id
          Workflow ID.
        • lockId
          int lockId
          The ID of the user who has currently locked the workflow.
        • lockName
          String lockName
          The name of the user who has currently locked the workflow.
        • matrix
          WFNodeMatrix matrix
          Node matrix.
        • name
          String name
          Workflow name.
        • nameTranslationKey
          String nameTranslationKey
          Translation-keyword for WFDiagram.name.
          Since:
          9.00.018.005
        • nodes
          WFNode[] nodes
          Array of nodes.
        • objId
          String objId
          ID or GUID of the associated folder or document object. checkoutWorkFlow will always return the numeric object ID in this field. checkinWorkFlow is able to receive a GUID too.
        • objName
          String objName
          Sord name. Readonly.
          Since:
          7.00.026.003
        • objType
          int objType
          Sord type of the associated folder or document.
        • overTimeLimit
          boolean overTimeLimit
          True, if the workflow exceeds the time limit. Read-only.
          Since:
          6.00.096
        • ownerId
          int ownerId
          ID of the user who has started the workflow.
        • ownerName
          String ownerName
          Name of the user who has started the workflow.
        • packageName
          String packageName
          Package name of WFDiagram
          Since:
          20.00.000.009
        • parentFlowId
          int parentFlowId
          ID of the parent workflow.
          Since:
          9.00.030.022
        • prio
          int prio
          Workflow priortiy: 0...high, 1...medium, 2...low.
        • processOnServerId
          String processOnServerId
          This value determines on which replication server a workflow is allowed to be continued. If not empty, the workflow can only be modified and continued on this server (resp. replication branch). Value must match to an existing ReplSetName.name in the replication configuration. The current local replication server id is specified in ServerInfo.replProcessOnServerId. This member is only valid for ACTIVE or FINISHED workflows and is set automatically by the Indexserver. It can be changed within workflows with WFNodeC.TYPE_SET_SERVER_ID nodes.
          Since:
          7.00.000.015
          See Also:
        • startDateIso
          String startDateIso
          Date of start in ISO format.
        • subWorkflows
          Map<Integer,WFDiagram> subWorkflows
          Sub workflows.
          Since:
          9.00.030.022
        • templateId
          int templateId
          The workflow was started based on this workflow template. This member is only valid for active and finished workflows.
          See Also:
        • templateName
          String templateName
          The workflow was started based on the workflow template with this name. This member is only valid for active and finished workflows.
          See Also:
        • timeLimit
          int timeLimit
          Time-limit for the entire workflow in minutes.
          See Also:
        • timeLimitEscalations
          WFTimeLimit[] timeLimitEscalations
          Additional definitions for time limits.
          Since:
          7.00.000.016
          See Also:
        • timeLimitIso
          String timeLimitIso
          The entire workflow should be finished by this date. Otherwise the time-limit is exceeded. This member is only valid for active and finished workflows. Read-only.
          See Also:
        • timeLimitUserId
          int timeLimitUserId
          The ID of the user that should be informed,if the time-limit for the workflow is exceeded. The Indexserver does not send any notification to the user. The client application is responsible for doing this.
          See Also:
        • timeLimitUserName
          String timeLimitUserName
          The name of the user that should be informed, if the time-limit is exceeded. When writing a workflow with checkinWorkFlow, this value has preceedence before timeLimitUserId. Set timeLimitUserName to an empty string, if timeLimitUserId should be used.
        • tStamp
          String tStamp
          TStamp
          Since:
          7.00.000.010
        • TStampSync
          String TStampSync
          Timestamp of this object's last export by the replication.
          Since:
          9.99.009.001
        • type
          WFTypeZ type
          Typeof template: template, active or finished.
        • version
          WFVersion version
          Only templates: version information.
          Since:
          7.00.000.008
          See Also:
    • Class de.elo.ix.client.WFDiagramC

      class WFDiagramC extends Object implements Serializable
      serialVersionUID:
      1231341428L
      • Serialized Fields

        • lnGuid
          int lnGuid
          Maximum length of workflow GUID.
          Since:
          7.00.000.010
        • lnName
          int lnName
          Maximum length of workflow name.
        • lnNameTranslationKey
          int lnNameTranslationKey
          Maximum length of the name's translation key.
          Since:
          9.00.018.005
        • lnProcessOnServerId
          int lnProcessOnServerId
          Maximum length of processOnServerId.
          Since:
          7.00.000.015
        • lnTStamp
          int lnTStamp
          Maximum length of workflow TStamp.
          Since:
          7.00.000.010
    • Class de.elo.ix.client.WFDiagramZ

      class WFDiagramZ extends ValueClass implements Serializable
      serialVersionUID:
      1717407429L
      • Serialized Fields

        • bset
          long bset
          Bitset field for constants from the WFDiagramC class.
    • Class de.elo.ix.client.WFEditNode

      class WFEditNode extends ValueClass implements Serializable
      serialVersionUID:
      1822579866L
      • Serialized Fields

        • flowId
          int flowId
          Workflow identifier
        • node
          WFNode node
          The node to be processed
        • nodeId
          int nodeId
          Node identifier
        • succNodes
          WFNode[] succNodes
          Choice of following nodes. Array of ELOWorkFlowNode objects.
    • Class de.elo.ix.client.WFNode

      class WFNode extends ValueClass implements Serializable
      serialVersionUID:
      2015686193L
      • Serialized Fields

        • allowActivate
          boolean allowActivate
          Can this node be activated? A script can set this value to prevent the activation of the node. This member is valid for all node types.
        • comment
          String comment
          Comment text for the node. This member is valid for all node types.
        • commentTranslationKey
          String commentTranslationKey
          Translation-keyword for WFNode.comment.
          Since:
          9.00.018.005
        • delayDateIso
          String delayDateIso
          The node is displayed to the user at this date. This date is computed by enterDateIso + delayDays. This member is only valid for person nodes. Read-only.
        • delayDays
          int delayDays
          An active person node (Activate is set) might be displayed to the user delayed by this number of days. Only valid for person nodes.
        • department2
          int department2
          A group ID to constrain access to the node. Only members of this group are allowed to see and process the node. Only valid for person nodes.
        • departmentGroup
          int departmentGroup
          Grouping of nodes for function takeWorkFlowNode. A non-zero value binds nodes with the same value to a group of nodes that is evaluated in IXServicePortIF.takeWorkFlowNode(ClientInfo, int, int, String, int, LockZ). The function takeWorkFlowNodes takes - in addition to the given node - all nodes with the same group assignment specified by this member. This member is only used as a marker and is not interpreted as a group or user ID.
          Since:
          9.00.030.006
        • designDepartment
          int designDepartment

          A group ID or user ID that was originally assigned in the designer.

          • Only valid for person nodes.
          • If a template is checked in, designDepartment is always set to WFNode.userName respectively WFNode.userId.
          • If a new active workflow is checked in, it it is always set to WFNode.userName respectively WFNode.userId.
          • If an existing active workflow is checked in, the checked in value is saved
        • enterDateIso
          String enterDateIso
          The node was activated on this date. This member is valid for all node types.
        • exitDateIso
          String exitDateIso
          The node was exited/completed on this date. This member is valid for all node types.
        • flags
          int flags
          Control flags for the node, a combination of WFNodeC.FLAG_* constants. For start nodes (TYPE_BEGINNODE), the flags should be specified in WFDiagram.flags. To ensure compatibility with older client programs, the WFNode.flags of the start node are or-ed with the WFDiagram.flags. This member is valid for all node types.
          See Also:
        • formSpec
          String formSpec
          Multipurpose field.

          If the node is a collect node (type=WFNodeC.TYPE_COLLECTNODE), formSpec contains a comma separated list of node IDs. This nodes are deactivated when the collect node forwards the workflow. In addition to a list of IDs, the value of WFNodeC.DEACTIVATE_ALL_PREDS causes to deactivate all predecessor nodes.

          In case of a person node (WFNodeC.TYPE_PERSONNODE), formSpec can contain proprietary encoded information about a workflow form.

          Since:
          7.00.040.012
        • iconId
          String iconId
          Object-GUID of an icon file that is displayed in the designer.
          Since:
          7.00.040.012
          See Also:
        • id
          int id
          Node ID. This member is valid for all node types.
        • inUseDateIso
          String inUseDateIso
          The date when the node was last used(activated or completed). This member is valid for all node types.
        • isNext
          int isNext
          The activation state of the node. This member is valid for all node types.
        • label
          String label
          Display name by forwarding.
          Since:
          9.00.022.019
        • labelTranslationKey
          String labelTranslationKey
          Translation-keyword for WFNode.label.
          Since:
          9.00.030.021
        • moveCyclePosX
          int moveCyclePosX
          If a cycle is re-entered, the nodes in the cycle are duplicated. The copied nodes will be placed in the designer moved by this value to the right. If this value is 0, the nodes are moved 60 points right and 20 points up. This member is valid for all node types.
        • name
          String name
          The node description (work instruction). This member is valid for all node types.
        • nameTranslationKey
          String nameTranslationKey
          Translation-keyword for WFNode.name.
          Since:
          9.00.018.005
        • nbOfDonesToExit
          int nbOfDonesToExit
          The number of predecessor nodes that must be processed to forward this collector node. A value of -1 means that all predecessor nodes must be processed. If set to 0, the collect node switches when it is activated regardless of the state of the predecessor nodes. This member is only valid for collect nodes.
        • objKeyNames
          String[] objKeyNames
          Group names of index values (DocMaskLine.key resp. ObjKey.name) for which an edit box is to be displayed when forwarding a person node. This member is only valid for person nodes.
          Since:
          7.00.000.021
          See Also:
        • onEnter
          String onEnter
          A script or plugin name that is called, if a workflow node is entered. In order to capture this workflow event in JavaScript, store a script file that defines a function named onEnterNode in a sub-folder of "Indexserver Scripting Base/_ALL" or "Indexserver Scripting Base/instancename".
           
           function onEnterNode(ci, userId, workflow, nodeId) {
             // ci       ... ClientInfo object of the user that forwards the workflow.
             // userId   ... The calling user's ID (Integer)
             // workflow ... WFDiagram object
             // nodeId   ... The activated node ID (Integer)
           ...
           }
           
           
          See Indexserver Programming Manual for more information.

          If onEnter starts with a plugin's Bundle-SymbolicName, the event is delegated to function onEnterWorkflowNode of a WorkflowNodeEvents object. Such object is created by WorkflowNodeEventsFactory.create implemented in the plugin. Optionally, a path can be appended to the Bundle-SymbolicName which is passed to WorkflowNodeEventsFactory.create. This path has to start with a forward slash. E.g. onEnter="com.partner.wfevents/invoice-solution".

          This member is valid for all node types.
        • onEnterHandleRollback
          String onEnterHandleRollback
          A script or plugin name that is called when an error occurs inside a workflow script. All onEnterHandleRollback scripts, from one person node to the next person node, are stored in a temporary queue and all will get executed if an error inside a script occurs. The onEnterHandleRollBack script is not meant for dealing with an error in the onEnter Script, the script will only get stored in the temporary queue if the onEnter script was executed without any issues.

          In order to capture this workflow event in JavaScript, store a script file that defines a function named onEnterHandleRollbackNode in a sub-folder of "Indexserver Scripting Base/_ALL" or "Indexserver Scripting Base/instancename".

           
           function onEnterHandleRollbackNode(ci, userId, workflow, nodeId) {
             // ci       ... ClientInfo object of the user that forwards the workflow.
             // userId   ... The calling user's ID (Integer)
             // workflow ... WFDiagram object
             // nodeId   ... The deactivated node ID (Integer)
           ...
           }
           
           
          See Indexserver Programming Manual for more information.

          If onEnterHandleRollback starts with a plugin's Bundle-SymbolicName, the event is delegated to function WorkflowNodeEvents.onEnterHandleRollbackWorkflowNode(IXServerEventsContext, WFDiagram, int) of a WorkflowNodeEvents object returned from a call to WorkflowNodeEventsFactory.create(de.elo.ix.client.IXServerEventsContext, java.lang.String). Optionally, a path can be appended to the Bundle-SymbolicName which is passed to WorkflowNodeEventsFactory.create(de.elo.ix.client.IXServerEventsContext, java.lang.String). This path has to start with a forward slash. E.g. onEnterHandleRollback="com.partner.wfevents/invoice-solution".

          This member is valid for all node types.
          Since:
          21.02.000.005
        • onExit
          String onExit
          A script or plugin name that is called, if a workflow node is exited. In order to capture this workflow event in JavaScript, store a script file that defines a function named onExitNode in a sub-folder of "Indexserver Scripting Base/_ALL" or "Indexserver Scripting Base/instancename".
           
           function onExitNode(ci, userId, workflow, nodeId) {
             // ci       ... ClientInfo object of the user that forwards the workflow.
             // userId   ... The calling user's ID (Integer)
             // workflow ... WFDiagram object
             // nodeId   ... The deactivated node ID (Integer)
           ...
           }
           
           
          See Indexserver Programming Manual for more information.

          If onExit starts with a plugin's Bundle-SymbolicName, the event is delegated to function WorkflowNodeEvents.onExitWorkflowNode(de.elo.ix.client.IXServerEventsContext, de.elo.ix.client.WFDiagram, int) of a WorkflowNodeEvents object returned from a call to WorkflowNodeEventsFactory.create(de.elo.ix.client.IXServerEventsContext, java.lang.String). Optionally, a path can be appended to the Bundle-SymbolicName which is passed to WorkflowNodeEventsFactory.create(de.elo.ix.client.IXServerEventsContext, java.lang.String). This path has to start with a forward slash. E.g. onEnter="com.partner.wfevents/invoice-solution".

          This member is valid for all node types.
        • onExitHandleRollback
          String onExitHandleRollback
          A script or plugin name that is called when an error occurs inside a workflow script. All onExitHandleRollback scripts, from one person node to the next person node, are stored in a temporary queue and all will get executed if an error inside a script occurs. The onExitHandleRollback script is not meant for dealing with an error in the onExit Script, the script will only get stored in the temporary queue if the onExit script was executed without any issues.

          In order to capture this workflow event in JavaScript, store a script file that defines a function named onExitHandleRollbackNode in a sub-folder of "Indexserver Scripting Base/_ALL" or "Indexserver Scripting Base/instancename".

           
           function onExitHandleRollbackNode(ci, userId, workflow, nodeId) {
             // ci       ... ClientInfo object of the user that forwards the workflow.
             // userId   ... The calling user's ID (Integer)
             // workflow ... WFDiagram object
             // nodeId   ... The deactivated node ID (Integer)
           ...
           }
           
           
          See Indexserver Programming Manual for more information.

          If onExitHandleRollback starts with a plugin's Bundle-SymbolicName, the event is delegated to function WorkflowNodeEvents.onExitHandleRollbackWorkflowNode(de.elo.ix.client.IXServerEventsContext, de.elo.ix.client.WFDiagram, int) of a WorkflowNodeEvents object returned from a call to WorkflowNodeEventsFactory.create(de.elo.ix.client.IXServerEventsContext, java.lang.String). Optionally, a path can be appended to the Bundle-SymbolicName which is passed to WorkflowNodeEventsFactory.create(de.elo.ix.client.IXServerEventsContext, java.lang.String). This path has to start with a forward slash. E.g. onExitHandleRollback="com.partner.wfevents/invoice-solution".

          This member is valid for all node types.
          Since:
          21.02.000.005
        • overTimeLimit
          boolean overTimeLimit
          True, if the node exceeds the time limit. This member is only valid for person nodes in active or finished workflows. Read-only.
          Since:
          6.00.098
          See Also:
        • posX
          int posX
          The X position in the designer view. This member is valid for all node types.
        • posY
          int posY
          The Y position in the designer view. This member is valid for all node types.
        • prio
          int prio
          Node priortiy: 0...high, 1...medium, 2...low. Only valid for person nodes, type==WFNodeC.TYPE_PERSONNODE. The user assigned to the person node can change this value by conn.ix().forwardWorkflowNode():
           
            WFEditNode editNode = conn.ix().beginForwardWorkflowNode(flowId, nodeId, null, LockC.NO);
            WFNode activeNode = editNode.getNode();
            activeNode.setPrio(activeNode.getPrio()-1); // One level higher.
            ForwardWorkflowNodeInfo fwdInfo = new ForwardWorkflowNodeInfo();
            fwdInfo.setNode(activeNode);
            conn.ix().forwardWorkflowNode(wfActive.getId(), activeNode.getId(), fwdInfo, LockC.NO);
            
           
           
          Since:
          9.99.009.005
          See Also:
        • processOnServerId
          String processOnServerId
          Server ID (resp. replication branch). This member is only valid for nodes of type WFNodeC.TYPE_SET_SERVER_ID. and should be set to the name of a existing ReplSetName.name. After node is processed, updates value in WFDiagram.processOnServerId and stops processing. Further Workflow processing will be halted and only continued after replication on the server with the given ID.
          Since:
          7.00.000.015
          See Also:
        • properties
          String properties
          Node properties. Maximum byte size of this string in UTF-8 encoding is constrained to FileDataC.MAX_BLOB_LENGTH.
          Since:
          9.00.022.018
        • returnValue
          String returnValue
          Return value of a sub-workflow. The value defines the name of the successor node of the call-node WFNodeC.TYPE_CALL_SUB_WORKFLOW that will be activated when the sub-workflow returns. If the sub-workflow returns a node name that does not exist in the main workflow, a new person node is inserted between the call-node and its successors. This new node is named as the return value and is assigned to the workflow owner.
          Since:
          9.99.009.003
        • retVal
          int retVal
          Deprecated.
          Use #returnValue
          Return value of an end node. Only valid for TYPE_END.
          Since:
          9.00.030.022
        • scriptNames
          String[] scriptNames
          Script names used as action scripts in buttons when forwarding a person node. Script files for the Windows CLIENT have to be named as ELOWF_ + scriptNames[.]. This member is only valid for person nodes.
          Since:
          7.00.000.021
        • subFlowId
          int subFlowId
          Id of the active sub-workflow. Only valid for TYPE_CALL_SUB_WORKFLOW.
          Since:
          9.00.030.022
        • subTemplateId
          int subTemplateId
          ID, GUID or name of the sub-workflow template.
          Since:
          9.99.009.004
        • tag
          int tag
          reserved. DB column: wf_tag
        • timeLimit
          int timeLimit
          The time-limit to process the node. Measured in minutes. This member is only valid for person nodes.
        • timeLimitEscalations
          WFTimeLimit[] timeLimitEscalations
          Additional definitions for time limits. This member is only valid for person nodes.
          Since:
          7.00.000.016
          See Also:
        • timeLimitIso
          String timeLimitIso
          After this date the node exceeds the time-limit for processing. This member is only valid for person nodes. Read-only.
        • type
          int type
          The node type. This member is set to one of the TYPE_* constants in WFNodeC.
          See Also:
        • userDelayDateIso
          String userDelayDateIso
          The workflow node is deferred until this date. This member is only valid for person nodes in active or finished workflows. ISO date format.
          Since:
          7.00.000.000
        • userId
          int userId
          This user has to edit the node. This member is only valid for person nodes.
        • userName
          String userName
          The name of the user that has the ID userId This member is only valid for person nodes.
          See Also:
        • userTerminate
          String userTerminate
          The ID of the user who has forwarded the node. Not valid for template workflows. This member is only valid for person nodes.
        • yesNoCondition
          String yesNoCondition
          A value depending on the type of the node.

          WFNodeC.TYPE_IFNODE: test condition. Numeric values must be formatted according to the servers locale. Date values of AspectLineC.TYPE_ISO_DATE_ONLY or AspectLineC.TYPE_ISO_DATE_TIME must be given as ISO date values in timezone UTC.

          WFNodeC.TYPE_SPLITNODE: sets the workflow status to this value.

          WFNodeC.getTYPE_BEGINNODE(): contains workflow status.

          WFNodeC.TYPE_CYCLE: condition that evaluates true to leave the cycle.

    • Class de.elo.ix.client.WFNodeAssoc

      class WFNodeAssoc extends ValueClass implements Serializable
      serialVersionUID:
      1042649178L
      • Serialized Fields

        • done
          boolean done
          Indicates whether the bridge has been passed through/over (used). For a condition node, this member is true for both paths (TRUE and FALSE) if either has been passed. Thus it cannot be used in a client application to find out, which path the workflow has taken.
        • nodeFrom
          int nodeFrom
          Start node (starting location)
        • nodeTo
          int nodeTo
          Destination (end) node
        • type
          int type
    • Class de.elo.ix.client.WFNodeC

      class WFNodeC extends Object implements Serializable
      serialVersionUID:
      1514069164L
      • Serialized Fields

        • lnComment
          int lnComment
          Maximum length of comment.
        • lnCommentTranslationKey
          int lnCommentTranslationKey
          Maximum length of the comment's translation key.
          Since:
          9.00.018.007
        • lnCondition
          int lnCondition
        • lnFormSpec
          int lnFormSpec
          Maximum length of form spec.
          Since:
          9.00.000.029
        • lnLabel
          int lnLabel
          Maximum length of the label.
          Since:
          9.00.022.019
        • lnLabelTranslationKey
          int lnLabelTranslationKey
          Maximum length of the labelTranslationKey.
          Since:
          9.00.030.021
        • lnName
          int lnName
          Maximum length of node name.
        • lnNameTranslationKey
          int lnNameTranslationKey
          Maximum length of the name's translation key.
          Since:
          9.00.018.007
        • lnOnEnter
          int lnOnEnter
        • lnOnEnterHandleRollback
          int lnOnEnterHandleRollback
          Since:
          21.02.000.005
        • lnOnExit
          int lnOnExit
        • lnOnExitHandleRollback
          int lnOnExitHandleRollback
          Since:
          21.02.000.005
        • lnProcessOnServerId
          int lnProcessOnServerId
          Maximum length of processOnServerId.
          Since:
          7.00.000.015
        • lnProperties
          int lnProperties
          Maximum length of the properties.
          Since:
          9.00.050.004
        • lnYesNoCondition
          int lnYesNoCondition
    • Class de.elo.ix.client.WFNodeHistory

      class WFNodeHistory extends ValueClass implements Serializable
      serialVersionUID:
      784568809L
      • Serialized Fields

        • enterDateIso
          String enterDateIso
          The node was activated on this date. This member is valid for all node types.
        • exitDateIso
          String exitDateIso
          The node was exited/completed on this date. This member is valid for all node types.
        • flowGuid
          String flowGuid
          GUID of the workflow. DB column: wfguid
        • histGuid
          String histGuid
          GUID of the WorkflowHist object. DB column: wfhistguid
        • nodeId
          int nodeId
          Node ID. DB column: wf_nodeid
        • succ_0
          int succ_0
          Successor node(s) succ_0 ... Succ 19 DB column: wf_succ_0
        • succ_1
          int succ_1
          DB column: wf_succ_1
        • succ_10
          int succ_10
          DB column: wf_succ_10
        • succ_11
          int succ_11
          DB column: wf_succ_11
        • succ_12
          int succ_12
          DB column: wf_succ_12
        • succ_13
          int succ_13
          DB column: wf_succ_13
        • succ_14
          int succ_14
          DB column: wf_succ_14
        • succ_15
          int succ_15
          DB column: wf_succ_15
        • succ_16
          int succ_16
          DB column: wf_succ_16
        • succ_17
          int succ_17
          DB column: wf_succ_17
        • succ_18
          int succ_18
          DB column: wf_succ_18
        • succ_19
          int succ_19
          DB column: wf_succ_19
        • succ_2
          int succ_2
          DB column: wf_succ_2
        • succ_3
          int succ_3
          DB column: wf_succ_3
        • succ_4
          int succ_4
          DB column: wf_succ_4
        • succ_5
          int succ_5
          DB column: wf_succ_5
        • succ_6
          int succ_6
          DB column: wf_succ_6
        • succ_7
          int succ_7
          DB column: wf_succ_7
        • succ_8
          int succ_8
          DB column: wf_succ_8
        • succ_9
          int succ_9
          DB column: wf_succ_9
        • userId
          int userId
          ID of user who has to process the node. Might be a group ID too. Only valid for person nodes. DB column: wf_userid
        • userName
          String userName
          Name of user who has to process the node. Might be a group name too. Only valid for person nodes. DB column: wf_username
    • Class de.elo.ix.client.WFNodeHistoryC

      class WFNodeHistoryC extends Object implements Serializable
      serialVersionUID:
      1457412372L
      • Serialized Fields

        • lnFlowGuid
          int lnFlowGuid
          DB column: wfguid
        • lnHistGuid
          int lnHistGuid
          DB column: wfhistguid
          Since:
          9.00.030.018
        • lnUserName
          int lnUserName
          DB column: wf_username
    • Class de.elo.ix.client.WFNodeMatrix

      class WFNodeMatrix extends ValueClass implements Serializable
      serialVersionUID:
      425879495L
      • Serialized Fields

        • assocs
          WFNodeAssoc[] assocs
          Array of the edges. Since 9.00.030, IX stores the order of the items in the database. When reading a workflow, the saved element order is restored.
    • Class de.elo.ix.client.WFNodeMatrixC

      class WFNodeMatrixC extends Object implements Serializable
      serialVersionUID:
      171864975L
    • Class de.elo.ix.client.WFNodeZ

      class WFNodeZ extends ValueClass implements Serializable
      serialVersionUID:
      226200225L
      • Serialized Fields

        • bset
          long bset
          Bitset field for constants from the WFNodeC class.
    • Class de.elo.ix.client.WFTakeNodeC

      class WFTakeNodeC extends Object implements Serializable
      serialVersionUID:
      1164251184L
    • Class de.elo.ix.client.WFTimeLimit

      class WFTimeLimit extends ValueClass implements Serializable
      serialVersionUID:
      633363356L
      • Serialized Fields

        • overTimeLimit
          boolean overTimeLimit
          True, if the workflow exceeds the time limit. Read-only.
          Since:
          7.00.000.017
        • timeLimit
          int timeLimit
          Time-limit in minutes.
          See Also:
        • timeLimitIso
          String timeLimitIso
          After this date the node exceeds the time-limit for processing. Read-only.
          See Also:
        • userId
          int userId
          The ID of the user that should be informed, if the time-limit is exceeded. The Indexserver does not send any notification to the user. The client application is responsible for doing this.
        • userName
          String userName
          User name for timeLimitUserId; When writing a workflow with checkinWorkFlow, this value has preceedence before timeLimitUserId. Set timeLimitUserName to an empty string, if timeLimitUserId should be used.
    • Class de.elo.ix.client.WFTypeC

      class WFTypeC extends Object implements Serializable
      serialVersionUID:
      1842783874L
    • Class de.elo.ix.client.WFTypeZ

      class WFTypeZ extends ValueClass implements Serializable
      serialVersionUID:
      927083544L
      • Serialized Fields

        • bset
          long bset
          Bitset field for constants from the WFTypeC class.
    • Class de.elo.ix.client.WFVersion

      class WFVersion extends ValueClass implements Serializable
      serialVersionUID:
      914434915L
      • Serialized Fields

    • Class de.elo.ix.client.WFVersionC

      class WFVersionC extends Object implements Serializable
      serialVersionUID:
      1378592156L
      • Serialized Fields

        • lnComment
          int lnComment
          Length of WFVersion.comment.
        • lnVersion
          int lnVersion
          Length of WFVersion.version.
          Since:
          7.00.000.018
    • Class de.elo.ix.client.WorkFlowActiveDoc

      class WorkFlowActiveDoc extends ValueClass implements Serializable
      serialVersionUID:
      1807635378L
      • Serialized Fields

        • activate
          int activate
          ELO-date when the node was entered. DB column: wf_activate
        • activeAcl
          String activeAcl
          Contains the ACL of the workflow. Only valid for begin nodes.
          Since:
          11.00.000.023
        • alertFromBegin
          int alertFromBegin
          Time-limt for the entire workflow in minutes. This value is only valid for the begin node. DB column: wf_alert_from_begin
        • alertTo
          int alertTo
          ID of user who should be informed, if a time-limit exceeds. It might be the time-limit for the entire workflow or for a signle person node. DB column: wf_alert_to
        • alertTo2
          int alertTo2
          ID of user who should be informed, if the time-limit alertWait2 exceeds.
          Since:
          7.00.000.014
        • alertTo3
          int alertTo3
          ID of user who should be informed, if the time-limit alertWait2 exceeds.
          Since:
          7.00.000.014
        • alertWait
          int alertWait
          Time-limit for a single node. This value is only valid for person nodes. DB column: wf_alert_wait
        • alertWait2
          int alertWait2
          Second Time-limit for a person node or begin node.
          Since:
          7.00.000.014
        • alertWait3
          int alertWait3
          Third Time-limit for a person node or begin node.
          Since:
          7.00.000.014
        • comment
          String comment
          Comment, only valid for person nodes. DB column: wf_comment
        • commentTranslationKey
          String commentTranslationKey
          Translation-keyword for WFNode.comment.
          Since:
          9.00.018.005
        • completionDate
          int completionDate
          ELO-date when the workflow was finished. All nodes contain the same value. DB column: wf_completion_date
        • condition
          String condition
          Contains the ACL of the workflow template. Only valid for begin nodes. DB column: wf_condition
        • delayDate
          int delayDate
          Activate + DelayDays. Not valid for template workflows. Only valid for person nodes. DB column: wf_duedate
        • delayDays
          int delayDays
          An active person node (Activate is set) might be displayed to the user delayed by this number of days. Only valid for person nodes. DB column: wf_delaydays
        • deleted
          int deleted
          Flag that indicates whether the workflow template is deleted. If the value is not 0, the workflow template is deleted. Only valid for template workflows. DB column: wf_deleted
        • department
          int department
          ID of user who has to process the node. Might be a group ID too. Only valid for person nodes. DB column: wf_department
        • department2
          int department2
          A group ID to constrain access to the node. Only members of this group are allowed to see and process the node. Only valid for person nodes. DB column: wf_department2
        • departmentGroup
          int departmentGroup
          Grouping of nodes for function takeWorkFlowNode.
          Since:
          9.00.030.006
          See Also:
        • designDepartment
          int designDepartment
          A group ID or user ID that was originally assigned in the designer. DB column: wf_designdepartment
        • eloObjId
          int eloObjId
          Associated object ID. Only valid for non-template workflows. DB column: wf_eloobjid
        • flowId
          int flowId
          Workflow ID. DB column: wf_flowid
        • flowName
          String flowName
          Workflow name. DB column: wf_flow_name
        • flowNameTranslationKey
          String flowNameTranslationKey
          Translation-keyword for WFDiagram.name.
          Since:
          9.00.018.005
        • formSpec
          String formSpec
          User defined data to be stored in the database.
          Since:
          7.00.040.012
        • iconId
          String iconId
          Object-GUID of an icon file that is displayed in the designer.
          Since:
          7.00.040.012
        • inUseDate
          int inUseDate
          ELO-date when the node was visited the last time. DB column: wf_in_use_date
        • isNext
          int isNext
          Contains 1, if this node is active. DB column: wf_is_next
        • label
          String label
          Display name by forwarding.
          Since:
          9.00.022.019
        • labelTranslationKey
          String labelTranslationKey
          Translation-keyword for WorkFlowActiveDoc.label.
          Since:
          9.00.030.021
          See Also:
        • locked
          int locked
          If node is locked, it contains 1 otherwise 0 DB column: wf_locked
        • lockId
          int lockId
          User ID of the owner of the lock. DB column: wf_locked_owner
        • moveCyclePosX
          int moveCyclePosX
          If a cycle is re-entered, the nodes in the cycle are duplicated. The copied nodes will be placed in the designer moved by this value to the right. If this value is 0, the nodes are moved 60 points right and 20 points up. DB column: wf_dx
        • name
          String name
          Node name (work instruction). DB column: wf_name
        • nameTranslationKey
          String nameTranslationKey
          Translation-keyword for WFNode.name.
          Since:
          9.00.018.005
        • nextServerId
          String nextServerId
          Next server name. This value is used in replication environments and defines the ID of the next server (resp. replication branch) where the workflow continues processing.
          Since:
          7.00.000.014
        • nodeFlags
          int nodeFlags
          Node flags. DB column: wf_nodeflags
        • nodeId
          int nodeId
          Node ID. DB column: wf_nodeid
        • nodeType
          int nodeType
          Node type (begin node, split node, etc.). DB column: wf_node_type
        • onActivate
          String onActivate
          Name of script to be executed, if the node is activated (entered). DB column: wf_ev_on_activate
        • onEnterHandleRollback
          String onEnterHandleRollback
          Name of script to be executed when the node encounters an error (exception). DB column: wf_ev_on_exception_after_enter
          Since:
          21.02.000.005
        • onExitHandleRollback
          String onExitHandleRollback
          Name of script to be executed when the node encounters an error (exception). DB column: wf_ev_on_exception_after_exit
          Since:
          21.02.000.005
        • onTerminate
          String onTerminate
          Name of script to be executed, if the node is leaved (exited). DB column: wf_ev_on_terminate
        • packageName
          String packageName
          PackageName of a Workflow, only used for workflow templates
          Since:
          20.00.000.009
        • posX
          int posX
          Node X position in designer view. DB column: pos_x
        • posY
          int posY
          Node Y position in designer view. DB column: pos_y
        • prio
          int prio
          Workflow priority: 0...high, 1...medium, 2...low. DB column: wf_prio
        • properties
          String properties
          Properties field of node.
          Since:
          9.00.022.019
        • returnValue
          String returnValue
          Return value of an end node.
          Since:
          9.99.009.003
        • retVal
          int retVal
          Return value of an end node.
          Since:
          9.00.030.022
        • subWorkflow
          int subWorkflow
          ID of the active sub-workflow.
          Since:
          9.00.030.022
        • subWorkflowTemplate
          int subWorkflowTemplate
          ID of the sub-workflow template.
          Since:
          9.99.009.004
        • succ_0
          int succ_0
          Successor node(s) succ_0 ... Succ 19 DB column: wf_succ_0 This mebers are moved into WorkFlowNodeMatrix. They are still here due to compatibiltiy with older stream versions.
        • succ_1
          int succ_1
          DB column: wf_succ_1
        • succ_10
          int succ_10
          DB column: wf_succ_10
        • succ_11
          int succ_11
          DB column: wf_succ_11
        • succ_12
          int succ_12
          DB column: wf_succ_12
        • succ_13
          int succ_13
          DB column: wf_succ_13
        • succ_14
          int succ_14
          DB column: wf_succ_14
        • succ_15
          int succ_15
          DB column: wf_succ_15
        • succ_16
          int succ_16
          DB column: wf_succ_16
        • succ_17
          int succ_17
          DB column: wf_succ_17
        • succ_18
          int succ_18
          DB column: wf_succ_18
        • succ_19
          int succ_19
          DB column: wf_succ_19
        • succ_2
          int succ_2
          DB column: wf_succ_2
        • succ_3
          int succ_3
          DB column: wf_succ_3
        • succ_4
          int succ_4
          DB column: wf_succ_4
        • succ_5
          int succ_5
          DB column: wf_succ_5
        • succ_6
          int succ_6
          DB column: wf_succ_6
        • succ_7
          int succ_7
          DB column: wf_succ_7
        • succ_8
          int succ_8
          DB column: wf_succ_8
        • succ_9
          int succ_9
          DB column: wf_succ_9
        • succType
          int succType
          This value depends on the node type and is not processed anymore by Indexserver. It is written for compability with workflows of older CLIENT versions. DB column: wf_succ_type
        • tag
          int tag
          reserved. DB column: wf_tag
        • templateId
          int templateId
          Workflow template ID. Not valid for template workflows. For active and finished workflows this member specifies the template ID that was used to start the workflow. If the workflow is started as an adhoc workflow, this member is 0 and flags contains the bit FLAG_ROOT_ADHOC. DB column: wf_template
        • terminate
          int terminate
          ELO-date when the node was exited. DB column: wf_terminate
        • userDelayDate
          int userDelayDate
          The workflow node is deferred until this date. ELO date format. DB column: wf_user_delaydate
          Since:
          7.00.000.000
        • userTerminate
          String userTerminate
          The ID of the user who has forwarded the node. Not valid for template workflows. Only valid for person nodes. DB column: wf_userterminate
        • versionCreateDate
          int versionCreateDate
          ID of the user who created the workflow version.
          Since:
          7.00.000.018
        • versionId
          int versionId
          Version ID.
          Since:
          7.00.000.008
        • versionName
          String versionName
          Version comment.
          Since:
          7.00.000.008
        • versionTag
          String versionTag
          Version number.
          Since:
          7.00.000.018
        • versionUserId
          int versionUserId
          ID of the user who created the workflow version.
          Since:
          7.00.000.018
        • yNCondition
          String yNCondition
          IF-Nodes: test condition, person nodes: index values or scripts, split nodes: workflow status. DB column: wf_yesnocondition
    • Class de.elo.ix.client.WorkFlowActiveDocC

      class WorkFlowActiveDocC extends Object implements Serializable
      serialVersionUID:
      509854692L
      • Serialized Fields

        • lnActiveAcl
          int lnActiveAcl
          Column length: Contains the ACL of the workflow. Only valid for begin nodes. DB column: wf_active_acl
          Since:
          11.00.000.023
        • lnComment
          int lnComment
          DB column: wf_comment
        • lnCommentTranslationKey
          int lnCommentTranslationKey
          Column length: Translation-keyword for WFNode.comment. DB column: wf_commenttrkey
          Since:
          9.00.018.005
        • lnCondition
          int lnCondition
          DB column: wf_condition
        • lnFlowName
          int lnFlowName
          DB column: wf_flow_name
        • lnFlowNameTranslationKey
          int lnFlowNameTranslationKey
          Column length: Translation-keyword for WFDiagram.name. DB column: wf_flownametrkey
          Since:
          9.00.018.005
        • lnFormSpec
          int lnFormSpec
          Column length: User defined data to be stored in the database. DB column: wf_form_spec
          Since:
          7.00.040.012
        • lnIconId
          int lnIconId
          Column length: Object-GUID of an icon file that is displayed in the designer. DB column: wf_icon_guid
          Since:
          7.00.040.012
        • lnLabel
          int lnLabel
          Column length: Display name by forwarding. DB column: wf_label
          Since:
          9.00.022.019
        • lnLabelTranslationKey
          int lnLabelTranslationKey
          Column length: Translation-keyword for WorkFlowActiveDoc.label. DB column: wf_labeltrkey
          Since:
          9.00.030.021
        • lnName
          int lnName
          DB column: wf_name
        • lnNameTranslationKey
          int lnNameTranslationKey
          Column length: Translation-keyword for WFNode.name. DB column: wf_nametrkey
          Since:
          9.00.018.005
        • lnNextServerId
          int lnNextServerId
          Column length: Next server name. This value is used in replication environments and defines the ID of the next DB column: nextserverid
          Since:
          7.00.000.014
        • lnOnActivate
          int lnOnActivate
          DB column: wf_ev_on_activate
        • lnOnEnterHandleRollback
          int lnOnEnterHandleRollback
          Column length: Name of script to be executed when the node encounters an error (exception). DB column: DB column: wf_ev_on_enter_handle_rollback
          Since:
          21.02.000.005
        • lnOnExitHandleRollback
          int lnOnExitHandleRollback
          Column length: Name of script to be executed when the node encounters an error (exception). DB column: DB column: wf_ev_on_exit_handle_rollback
          Since:
          21.02.000.005
        • lnOnTerminate
          int lnOnTerminate
          DB column: wf_ev_on_terminate
        • lnPackageName
          int lnPackageName
          Column length: PackageName of a Workflow, only used for workflow templates DB column: packagename
          Since:
          20.00.000.009
        • lnProperties
          int lnProperties
          Column length: Properties field of node. DB column: wf_properties
          Since:
          9.00.022.019
        • lnReturnValue
          int lnReturnValue
          Column length: Return value of an end node. DB column: wf_returnvalue
          Since:
          9.99.009.003
        • lnUserTerminate
          int lnUserTerminate
          DB column: wf_userterminate
        • lnVersionName
          int lnVersionName
          Column length: Version comment. DB column: wf_version_name
          Since:
          7.00.000.008
        • lnVersionTag
          int lnVersionTag
          Column length: Version number. DB column: wf_version_tag
          Since:
          7.00.000.018
        • lnYNCondition
          int lnYNCondition
          DB column: wf_yesnocondition
    • Class de.elo.ix.client.WorkflowExchangeInfo

      class WorkflowExchangeInfo extends ValueClass implements Serializable
      serialVersionUID:
      -5788666338617977775L
      • Serialized Fields

        • subWorkflowMap
          Map<Integer,WFDiagram> subWorkflowMap
          Map contains the all direct und indirect subworkflows. The workflow ID is the key.
          Since:
          9.00.030.022
        • subWorkflowVersionMap
          Map<Integer,ArrayList<WFDiagram>> subWorkflowVersionMap
          Map contains the workflow verions of the sub workflows.
          Since:
          9.00.030.022
        • userNames
          Map<Integer,UserName> userNames
          The users associated with the workflow
        • workflow
          WFDiagram workflow
          The exchanged workflow.
        • workflowVersions
          WFDiagram[] workflowVersions
          The workflow version.
    • Class de.elo.ix.client.WorkflowExportOptions

      class WorkflowExportOptions extends Object implements Serializable
      serialVersionUID:
      402835780L
      • Serialized Fields

        • characterSet
          String characterSet
          Character set for the export-data.
        • flowId
          String flowId
          Id of the workflow, that will be exported.
        • flowVersId
          String flowVersId
          Deprecated.
          Reserved.
        • format
          int format
          Export format.
          Since:
          9.00.016.017
        • wordWrap
          String wordWrap
          Word wrap for the export-data.
    • Class de.elo.ix.client.WorkflowExportOptionsC

      class WorkflowExportOptionsC extends Object implements Serializable
      serialVersionUID:
      -2157887539491497039L
    • Class de.elo.ix.client.WorkFlowHead

      class WorkFlowHead extends ValueClass implements Serializable
      serialVersionUID:
      37271022L
      • Serialized Fields

        • actServerId
          String actServerId
          The current sever ID (resp. replication branch) where the workflow can be condinued.
          Since:
          7.00.000.014
        • callNodeId
          int callNodeId
          The call node id of the main workflow, which call this sub workflow.
          Since:
          10.00.000.004
        • flowId
          int flowId
          Workflow ID
        • guid
          String guid
          GUID
        • parentWorkflow
          int parentWorkflow
          Id of the main workflow.
          Since:
          9.00.030.022
        • status
          int status
          Status, != 0 means deleted
        • tStamp
          String tStamp
          Timestamp The format is JJJJ.MM.DD.hh.mm.ss
        • tStampSync
          String tStampSync
          Timestamp of this object's last export by the replication.
          Since:
          12.02.001.003
        • type
          int type
          Workflow type.
          Since:
          7.00.000.014
    • Class de.elo.ix.client.WorkFlowHeadC

      class WorkFlowHeadC extends Object implements Serializable
      serialVersionUID:
      807993720L
      • Serialized Fields

        • lnActServerId
          int lnActServerId
          Column length: The current sever ID (resp. replication branch) where the workflow can be condinued. DB column: actserverid
          Since:
          7.00.000.014
        • lnGuid
          int lnGuid
          Column length: GUID DB column: wfguid
        • lnTStamp
          int lnTStamp
          Column length: Timestamp The format is JJJJ.MM.DD.hh.mm.ss DB column: wftstamp
        • lnTStampSync
          int lnTStampSync
          Column length: Timestamp of this object's last export by the replication. DB column: wftstampsync
          Since:
          12.02.001.003
    • Class de.elo.ix.client.WorkflowImportOptions

      class WorkflowImportOptions extends ValueClass implements Serializable
      serialVersionUID:
      2642818434240595609L
      • Serialized Fields

        • replaceMissingUserByUserId
          String replaceMissingUserByUserId
          If this variable is set, the missing user is replaced by this user. Otherwise the missing user will be created using a random password.
    • Class de.elo.ix.client.WorkflowNodeInfo

      class WorkflowNodeInfo extends ValueClass implements Serializable
      serialVersionUID:
      -7253758270858363572L
      • Serialized Fields

        • flags
          int flags
          Control flags for the node, a combination of WFNode.C.FLAG_* constants.
        • nodeName
          String nodeName
          The node name
        • workflow
          String workflow
          The template ID of the subworkflow to start.
    • Class de.elo.ix.client.WorkFlowNodeMatrix

      class WorkFlowNodeMatrix extends ValueClass implements Serializable
      serialVersionUID:
      1337377725L
      • Serialized Fields

        • flowId
          int flowId
          Workflow ID
        • isNext
          int isNext
          Contains 1, if this node is active. DB column: wf_is_next
        • nodeId
          int nodeId
          Node ID
        • succ_0
          int succ_0
        • succ_1
          int succ_1
        • succ_10
          int succ_10
        • succ_11
          int succ_11
        • succ_12
          int succ_12
        • succ_13
          int succ_13
        • succ_14
          int succ_14
        • succ_15
          int succ_15
        • succ_16
          int succ_16
        • succ_17
          int succ_17
        • succ_18
          int succ_18
        • succ_19
          int succ_19
        • succ_2
          int succ_2
        • succ_3
          int succ_3
        • succ_4
          int succ_4
        • succ_5
          int succ_5
        • succ_6
          int succ_6
        • succ_7
          int succ_7
        • succ_8
          int succ_8
        • succ_9
          int succ_9
        • succOvertime
          int succOvertime
          Id of successor node, which should be activated by the escalation.
          Since:
          9.00.030.018
        • succType
          int succType
          Type of successor node.
        • terminate
          int terminate
          ELO-date when the node was exited. DB column: wf_terminate
        • versionId
          int versionId
          Version ID.
          Since:
          7.00.000.008
    • Class de.elo.ix.client.WorkFlowNodeMatrixC

      class WorkFlowNodeMatrixC extends Object implements Serializable
      serialVersionUID:
      813423307L
      • Serialized Fields

        • lnEdgesOrdinals
          int lnEdgesOrdinals
          Column length: Sort order of edges. DB column: wf_edges_ordinals
          Since:
          9.00.030.014
  • Package de.elo.ix.client.compatibility

    • Class de.elo.ix.client.compatibility.BRequest_RawStreamService_download

      class BRequest_RawStreamService_download extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      280725475L
    • Class de.elo.ix.client.compatibility.BRequest_RawStreamService_upload

      class BRequest_RawStreamService_upload extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      527524138L
    • Class de.elo.ix.client.compatibility.BStub_RawStreamService

      class BStub_RawStreamService extends byps.BStub implements Serializable
      serialVersionUID:
      354585327L
    • Class de.elo.ix.client.compatibility.WClientC

      class WClientC extends Object implements Serializable
      serialVersionUID:
      1800529481L
  • Package de.elo.ix.client.config

  • Package de.elo.ix.client.devents

  • Package de.elo.ix.client.esearch

  • Package de.elo.ix.client.esearch.aggregations

    • Class de.elo.ix.client.esearch.aggregations.AggregationQueryParams

      class AggregationQueryParams extends Object implements Serializable
      serialVersionUID:
      725054716L
    • Class de.elo.ix.client.esearch.aggregations.AggregationResult

      class AggregationResult extends Object implements Serializable
      serialVersionUID:
      406330875L
      • Serialized Fields

    • Class de.elo.ix.client.esearch.aggregations.Bucket

      class Bucket extends Object implements Serializable
      serialVersionUID:
      856741522L
      • Serialized Fields

        • aggregations
          Map<String,AggregationResult> aggregations
          In case the bucket aggregation query has defined sub-aggregations, this Map contains the results of that sub-aggregations within this bucket.
        • docCount
          long docCount
          Number of documents belonging to the bucket's criteria.
        • from
          String from
          For aggregations of type RANGE and DATE_RANGE, this value is a string representation of the lower bound of this bucket.
        • key
          String key
          The bucket key identifying the bucket.
        • to
          String to
          For aggregations of type RANGE and DATE_RANGE, this value is a string representation of the upper bound of this bucket.
        • type
          AggregationTypeE type
          Type of aggregation.
    • Class de.elo.ix.client.esearch.aggregations.DateHistogramAggregationQueryParams

      class DateHistogramAggregationQueryParams extends AggregationQueryParams implements Serializable
      serialVersionUID:
      459332504L
      • Serialized Fields

        • bucketKeyDateFormat
          BucketKeyDateFormatE bucketKeyDateFormat
          Specifies the format of returned values of the key names of buckets.
          If this is not set, the default format is used "yyyMMddHHmmssSSS", which is the default ELO ISODate format.
        • calendarInterval
          CalendarIntervalE calendarInterval
          Specifies the width of generated buckets measured in time units (e.g. month).
          Multiple quantities, such as 6months, are not supported by ES.
        • extendedBounds
          DateRangeValue extendedBounds
          Sets optional extended bounds if parameter minDocCount equals to zero.
          Explanation:
          By default the histogram returns all the buckets within the range of the data itself, that is, the documents with the smallest values will determine the min bucket (the bucket with the smallest key) and the documents with the highest values will determine the max bucket (the bucket with the highest key). So, even if minDocCount is set to 0, you won't get empty buckets at the beginning and at the end of the intended range.
          With extended_bounds setting, you now can "force" the histogram aggregation to start building buckets on a specific min value and also keep on building buckets up to a max value (even if there are no documents anymore).
          Using extended_bounds only makes sense when min_doc_count is 0 (the empty buckets will never be returned if min_doc_count is greater than 0).

          Note that (as the name suggest) extended_bounds is not filtering buckets. Meaning, if the extended_bounds.min is higher than the values extracted from the documents, the documents will still dictate what the first bucket will be (and the same goes for the extended_bounds.max and the last bucket). For filtering buckets, one should add an appropriate filter to the search query or one could nest the histogram aggregation under a filter aggregation.


          Note that inner roundTo-Parameters within the from/to values are ignored for setting bounds.


          Note that DateNowValues (with or without relative and roundTo) are not supported for bounds.

          Note that if parameter hardBounds is also given, extendedBounds must be completely inside hardBounds, otherwise ES will emit an error.

        • hardBounds
          DateRangeValue hardBounds
          The optional hard_bounds is a counterpart of extended_bounds and can limit the range of buckets in the histogram.
          It is particularly useful in the case of not filtered time ranges that can result in a very large number of buckets.
          If you set a hard limit, all other buckets outside the limit will be omitted even if documents that should go to this buckets are present in the results.

          Note that inner roundTo-Parameters within the from/to values are ignored for setting bounds.


          Note that DateNowValues (with or without relative and roundTo) are not supported for bounds.


          Note that if parameter extendedBounds is also given, extendedBounds must be completely inside hardBounds, otherwise ES will emit an error.

        • minDocCount
          int minDocCount
          If minDocCount = 0, the response will fill gaps in the histogram with empty buckets. It is possible change that and request buckets with a higher minimum count by means of the min_doc_count setting.
          We set the default to a value of 1, to not overload the client with tons of unwanted buckets.
        • missingValue
          DateIsoValue missingValue
          The optional missingValue parameter defines how documents that are missing a value should be treated. By default they will be ignored but it is also possible to treat them as if they have a value.

          Note that inner roundTo-Parameter of DateIsoValue will be ignored here as we need an exact value.

        • offset
          DateRelative offset
          Provides an optional offset to change the start value of each bucket by the specified positive (+) or negative offset (-) duration.
          For example, when using an interval of day, each bucket runs from midnight to midnight. Setting the offset parameter to +6h changes each bucket to run from 6am to 6am.

          The offset unit must be smaller than the unit of the specified calendarInterval. For example, when using an interval of day, the offset unit can only be one of hour or minute. When using an interval of minute (smallest unit allowed), any offset makes no sense at all and will result in an error. Using an offset of year is not permitted as it is not smaller than the biggest interval unit.
          The DateRelative object contains a value for each unit. But at most one of them is allowed to be set, the others have to be zero.
        • order
          AggregationOrderE order
          The optional order buckets are retrieved.
          By default, the date_histogram aggregation orders buckets by their key ascending.

          If this value is omitted, the default will be used.
        • subAggregations
          Map<String,AggregationQuery> subAggregations
          Inner aggregations of this aggregation.
    • Class de.elo.ix.client.esearch.aggregations.DateHistogramAggregationResult

      class DateHistogramAggregationResult extends Object implements Serializable
      serialVersionUID:
      80852881L
      • Serialized Fields

        • buckets
          List<Bucket> buckets
          The result buckets.
    • Class de.elo.ix.client.esearch.aggregations.FilterAggregationQueryParams

      class FilterAggregationQueryParams extends AggregationQueryParams implements Serializable
      serialVersionUID:
      906230051L
      • Serialized Fields

        • queryOperator
          QueryOperator queryOperator
          The query operator to limit the set of documents for all sub-aggregations.
        • subAggregations
          Map<String,AggregationQuery> subAggregations
          Inner aggregations of this aggregation.
    • Class de.elo.ix.client.esearch.aggregations.FilterAggregationResult

      class FilterAggregationResult extends Object implements Serializable
      serialVersionUID:
      988167577L
      • Serialized Fields

        • aggregations
          Map<String,AggregationResult> aggregations
          This Map contains the results of all defined sub-aggregations within this filter.
        • docCount
          long docCount
          Number of documents belonging to the filter's criteria.
    • Class de.elo.ix.client.esearch.aggregations.HistogramAggregationQueryParams

      class HistogramAggregationQueryParams extends AggregationQueryParams implements Serializable
      serialVersionUID:
      361288558L
      • Serialized Fields

        • extendedBounds
          DoubleRangeValue extendedBounds
          Sets optional extended bounds if parameter minDocCount equals to zero.
          Explanation:
          By default the histogram returns all the buckets within the range of the data itself, that is, the documents with the smallest values will determine the min bucket (the bucket with the smallest key) and the documents with the highest values will determine the max bucket (the bucket with the highest key). So, even if minDocCount is set to 0, you won't get empty buckets at the beginning and at the end of the intended range.
          With extended_bounds setting, you now can "force" the histogram aggregation to start building buckets on a specific min value and also keep on building buckets up to a max value (even if there are no documents anymore).
          Using extended_bounds only makes sense when min_doc_count is 0 (the empty buckets will never be returned if min_doc_count is greater than 0).

          Note that (as the name suggest) extended_bounds is not filtering buckets. Meaning, if the extended_bounds.min is higher than the values extracted from the documents, the documents will still dictate what the first bucket will be (and the same goes for the extended_bounds.max and the last bucket). For filtering buckets, one should add an appropriate filter to the search query or one could nest the histogram aggregation under a filter aggregation.


          Note that if parameter hardBounds is also given, extendedBounds must be completely inside hardBounds, otherwise ES will emit an error.

        • hardBounds
          DoubleRangeValue hardBounds
          The optional hard_bounds is a counterpart of extended_bounds and can limit the range of buckets in the histogram.
          It is particularly useful in the case of open data ranges that can result in a very large number of buckets.
          If you set a hard limit, all other buckets outside the limit will be omitted even if documents that should go to this buckets are present in the results.

          Note that if parameter extendedBounds is also given, extendedBounds must be completely inside hardBounds, otherwise ES will emit an error.

        • interval
          DoubleSingleValue interval
          Specifies the width of generated buckets.
          The interval must be greater than zero.
          Important: The generated buckets include the lower bound and exclude the upper bound, i.e. [from, to).
        • minDocCount
          int minDocCount
          If minDocCount = 0, the response will fill gaps in the histogram with empty buckets. It is possible to change that and request buckets with a higher minimum count by means of the min_doc_count setting.
          We set the default to a value of 1, to not overload the client with tons of unwanted buckets.
        • missingValue
          DoubleSingleValue missingValue
          The optional missingValue parameter defines how documents that are missing a value should be treated. By default they will be ignored but it is also possible to treat them as if they have a value.
        • offset
          DoubleSingleValue offset
          Provides an optional offset to change the start value of each bucket by the specified positive offset.
          For example, when using an interval of 10, buckets will run from [0, 10), [10, 20), [20, 30) and so on. Setting the offset parameter to 5 changes buckets to run from [5, 15), [15, 25), [25, 35) and so on.

          The offset must be within [0, interval).
        • order
          AggregationOrderE order
          The optional order buckets are retrieved.
          By default, the histogram aggregation orders buckets by their key ascending.

          If this value is omitted, the default will be used.
        • subAggregations
          Map<String,AggregationQuery> subAggregations
          Inner aggregations of this aggregation.
    • Class de.elo.ix.client.esearch.aggregations.HistogramAggregationResult

      class HistogramAggregationResult extends Object implements Serializable
      serialVersionUID:
      6610716L
      • Serialized Fields

        • buckets
          List<Bucket> buckets
          The result buckets.
    • Class de.elo.ix.client.esearch.aggregations.RangeAggregationQueryParams

      class RangeAggregationQueryParams extends AggregationQueryParams implements Serializable
      serialVersionUID:
      24469613L
      • Serialized Fields

        • ranges
          List<DoubleRangeValue> ranges
          Defines a set of ranges - each representing a bucket.
          During the aggregation process, the values extracted from each document will be checked against each bucket range and "bucket" the relevant/matching document.
        • subAggregations
          Map<String,AggregationQuery> subAggregations
          Inner aggregations of this aggregation.
    • Class de.elo.ix.client.esearch.aggregations.RangeAggregationResult

      class RangeAggregationResult extends Object implements Serializable
      serialVersionUID:
      36047191L
      • Serialized Fields

        • buckets
          List<Bucket> buckets
          The result buckets.
    • Class de.elo.ix.client.esearch.aggregations.SingleValueMetricsAggregationQueryParams

      class SingleValueMetricsAggregationQueryParams extends AggregationQueryParams implements Serializable
      serialVersionUID:
      992002702L
      • Serialized Fields

        • missingValue
          String missingValue
          The missing parameter defines how documents that are missing a value should be treated. By default they will be ignored but it is also possible to treat them as if they had a value.
          Note: At ELO this is currently only supported for string-based values.
          Note: This field will be ignored if type is VALUE_COUNT.
    • Class de.elo.ix.client.esearch.aggregations.SingleValueMetricsAggregationResult

      class SingleValueMetricsAggregationResult extends Object implements Serializable
      serialVersionUID:
      307524579L
      • Serialized Fields

        • value
          double value
          The result of the metrics aggregation.
    • Class de.elo.ix.client.esearch.aggregations.TermsAggregationQueryParams

      class TermsAggregationQueryParams extends AggregationQueryParams implements Serializable
      serialVersionUID:
      712895929L
      • Serialized Fields

        • missingValue
          String missingValue
          The missing parameter defines how documents that are missing a value should be treated. By default they will be ignored but it is also possible to treat them as if they had a value. Note: At ELO this is (regarding terms aggregations) currently only supported for string-based values.
        • order
          AggregationOrderE order
          The optional order buckets are retrieved.
          By default, the terms aggregation orders terms by descending document count.

          If this value is omitted, the default will be used.
        • shardSizeMultiplier
          int shardSizeMultiplier
          Each aggregation will run separately on each requested shard. The shardSize parameter indicates the number of term buckets each shard will return to the coordinating node, which will compute the result buckets.
          To get more accurate results, the terms aggregation fetches more than the top size terms from each shard. It fetches the top shard_size terms, which defaults to size * 1.5 + 10.

          If useShardSizeMultiplier equals to true, this parameter must contain the multiplier replacing the value 1.5 in above term. The provided value must be greater or equal 1.
          The resulting term applied is: size * shardSizeMultiplier + 10
        • size
          int size
          By default, the terms aggregation returns the top ten terms.
          Use the size parameter to return more terms, up to the search.max_buckets limit.
          This value must be greater than zero.
        • subAggregations
          Map<String,AggregationQuery> subAggregations
          Inner aggregations of this aggregation.
        • useShardSizeMultiplier
          boolean useShardSizeMultiplier
          Each aggregation will run separately on each requested shard. The terms aggregations shardSize parameter indicates the number of term buckets each shard will return to the coordinating node. The coordinating node will compute the result buckets with size = "size".
          To get more accurate results, the terms aggregation fetches more than the top size terms from each shard. It fetches the top shard_size terms, which defaults to size * 1.5 + 10.
          See also ES documentation: https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-terms-aggregation.html#search-aggregations-bucket-terms-aggregation-shard-size
          This parameter enables providing an alternative multiplier than 1.5
          Provide this multiplier in field shardSizeMultiplier.
          See Also:

          • For normal cases the default should be sufficient. So, if you leave this value to its default "false", the parameter shardSizeMultiplier will be ignored.
    • Class de.elo.ix.client.esearch.aggregations.TermsAggregationResult

      class TermsAggregationResult extends Object implements Serializable
      serialVersionUID:
      911846964L
      • Serialized Fields

        • buckets
          List<Bucket> buckets
          The buckets (main part of a terms aggregation).
        • docCountErrorUpperBound
          long docCountErrorUpperBound
          If you set the show_term_doc_count_error parameter to true, the terms aggregation will include doc_count_error_upper_bound, which is an upper bound to the error on the doc_count returned by each shard. It’s the sum of the size of the largest bucket on each shard that didn’t fit into shard_size.
        • sumOtherDocCount
          long sumOtherDocCount
          Number of documents that didn’t make it into the the top size terms.
          If this is greater than 0, you can be sure that the terms agg had to throw away some buckets, either because they didn’t fit into size on the coordinating node or they didn’t fit into shard_size on the data node.
    • Class de.elo.ix.client.esearch.aggregations.ValueCountAggregationResult

      class ValueCountAggregationResult extends Object implements Serializable
      serialVersionUID:
      746691777L
      • Serialized Fields

        • value
          long value
          The result of the value_count aggregation.
  • Package de.elo.ix.client.esearch.configpage

    • Class de.elo.ix.client.esearch.configpage.ESInfoObj

      class ESInfoObj extends Object implements Serializable
      serialVersionUID:
      736983867L
      • Serialized Fields

        • arhiveStatus
          int arhiveStatus
        • connectionCount
          int connectionCount
        • documentCount
          int documentCount
        • installedPlugins
          List<String> installedPlugins
        • installedVersion
          String installedVersion
        • langsWithDocCount
          List<String> langsWithDocCount
        • lastUpdate
          String lastUpdate
        • nodeList
          List<ESNodeObj> nodeList
        • thesaurusLangs
          List<String> thesaurusLangs
        • thesaurusStatus
          int thesaurusStatus
    • Class de.elo.ix.client.esearch.configpage.ESInstanceSettings

      class ESInstanceSettings extends Object implements Serializable
      serialVersionUID:
      1229780589L
      • Serialized Fields

        • additionalIndex
          EsSettingsProperty additionalIndex
          Set to true if this IX should generate a separate index (e.g. second system for test purposes or scheduled reindex)
        • allowLeadingWildcards
          EsSettingsProperty allowLeadingWildcards
          Allow leading wildcard for search queries. Defaults to false. Setting it to true might result in very poor search perfomance.
          Since:
          11.00.000.045
        • archiveLang
          String archiveLang
          Archive language.

          Immutable.

        • clusterName
          EsSettingsProperty clusterName
          Elasticsearch cluster name.
        • completion
          EsSettingsProperty completion
          Query "auto completion" on search
        • configuredLangs
          EsSettingsProperty configuredLangs
          Configured languages (without archive language), separated by comma
        • continueReindexOnFailure
          EsSettingsProperty continueReindexOnFailure
          Define if reindex process should be continued or interrupted on failure.
        • correction
          EsSettingsProperty correction
          Query "corrections" on search
        • feedAnalyzer
          EsSettingsProperty feedAnalyzer
          Define if feed should use archive language, one of the configured languages or try to determine the language based on content.
        • germanAnalyzer
          EsSettingsProperty germanAnalyzer
          Option to define a analyzer for German language without decomposition (to speed up analysis process, but results in worse search results). Default: empty or "elo_german". Set to "elo_german_without_decomp" to use analyzer without decomposition.
        • hosts
          EsSettingsProperty hosts
          Elasticsearch host address.
        • indexingDisabled
          EsSettingsProperty indexingDisabled
          Define if this IX instance should be used to run reindex and updater thread. Can only be set instance specific.
        • indexingOfMetadataFieldsViaKeywordingRelationEnabled
          EsSettingsProperty indexingOfMetadataFieldsViaKeywordingRelationEnabled
          EIX-1567: Erlaubt das Indizieren von markierten Indexfeldern von Sords, die über Felder vom Typ RELATION referenziert werden. Die markierten Felder der so referenzierten Sords werden mit im referenzierenden Sord indiziert. Nur relevant für Sords mit Aspekt-Data-Organisation. Defaults to true.
          Since:
          21.00.000.019
        • indexName
          EsSettingsProperty indexName
          Elasticsearch index name
        • instanceName
          String instanceName
        • maxAmountOfReferencesInErrorFolder
          EsSettingsProperty maxAmountOfReferencesInErrorFolder
          Maximum number of references created in Reindex error folder during reindex process
        • maxFulltextLength
          EsSettingsProperty maxFulltextLength
          Define the maximun length for fulltext documents indexed by iSearch. If not set or set to <= 0, complete documents are indexed.
        • maxObjsPerReindexInterval
          EsSettingsProperty maxObjsPerReindexInterval
          Maximum number of objects to be processed in one time unit of updater. Default: 1.000. Set to -1 if nothing should be changed.
        • maxObjsPerUpdateInterval
          EsSettingsProperty maxObjsPerUpdateInterval
          Maximum number of objects selected by reindexer. Default: 10.000 Set to -1 if nothing should be changed.
        • maxSearchResults
          EsSettingsProperty maxSearchResults
          Define how many results should be returned with findFirstSords and findNextSords (in total!) by iSearch. Defaults to 10000.
          Since:
          11.00.000.045
        • maxTokenLength
          EsSettingsProperty maxTokenLength
          Maximum length of tokens in elastic search. Defaults to 300, max 10922. Set to -1 if nothing should be changed.
        • nbOfAllowedLangs
          int nbOfAllowedLangs
          Number of allowed languages.

          Immutable.

        • nodeName
          EsSettingsProperty nodeName
          Elasticsearch node name
        • numberOfShards
          EsSettingsProperty numberOfShards
          Number of shards per index in Elasticsearch. Default: 1.
        • numberOfShardsByMaskId
          EsSettingsProperty numberOfShardsByMaskId
          Define the nuber of shards for individual masks. Use a higher number of (e.g. 3) for masks with many objects. Masks which are not defined with this setting use numberOfShards. Syntax: maskId:number of shards;maskId: number of shards, e.g. "23:2;34:5"
        • reindexFromObjId
          EsSettingsProperty reindexFromObjId
          Reindex processes object IDs >= this one. Set to -1 to delete, everything >= 0 is written to db (if lower than reindexToObjId) Always needs to send reindexFromObjId and reindexToObjId.
        • reindexStarted
          String reindexStarted
          Reindex started at this time. Format: yyyyMMddHHmmss Timezone: JVM default.
        • reindexToObjId
          EsSettingsProperty reindexToObjId
          Reindex processes object IDs <= this one. Set to -1 to delete, everything >= 0 is written to db (if greater than reindexFromObjId) Always needs to send reindexFromObjId and reindexToObjId.
        • searchAnalyzer
          EsSettingsProperty searchAnalyzer
          Define a special analyzer to use during search. Please make sure the defined analyzer exists. Remove or set to "default" to disable.
        • skipNonAsciiStepsOnFallback
          EsSettingsProperty skipNonAsciiStepsOnFallback
          Determines if we should skip some analyzer steps when we use the fallback analyzer. The skipped steps are trimming non-ascii chars from the analyzed text. Setting this option to true results in using a different fallback analyzer both for indexing and search without the trimming steps. This analyzer is meant to be used only for fulltext docs (body and summary) and not for Sord fields. Defaults to false.
          Since:
          12.00.000.055
        • synonyms
          EsSettingsProperty synonyms
          Query synonyms on search
        • updaterFromTs
          EsSettingsProperty updaterFromTs
          Process documents newer than this date. Format: yyyyMMddHHmmss Timezone: JVM default.
        • updaterInterval
          EsSettingsProperty updaterInterval
          How often should the updater run? Interval in seconds
        • updaterNextStart
          EsSettingsProperty updaterNextStart
          Next start of updater. Format: yyyyMMddHHmmss. Timezone: JVM default.
        • useSsl
          boolean useSsl
          Use SSL encryption.
    • Class de.elo.ix.client.esearch.configpage.ESNodeObj

      class ESNodeObj extends Object implements Serializable
      serialVersionUID:
      -4251768664742770857L
      • Serialized Fields

    • Class de.elo.ix.client.esearch.configpage.ESSettingsObj

      class ESSettingsObj extends Object implements Serializable
      serialVersionUID:
      -2640461774038361797L
      • Serialized Fields

        • allInstanceNames
          ArrayList<String> allInstanceNames
          List of all instance names
        • instanceName
          String instanceName
          Name of this IX instance
        • instanceSettings
          ArrayList<ESInstanceSettings> instanceSettings
          List of instance settings. Contains settings (as in database) for instance _ALL and every IX instance.
    • Class de.elo.ix.client.esearch.configpage.EsSettingsProperty

      class EsSettingsProperty extends Object implements Serializable
      serialVersionUID:
      640416996L
      • Serialized Fields

        • defaultValue
          String defaultValue
          Default value of property.
        • possibleValues
          ArrayList<String> possibleValues
          List of all possible values. If empty, there are no specified possible values.
        • value
          String value
          Value of property as set in database. If empty, default value is used.
    • Class de.elo.ix.client.esearch.configpage.ESStatusObj

      class ESStatusObj extends Object implements Serializable
      serialVersionUID:
      4211519077381032064L
      • Serialized Fields

        • esConnection
          boolean esConnection
          Is this IX connected to the Elasticsearch server.
        • lastExceptionReindexer
          String lastExceptionReindexer
          Last exception of reindexer of this IX
        • lastExceptionUpdater
          String lastExceptionUpdater
          Last exception of updater of this IX
        • runningReindexers
          Map<String,String> runningReindexers
          List of all IXs with an active reindex process. It returns the IX ID and its progress percent.
        • runningUpdaters
          Map<String,String> runningUpdaters
          List of all IXs with an active updater process. It returns the IX ID and its progress percent.
  • Package de.elo.ix.client.esearch.query

    • Class de.elo.ix.client.esearch.query.AggregationQuery

      class AggregationQuery extends Object implements Serializable
      serialVersionUID:
      471128847L
      • Serialized Fields

        • aggregationQueryParams
          AggregationQueryParams aggregationQueryParams
          Contains type specific parameters (e.g. for type=TERMS parameters size, sub-aggregations, ...)
        • fieldType
          FieldTypeE fieldType
          Defines the concrete ES field together with searchField.
          Options are tokenized, not tokenized, numeric, date.
          See Also:
        • indexFieldKey
          String indexFieldKey
          If searchfield equals to SearchFieldE.INDEXFIELD, provide the name of the index field here.
          If searchField != SearchFieldE.INDEXFIELD, this value is ignored. If the associated docmask is of type DocMaskC.DATA_ORGANISATION_OBJKEYS or DATA_ORGANISATION_TABLE the value of this field should be the line key of the docMaskLine. If the associated docMask is of type DocMaskC.DATA_ORGANISATION_ASPECT the value of this field should be the name of the aspectAssoc followed by "¶" followed by the line key of the aspectLine, e.g. CUSTOMERADDRESS¶STREET.
        • name
          String name
        • searchField
          SearchFieldE searchField
          Provides the constant of the field to be aggregated.
          To aggregate an index field, set this to SearchFieldE.INDEXFIELD and provide its name in indexFieldKey.
          See Also:
        • type
          AggregationTypeE type
    • Class de.elo.ix.client.esearch.query.AndOperator

      class AndOperator extends QueryOperator implements Serializable
      serialVersionUID:
      547828846L
      • Serialized Fields

        • queryObjectList
          List<QueryObject> queryObjectList
          List of QueryObjects which are and combined.
    • Class de.elo.ix.client.esearch.query.ContextTermQuery

      class ContextTermQuery extends Object implements Serializable
      serialVersionUID:
      -7982429242697412307L
      • Serialized Fields

        • filter
          QueryFilter filter
          Specify the field and type for which a context term should be returned.
        • isNegated
          boolean isNegated
          To exclude a value from contextTerms, use set isNegated=true. Defaults to false.
          Since:
          11.00.000.002
        • returnType
          ContextTermReturnTypeE returnType
          Specify the return type of this ContextTerm.
    • Class de.elo.ix.client.esearch.query.NotOperator

      class NotOperator extends QueryOperator implements Serializable
      serialVersionUID:
      1458099644L
      • Serialized Fields

        • queryFilter
          QueryFilter queryFilter
          A negated QueryObject.
          Since:
          10.17.059.012
    • Class de.elo.ix.client.esearch.query.OrOperator

      class OrOperator extends QueryOperator implements Serializable
      serialVersionUID:
      841639079L
      • Serialized Fields

        • queryObjectList
          List<QueryObject> queryObjectList
          List of QueryObjects which are or combined.
    • Class de.elo.ix.client.esearch.query.QueryFilter

      class QueryFilter extends QueryObject implements Serializable
      serialVersionUID:
      594680222L
      • Serialized Fields

        • boost
          float boost
          Boost for calculated relevance.
          A field can be boosted and therefore has a higher influence on the calculated relevance.
          For more information, refere to https://www.elastic.co/guide/en/elasticsearch/guide/current/multi-query-strings.html#prioritising-clauses
        • docMaskLine
          String docMaskLine
          Deprecated.
          use indexFieldKey instead
          Provide the name of the index field here.
          If searchField != SearchFieldC.INDEXFIELD, this value is ignored.
        • fieldType
          FieldTypeE fieldType
          Define how to search for a value.
          Options are tokenized, not tokenized, numeric, date.
          The delivered FilterValue must match this fieldType, if not, an exception is thrown.
          See Also:
        • indexFieldKey
          String indexFieldKey
          Provide the name of the index field here.
          If searchField != SearchFieldC.INDEXFIELD, this value is ignored. If the associated docmask is of type DocMaskC.DATA_ORGANISATION_OBJKEYS or DATA_ORGANISATION_TABLE the value of this field should be the line key of the docMaskLine. If the associated docMask is of type DocMaskC.DATA_ORGANISATION_ASPECT the value of this field should be the name of the aspectAssoc followed by "¶" followed by the line key of the aspectLine, e.g. CUSTOMERADDRESS¶STREET.
          Since:
          20.00.000.100
        • searchField
          SearchFieldE searchField
          Provide the constant of the field to search in.
          To search in a index field, set this to SearchFieldC.INDEXFIELD and provide its name in indexFieldKey.
          See Also:
        • value
          FilterValue value
          The value for the QueryFilter.
          See Also:
    • Class de.elo.ix.client.esearch.query.QueryObject

      class QueryObject extends Object implements Serializable
      serialVersionUID:
      -4675061948286107766L
    • Class de.elo.ix.client.esearch.query.QueryOperator

      class QueryOperator extends QueryObject implements Serializable
      serialVersionUID:
      -6252029088323417632L
      • Serialized Fields

        • operatorType
          OperatorType operatorType
          Operator to be used to combine the objects. This field is required in REST calls to distinguish between the operators AndOperator and OrOperator.
          Since:
          21.02.000.002
  • Package de.elo.ix.client.esearch.query.data

  • Package de.elo.ix.client.feed

    • Class de.elo.ix.client.feed.Action

      class Action extends ValueClass implements Serializable
      serialVersionUID:
      5181017258899789203L
    • Class de.elo.ix.client.feed.ActionC

      class ActionC extends ActionDataC implements Serializable
      serialVersionUID:
      1988394652L
    • Class de.elo.ix.client.feed.ActionDataC

      class ActionDataC extends Object implements Serializable
      serialVersionUID:
      423487901L
      • Serialized Fields

        • lnAcl
          int lnAcl
          Column length: Raw ACL representation. Only valid for Actions of type EActionType.UserComment or DB column: actionacl
          Since:
          9.00.000.034
        • lnCreateDateIso
          int lnCreateDateIso
          Column length: Create date. This element is the ISO formatted create date of the action. When this object is DB column: createdateiso
        • lnDocVersionGuid
          int lnDocVersionGuid
          Column length: GUID of the associated document version. This element is only valid for generated actions that DB column: docversionguid
        • lnFeedGuid
          int lnFeedGuid
          Column length: Feed GUID. This action belongs to the feed identified by this GUID. DB column: feedguid
        • lnGuid
          int lnGuid
          Column length: Action GUID. Unique identifier. DB column: actionguid
        • lnParentGuid
          int lnParentGuid
          Column length: Parent action GUID. This element is only valid for user comments, DB column: parentguid
        • lnText
          int lnText
          Column length: Comment text. This element is only valid for EActionType.UserComment, and DB column: actiontext
        • lnTStamp
          int lnTStamp
          Column length: Time stamp. Time stamp of creation or modification. DB column: actiontstamp
        • lnTStampSync
          int lnTStampSync
          Column length: Timestamp of this object's last export by the replication. DB column: actiontstampsync
          Since:
          9.99.009.001
        • lnUpdateDateIso
          int lnUpdateDateIso
          Column length: Update date. This element is only valid for EActionType.UserComment. It holds the ISO DB column: updatedateiso
        • lnUserGuid
          int lnUserGuid
          Column length: User GUID. The GUID of the user who has created this action. For actions of type DB column: userguid
        • lnWorkflowGuid
          int lnWorkflowGuid
          Column length: GUID of the associated workflow. This element is valid for action types that belong to a DB column: workflowguid
    • Class de.elo.ix.client.feed.ActionHistDataC

      class ActionHistDataC extends Object implements Serializable
      serialVersionUID:
      734763371L
      • Serialized Fields

        • lnActionGuid
          int lnActionGuid
          Column length: Action GUID. Unique identifier. DB column: actionguid
        • lnCreateDateIso
          int lnCreateDateIso
          Column length: Create date. This element is the ISO formatted create date of the action in the time zone of DB column: createdateiso
        • lnText
          int lnText
          Column length: Comment text. This element is only valid for EActionType.UserComment, and DB column: actiontext
    • Class de.elo.ix.client.feed.ActionHistory

      class ActionHistory extends ValueClass implements Serializable
      serialVersionUID:
      598833764L
    • Class de.elo.ix.client.feed.ActionHistoryC

      class ActionHistoryC extends ActionHistDataC implements Serializable
      serialVersionUID:
      442981425L
    • Class de.elo.ix.client.feed.ActionZ

      class ActionZ extends Object implements Serializable
      serialVersionUID:
      1006784044L
      • Serialized Fields

        • bset
          long bset
    • Class de.elo.ix.client.feed.BRequest_FeedNotification_updateAction

      class BRequest_FeedNotification_updateAction extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      688797212L
      • Serialized Fields

    • Class de.elo.ix.client.feed.BRequest_FeedService_checkinAction

      class BRequest_FeedService_checkinAction extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      1138765790L
    • Class de.elo.ix.client.feed.BRequest_FeedService_checkoutAction

      class BRequest_FeedService_checkoutAction extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      1737190301L
    • Class de.elo.ix.client.feed.BRequest_FeedService_checkoutHashTag

      class BRequest_FeedService_checkoutHashTag extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      122354907L
    • Class de.elo.ix.client.feed.BRequest_FeedService_createAction

      class BRequest_FeedService_createAction extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      643943187L
    • Class de.elo.ix.client.feed.BRequest_FeedService_createHashTagSubscription

      class BRequest_FeedService_createHashTagSubscription extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      1471082196L
      • Serialized Fields

    • Class de.elo.ix.client.feed.BRequest_FeedService_findFirstActions

      class BRequest_FeedService_findFirstActions extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      334710983L
    • Class de.elo.ix.client.feed.BRequest_FeedService_findFirstHashTagRelation

      class BRequest_FeedService_findFirstHashTagRelation extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      2144547950L
    • Class de.elo.ix.client.feed.BRequest_FeedService_findFirstNotification

      class BRequest_FeedService_findFirstNotification extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      906090337L
    • Class de.elo.ix.client.feed.BRequest_FeedService_findHashTagByActions

      class BRequest_FeedService_findHashTagByActions extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      421489164L
    • Class de.elo.ix.client.feed.BRequest_FeedService_findHashTags

      class BRequest_FeedService_findHashTags extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      66310175L
    • Class de.elo.ix.client.feed.BRequest_FeedService_findNextActions

      class BRequest_FeedService_findNextActions extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      933597872L
    • Class de.elo.ix.client.feed.BRequest_FeedService_findNextHashTagRelation

      class BRequest_FeedService_findNextHashTagRelation extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      1204755579L
    • Class de.elo.ix.client.feed.BRequest_FeedService_findNextNotification

      class BRequest_FeedService_findNextNotification extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      1326557416L
      • Serialized Fields

    • Class de.elo.ix.client.feed.BRequest_FeedService_findPostActions

      class BRequest_FeedService_findPostActions extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      116865123L
    • Class de.elo.ix.client.feed.BRequest_FeedService_internalInsertSystemAction

      class BRequest_FeedService_internalInsertSystemAction extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      1637137212L
    • Class de.elo.ix.client.feed.BRequest_FeedService_registerNotify

      class BRequest_FeedService_registerNotify extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      458959949L
    • Class de.elo.ix.client.feed.BRequest_FeedService_unregisterNotify

      class BRequest_FeedService_unregisterNotify extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      285270298L
    • Class de.elo.ix.client.feed.BStub_FeedNotification

      class BStub_FeedNotification extends byps.BStub implements Serializable
      serialVersionUID:
      320199695L
    • Class de.elo.ix.client.feed.BStub_FeedService

      class BStub_FeedService extends byps.BStub implements Serializable
      serialVersionUID:
      1670701039L
    • Class de.elo.ix.client.feed.Feed

      class Feed extends ValueClass implements Serializable
      serialVersionUID:
      7019850817229028849L
      • Serialized Fields

        • createDateIso
          String createDateIso
          Create date. It holds the ISO formatted create date in the time zone of the client application. In order to convert this value into a date object, invoke function IXConnection.isoToDate(java.lang.String).
        • guid
          String guid
          Feed GUID.
        • objGuid
          String objGuid
          GUID of the associated Sord object.
        • tStamp
          String tStamp
          Time stamp. Time stamp of creation or modification.
        • TStampSync
          String TStampSync
          Timestamp of this object's last export by the replication.
          Since:
          9.99.009.001
    • Class de.elo.ix.client.feed.FeedC

      class FeedC extends FeedDataC implements Serializable
      serialVersionUID:
      714225908148142628L
    • Class de.elo.ix.client.feed.FeedDataC

      class FeedDataC extends Object implements Serializable
      serialVersionUID:
      1837685365L
      • Serialized Fields

        • lnCreateDateIso
          int lnCreateDateIso
          Column length: Create date. It holds the ISO formatted create date in the time zone of the client application. DB column: createdateiso
        • lnGuid
          int lnGuid
          Column length: Feed GUID. DB column: feedguid
        • lnObjGuid
          int lnObjGuid
          Column length: GUID of the associated Sord object. DB column: objguid
        • lnTStamp
          int lnTStamp
          Column length: Time stamp. Time stamp of creation or modification. DB column: feedtstamp
        • lnTStampSync
          int lnTStampSync
          Column length: Timestamp of this object's last export by the replication. DB column: feedtstampsync
          Since:
          9.99.009.001
    • Class de.elo.ix.client.feed.FeedPost

      class FeedPost extends Object implements Serializable
      serialVersionUID:
      -2513762112620351635L
      • Serialized Fields

        • creatorIds
          HashSet<Integer> creatorIds
          List of all user IDs which created any action
        • feedGuid
          String feedGuid
          GUID of corresponding feed (read from parentAction.feedGuid)
        • hashTags
          HashSet<String> hashTags
          List of all hashtags of actions if action.type == EActionType.UserComment
        • lastChanged
          String lastChanged
          Date of last change of any action
        • linkedGuids
          HashSet<String> linkedGuids
          List of GUIDs which are linked in any action if action.type == EActionType.UserComment
        • mentions
          HashSet<String> mentions
          List of all mentions (UserNames) of actions if action.type == EActionType.UserComment
        • parentAction
          Action parentAction
          an action where action.parentGuid is empty
        • sordGuid
          String sordGuid
          GUID of corresponsing Sord
        • subActions
          List<Action> subActions
          List of all subActions (action.parentGuid = parentAction.guid)
        • text
          String text
          Text of all actions, separated by a whitespace
        • textList
          List<String> textList
          List of all texts of all actions
        • versionComment
          String versionComment
          Version comment of corresponding DocVersion if parentAction.getDocVersionGuid() is set.
        • versionName
          String versionName
          Name of corresponding DocVersion if parentAction.getDocVersionGuid() is set.
    • Class de.elo.ix.client.feed.FeedZ

      class FeedZ extends Object implements Serializable
      serialVersionUID:
      126672288L
      • Serialized Fields

        • bset
          long bset
    • Class de.elo.ix.client.feed.FindActionsInfo

      class FindActionsInfo extends Object implements Serializable
      serialVersionUID:
      1747180074L
      • Serialized Fields

        • actionTypes
          List<EActionType> actionTypes
          Search by action types. If this element is empty, actions of all types are returned.
          Since:
          9.00.012.001
        • createDateIso
          String createDateIso
          Search by create date. A date range can be specified by using the default range delimiter "..." or the one defined in FindOptions.getRangeDelimiter(). The time part is assumed to be in the timezone defined by ClientInfo.getTimeZone().
        • findHashTags
          boolean findHashTags
          Search for HashTags If this member is true, all HashTags within the action will be returned
          Since:
          9.00.022.016
        • findNotifications
          boolean findNotifications
          Search for notifications. If this member is true, only those actions are found for which the user was notified.
          Since:
          9.00.014.003
        • findResultAccessMode
          FindResultAccessMode findResultAccessMode
          Describes how the client application will access the results.
          Since:
          11.00.000.033
        • findSubscriptions
          boolean findSubscriptions
          If true a Map<String, Subscription> will be set in the FindResult
          Since:
          9.00.030.016
        • objId
          String objId
          Search by Sord ID, GUID, etc. This value can be an ID, a GUID or an expression as defined in IXServicePortIF.checkoutSord(de.elo.ix.client.ClientInfo, String, de.elo.ix.client.EditInfoZ, de.elo.ix.client.LockZ).
        • sordZ
          SordZ sordZ
          Sord element selector. If this member is not null or empty, the returned FindResult object contains the associated Sord objects in FindResult.sords.
          Since:
          9.00.014.003
        • spaceGuid
          String spaceGuid
          Collect feed actions of all items in a teamspace or workspace. This option contains the Sord.getGuid() of a teamspace or workspace and can only be combinded with FindActionsInfo.createDateIso, FindActionsInfo.actionTypes, FindActionsInfo.userId, and FindActionsInfo.sordZ.
          Since:
          21.03.000.007
        • userId
          String userId
          Search by user ID, GUID, name.
    • Class de.elo.ix.client.feed.FindActionsInfoC

      class FindActionsInfoC extends Object implements Serializable
      serialVersionUID:
      -3734752200843264454L
    • Class de.elo.ix.client.feed.FindHashTagInfo

      class FindHashTagInfo extends Object implements Serializable
      serialVersionUID:
      5681720607302211088L
      • Serialized Fields

        • actionZ
          ActionZ actionZ
          Action element selector.
          Since:
          9.00.030.007
        • createDateIso
          String createDateIso
          Search by create date. A date range can be specified by using the default range delimiter "..." or the one defined in FindOptions.getRangeDelimiter().
        • findFeeds
          boolean findFeeds
          If true a Map<String, Feed> will be set in the FindResult. by default true
          Since:
          9.00.030.007
        • findHashTags
          boolean findHashTags
          Since:
          9.00.030.020
        • findResultAccessMode
          FindResultAccessMode findResultAccessMode
          Describes how the client application will access the results.
          Since:
          11.00.000.033
        • findSubscriptions
          boolean findSubscriptions
          If true a Map<String, Subscription> will be set in the FindResult
          Since:
          9.00.030.016
        • hashtagGuidOrName
          String hashtagGuidOrName
          HashTag Guid or Name
        • lastUsedIso
          String lastUsedIso
          Search by last used. A date range can be specified by using the default range delimiter "..." or the one defined in FindOptions.getRangeDelimiter().
        • minCount
          int minCount
          Filter the result by number of use. Only HashTags with >= minCount will be returned
          Since:
          9.00.030.004
        • sordZ
          SordZ sordZ
          Sord element selector.
          Since:
          9.00.030.007
    • Class de.elo.ix.client.feed.FindNotificationInfo

      class FindNotificationInfo extends Object implements Serializable
      serialVersionUID:
      -8724906273158945941L
      • Serialized Fields

        • actionZ
          ActionZ actionZ
          Action element selector.
          Since:
          9.00.030.007
        • createDateIso
          String createDateIso
          Search by create date. A date range can be specified by using the default range delimiter "..." or the one defined in FindOptions.getRangeDelimiter().
        • findFeeds
          boolean findFeeds
          If true a Map<String, Feed> will be set in the FindResult. by default true
          Since:
          9.00.030.007
        • findHashTags
          boolean findHashTags
          If true a List<HashTagRelation> and a Map<String, HashTag> will be set in the FindResult
          Since:
          9.00.030.007
        • findSubscriptions
          boolean findSubscriptions
          If true a Map<String, Subscription> will be set in the FindResult
          Since:
          9.00.030.016
        • inclImportant
          boolean inclImportant
          If true and createDateIso is set, it will also return all Notifications marked as Important even if they are not in the specified createDate range. If true and createDateIso is not set, it will return only Notifications marked as Important
        • sordZ
          SordZ sordZ
          Sord element selector.
        • userGuidOrID
          String userGuidOrID
          GUID or ID or Name of the User. If null, current user will be set. If GUID/ID is not the current user, admin rights are needed to preform the search
        • what
          int what
          Reserved.
    • Class de.elo.ix.client.feed.HashTag

      class HashTag extends ValueClass implements Serializable
      serialVersionUID:
      5780542477763314377L
      • Serialized Fields

        • counter
          int counter
          Counter. Counts how often this HashTag is used.
        • createDateIso
          String createDateIso
          Create date. It holds the ISO formatted create date in the time zone of the client application. In order to convert this value into a date object, invoke function IXConnection.isoToDate(java.lang.String).
        • hstgGuid
          String hstgGuid
          HashTag GUID. Unique identifier.
        • hstgName
          String hstgName
          HashTag Name.
        • lastUsedIso
          String lastUsedIso
          Last used. It holds the ISO formatted date of the last use of this HashTag In order to convert this value into a date object, invoke function IXConnection.isoToDate(java.lang.String).
        • status
          int status
          Status.
        • tStamp
          String tStamp
          Timestamp for replication.
    • Class de.elo.ix.client.feed.HashTagC

      class HashTagC extends HashTagDataC implements Serializable
      serialVersionUID:
      250741620L
    • Class de.elo.ix.client.feed.HashTagDataC

      class HashTagDataC extends Object implements Serializable
      serialVersionUID:
      513648569L
      • Serialized Fields

        • lnCreateDateIso
          int lnCreateDateIso
          Column length: Create date. It holds the ISO formatted create date in the time zone of the client application. DB column: createdateiso
        • lnHstgGuid
          int lnHstgGuid
          Column length: HashTag GUID. Unique identifier. DB column: hstgguid
        • lnHstgName
          int lnHstgName
          Column length: HashTag Name. DB column: hstgname
        • lnLastUsedIso
          int lnLastUsedIso
          Column length: Last used. It holds the ISO formatted date of the last use of this HashTag In order to convert DB column: lastusediso
        • lnTStamp
          int lnTStamp
          Column length: Timestamp for replication. DB column: tstamp
    • Class de.elo.ix.client.feed.HashTagRelation

      class HashTagRelation extends ValueClass implements Serializable
      serialVersionUID:
      6753963508100629552L
      • Serialized Fields

        • actionGuid
          String actionGuid
          Guid of the Action in which the HashTag is used.
        • hashtagGuid
          String hashtagGuid
          Guid of the HashTag.
        • status
          int status
          Status.
        • tStamp
          String tStamp
          Timestamp for replication.
    • Class de.elo.ix.client.feed.HashTagRelationC

      class HashTagRelationC extends HashTagRelationDataC implements Serializable
      serialVersionUID:
      4683775591391452558L
    • Class de.elo.ix.client.feed.HashTagRelationDataC

      class HashTagRelationDataC extends Object implements Serializable
      serialVersionUID:
      2035445347L
      • Serialized Fields

        • lnActionGuid
          int lnActionGuid
          Column length: Guid of the Action in which the HashTag is used. DB column: actionguid
        • lnHashtagGuid
          int lnHashtagGuid
          Column length: Guid of the HashTag. DB column: hashtagguid
        • lnTStamp
          int lnTStamp
          Column length: Timestamp for replication. DB column: tstamp
    • Class de.elo.ix.client.feed.HashTagRelationZ

      class HashTagRelationZ extends Object implements Serializable
      serialVersionUID:
      -21280714186404733L
      • Serialized Fields

        • bset
          long bset
    • Class de.elo.ix.client.feed.HashTagZ

      class HashTagZ extends Object implements Serializable
      serialVersionUID:
      -4906803239829308435L
      • Serialized Fields

        • bset
          long bset
  • Package de.elo.ix.client.fio

  • Package de.elo.ix.client.health

    • Class de.elo.ix.client.health.BRequest_HealthCheckService_computeDoubleValue

      class BRequest_HealthCheckService_computeDoubleValue extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      1919177848L
    • Class de.elo.ix.client.health.BRequest_HealthCheckService_read

      class BRequest_HealthCheckService_read extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      771256331L
    • Class de.elo.ix.client.health.BRequest_HealthCheckService_update

      class BRequest_HealthCheckService_update extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      1948144488L
    • Class de.elo.ix.client.health.BRequest_HealthCheckService_updateAll

      class BRequest_HealthCheckService_updateAll extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      720562919L
    • Class de.elo.ix.client.health.BRequest_HealthCheckService_updateDoubleValue

      class BRequest_HealthCheckService_updateDoubleValue extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      677413784L
      • Serialized Fields

    • Class de.elo.ix.client.health.BRequest_HealthCheckService_updateMeanValue

      class BRequest_HealthCheckService_updateMeanValue extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      1150533084L
      • Serialized Fields

        • ci
          ClientInfo ci
        • meanValue
          double meanValue
        • name
          String name
        • sampleSize
          long sampleSize
    • Class de.elo.ix.client.health.BRequest_HealthCheckService_uploadAll

      class BRequest_HealthCheckService_uploadAll extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      1827236639L
    • Class de.elo.ix.client.health.BStub_HealthCheckService

      class BStub_HealthCheckService extends byps.BStub implements Serializable
      serialVersionUID:
      969424915L
    • Class de.elo.ix.client.health.HealthCheckInfo

      class HealthCheckInfo extends ValueClass implements Serializable
      serialVersionUID:
      -4637445262440338798L
      • Serialized Fields

        • doubleValue
          double doubleValue
          Numeric value. Either this value or HealthCheckInfo.stringValue has to be set.
        • maxValue
          long maxValue
          Maximaler Wert für mean values.

          EIX-1408

          Since:
          20.00.000.001
        • minValue
          long minValue
          Minimaler Wert für mean values.

          EIX-1408

          Since:
          20.00.000.001
        • name
          String name
          Value name.
        • operation
          HealthCheckValueOperation operation
          Operation to process when updating the value.
          Since:
          10.00.020.016
        • sampleSize
          long sampleSize
          Sample size for mean values. If HealthCheckInfo.doubleValue is a arithmetic mean, this value gives the number of the underlying samples. If HealthCheckInfo.stringValue is set, this value has to be 0.
        • stringValue
          String stringValue
          String value. Either this or HealthCheckInfo.doubleValue has to be set.
        • timeStamp
          String timeStamp
          Since:
          20.00.000.002
        • type
          HealthCheckInfoType type
          Type defining interpretation of the given data.

          EIX-1408

          Since:
          20.00.000.001
    • Class de.elo.ix.client.health.HealthCheckInfoC

      class HealthCheckInfoC extends Object implements Serializable
      serialVersionUID:
      526645641L
      • Serialized Fields

        • lnDoubleValue
          int lnDoubleValue
          Column length: Numeric value. Either this value or #stringValue has to be set. DB column: doubleValue
        • lnName
          int lnName
          Column length: Value name. DB column: name
        • lnSampleSize
          int lnSampleSize
          Column length: Sample size for mean values. If #doubleValue is a arithmetic mean, this value gives the DB column: sampleSize
        • lnStringValue
          int lnStringValue
          Column length: String value. Either this or #doubleValue has to be set. DB column: stringValue
    • Class de.elo.ix.client.health.HealthCheckInfos

      class HealthCheckInfos extends ValueClass implements Serializable
      serialVersionUID:
      2499354165522755418L
  • Package de.elo.ix.client.importexport

    • Class de.elo.ix.client.importexport.ExportDesc

      class ExportDesc extends ValueClass implements Serializable
      serialVersionUID:
      1913823875L
      • Serialized Fields

        • exportRefPath
          String[] exportRefPath
          The path of the exported element or when multiple sords are exported the computed common path
        • sourceArchive
          String sourceArchive
          The name of the source repository of the export
  • Package de.elo.ix.client.ldap

    • Class de.elo.ix.client.ldap.BRequest_LdapService_configure

      class BRequest_LdapService_configure extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      1889131443L
    • Class de.elo.ix.client.ldap.BRequest_LdapService_createConfig

      class BRequest_LdapService_createConfig extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      2060589937L
    • Class de.elo.ix.client.ldap.BStub_LdapService

      class BStub_LdapService extends byps.BStub implements Serializable
      serialVersionUID:
      1709005937L
    • Class de.elo.ix.client.ldap.Domain

      class Domain extends ValueClass implements Serializable
      serialVersionUID:
      111619615L
      • Serialized Fields

        • attributeForUserPropOS
          String attributeForUserPropOS
          LDAP attribute to be used as OS name for UserInfoC.PROP_NAME_OS. This value is either Domain.AD_SAM_ACCOUNT_NAME or Domain.AD_USER_PRINCIPAL_NAME. If set as Domain.AD_USER_PRINCIPAL_NAME, also set Domain.searchFilterForPerson to Domain.FILTER_PERSON_USER_PRINCIPAL_NAME. Default is sAMAccountName.
          Since:
          11.00.000.060
        • attributeNameMail
          String attributeNameMail
          Name of attribute that contains the user's mail address. Defaults to "mail".
        • attributeNameMemberOf
          String attributeNameMemberOf
          Name of attribute that contains the user's groups. Defaults to "memberOf".
        • attributesToRead
          Set<String> attributesToRead
          Read this LDAP attributes into ldapProperties of UserInfo. The attributes Domain.getAttributeNameMail() and Domain.getAttributeNameMemberOf() are always read and need not to be included in this collection.
        • attributeSuperior
          String attributeSuperior
          Attribute to determine the superior of an ELO user. Set this attribute ID e.g. to Domain.AD_ATTRIBUTE_MANAGER to assign the superior of a user on login. This value is empty by default, which means that ELO Administrator (user ID 0) is assigned as superior.
          Since:
          12.00.000.052
        • connectionTimeoutSeconds
          int connectionTimeoutSeconds
          Timeout limit when connecting to a LDAP server.
        • defaultUserName
          String defaultUserName
          Optional user name to connect to the LDAP servers. This account must have the permission to list the group associations of all users. It does not need to be an ELO account too.
        • defaultUserPasswordEncr
          String defaultUserPasswordEncr
          Optional encrypted user password to connect to the LDAP servers. This password can also be set in plain text. It is automatically encrypted when stored into a file or database.
        • domainPrefix
          String domainPrefix
          Domain prefix. The login name of the user is prefixed by this value to build the user property UserInfoC.PROP_NAME_OS. When using this prefix, users should also use this prefix for login. This value must end with a separator char, e.g. backslash. E.g. ELO\\
        • groupSearchDNList
          List<String> groupSearchDNList
          Search paths to find groups. If empty, only those groups are assigned to the user in ELO the user is a direct member of in LDAP. If not empty, the user's groups are recursively searched through group in group membership. A group found via this search is always added to the user regardless of whether its location fits to the given list. But groups that do not match any location are not investigated deeper.
        • initialContextEnvironment
          Map<String,String> initialContextEnvironment
          Additional properties to build the login environment. Example: initialContextEnvironment.put(Context.SECURITY_AUTHENTICATION, "DIGEST-MD5");
        • maxGroupNesting
          int maxGroupNesting
          Groups are collected recursively up to this depth. A value of 0 means no depth limit. This value is ignored, if Domain.groupSearchDNList is empty.
        • name
          String name
          Domain name. E.g. ELO.LOCAL
        • nameFormatter
          String nameFormatter
          Format string to build a unique ELO account name from LDAP attributes. LDAP attributes have to be enclosed in $. Examples: 1. $cn$, $department$ ; 2. $sAMAccountName$ $department$
        • parentOfNewUser
          String parentOfNewUser
          Assign this user as parent for a new ELO user. ID, GUID or name of existing ELO user or group that is assigned as UserInfo#parent when a new ELO user is created. This value is empty by default, which means that ELO Administrator (user ID 0) is assigned as parent.
          Since:
          12.00.000.056
        • personSearchDNList
          List<String> personSearchDNList
          Search paths to find persons. Only users that are found in one of this DN can login to ELO. E.g. "cn=users,dc=elotest2,dc=local".
        • requiredGroup
          String requiredGroup
          Users must be member of this LDAP group. Optional, short LDAP group name (not a DN) the user must be a member of in order to login. The membership in this group is checked after the group list has been collected. Hence, Domain.groupSearchDNList and Domain.maxGroupNesting have an effect on this check too. The comparison to this value is case-sensitive.
        • searchFilterForGroups
          String searchFilterForGroups
          Name of attribute that contains the user's groups. Defaults to "(&(objectCategory=group)(member={0}))"
        • searchFilterForMail
          String searchFilterForMail
          Search filter for mail address. Defaults to "(&(objectclass=person)(mail={0}))"
        • searchFilterForPerson
          String searchFilterForPerson
          Search filter for person. Defaults to "(&(objectclass=person)(sAMAccountName={0}))"
        • searchTimeLimitSeconds
          int searchTimeLimitSeconds
          Search for groups can least up to this number of seconds.
        • servers
          List<Server> servers
          List of LDAP servers of the domain.
    • Class de.elo.ix.client.ldap.LdapConfig

      class LdapConfig extends ValueClass implements Serializable
      serialVersionUID:
      944564842L
      • Serialized Fields

        • assignGroups
          boolean assignGroups
          If authentication succeeds, update the user's memberships in ELO groups.
        • createNewUser
          boolean createNewUser
          If authentication succeeds, create a new ELO user if she does not already exist.
        • domains
          List<Domain> domains
          List of configuration data for each domain.
        • enabled
          boolean enabled
          Enable/disable authentication via LDAP.
          Since:
          20.00.000.004
        • name
          String name
          Configuration name. Optional configuration name.
        • notResponsibleForUserOrGroupIds
          Set<String> notResponsibleForUserOrGroupIds
          List of user IDs, or user GUIDs, or group IDs (not group GUIDs) that cannot be authenticated by this UserDirectory. If the user passed in UserDirectory.authenticate, parameter loginName, is associated to an ID found in this list, function authenticate returns NOT_RESPONSIBLE_FOR_AUTHENTICATION. This value is also returned, if one of the user's groups is included in the list. The list contains user ID 0 (Administrator) and UserInfoC.GUID_ELOSERVICE (ELO Service), if this LdapConfig object is initialized by LdapService.createConfig(de.elo.ix.client.ClientInfo).
    • Class de.elo.ix.client.ldap.Server

      class Server extends ValueClass implements Serializable
      serialVersionUID:
      809425097L
      • Serialized Fields

        • lastException
          String lastException
          An exception message if connection to Server.ldapUrl failed.
        • lastLoginDurationMillis
          long lastLoginDurationMillis
          Duration of last login. Read only.
        • ldapUrl
          String ldapUrl
          URL to access the LDAP directory.
        • priority
          double priority
          Priority for using this URL compared to others. Higher value means more preferred.
  • Package de.elo.ix.client.myelo

  • Package de.elo.ix.client.notify

    • Class de.elo.ix.client.notify.BRequest_ClientNotification_adminMode

      class BRequest_ClientNotification_adminMode extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      475567923L
      • Serialized Fields

    • Class de.elo.ix.client.notify.BRequest_ClientNotification_updateTask

      class BRequest_ClientNotification_updateTask extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      1469990419L
    • Class de.elo.ix.client.notify.BStub_ClientNotification

      class BStub_ClientNotification extends byps.BStub implements Serializable
      serialVersionUID:
      2104055021L
  • Package de.elo.ix.client.plugin

    • Class de.elo.ix.client.plugin.BRequest_PluginService_configure

      class BRequest_PluginService_configure extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      825244123L
    • Class de.elo.ix.client.plugin.BRequest_PluginService_getHistory

      class BRequest_PluginService_getHistory extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      944056329L
    • Class de.elo.ix.client.plugin.BRequest_PluginService_getPlugin

      class BRequest_PluginService_getPlugin extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      1954453218L
    • Class de.elo.ix.client.plugin.BRequest_PluginService_getPlugins

      class BRequest_PluginService_getPlugins extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      458507499L
    • Class de.elo.ix.client.plugin.BRequest_PluginService_install

      class BRequest_PluginService_install extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      686541360L
    • Class de.elo.ix.client.plugin.BRequest_PluginService_send

      class BRequest_PluginService_send extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      246697101L
    • Class de.elo.ix.client.plugin.BRequest_PluginService_start

      class BRequest_PluginService_start extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      942759383L
    • Class de.elo.ix.client.plugin.BRequest_PluginService_stop

      class BRequest_PluginService_stop extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      246682643L
    • Class de.elo.ix.client.plugin.BRequest_PluginService_uninstall

      class BRequest_PluginService_uninstall extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      1004077015L
    • Class de.elo.ix.client.plugin.BRequest_PluginService_upload

      class BRequest_PluginService_upload extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      785341652L
    • Class de.elo.ix.client.plugin.BStub_PluginService

      class BStub_PluginService extends byps.BStub implements Serializable
      serialVersionUID:
      2078870031L
    • Class de.elo.ix.client.plugin.PluginInfo

      class PluginInfo extends Object implements Serializable
      serialVersionUID:
      1597637633L
      • Serialized Fields

        • id
          long id
          Plugin ID. This value is transient and might change after Indexserver has re-loaded or re-started.
        • serviceNames
          List<String> serviceNames
          List of service names provides by this plugin. A list of full qualified class names, e.g. IXServerEvents.class.getName(), WorkflowNodeEvents.class.getName(), DynamicKeywordEvents.class.getName()
          Since:
          10.99.999.010
        • state
          PluginState state
          Plugin state.
        • symbolicName
          String symbolicName
          Plugin name. Symbolic name of OSGi plugin.
    • Class de.elo.ix.client.plugin.PluginMessage

      class PluginMessage extends byps.BValueClass implements Serializable
      serialVersionUID:
      1652390957L
      • Serialized Fields

        • bytes
          Map<String,byte[]> bytes
          Byte array parameters. In case of a HTTP request or response, this element can contain the response data at map key PluginMessageC.BODY.
        • id
          long id
          Message ID.
        • objects
          Map<String,byps.BValueClass> objects
          API object parameters. E.g. Sord objects. In case of a HTTP request or response, this element is ignored.
        • parameters
          Map<String,String> parameters
          String parameters.
        • source
          PluginMessageSource source
          Message source. Read only.
        • status
          int status
          Message response status code. In case of a HTTP request, this element specifies the response status code. A value of 0 is implicitly mapped to 200.
        • streams
          Map<String,InputStream> streams
          Stream parameters. In case of a HTTP request or response, this element can contain the response data at map key PluginMessageC.BODY.
        • uri
          String uri
          Message URI.
    • Class de.elo.ix.client.plugin.PluginMessageC

      class PluginMessageC extends Object implements Serializable
      serialVersionUID:
      2130586885L
  • Package de.elo.ix.client.search

  • Package de.elo.ix.client.subs

  • Package de.elo.ix.client.system

    • Class de.elo.ix.client.system.ArchivReport

      class ArchivReport extends ValueClass implements Serializable
      serialVersionUID:
      -1230371933360025610L
    • Class de.elo.ix.client.system.ArchivValue

      class ArchivValue extends ValueClass implements Serializable
      serialVersionUID:
      -1965890382477333238L
      • Serialized Fields

        • count
          int count
        • year
          int year
    • Class de.elo.ix.client.system.BRequest_SystemInformation_archivReport

      class BRequest_SystemInformation_archivReport extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      1995041693L
    • Class de.elo.ix.client.system.BRequest_SystemInformation_countDocsInStorePath

      class BRequest_SystemInformation_countDocsInStorePath extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      1786633213L
    • Class de.elo.ix.client.system.BRequest_SystemInformation_licenseReport

      class BRequest_SystemInformation_licenseReport extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      821360905L
    • Class de.elo.ix.client.system.BRequest_SystemInformation_userReport

      class BRequest_SystemInformation_userReport extends byps.BMethodRequest implements Serializable
      serialVersionUID:
      2081672491L
    • Class de.elo.ix.client.system.BStub_SystemInformation

      class BStub_SystemInformation extends byps.BStub implements Serializable
      serialVersionUID:
      708455930L
    • Class de.elo.ix.client.system.LicenseCounter

      class LicenseCounter extends ValueClass implements Serializable
      serialVersionUID:
      1522145897474644048L
      • Serialized Fields

        • accessMap
          HashMap<Integer,Integer> accessMap
          License counters. Counter 0 contains the number of writes from a full client.
        • countType
          int countType
          Deprecated.
        • disabled
          boolean disabled
          True, if the user has been inactive for 30 days.
        • sumAccess
          int sumAccess
          Deprecated.
        • userInfo
          UserInfo userInfo
          User object.
    • Class de.elo.ix.client.system.LicenseReport

      class LicenseReport extends ValueClass implements Serializable
      serialVersionUID:
      1033535844041026475L
      • Serialized Fields

        • counterList
          List<LicenseCounter> counterList
          list of counter delegated from am
        • deletedUser
          int deletedUser
          Deprecated.
        • freeUser
          int freeUser
          Deprecated.
        • fullUser
          int fullUser
          Deprecated.
        • ixUser
          int ixUser
          Deprecated.
        • licenseType
          LicenseType licenseType
          License type.
          Since:
          20.00.000.106
        • nbOfIgLicenses
          int nbOfIgLicenses
          Deprecated.
          Number of ELO Internet Gateway users. This field is not used anymore.
        • nbOfServerLicenses
          int nbOfServerLicenses
          Deprecated.
          Number of server licenses. This field is not used anymore.
        • reportMode
          int reportMode
          report period / access mode.
          Since:
          12.00.000.049
        • serno
          String serno
          Deprecated.
          License key. This field is not used anymore.
    • Class de.elo.ix.client.system.SystemInfo

      class SystemInfo extends ValueClass implements Serializable
      serialVersionUID:
      -5962790692980969040L
      • Serialized Fields

        • endDate
          long endDate
          Select documents created before or on this date. This is an ISODate in UTC.
        • reportMode
          UserReportZ reportMode
          Report mode for SystemInformation.userReport(de.elo.ix.client.ClientInfo, SystemInfo) to determine which information should be reported.
          Since:
          12.00.000.049
        • startDate
          long startDate
          Select documents created on or after this date. This is an ISODate in UTC.
        • storePathID
          int storePathID
          ID of the StoreInfo where the documents should be counted.
        • userReportMode
          long userReportMode
          Deprecated.
    • Class de.elo.ix.client.system.SystemReport

      class SystemReport extends ValueClass implements Serializable
      serialVersionUID:
      -2730548240809318936L
      • Serialized Fields

        • doccount
          long doccount
        • docsize
          long docsize
        • ftsize
          long ftsize
        • previewsize
          long previewsize
    • Class de.elo.ix.client.system.UserReport

      class UserReport extends ValueClass implements Serializable
      serialVersionUID:
      5744252549902757250L
      • Serialized Fields

        • childIds
          List<Integer> childIds
          List of child IDs.
          Since:
          12.00.000.049
        • counterGroup
          int counterGroup
          Count of groups.
          Since:
          12.00.000.049
        • counterNoLogin
          int counterNoLogin
          Count of users without login flag.
          Since:
          12.00.000.049
        • counterTotal
          int counterTotal
          Total count of all users.
          Since:
          12.00.000.049
        • counterUser
          int counterUser
          Count of users.
          Since:
          12.00.000.049
        • dmsDesktopUserIds
          List<Integer> dmsDesktopUserIds
          List of DMS Desktop user IDs.
          Since:
          12.00.000.049
        • optionGroupIds
          List<Integer> optionGroupIds
          List of option group IDs.
          Since:
          12.00.000.049
        • subadminIds
          List<Integer> subadminIds
          List of subadmin IDs.
          Since:
          12.00.000.049
        • userNames
          List<UserName> userNames
          All user names.
          Since:
          12.00.000.049
    • Class de.elo.ix.client.system.UserReportC

      class UserReportC extends Object implements Serializable
      serialVersionUID:
      681073719490914217L
    • Class de.elo.ix.client.system.UserReportZ

      class UserReportZ extends ValueClass implements Serializable
      serialVersionUID:
      -3463963604631807637L
      • Serialized Fields

        • bset
          long bset
  • Package de.elo.ix.client.webapp.servlet