Package de.elo.ix.client
package de.elo.ix.client
IndexServer API classes.
These classes are used in the API of the IndexServer.
-
ClassDescriptionThis class defines constants for access rights.This class contains the option for the methode getAclAccessThis class contains the result return by the method getAclAccess.Human readable ACL entry.Types of ACL items.This class represents an activity.Constants for class Activity.Bit constants for members of ActivityThis class represents an option for an activity project.Constants for class ActivityOptionThis class represents an activity project.Constants for class ActivityProject.Bit constants for members of ActivityProjectTyped element selector for class Activity.Constants for the administration mode.Deprecated.This class is not used in any Indexserver function.Bit constants for members of AlertThis class is a container for one value of a serializable type.This class defines the constants for the type member in Any.This class defines which notification messages the server has to send.Characteristic properties of the archive.An object of this class controls the function getArchiveStatistics.Archive path.This class defines a keywording aspect.This class defines an aspect association.Bit constants for members of AspectAssocConstants related to class
Aspect
.Bit constants for members of AspectAspect info object.This class contains data for a line in a document mask, ifDocMask.dataOrganisation
=DocMaskC.DATA_ORGANISATION_ASPECT
.Constants for classAspectLine
Bit constants for members of AspectLineThis class encapsulates the constants of the AspectC class.Options for functionIXServicePortIF.evalAutoFiling(ClientInfo, String, Sord, AutoFilingOptions)
Contains the archive destination returned by a call toIXServicePortIF.evalAutoFiling(ClientInfo, String, Sord, AutoFilingOptions)
.This class represents settings of a ELOdm backup profile.This class represents the status of the ELOdm backup and purge tasksThis class represents the status of the ELOdm backup taskInternal class.This class is used in the scripting API of Indexserver and provides bit operations on 64 bit integers.Aspect cardinality.Option class for the methode CheckInDocMaskLineTemplateThis class defines options for the API function checkinDocBegin2.Objects of this class specify the selection criteria forcheckinOrgUnits
.Objects of this class specify the selection criteria forcheckinReport
.Constants for the functioncheckinUsers
.This class encapsulates the constants of CheckinUsersC.Objects of this class specify the selection criteria forIXServicePortIF.checkoutOrgUnits(ClientInfo, CheckoutOrgUnitInfo, LockZ)
No criterias can be set yet.Constants to select users and groupsThis class encapsulates the constants of CheckoutUsersC.Parameter class for the method checkoutWorkflowHistory.This class contains the results returned by the function checkoutWorkflowHistory.Contains the session ticket and the users language and country.Constants for ClientInfo.Colours for marking entries in the archive.Bit constants for members of ColorDataThis class specifies additional options for compareAcl.This class contains the results returned by the function combineAcl.This class defines the parameters for computing a document file hash byIXServicePortIF.computeDocumentHash(ClientInfo, ComputeDocumentHashInfo)
.This class provides the result data computed byIXServicePortIF.computeDocumentHash(ClientInfo, ComputeDocumentHashInfo)
.Used for accessing directories or files on the server.Constants for the ConfigFile class.This class encapsulates the constants of ConfigFileC.Mode for the ELOdm backup and purge tasksConstants for class ControlBackupInfo (mode for the ELOdm backup and purge tasks)Controls the options of de.elo.ix.IXServicePortIF.copySord().Structure for the options for the copy-process.Results of aProcessCopyElements
-Operation.Constants to copy or move archive entries, or to create a logical link.This class encapsulates the constants of the CopySordsC class.This class provides counters for use by the access manager.Constants class for the CounterInfo class.Class for the results of one count process.This class defines an encryption set.This class defines options for the API function deleteActivity.This class contains options for deleting archive entries using theIXServicePortIF.deleteSord(ClientInfo, String, String, LockZ, DeleteOptions)
function.Objects of this class specify the selection criteria fordeleteOrgUnits
.Document version data, e.Bit constants for members of DocHistoryDocument information table of DM.Bit constants for members of DocInfoDMContains the data for a storage mask.Constants related to classDocMask
.Bit constants for members of DocMaskThis class contains a member of aDocMask
object.This class describes how a keywording form inherits from another keywording form.Bit constants for members of DocMaskInheritThis class contains data for a line in the document mask.Constants for classDocMaskLine
.Bit constants for members of DocMaskLineThis class contains data for a document mask line template.Constants related to classDocMaskLineTemplate
.Bit constants for members of DocMaskLineTemplateThis class encapsulates the constants of the DocMaskLineTemplateC class.This class encapsulates the constants of the DocMaskC class.Document object with identifier and version arrays for the document and attachments.Description: This class describes a document version, a document preview or a signature.Authentication type.Contains data to edit the indexing information.Constants to read data for editing the indexing information of an archive entryOptions for reading or writing of esw-files.This class encapsulates the constants of the EditInfoC class.Internal class.Internal classBit constants for members of EloDmOptInternal class.Internal class.Bit constants for members of EloFtOptInternal class.Bit constants for members of EloFtStopInternal class.Internal class.Bit constants for members of EloIxOpt_oldBit constants for members of EloIxOptThis class represents an event used by the event bus API functions.Constants related to the event bus API.This class supplies params to control the creation of an event bus ID.This class describes an event filter.This class describes an event bus listener.This class is used to specify which script has to be executed in function executeScript.The function executeScript returns an object of this class to provide returned information or error information.Options for extended export.Constant class for the ExportExtOptions class.Constants class for the ExportOptions class.Class for the data contained in a file.Member constants for class FileData.Member selector for class FileData.This class specifies constraints for the API functionIXServicePortIF.findFirstActivities(ClientInfo, FindActivityInfo, int, ActivityZ)
.This class defines the options for IXServicePortIF.findActivityProjects.Find criterias for selecting alerts.Find objects by ACLThis class contains disjunct conditions to search for aspect data in the database.Deprecated.This class is used to search for objects that have to be indexed by the fulltext database engine.Constants forFindByFulltextCtrl
.A search using FindByFulltextCtrl returns this result items in addition to findResult.sords.Additional information for an item found by fulltext search.Finds an object according to the object's index properties.Finds an object according to the objects notes (sticky notes) content.This class can be used to find the documents for which preview files have to be created.This class holds additional information for FindInfo, in order to restrict a search using document types.This class holds additional information for FindInfo, in order to restrict a search using the document history (version).This class controls the search for child objects of an archive entry.This class describes the files to select from a postbox directory or from a configuration directory.Deprecated.Constants used in class FindDirectCriteria for searching sords for keywording relation.This class controls the search function findFirstSords.SQL command that is built from a FindInfo object.Finds the links of an object.This class contains several options to control the search process of findFirstSords.Objects of this class specify the selection criteria for report entries infindReport
.This class contains the search results of a call toIXServicePortIF.findFirstSords
This constants are used to control the caching of find results.This class specifies the sorting criteria of a search for aspect data.Find criteria for function findFirstSubscriptions.This class contains the search criteria that are required for locating a task (reminders, workflow tasks or activity).This class is used to find translations of terms.Constants forFindTranslateTermInfo
.This class describes the search criteria forIXServicePortIF.findFirstUsers(de.elo.ix.client.ClientInfo, de.elo.ix.client.FindUserInfo, int)
.This class contains the search criteria for selecting workflows.This class describes a font.This class controls workflow node forwarding inIXServicePortIF.forwardWorkflowNode(ClientInfo, int, int, ForwardWorkflowNodeInfo, LockZ)
.This class provides information about the configuration of the fulltext database.Constants for class FulltextConfig.Parameter class for the functionIXServicePortIF.getWebDAVPathFromObjID2(de.elo.ix.client.ClientInfo, de.elo.ix.client.GetWebDAVPathOptions)
Class for the result of the IX functionIXServicePortIF.getWebDAVPathFromObjID2(de.elo.ix.client.ClientInfo, de.elo.ix.client.GetWebDAVPathOptions)
This class contains information from the HttpServletRequest received by the Indexserver servletThis class contains information for the HttpServletResponse object to be sent by the Indexserver servlet.Contains an numeric ID value, a GUID value in string format and a name.Defines the Options of an Import.This class represents a condition to filter aspect data of typeIndexValueC.TYPE_DOUBLE
in the database.This class represents a condition to filter aspect data of typeIndexValueC.TYPE_INT
in the database.The constants in this class define the supported operations for conditions when searching for aspect objects in the database.This class represents a condition to filter aspect data that is not of typeIndexValueC.TYPE_INT
orIndexValueC.TYPE_DOUBLE
in the database.This class is used to search for index values in aspect objects.Association between Indexserver URL and archive name.This class is a container for one value of a serializable type.This class defines the constants for the type member in IndexValue.Constants for cache invalidation.This class contains the parameters for the API function invalidateCache2ParamObject for InvalidateCacheInfo.This class contains the result of a invalidateCache2 call.BAuthentication implementation for IXConnection.Interface used as abstraction for authentication logic.AIXAuthenticationIF
implementation for normalizedIXConnection
.This class encapsulates anIXAuthenticationIF
object to intercept authentication functions.Deprecated.Use de.elo.ix.client.IXConnection class.Deprecated.This class encapsulates an OutputStream for downloading a document.Indexserver connection class.This functional interface is called after when the connection is closed.IXConnection interface.This class wraps a IXConnectionIF to intercept function calls.This class is used to create IXConnection objects that represent sessions to Indexserver.This class contains the parts of a RemoteException in member variables.Handler interface for event bus events.This class contains constant definitions for Indexserver error numbers used in Indexserver exceptions.This class describes an exception that can occur during the execution of an Index server function.The Indexserver fires this events while processing API calls.Execution context of server events.Constants for options and classes used by Indexserver.Indexserver API.This class forwards old API functions to the new API.A HWireClient class special to ELO Indexserver.Objects of this class provide information on the state of any background processes.Contains information about a key object: ID and name.This class contains a name and an associated value.This class provides general informations for a keyword list.Bit constants for members of KeywordListThis Class contains parameters for the IX callIXServicePortIF.checkoutKeywordsDynamic(ClientInfo, KeywordsDynamicInfo)
.The class KeywordsDynamicResult defines the return value of the IX callIXServicePortIF.checkoutKeywordsDynamic(ClientInfo, KeywordsDynamicInfo)
.This class encapsulates the constants of KeywordC.This class contains license information.License information to be checked withIXServicePortIF.checkLicense(ClientInfo, LicenseInfo)
.Result of license check.Constants for linkSord(...).This class encapsulates the constants of LinkSordC.Constants to lock data against concurrent modification.This class encapsulates the constants of the LockC class.Object returned when logging in to the IX.Options for functionIXServerEvents.onBeforeLogin(IXServerEventsContext, String, LoginScriptOptions)
Constants forLoginScriptOptions
.This class represents a map which contains user defined key-value pairs.Constant class for MapDataThis class contains the information of a map domain.This class defines constants for the predefined map tables.Bit constants for members of MapDomainInternal class.Bit constants for members of MapHeadVersion history for maps.Element selectors for class MapHist.Bit constants for members of MapHistThis class provides the version information for a map attribute that has been modified.Bit constants for members of MapHistItemInternal class.Bit constants for members of MapItemThis class represents map values.Mask name object.Parameter class of the functionIXServicePortIF.moveDocuments(ClientInfo, MoveDocumentsInfo)
.NavigationInfo is used as traversal information for structured bulk operations restricting specific processsing, e.g.Constants class for the NavigationInfo class.This helper class inherits all members fromNoteData
and adds a static member to access the bit constants for theNoteData
members.Constants for notes.Bit constants for members of NoteThis class describes a freehand line annotation.Constants for NoteFreehandThis class contains additional information for image stamps.This class describes the template information for a stamp.Constants for class NoteTemplateBit constants for members of NoteTemplateThis class conatins additional information for textual notes.This class encapsulates the constants of the NoteC class.Objects of this class represent a change notification.Constants for class Notification.Bit constants for members of NotificationThis class encapsulates the constants ofNotificationC
This class is used in IXServicePortIF.notifyServer to describe which operation(s) has (have) been processed by the client application.This class is used as a return value of IXServicPortIF.notifyServer.Internal class.Bit constants for members of ObjChangeBit constants for members of SordBit constants for members of SordHistBit constants for members of SordHistKeyThis class wraps the ObjKeyData class to provide a convenient way to access the index lines that have multiple columns.Constants for the ObjKey class.Internal use.Bit constants for members of ObjKeyDataBit constants for members of SordLinkThis class defines the properties of an OCR request.Constants for OCR processing.This class describes a request for querying the supported languages of the OCR.This class describes an OCR analysis request.This class contains the coordinates of a rectangle and is used by theOcrInfoRecognizeFile
class.This class contains the informations about an OCR result.This class contains the result of a OcrInfoQueryLanguages request.This class contains the result of an OCR analysis.This class is used to describe an OCR worker process.Data class containing organizational unit information data.Constants related to organizational unit information.Data class containing some organizational unit information data: name and IDConstants for the class PackageDataCDescribes checkout criteria forPackageService.checkoutPackages(ClientInfo ci, PackageCheckoutInfo checkoutInfo, PackageDataZ packageZ, LockZ lockZ)
.Export aller Daten im Repository zu einem Package EIX-1895This class defines a package.Bit constants for members of PackageDataType safe element selector for class PackageData.Describe delete criteria forPackageService.deletePackages(ClientInfo ci, PackageDeleteInfo deleteInfo, LockZ unlockZ)
.Describe export criteria forPackageService.exportPackageContent(ClientInfo ci, PackageExportInfo exportInfo)
.Describe event info for onAfterPackageImport.This class defines a package level.Bit constants for members of PackageLevelDataResult of the functionPackageService.checkoutPackages(ClientInfo ci, PackageCheckoutInfo checkoutInfo, PackageDataZ packageZ, LockZ lockZ)
EIX-1895This interface provides functions to access packages.This class represents one row in the database table physdel.Constants for the PhysDel.type member.Bit constants for members of PhysDelInternal class.Bit constants for members of PhysDelDocsThis class describes a 2D point.This class is used to assign or remove ACLs to an object.Copy archive elements in other position in the archive.This class make possible the count of the archive elements.Fulltext-Property to be added to/removed from an object.Specific processing information for each node of processTrees(...) or processFindResults(...).Constants class for the ProcessInfo class.This class of keywording.This class specifies the options for moving a document into another storage path.This class specifies the options for setting a sord'sSord.regionId
(i.e.Releases the locks on archive elements.Replication sets to be added to/removed from an object.NOT CURRENTLY SUPPORTEDThis class specifies the options for setting a sord's spaceGuid (i.e.This class describes the public download information.Constants for class PublicDownload.Bit constants for members of PublicDownloadThis class contains several options that are used to get the public downloads.This class represents the purge settings of the ELOdm purge taskConstants for class PurgeSettingsThis class represents the status of the ELOdm purge taskConstants for querying log messages of background jobs.AQueryJobProtocolEvent
represents a eventThis class contains the parameters for the interface functionIXServicePortIF.queryJobProtocol(ClientInfo, QueryJobProtocolInfo)
.This class contains the results from querying the protocol of a background thread.Internal class.Bit constants for members of RelationBit constants for members of ReminderConstants for replication codes.Internal classBit constants for members of RepliHistObjects of this class store the replication information of archive entries.Internal class.Bit constants for members of ReplSetCombinationProperties of a replication set.Bit constants for members of ReplSetNameBit constants for members of ReportInfoThis class describes an ERP code - a filter code number in the ELO report.This class describes a report/protocol entry for an action carried out in the archive.Report information.Additional report information for modified user.Additional report information for user modifications.This class encapsulates the constants ofReportModeC
This class contains the codes for the activities/processes that are to be protocolled in a report.Constants for report modeParameter Class forIXServicePortIF.resolveRights(ClientInfo, UserInfo, ResolveRightsInfo)
.Class for the result of the IX-FunctionIXServicePortIF.resolveRights(ClientInfo, UserInfo, ResolveRightsInfo)
.Constants forResolveRightsResult
.This class contains several options for undeleting archive SORDs byrestoreSord
This class defines options used inFindOptions.searchMode
.This class encapsulates the constants ofSearchModeC
License key, version and list of other IndexserversThis class contains infomation about the filing paths of the document manager (DM).Constants used by the members of the class ServerInfoDM.Internal class.Bit constants for members of ServerStateProvides details of the current session with the Index ServerObjects of this class hold an array of options that are used to manipulate the current Indexserver session.Constants of SessionOptions.Indexing information of an archive entry.Constants for indexing information.Objects of this class are data elements and control the values assigned to certain boolean properties(yes/no attributes).Version history for the keywording from an object.Constanst for class SordHist.This class provides the version information for a keywording attribute that has been modified.This class represents a link to an archive entry.Constants-class for the table links.Each file structure element is assigned a SordType.Constants for folder or document types.Bit constants for members of SordTypeThis class encapsulates the constants ofSordTypeC
This class encapsulates the constants ofSordC
This class contains constants for sorting of archive entries and search results.Possible sorting sequences of database searches for aspect data.This class contains several options that are used to start the AdHocWorkflowThis class is used as a parameter in the functionIXServicePortIF.startWorkFlow2(ClientInfo, String, StartWorkflowInfo)
.This class represents a storage path.Definition of a document path.This class describes a subscription.Bit constants for members of SubscriptionDeprecated.Replaced bySubstitution
Deprecated.Replaced bySubstitutionC
Internal class.Bit constants for members of ThesaurusObjects of this class represent one term in different languages.Constants for class TranslateTerm.Bit constants for members of TranslateTermDataThis class describes additional params for an upload or download URL.Data class containing the user information data for the user logged in to the Index server.Constants related to user information.Contains user name, ID and type (group or user).This class contains the information of a user node using to create a AdHocWorkflow.User profile optionsThe constants in this class exist due to compatibility requirements with older Index Server versions, which gave back formatted data (Sord.xDataDispl).Internal class.Bit constants for members of UserProfileDataDescribes the tasks assigned to a user.This class encapsulates the constants of the UserTaskSortOrderC class.Objects of this class contain the returned data from IXServicePortIF.getDistinctValuesOfObjKey.Internal class.Bit constants for members of VtDocThis class is used to synchronize the workflow cache.Data used to display a workflow node int the task view.This class is used as a parameter in the functionIXServicePortIF.delegateWorkFlowNode(ClientInfo, WFDelegateNodeInfo, LockZ)
.This class represents an active or finished workflow or a workflow templateConstants for workflows.This class encapsulates the constants of the WFDiagramC class.Data required for processing a workflow person node.Objects of this class represent a workflow node.Represents a bridge (connection) in a workflow diagramConstants forWorkFlowNode
.Version history for a workflow node.Bit constants for members of WFNodeHistoryStores the relationship between workflow nodesThese constants describe the type of connection between two nodes.This class encapsulates the constants of the WFNodeC class.Constant class for controlling the taking over(passing to another user) of a workflow object.This class describes a time limit for a workflow or for a person node of a workflow.Constants class for WFType.This class encapsulates the constants of the WFTypeC class.Version information for a workflow template.Constants for WFVersionInternal class.Bit constants for members of WorkFlowActiveDocThis class represents a workflow export data.Structure for the options for the workflow-export.Contants related to the workflow export.Helperclass to access the DB table workflowtemplhead, workflowactivedochead, ...Bit constants for members of WorkFlowHeadOptions for the workflow import.Helperclass to access the node matrix.Bit constants for members of WorkFlowNodeMatrix