Package de.elo.ix.client

Class IXServicePortIF_BYPS

java.lang.Object

de.elo.ix.client.IXServicePortIF_BYPS

All Implemented Interfaces:

byps.Remote, IXServicePortIF, de.elo.utils.net.Remote, Remote

public class IXServicePortIF_BYPS
extends Object
implements IXServicePortIF

This class forwards old API functions to the new API. The new API functions do not require a ClientInfo parameter. This parameter is set internally on a low level by the IXConnection class. In order to have the old API available, this class defines an implementation of the old API and forwards all functions to the associated IXConnection object.

Field Summary

Fields inherited from interface de.elo.ix.client.IXServicePortIF

serialVersionUID

Constructor Summary

Constructors

Constructor	Description
IXServicePortIF_BYPS(IXConnFactory connFact, IXConnection firstConn)

Method Summary

Modifier and Type	Method	Description
boolean	activateSubstitution(ClientInfo ci, String substituionGuid, LockZ unlockZ)	Activate the submitted substitution.
String	addUrlParams(ClientInfo ci, String url, UrlParams params)	Adds additional params to an upload or download URL.
int	adminMode(ClientInfo ci, int mode)	Queries, enters or leaves the administration mode.
void	alive(ClientInfo ci)	Extends the ticket lifetime.
ApplyForNotificationsInfo	applyForNotifications(ClientInfo ci, ApplyForNotificationsInfo info)	Specify, which notifications should be sent by the server.
WFEditNode	beginEditWorkFlowNode(ClientInfo ci, int nFlowId, int nNodeId, LockZ lockZ)	Locks a person task node of an active workflow inside the database and returns data needed to edit it.
WFEditNode	beginForwardWorkflowNode(ClientInfo ci, int flowId, int nodeId, BeginForwardWorkflowNodeInfo forwardNodeInfo, LockZ lockZ)	Prepare forwarding of a workflow node.
EditInfo	changeSordMask(ClientInfo ci, Sord sord, String maskId, EditInfoZ editInfoZ)	Changes the storage mask of a archive entry.
String	checkinActivity(ClientInfo ci, Activity act, LockZ unlockZ)	This function inserts or updates an activity.
String	checkinActivityProject(ClientInfo ci, ActivityProject actProj, LockZ unlockZ)	This function writes an activity project into the database.
int	checkinAspect(ClientInfo ci, Aspect aspect, AspectZ aspectZ, LockZ lockZ)	Update or insert an Aspect object.
void	checkinColors(ClientInfo ci, ColorData[] colors, LockZ unlockZ)	Check-in the marker definitions (colors for the archive entries).
void	checkinConfigFiles(ClientInfo ci, ConfigFile[] configFiles, LockZ unlockZ)	Uploads configuration files to the configuration directory on the server.
ConfigFile[]	checkinConfigFilesBegin(ClientInfo ci, String[] names)	Prepare ConfigFile objects with URLs to upload configuration or intray files.
ConfigFile[]	checkinConfigFilesEnd(ClientInfo ci, ConfigFile[] configFiles, LockZ unlockZ)	Finishes a check-in procedure for configuration files.
void	checkinCounters(ClientInfo ci, CounterInfo[] counterInfos, LockZ unlockZ)	Update counter values or create new counters.
void	checkinCryptInfos(ClientInfo ci, CryptInfo[] cryptInfos, LockZ unlockZ)	Write and optionally unlock encryption information.
Document	checkinDocBegin(ClientInfo ci, Document document)	Prepares the Indexserver to enable a document to be checked in.
Document	checkinDocBegin2(ClientInfo ci, Sord sord, Document document, CheckinDocOptions opts)	Prepares the Indexserver to enable a document to be checked in.
Document	checkinDocDupl(ClientInfo ci, Sord sord, SordZ sordZ, Document document, LockZ unlockZ)	Checks-in already existing documents again.
Document	checkinDocEnd(ClientInfo ci, Sord sord, SordZ sordZ, Document document, LockZ unlockZ)	Checks in an uploaded document.
int	checkinDocMask(ClientInfo ci, DocMask docMask, DocMaskZ docMaskZ, LockZ unlockZ)	Writes a keywording form into the database.
int	checkinDocMaskLineTemplate(ClientInfo ci, DocMaskLineTemplate dmlt, DocMaskLineTemplateZ dmltZ, CheckInDocMaskLineTemplateOptions options, LockZ lockZ)	Writes a keyword template into the database.
Document[]	checkinDocsBegin(ClientInfo ci, Document[] documents)	This method prepares the Index Server to allow multiple documents to be checked in at one time.
Document[]	checkinDocsEnd(ClientInfo ci, Sord[] sords, SordZ[] sordZs, Document[] documents, LockZ unlockZ)	This method checks-in uploaded documents.
ESSettingsObj	checkinEsSettings(ClientInfo ci, ESSettingsObj settings)	Check in ElasticSearch settings for ESConfigPage only.
int[]	checkinKeys(ClientInfo ci, KeyInfo[] keyInfos, LockZ unlockZ)	Writes or inserts key objects.
void	checkinKeywordList(ClientInfo ci, KeywordList kwList, LockZ unlockZ)	Write or insert a keyword list.
void	checkinKeywords(ClientInfo ci, Keyword[] kws, LockZ unlockZ)	Insert keywords and all their children.
void	checkinMap(ClientInfo ci, String domainName, String id, int objId, KeyValue[] data, LockZ unlockZ)	Inserts or updates the given key-value-pairs in data in the map specified by id.
void	checkinMapDomain(ClientInfo ci, MapDomain mapDomain, LockZ unlockZ)	Creates or updates a map domain.
int[]	checkinNotes(ClientInfo ci, String objId, Note[] notes, NoteZ noteZ, LockZ unlockZ)	Write or insert Notes.
int[]	checkinNoteTemplates(ClientInfo ci, NoteTemplate[] noteTemplates, NoteTemplateZ ntemplZ, LockZ unlockZ)	Writes the given stamp definition into the database.
Notification	checkinNotification(ClientInfo ci, Notification notif, NotificationZ notiZ)	Inserts or updates a Notification object if userGuid is null, the own Guid will be taken if userGuid is not the own Guid, admin rights are needed
Map<Integer,OrgUnitInfo>	checkinOrgUnits(ClientInfo ci, OrgUnitInfo[] orgUnitInfos, CheckinOrgUnitInfo checkinOrgUnitInfo, LockZ unlockZ)	Inserts or updates organizational units.
int[]	checkinReminder(ClientInfo ci, Reminder remi, String[] receiverIds, boolean expandGroups, LockZ unlockZ)	Inserts or updates a reminder object.
void	checkinReplNames(ClientInfo ci, ReplSetName[] replNames, LockZ unlockZ)	Writes replication set names.
void	checkinReport(ClientInfo ci, ReportInfo report, CheckinReportInfo reserved, LockZ lockZ)	Inserts custom report entries.
void	checkinReportOptions(ClientInfo ci, ReportOptions options, LockZ unlockZ)	Writes the report options.
int	checkinSord(ClientInfo ci, Sord sord, SordZ sordZ, LockZ unlockZ)	Writes or inserts a archive entry into the database.
int[]	checkinSordPath(ClientInfo ci, String parentId, Sord[] sords, SordZ sordZ)	Checks the existence of an archive path and creates missing entries if necessary by traversing top-down through the Sords array.
void	checkinSordTypes(ClientInfo ci, SordType[] sordTypes, LockZ unlockZ)	Write or insert sord type information.
StoreInfo[]	checkinStorage(ClientInfo ci, StoreInfo[] storeInfos, LockZ unlockZ)	This method passes path information to the document manager.
void	checkinSubs(ClientInfo ci, SubsInfo[] deps, LockZ unlockZ)	Insert deputy/substitute information.
Subscription	checkinSubscription(ClientInfo ci, Subscription subs, SubscriptionZ subsZ)	Add a subscription.
SubstitutionsResult	checkinSubstitutions(ClientInfo ci, CheckinSubstitutionsInfo checkinSubstitutionsInfo, SubstitutionZ substitutionZ, LockZ unlockZ)	Insert new substitutions or update existing ones.
String[]	checkinTranslateTerms(ClientInfo ci, TranslateTerm[] tterms, LockZ unlockZ)	Write or insert terms into the translation table.
int	checkinUser(ClientInfo ci, UserInfo userInfo, CheckinUsersZ checkinUsersZ, LockZ unlockZ)	Update or insert a user or group.
void	checkinUserProfile(ClientInfo ci, UserProfile userProfile, LockZ unlockZ)	Write (add) user profile options.
int[]	checkinUsers(ClientInfo ci, UserInfo[] userInfos, CheckinUsersZ checkinUsersZ, LockZ unlockZ)	Updates or inserts users or groups.
int	checkinWorkFlow(ClientInfo ci, WFDiagram wf, WFDiagramZ workFlowDiagramZ, LockZ unlockZ)	Write/create a workflow.
int[]	checkinWorkflowTemplate(ClientInfo ci, WFDiagram wf, WFDiagramZ wfZ, LockZ unlockZ)	Check in a workflow template as a new version or overwrite an existing version.
LicenseResult	checkLicense(ClientInfo ci, LicenseInfo licenseInfo)	Check licensing information.
Activity	checkoutActivity(ClientInfo ci, String actGuid, LockZ lockZ)	This function reads and optionally locks an activity.
ActivityProject	checkoutActivityProject(ClientInfo ci, String projectName, LockZ lockZ)	This function reads and optionally locks an activity project.
Aspect	checkoutAspect(ClientInfo ci, String aspectId, AspectZ aspectZ, LockZ lockZ)	Read and maybe lock an Aspect object.
List<Aspect>	checkoutAspects(ClientInfo ci, List<String> aspectIds, AspectZ aspectZ, LockZ lockZ)	Read and maybe lock a list of Aspect objects (EIX-2437).
ColorData[]	checkoutColors(ClientInfo ci, LockZ lockZ)	Checkout the markers definitions (colors of archive entries).
ColorData[]	checkoutColors2(ClientInfo ci, int options, LockZ lockZ)	Checkout the markers definitions (colors of archive entries) for administration purposes.
ConfigFile[]	checkoutConfigFiles(ClientInfo ci, String[] names, ConfigFileZ configFileZ, LockZ lockZ)	Read config file names and file data.
CounterInfo[]	checkoutCounters(ClientInfo ci, String[] counterNames, boolean incrementCounters, LockZ lockZ)	Get counter information.
CryptInfo[]	checkoutCryptInfos(ClientInfo ci, String[] ids, LockZ lockZ)	Read and optionally lock the password information for document encryption.
EditInfo	checkoutDoc(ClientInfo ci, String objId, String docId, EditInfoZ editInfoZ, LockZ lockZ)	Reads the indexing information and the download URL of a document.
DocMask	checkoutDocMask(ClientInfo ci, String maskId, DocMaskZ docMaskZ, LockZ lockZ)	Reads a storage mask from the database.
DocMaskLineTemplate[]	checkoutDocMaskLineTemplates(ClientInfo ci, String[] groups, DocMaskLineTemplateZ dmltZ, LockZ lockZ)	Check out keyword templates.
ESInfoObj	checkoutEsInfo(ClientInfo ci)	Check out the ElasticSearch informations for ESConfigPage only.
ESSettingsObj	checkoutEsSettings(ClientInfo ci)	Check out the ElasticSearch settings for ESConfigPage only.
ESStatusObj	checkoutEsStatus(ClientInfo ci)	Checkout status of iSearch and updaters and reindexers, for ESConfigPage only.
KeyInfo[]	checkoutKeys(ClientInfo ci, String[] ids, LockZ lockZ)	Reads a list of key objects.
KeywordList	checkoutKeywordList(ClientInfo ci, String kwid, KeywordZ keywordZ, int max, LockZ lockZ)	Reads a keyword list.
Keyword[]	checkoutKeywords(ClientInfo ci, String[] kwids, KeywordZ keywordZ, int max, LockZ lockZ)	Collects keywords and their children.
KeywordsDynamicResult	checkoutKeywordsDynamic(ClientInfo ci, KeywordsDynamicInfo keywordsDynamicInfo)	Queries dynamic keyword lists.
MapData	checkoutMap(ClientInfo ci, String domainName, String id, String[] keyNames, LockZ lockZ)	Reads a map or parts of a map.
MapDomain	checkoutMapDomain(ClientInfo ci, String domainName, LockZ lockZ)	Reads the data of a map domain.
MapHist[]	checkoutMapHistory(ClientInfo ci, String domainName, String mapId, MapHistZ membersZ)	Reads the history entries for the given map.
Note[]	checkoutNotes(ClientInfo ci, String objId, String[] noteIds, NoteZ noteZ, LockZ lockZ)	Read notes of a given Sord.
NoteTemplate[]	checkoutNoteTemplates(ClientInfo ci, String userId, String[] ids, NoteTemplateZ ntemplZ, LockZ lockZ)	Read the stamp definitions from the users options.
Notification	checkoutNotification(ClientInfo ci, String watchGuid, String userGuid)	Reads Notification for a watchGuid / userGuid combination if userGuid is null, the own Guid will be taken if userGuid is not the own Guid, admin rights are needed
Map<Integer,OrgUnitInfo>	checkoutOrgUnits(ClientInfo ci, CheckoutOrgUnitInfo checkoutOrgUnitInfo, LockZ lockZ)	Read the data of all OUs.
PreviewImageResult	checkoutPreviewImageURLs(ClientInfo ci, PreviewImageInfo previewImageInfo)	Generates URLs for preview images of documents.
Reminder[]	checkoutReminders(ClientInfo ci, int[] reminderIds, LockZ lockZ)	Reads and locks a reminder object.
ReplSetName[]	checkoutReplNames(ClientInfo ci, LockZ lockZ)	Reads replication set names.
ReportOptions	checkoutReportOptions(ClientInfo ci, LockZ lockZ)	Reads the report options.
EditInfo	checkoutSord(ClientInfo ci, String objId, EditInfoZ editInfoZ, LockZ lockZ)	Reads the data needed to edit an existing archive entry.
SordHist[]	checkoutSordHistory(ClientInfo ci, String objId)	checkoutSordHistory retrieves all history entries related to a given object.
SordPaths	checkoutSordPath(ClientInfo ci, String objId, SordZ sordZ, CheckoutSordPathInfo csi)	Gets the list of Sord object which are the predecessors of the sord given by the objId.
SordType[]	checkoutSordTypes(ClientInfo ci, int[] sordTypeIds, SordTypeZ sordTypeZ, LockZ lockZ)	Get sord type information.
StoreInfo[]	checkoutStorage(ClientInfo ci, String[] ids, LockZ lockZ)	checkoutStorage retrieves an array of configured paths from the Document Manager.
SubsInfo[]	checkoutSubs(ClientInfo ci, String userId, LockZ lockZ)	Read the substitute information for the given user.
SubstitutionsResult	checkoutSubstitutions(ClientInfo ci, CheckoutSubstitutionsInfo checkoutSubstitutionsInfo, SubstitutionZ substitutionZ, LockZ lockZ)	Checkout substitutions.
TranslateTerm[]	checkoutTranslateTerms(ClientInfo ci, String[] termIds, LockZ lockZ)	Read terms from translation table for viewing or editing.
UserInfo	checkoutUser(ClientInfo ci, String id, CheckoutUsersZ checkoutUsersZ, LockZ lockZ)	Reads the user data for a user or group.
UserProfile	checkoutUserProfile(ClientInfo ci, UserProfile userProfile, LockZ lockZ)	Read user profile options.
UserInfo[]	checkoutUsers(ClientInfo ci, String[] ids, CheckoutUsersZ checkoutUsersZ, LockZ lockZ)	Reads the user data for users or groups.
WFDiagram	checkoutWorkFlow(ClientInfo ci, String flowId, WFTypeZ typeZ, WFDiagramZ workFlowDiagramZ, LockZ lockZ)	Reads a workflow definition.
CheckoutWorkflowHistoryResult	checkoutWorkflowHistory(ClientInfo ci, CheckoutWorkflowHistoryParams checkoutWorkflowHistoryParams)	Reads the histories of a node or a whole workflow.
WFDiagram	checkoutWorkflowTemplate(ClientInfo ci, String flowId, String versionId, WFDiagramZ wfZ, LockZ lockZ)	Check out versions of a workflow template.
boolean	cleanupStart(ClientInfo ci, DeleteOptions deleteOptions)	cleanupStart(ClientInfo ci) removes all deleted objects and related entries from the archive database.
JobState	cleanupState(ClientInfo ci)	cleanupState(ClientInfo ci) returns state information in a BackgroundThreadInfo.
boolean	cleanupStop(ClientInfo ci)	cleanupStop(ClientInfo ci) stops the cleaning as soon as possible finishing open transactions first.
void	closeEventBus(ClientInfo ci, long busId)	Close an event bus opened by openEventBus.
JobState[]	collectJobStates(ClientInfo ci, boolean activeJobs, boolean finishedJobs, boolean fullInfo)	collectJobStates lists all the states of currently existing jobs from the IX backround job pool running or finished, but still listed.
MapDomain[]	collectMapDomains(ClientInfo ci)	Collects the existing map domains.
WFCollectNode[]	collectWorkFlowNodes(ClientInfo ci, String flowName, WFTypeZ wfTypeZ, String nodeName, int nodeType, String objId, String enterDateIso, String exitDateIso, String[] userIds, boolean onlyActive, boolean onlyStartNodes)	Collect workflow nodes.
IdName[]	collectWorkFlows(ClientInfo ci, WFTypeZ typeZ)	Collects workflow names.
CombineAclResult	combineAcl(ClientInfo ci, AclItem[] lhs, AclItem[] rhs, CombineAclOptions options)	Compares the given ACLs and computes the sum, difference and intersection.
ComputeDocumentHashResult	computeDocumentHash(ClientInfo ci, ComputeDocumentHashInfo fileHashInfo)	Compute the hash value of an archived document.
BackupProfile[]	configureBackup(ClientInfo ci, BackupProfile[] backupProfiles)	Query or send backup profile information of the ELOdm.
FulltextConfig	configureFulltext(ClientInfo ci, String userId, FulltextConfig opts)	Get or set the fulltext configuration.
License	configureLicense(ClientInfo ci, String licenseData)	Read or update license information.
PurgeSettings	configurePurge(ClientInfo ci, PurgeSettings purgeSettings)	Query or send the purge task settings of the ELOdm.
JobState	controlBackgroundThread(ClientInfo ci, JobState jobState)	Query the status of the job and control its state.
BackupPurgeStatus	controlBackup(ClientInfo ci, ControlBackupInfo controlBackupInfo)	Query the status of the backup and purge tasks of the ELOdm.
String	cookKeyword(ClientInfo ci, String kwid)	Replaces control sequences in the text of a keyword.
int	copySord(ClientInfo ci, String newParentId, String objId, CopyInfo copyInfo, CopySordZ copySordZ)	Moves an archive entry or creates a relation (logical copy).
Activity	createActivity(ClientInfo ci, String projectName, String objId)	This function creates an activity in memory based on the given project and assigned to the given object.
ActivityProject	createActivityProject(ClientInfo ci, String projectName)	This function creates an activity project in memory.
Aspect	createAspect(ClientInfo ci, String name, List<AspectLine> lines)	Initialize an Aspect object.
AspectAssoc	createAspectAssoc(ClientInfo ci, String name, String aspectId, Cardinality cardinality)	Initializes an AspectAssoc object.
DocMask	createAspectMask(ClientInfo ci, String name, List<AspectAssoc> aspectAssocs)	Initializes a DocMask object as a keywording form for aspects.
EditInfo	createDoc(ClientInfo ci, String parentId, String maskId, String docTemplate, EditInfoZ editInfoZ)	Creates a new document with indexing information.
DocMask	createDocMask(ClientInfo ci, String maskId)	Creates a storage mask object and assigns default values.
long	createEventBusListener(ClientInfo ci, long subsId, EventListener eventListener)	Creates an event bus listener.
long	createEventBusSubscriber(ClientInfo ci)	Create an event bus subscriber.
KeyInfo	createKey(ClientInfo ci)	Creates and initializes a key object.
void	createNewEncryptionSet(ClientInfo ci, CryptInfo cryptInfo, LockZ unlockZ)	ToBeFilled
Note	createNote(ClientInfo ci, String objId)	Returns an initialized, temporary Note object.
Note	createNote2(ClientInfo ci, String objId, int noteType, String templId)	Returns an initialized, temporary Note object.
NoteTemplate	createNoteTemplate(ClientInfo ci, String userId)	Initializes a new NoteTemplate object.
Reminder	createReminder(ClientInfo ci, String objId)	Creates a reminder for the Sord specified by objId.
String[]	createRsaKeys(ClientInfo ci)	Helper function to create a RSA key pair.
EditInfo	createSord(ClientInfo ci, String parentId, String maskId, EditInfoZ editInfoZ)	Creates an object containing all the data needed to edit the indexing information of a new archive entry.
Subscription	createSubscription(ClientInfo ci, String watchGuid)	Initialize a subscription object.
String	createSuperiorSubstitution(ClientInfo ci, CreateSuperiorSubstitutionInfo createSuperiorSubstitutionInfo)	Create a Substitution as a superior.
UserInfo	createUser(ClientInfo ci, String rightsAsUserId)	Creates an object for user data.
WFNode	createWFNode(ClientInfo ci, int nodeId, int nodeTypeC)	Initalizes a WFNode object.
WFDiagram	createWorkFlow(ClientInfo ci, String wfName, WFTypeZ typeZ)	Prepares a WFDiagram structure.
boolean	deactivateSubstitution(ClientInfo ci, String substituionGuid, LockZ unlockZ)	Deactivate the submitted substitution.
void	deferWorkFlowNode(ClientInfo ci, String flowId, int nodeId, String userDelayDateIso, LockZ lockZ)	Sets the value userDelayDateIso of the given node.
void	delegateWorkFlowNode(ClientInfo ci, WFDelegateNodeInfo delegateNodeInfo, LockZ lockZ)	Delegates the specified workflow node to another user.
void	deleteActivity(ClientInfo ci, String actGuid, DeleteActivityOptions deleteOptions, LockZ unlockZ)	This function deletes an activity.
void	deleteActivityProject(ClientInfo ci, String projectName, LockZ unlockZ)	This function deletes an activity project from the database.
boolean	deleteAspect(ClientInfo ci, String aspectId, LockZ lockZ)	Delete an Aspect object.
void	deleteConfigFiles(ClientInfo ci, String[] names, LockZ unlockZ)	Deletes configuration files.
void	deleteCounters(ClientInfo ci, String[] counterNames, LockZ unlockZ)	Delete counters.
boolean	deleteDocMask(ClientInfo ci, String maskId, String assignMaskId, LockZ unlockZ)	Deletes a storage mask.
void	deleteDocMaskLineTemplates(ClientInfo ci, String[] groups, LockZ unlockZ)	Delete keyword templates This function requires ELO 10 license.
void	deleteEventBusListener(ClientInfo ci, long lsnId)	Deletes an event bus listener.
void	deleteEventBusSubscriber(ClientInfo ci, long subsId)	Deletes an event bus subscriber.
void	deleteKeys(ClientInfo ci, String[] ids, LockZ unlockZ)	Deletes keys.
void	deleteKeywordList(ClientInfo ci, String kwid, LockZ unlockZ)	Deletes a keyword list.
void	deleteKeywords(ClientInfo ci, String[] kwids, LockZ unlockZ)	Deletes the keywords with the given IDs.
void	deleteMap(ClientInfo ci, String domainName, String id, String[] keyNames, LockZ unlockZ)	Delete map items.
void	deleteMapDomain(ClientInfo ci, String domainName, LockZ unlockZ)	Deletes a map domain and removes the associated database tables.
void	deleteNotes(ClientInfo ci, String[] noteIds, LockZ unlockZ)	Deletes notes.
void	deleteNoteTemplates(ClientInfo ci, String userId, String[] ids, LockZ unlockZ)	Delete the stamp definition with the given ID.
int	deleteNotification(ClientInfo ci, String objGuid, String userGuid)	Deleting the Notification identified by objGuid / userGuid combination if the Notification has child Notifications, they will be deleted as well.
void	deleteOrgUnits(ClientInfo ci, String[] ids, LockZ unlockZ)	Delete OUs.
void	deleteReminders(ClientInfo ci, int[] reminderIds, LockZ unlockZ)	Deletes the reminders (logically) with the the given IDs.
void	deleteReport(ClientInfo ci, String endDateISO)	Deletes report entries until endDateISO.
boolean	deleteSord(ClientInfo ci, String parentId, String objId, LockZ unlockZ, DeleteOptions deleteOptions)	Deletes an archive entry and all child entries or deletes a relation (logical copy).
void	deleteSordTypes(ClientInfo ci, int[] sordTypeIds, LockZ unlockZ)	Delete sord type information.
void	deleteSubs(ClientInfo ci, SubsInfo[] deps, LockZ unlockZ)	Delete deputy information.
void	deleteSubscription(ClientInfo ci, Subscription subs)	Delete a subscription.
boolean	deleteSubstitutions(ClientInfo ci, DeleteSubstitutionsInfo deleteSubstitutionsInfo, LockZ unlockZ)	Delete substitutions by its GUIDs.
void	deleteTranslateTerms(ClientInfo ci, String[] termIds, LockZ unlockZ)	Delete terms from the translation table.
void	deleteUser(ClientInfo ci, String id, LockZ unlockZ)	Deletes user or group.
void	deleteUserProfile(ClientInfo ci, UserProfile userProfile, LockZ unlockZ)	Deletes profile options.
void	deleteUsers(ClientInfo ci, String[] ids, LockZ unlockZ)	Deletes users or groups.
void	deleteWorkFlow(ClientInfo ci, String flowId, WFTypeZ typeZ, LockZ unlockZ)	Deletes a workflow.
void	deleteWorkflowTemplate(ClientInfo ci, String flowId, String versionId, LockZ unlockZ)	Deletes a workflow template version.
void	editPublicDownloadUrls(ClientInfo ci, PublicDownloadOptions opts)	Edits the public downloads
String	encryptStringRsa(ClientInfo ci, String key, String data, boolean encryptNotDecrypt)	Encrypt or decrypt a string using the RSA algorithm.
void	endEditWorkFlowNode(ClientInfo ci, int nFlowId, int nNodeId, boolean bTerminate, boolean bCancel, String sName, String sComment, int[] arrEnterNodesIds)	Stores an edited person node of an active workflow into the database and unlocks the workflow.
AutoFilingResult	evalAutoFiling(ClientInfo ci, String maskId, Sord sord, AutoFilingOptions opts)	Evaluate the destination archive path based on filing definitions of a keywording from.
Any	executeRegisteredFunction(ClientInfo ci, String functionName, Any param)	Execute a registered function defined in a JavaScript or in an event handler.
String	executeRegisteredFunctionString(ClientInfo ci, String functionName, String param)	Execute a registered function defined in a JavaScript or in an event handler.
ExecuteScriptResult	executeScript(ClientInfo ci, ExecuteScriptParams params)	Execute a script.
FileData	exportWorkflow(ClientInfo ci, WorkflowExportOptions wfExportOptions)	Exports the workflow-version.
ActivityProject[]	findActivityProjects(ClientInfo ci, FindActivityProjectsInfo findInfo)	This function reads all activity projects.
FindResult	findAggregations(ClientInfo ci, FindInfo findInfo)	Find aggregation data for dashboards and statistics.
FindResult	findBackgroundThreads(ClientInfo ci, FindBackgroundThreadOptions findBackgroundThreadOptions)	Query all jobs executed in the background.
void	findClose(ClientInfo ci, String searchId)	Deletes the search results explicitly in the Indexserver process to save memory.
FindResult	findCompletion(ClientInfo ci, FindInfo findInfo, int max)	Autocompletion/ Type as you search Use CompletionOptions in findInfo.indByElastic.eSearchOptions.
FindResult	findContextTerms(ClientInfo ci, FindInfo findInfo, int maxTermsPerField)	Find terms for faceted search.
FindResult	findFirstActivities(ClientInfo ci, FindActivityInfo findInfo, int max, ActivityZ activityZ)	This function reads the activities of an object.
FindResult	findFirstConfigFiles(ClientInfo ci, FindConfigFileInfo findInfo, int max, ConfigFileZ configFileZ)	Finds configuration or postbox files.
FindResult	findFirstNotes(ClientInfo ci, FindInfo findInfo, int max, NoteZ noteZ)	Find first notes.
FindResult	findFirstReportInfos(ClientInfo ci, FindReportInfo opts, int max)	Finds report entries.
FindResult	findFirstSords(ClientInfo ci, FindInfo findInfo, int max, SordZ sordZ)	Find archive entries and retrieve the first max objects.
FindResult	findFirstSubscriptions(ClientInfo ci, FindSubscriptionInfo findInfo, int max, SubscriptionZ subsZ)	Find first max subscriptions.
FindResult	findFirstTasks(ClientInfo ci, FindTasksInfo findInfo, int max)	Finds reminders, activities and active workflow nodes.
FindResult	findFirstTranslateTerms(ClientInfo ci, FindTranslateTermInfo findInfo, int max)	Find terms for which a translation is available.
FindResult	findFirstUsers(ClientInfo ci, FindUserInfo findUserInfo, int max)	Find user data.
FindResult	findFirstWorkflows(ClientInfo ci, FindWorkflowInfo findInfo, int max, WFDiagramZ wfDiagramZ)	Finds active workflows.
FindResult	findNextActivities(ClientInfo ci, String searchId, int idx, int max, ActivityZ activityZ)	This function reads the next activites of an object.
FindResult	findNextConfigFiles(ClientInfo ci, String searchId, int idx, int max, ConfigFileZ configFileZ)	Finds next configuration files.
FindResult	findNextNotes(ClientInfo ci, String searchId, int idx, int max, NoteZ noteZ)	Find next notes.
FindResult	findNextReportInfos(ClientInfo ci, String searchId, int idx, int max)	Finds report entries.
FindResult	findNextSords(ClientInfo ci, String searchId, int idx, int max, SordZ sordZ)	Retrieves further results of a previous search with findFirstSords.
FindResult	findNextSubscriptions(ClientInfo ci, String searchId, int idx, int max, SubscriptionZ subsZ)	Find next max subscriptions beginning at index idx.
FindResult	findNextTasks(ClientInfo ci, String searchId, int idx, int max)	Continues the find process started with findFirstTasks.
FindResult	findNextTranslateTerms(ClientInfo ci, String searchId, int idx, int max)	Find next terms.
FindResult	findNextUsers(ClientInfo ci, String searchId, int idx, int max)	Find next user data.
FindResult	findNextWorkflows(ClientInfo ci, String searchId, int index, int maxResults)	Finds more active workflows.
FindResult	findSearchTerms(ClientInfo ci, FindInfo findInfo, int max)	Corrections and synonyms.
void	finishExport(ClientInfo ci, String exportId)	Removes temp-files after an export.
String	forwardSubstitution(ClientInfo ci, ForwardSubstitutionInfo forwardSubstitutionInfo, LockZ unlockZ)	Forward or transfer a substitution to an other user.
ForwardWorkflowNodeResult	forwardWorkflowNode(ClientInfo ci, int flowId, int nodeId, ForwardWorkflowNodeInfo forwardNodeInfo, LockZ unlockZ)	Forward a workflow node, terminate a workflow or modify node data.
AclAccessResult	getAclAccess(ClientInfo ci, AclAccessInfo aai)	Returns the access of the given ACL.
ArchiveStatistics	getArchiveStatistics(ClientInfo ci, long opts)	Read characteristical properties of the archive.
Map<Integer,String>	getCompiledScripts(ClientInfo ci)	This function returns a map containing information of all compiled scripts.
IXServicePortC	getConstants(ClientInfo ci)	Retrieves the constants.
ContextTerm[]	getContextTerms(ClientInfo ci, FindInfo findInfo, String field, int max)	Find terms for faceted search.
int	getDebuggerPort(ClientInfo ci)	This function returns debugger's port.
ValuesOfObjKey	getDistinctValuesOfObjKey(ClientInfo ci, String okeyName, ValuesOfObjKeyOptions opts)	Read all distinct values from the database that are used for the given ObjKey name, potentionally causing an enormous database load.
EditInfo[]	getEditInfoFromESW(ClientInfo ci, FileData[] fileDatas, EditInfoEswOptions eswOptions)	Returns the EditInfo-Objects from the FileData-Objects.
FileData[]	getESWFromEditInfo(ClientInfo ci, EditInfo[] editInfos, EditInfoEswOptions eswOptions)	Returns the FileData-Objects from the EditInfo-Objects.
String	getExportZipUrl(ClientInfo ci, String exportId)	Gets the URL for downloading the generated ZIP-archive of this export.
String	getImportZipUrl(ClientInfo ci, String importId)	Retrieves the URL for uploading the ZIP-archive for this import.
List<PublicDownload>	getPublicDownloads(ClientInfo ci, PublicDownloadOptions opts)	Gets the public downloads.
String	getScriptsToDebug(ClientInfo ci)	This function returns the list of the scripts which are currently debugged, i.e.
String[]	getSearchTerms(ClientInfo ci, FindInfo findInfo, int termType)	Get alternative terms for an iSearch search.
ServerInfo	getServerInfo(ClientInfo ci)	Retrieves configurational information, e.g.
ServerInfoDM	getServerInfoDM(ClientInfo ci)	Gets DM configuration information.
LoginResult	getSessionFromTicket(ClientInfo ci, int options)	Returns the LoginResult object that represents the session of the ticket contained in the given ClientInfo object.
SessionInfo[]	getSessionInfos(ClientInfo ci, SessionInfoParams params)	Returns the SessionInfo-Objects about all the active connections.
SessionOptions	getSessionOptions(ClientInfo ci)	Retrieve the current session options.
UserName[]	getUserNames(ClientInfo ci, String[] ids, CheckoutUsersZ checkoutUsersZ)	Reads user or group names and IDs.
String	getWebDAVPathFromObjID(ClientInfo ci, String objId)	Returns the WebDAV path from an Object ID.
GetWebDAVPathResult	getWebDAVPathFromObjID2(ClientInfo ci, GetWebDAVPathOptions options)	Returns the WebDAV path from an Object ID.
WFVersion[]	getWorkflowTemplateVersions(ClientInfo ci, String flowId, boolean onlyDeleted)	Reads the version information of all versions of the given workflow.
int	importWorkFlow(ClientInfo ci, String flowName, byte[] fileData)	Imports a workflow template from a file.
int	importWorkFlow2(ClientInfo ci, String flowName, byte[] fileData, WorkflowImportOptions importOptions)	Imports a workflow template from a file.
PublicDownload	insertPublicDownload(ClientInfo ci, PublicDownloadOptions opts)	Creates and inserts a new public download
Event[]	internalReceiveEvents(ClientInfo ci, long subsId, long timeoutMillis)	Read events from the server.
void	invalidateCache(ClientInfo ci, int flags)	Invalidate the internally used caches for users, storage masks, etc.
InvalidateCacheResult	invalidateCache2(ClientInfo ci, InvalidateCacheInfo info)	Invalidate the internally used caches.
void	linkSords(ClientInfo ci, String fromId, String[] toIds, LinkSordZ linkZ)	Links archive entries.
void	linkSords2(ClientInfo ci, String fromId, String[] toIds, LinkSordZ linkSordZ, LinkSordInfo linkSordInfo)	Links archive entries like IXServicePortIF.linkSords(de.elo.ix.client.ClientInfo, java.lang.String, java.lang.String[], de.elo.ix.client.LinkSordZ).
int	lockArchive(ClientInfo ci, String keyId)	Locks the archive for users or retrieves the lock on the archive.
LoginResult	login(ClientInfo ci, String userName, String userPwd, String clientComputer, String runAsUser)	Log on to Indexserver.
LoginResult	loginAdmin(ClientInfo ci, String userName, String userPwd, String clientComputer, String reportAsUser)	Login any user as an administrator.
LoginResult	loginEloProf(ClientInfo ci, int userId, String certificate, String clientComputer)	This login is used by ELOprofessional applications if the Indexserver is used to forward workflows (WorkflowServer).
LoginResult	loginKerberos(ClientInfo ci, byte[] ticket, String clientComputer)	Login using Kerberos ticket.
void	logout(ClientInfo ci)	Log out user.
JobState	moveDocuments(ClientInfo ci, MoveDocumentsInfo moveDocumentsInfo)	Move documents from one storage path to another storage path.
NotifyServerResult	notifyServer(ClientInfo ci, NotifyServerInfo msg)	This function notifies the Indexserver about an operation of the client program.
long	openEventBus(ClientInfo ci, EventBusParams params)	Open a new event bus.
IXExceptionData	parseException(ClientInfo ci, String exceptionString)	Parses the given string of an exception into a structured IXExceptionData object.
JobState	processFindResult(ClientInfo ci, String searchId, ProcessInfo procInfo)	Executes the processing information given by processInfo for all objects found by a findFirstSords call.
OcrResult	processOcr(ClientInfo ci, OcrInfo ocrInfo)	Compute OCR on the given image data or on an archived document.
JobState	processTrees(ClientInfo ci, NavigationInfo navigationInfo, ProcessInfo procInfo)	processTrees extends ValueClass implements a generic tree walk for all subtrees specified in navInfo.
void	provideCryptPassword(ClientInfo ci, String encryptionSet, String pwd)	Provide a password to be used in the current session for encrypting and decrypting of documents.
void	provideSystemCryptPassword(ClientInfo ci, String encryptionSet, String pwd)	Provide a system password to be used in the current session for encrypting and decrypting of documents.
QueryJobProtocolResult	queryJobProtocol(ClientInfo ci, QueryJobProtocolInfo queryJobProtocolInfo)	Query the protocol of a background thread.
JobState	queryJobState(ClientInfo ci, String jobGuid, boolean activeJobs, boolean finishedJobs, boolean fullInfo)	Returns the job state for a given job GUID.
void	refSord(ClientInfo ci, String oldParentId, String newParentId, String objId, int manSortIdx)	Creates a new object relationship.
OcrWorker	registerOcrWorker(ClientInfo ci, OcrWorker ocrWorker)	This function is called from an OCR worker process to notify Indexserver about its state.
void	reload(ClientInfo ci)	This function reloads all internal objects.
void	reloadScripts(ClientInfo ci)	This function reloads all scripts.
List<ResolveRightsResult>	resolveRights(ClientInfo ci, UserInfo ui, ResolveRightsInfo info)	Resolves the rights of a user.
boolean	restoreSord(ClientInfo ci, String objId, RestoreOptions restoreOptions)	Restores an archive entry, its references and notes.
boolean	runEsProcess(ClientInfo ci, String processName, boolean startProcess)	Run a iSearch process now (if it is not running) or interrupt it if its running.
void	sendEvents(ClientInfo ci, long subsId, Event[] events)	Send events to event busses.
void	setScriptsToDebug(ClientInfo ci, String scriptsToDebug)	This function allows to set the the property "scriptsToDebug".
void	setServerInfo(ClientInfo ci, ServerInfo serverInfo)	Sets the writable members of ServerInfo.
void	setServerInfoDM(ClientInfo ci, ServerInfoDM serverInfo)	Sets the writable members of the DM configuration.
void	setSessionOptions(ClientInfo ci, SessionOptions opts)	This function sets options related to the session identified by the given ticket.
int	startAdHocWorkFlow(ClientInfo ci, String name, String objId, String[] arrUserIds, String nodeName, boolean forValidation, boolean serialFlow, String cancelUserId, String cancelMessage, String finishedUserId, String finishedMessage, String finishedScript)	Starts an Ad Hoc Workflow.
int	startAdHocWorkFlow2(ClientInfo ci, String name, String objId, UserNodeInfo[] userNodeInfo, StartAdHocWorkflowInfo startWfInfo)	Starts an Ad Hoc Workflow.
int	startAdHocWorkFlow3(ClientInfo ci, String name, String objId, StartAdHocWorkflowInfo startWfInfo)	Starts an Ad Hoc Workflow.
String	startExport(ClientInfo ci, String[] topLevelIDs, long options)	Starts an export-job.
String	startExportExt(ClientInfo ci, ExportExtOptions options)	Starts an export-job.
String	startImport(ClientInfo ci, String filingPath, int guidMethod, long options)	Starts an import-job.
int	startWorkFlow(ClientInfo ci, String templFlowId, String flowName, String objId)	Starts a workflow from a workflow template.
int	startWorkFlow2(ClientInfo ci, String objId, StartWorkflowInfo startWorkflowInfo)	Starts a workflow from a workflow template.
void	takeWorkFlowNode(ClientInfo ci, int nFlowId, int nNodeId, String sUserId, int nFlags, LockZ lockZ)	Assign a node to a user.
void	terminatePublicDownloadUrls(ClientInfo ci, PublicDownloadOptions opts)	Deletes the public downloads
int	terminateWorkFlow(ClientInfo ci, String flowId, LockZ unlockZ)	Terminates a workflow.
String[]	testAdapter(ClientInfo ci, String fn, String[] params)	This function is used for testing.
void	unlinkSords(ClientInfo ci, String fromId, String[] toIds, LinkSordZ linkZ)	Remove links between archive entries.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

IXServicePortIF_BYPS

public IXServicePortIF_BYPS(IXConnFactory connFact,
 IXConnection firstConn)

Method Details

alive

public void alive(ClientInfo ci)
           throws byps.RemoteException

Description copied from interface: IXServicePortIF

Extends the ticket lifetime.

Specified by:

alive in interface IXServicePortIF

Parameters:

ci - ClientInfo object with language, country and ticket

Throws:

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

beginEditWorkFlowNode

public WFEditNode beginEditWorkFlowNode(ClientInfo ci,
 int nFlowId,
 int nNodeId,
 LockZ lockZ)
                                 throws byps.RemoteException

Description copied from interface: IXServicePortIF

Locks a person task node of an active workflow inside the database and returns data needed to edit it. If lockZ is not set to LockC.NO, WFNode.inUseDate will be set to now.

Specified by:

beginEditWorkFlowNode in interface IXServicePortIF

Parameters:

ci - ClientInfo object with language, country and ticket.

nFlowId - Workflow ID.

nNodeId - Workflow node ID.

lockZ - Use LockC.YES or LockC.IF_FREE to lock all nodes of the workflow.

Returns:

Node data needed for editing.

Throws:

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

changeSordMask

public EditInfo changeSordMask(ClientInfo ci,
 Sord sord,
 String maskId,
 EditInfoZ editInfoZ)
                        throws byps.RemoteException

Description copied from interface: IXServicePortIF

Changes the storage mask of a archive entry.

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

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

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

Specified by:

changeSordMask in interface IXServicePortIF

Parameters:

ci - ClientInfo object with language, country and ticket.

sord - Indexing information of an archive entry.

maskId - ID or name of the new storage mask.

editInfoZ - Determines, which members to return in EditInfo. Reasonable predefined values are EditInfoC.mbSord and new EditInfoZ(EditInfoC.mbMask, SordC.mbAll). Be aware of the performance effects of this parameter: avoid using EditInfoC.mbAll.

Returns:

Data to edit an archive entry.

Throws:

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

See Also:

• createSord
• checkinSord
• checkoutSord

checkinColors

public void checkinColors(ClientInfo ci,
 ColorData[] colors,
 LockZ unlockZ)
                   throws byps.RemoteException

Description copied from interface: IXServicePortIF

Check-in the marker definitions (colors for the archive entries). This method deletes the current markers and inserts the supplied ones in colors. To insert a new color, set its Id to -1. If the supplied colors array does not contain a system color (Id == 0), a new system color object is created. The objects must have unique IDs (or -1) and unique names. Since the existing colors are entirely replaced by this function, use IXServicePortIF.checkoutColors2(ClientInfo, int, LockZ) with option ColorDataC.ALL_COLORS to obtain all existing colors to prepare a call to this function.

Specified by:

checkinColors in interface IXServicePortIF

Parameters:

ci - ClientInfo object with language, country and ticket

colors - Array of Color objects

unlockZ - Remove lock

Throws:

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

checkinConfigFiles

public void checkinConfigFiles(ClientInfo ci,
 ConfigFile[] configFiles,
 LockZ unlockZ)
                        throws byps.RemoteException

Description copied from interface: IXServicePortIF

Uploads configuration files to the configuration directory on the server.

Specified by:

checkinConfigFiles in interface IXServicePortIF

Parameters:

ci - ClientInfo object with language, country and ticket

configFiles - Objects with file name, directory and data.

unlockZ - reserved.

Throws:

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

checkinConfigFilesBegin

public ConfigFile[] checkinConfigFilesBegin(ClientInfo ci,
 String[] names)
                                     throws byps.RemoteException

Description copied from interface: IXServicePortIF

Prepare ConfigFile objects with URLs to upload configuration or intray files. The names[.] the must contain the destination directory and file name.

Examples

Example for file names	Description
names[.]=peter/postbox/file1.txt	Prepares a ConfigFile object to write file1.txt into peter s server side intray directory
configFile[.].dir=eloscripts/file1.txt	Prepares a ConfigFile object to write file1.txt into the directory for scripts.

 
 //Example for uploading a file into the server side intray of a user.
 IXConnection conn = ...
 String userName = ...
 File file = ...
 String destFile = userName + "/" + CONST.CONFIG_FILE.POSTBOX + "/" + file.getName();
 ConfigFile[] configFiles = conn.ix().checkinConfigFilesBegin(new String[] {destFile});
 String uploadResult = conn.upload(configFiles[0].url, file);
 configFiles[0].setUploadResult(uploadResult);
 configFiles = conn.ix().checkinConfigFilesEnd(configFiles);

 
 

Specified by:

checkinConfigFilesBegin in interface IXServicePortIF

Parameters:

ci - ClientInfo object with language, country and ticket

names - Files to insert.

Returns:

Array of ConfigFile objects each of which contains an upload URL.

Throws:

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

checkinConfigFilesEnd

public ConfigFile[] checkinConfigFilesEnd(ClientInfo ci,
 ConfigFile[] configFiles,
 LockZ unlockZ)
                                   throws byps.RemoteException

Description copied from interface: IXServicePortIF

Finishes a check-in procedure for configuration files.

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

Specified by:

checkinConfigFilesEnd in interface IXServicePortIF

Parameters:

ci - ClientInfo object with language, country and ticket

configFiles - Uploaded file information. Esp. configFiles[.].uploadResult. configFiles[.].fileData is ignored.

unlockZ - Reserved

Returns:

Array of configuration files containing download URLs.

Throws:

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

See Also:

• checkinConfigFilesBegin

checkinCounters

public void checkinCounters(ClientInfo ci,
 CounterInfo[] counterInfos,
 LockZ unlockZ)
                     throws byps.RemoteException

Description copied from interface: IXServicePortIF

Update counter values or create new counters.

Specified by:

checkinCounters in interface IXServicePortIF

Parameters:

ci - ClientInfo object with language, country and ticket

counterInfos - Array of counter objects. If counter object counterInfos[.] exists, its value is overwritten. If counter object does not exist, it is created an initialized by the given value.

unlockZ - Removes a lock previously set by checkoutCounters.

Throws:

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

checkinDocBegin

public Document checkinDocBegin(ClientInfo ci,
 Document document)
                         throws byps.RemoteException

Description copied from interface: IXServicePortIF

Prepares the Indexserver to enable a document to be checked in.

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

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

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

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

Specified by:

checkinDocBegin in interface IXServicePortIF

Parameters:

ci - ClientInfo object with language, country and ticket

document - Document object.

Returns:

Document object with upload URL.

Throws:

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

See Also:

• createDoc
• checkinDocEnd
• checkinDocsBegin

checkinDocDupl

public Document checkinDocDupl(ClientInfo ci,
 Sord sord,
 SordZ sordZ,
 Document document,
 LockZ unlockZ)
                        throws byps.RemoteException

Description copied from interface: IXServicePortIF

Checks-in already existing documents again.

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

Specified by:

checkinDocDupl in interface IXServicePortIF

Parameters:

ci - ClientInfo object with language, country and ticket

sord - Indexing information or null.

sordZ - Elements of sord to be stored into the database.

document - Document object to be used for the duplicate

unlockZ - Unlock the object

Returns:

Complete Document information - in particular the document ID

Throws:

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

checkinDocEnd

public Document checkinDocEnd(ClientInfo ci,
 Sord sord,
 SordZ sordZ,
 Document document,
 LockZ unlockZ)
                       throws byps.RemoteException

Description copied from interface: IXServicePortIF

Checks in an uploaded document.

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

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

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


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

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

Specified by:

checkinDocEnd in interface IXServicePortIF

Parameters:

ci - ClientInfo object with language, country and ticket

sord - Indexing information or null.

sordZ - Elements of sord to be stored into the database.

document - Document object previously returned from checkinDocBegin

unlockZ - Unlock the object.

Returns:

Complete Document information - in particular the document ID.

Throws:

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

See Also:

• SordC
• checkinDocBegin
• checkinDocsEnd

checkinDocMask

public int checkinDocMask(ClientInfo ci,
 DocMask docMask,
 DocMaskZ docMaskZ,
 LockZ unlockZ)
                   throws byps.RemoteException

Description copied from interface: IXServicePortIF

Writes a keywording form into the database. A new mask is inserted when docMask.no is less than 0.

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

Specified by:

checkinDocMask in interface IXServicePortIF

Parameters:

ci - ClientInfo object with language, country and ticket.

docMask - Mask object.

docMaskZ - Members to be written.

unlockZ - Unlock masks.

Returns:

Mask ID (DocMask.no)

Throws:

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

See Also:

• createDocMask
• checkoutDocMask

checkinDocsBegin

public Document[] checkinDocsBegin(ClientInfo ci,
 Document[] documents)
                            throws byps.RemoteException

Description copied from interface: IXServicePortIF

This method prepares the Index Server to allow multiple documents to be checked in at one time. Utilized in the same manner as checkinDocBegin but is for multiple documents.

Specified by:

checkinDocsBegin in interface IXServicePortIF

Parameters:

ci - ClientInfo object with language, country and ticket.

documents - Array of Document objects.

Returns:

Array of Document objects with upload URLs.

Throws:

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

See Also:

• checkinDocBegin

checkinDocsEnd

public Document[] checkinDocsEnd(ClientInfo ci,
 Sord[] sords,
 SordZ[] sordZs,
 Document[] documents,
 LockZ unlockZ)
                          throws byps.RemoteException

Description copied from interface: IXServicePortIF

This method checks-in uploaded documents. Utilized in the same manner as checkinDocEnd but for multiple documents and sords.

Specified by:

checkinDocsEnd in interface IXServicePortIF

Parameters:

ci - ClientInfo object with language, country and ticket

sords - Array of Sord objects

sordZs - Elements of sords to be stored into the database.

documents - Document objects previously returned from checkinDocsBegin

unlockZ - Unlock document

Returns:

Complete documents information - in particular the document ID.

Throws:

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

See Also:

• SordC

checkinKeys

public int[] checkinKeys(ClientInfo ci,
 KeyInfo[] keyInfos,
 LockZ unlockZ)
                  throws byps.RemoteException

Description copied from interface: IXServicePortIF

Writes or inserts key objects.

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

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

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

Specified by:

checkinKeys in interface IXServicePortIF

Parameters:

ci - ClientInfo object with language, country and ticket

keyInfos - List of key objects.

unlockZ - Unlock key data or force access.

Returns:

IDs of written or inserted keys.

Throws:

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

See Also:

• checkoutKeys

checkinKeywords

public void checkinKeywords(ClientInfo ci,
 Keyword[] kws,
 LockZ unlockZ)
                     throws byps.RemoteException

Description copied from interface: IXServicePortIF

Insert keywords and all their children.

The keyword IDs specify whether to insert or update

kws[.].id={existing ID}	Updates the keyword tree branch below the keyword with kws[.].id. The keyword must exist.
kws[.].id={new root ID}	Inserts or updates a new keyword list.

Usage

Operations	Solution
Insert a new child into an existing parent keyword	Check-in the parent keyword with all current children plus the new child. Setting the text members and children arrays of the current children to null leaves them unchanged.
Delete a child of an existing parent keyword	Check-in the parent keyword with all current children minus the child to be deleted. Setting the text members and children arrays of the current children to null leaves them unchanged.
Update text, add, enabled of an existing keyword	Check-in the keyword with a non empty text member. Only when the text is not null and not an empty string will the members add and enabled be written into the database.

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

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

Specified by:

checkinKeywords in interface IXServicePortIF

Parameters:

ci - ClientInfo object with language, country and ticket

kws - Keyword[] Array of child keywords. Members kw[.].raw and kw[.].children[.].id are ignored.

unlockZ - Remove lock.

Throws:

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

checkinNotes

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

Description copied from interface: IXServicePortIF

Write or insert Notes.

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

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

Specified by:

checkinNotes in interface IXServicePortIF

Parameters:

ci - ClientInfo object with language, country and ticket.

objId - String ID or GUID of associated Sord. This parameter can be null.

notes - Note[] Array of note objects. If objId is supplied, notes[.].objId is ignored.

noteZ - NoteZ Controls the members to be written.

unlockZ - Removes a lock on the notes.

Returns:

array of note IDs.

Throws:

byps.RemoteException

See Also:

• IXServicePortIF.deleteNotes(de.elo.ix.client.ClientInfo, java.lang.String[], de.elo.ix.client.LockZ)

checkinReminder

public int[] checkinReminder(ClientInfo ci,
 Reminder remi,
 String[] receiverIds,
 boolean expandGroups,
 LockZ unlockZ)
                      throws byps.RemoteException

Description copied from interface: IXServicePortIF

Inserts or updates a reminder object.

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

Specified by:

checkinReminder in interface IXServicePortIF

Parameters:

ci - ClientInfo object with language, country and ticket.

remi - Reminder object to insert or write.

receiverIds - If not null, this array contains the user IDs or names for which copies of the reminder are created too.

expandGroups - If remi.receiverId references a group and expandGroups is true, Reminder objects for all users of the group are created.

unlockZ - Removes a lock on the notes.

Returns:

int Reminder IDs

Throws:

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

checkinReplNames

public void checkinReplNames(ClientInfo ci,
 ReplSetName[] replNames,
 LockZ unlockZ)
                      throws byps.RemoteException

Description copied from interface: IXServicePortIF

Writes replication set names.

Specified by:

checkinReplNames in interface IXServicePortIF

Parameters:

ci - ClientInfo object with language, country and ticket

replNames - of replication set names.

unlockZ - Unlock the replication set names.

Throws:

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

checkinReportOptions

public void checkinReportOptions(ClientInfo ci,
 ReportOptions options,
 LockZ unlockZ)
                          throws byps.RemoteException

Description copied from interface: IXServicePortIF

Writes the report options.

Specified by:

checkinReportOptions in interface IXServicePortIF

Parameters:

ci - ClientInfo object with language, country and ticket

options - Report options

unlockZ - Unlock report data

Throws:

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

checkinSord

public int checkinSord(ClientInfo ci,
 Sord sord,
 SordZ sordZ,
 LockZ unlockZ)
                throws byps.RemoteException

Description copied from interface: IXServicePortIF

Writes or inserts a archive entry into the database.

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

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

Specified by:

checkinSord in interface IXServicePortIF

Parameters:

ci - ClientInfo object with language, country and ticket.

sord - Indexing information

sordZ - Determines, which members of sord to save. Default is SordC.mbAll.

unlockZ - Unlock archive entry. Default is LockC.NO.

Returns:

ID of the updated or inserted object.

Throws:

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

See Also:

• SordC
• createSord
• checkoutSord

checkinSordPath

public int[] checkinSordPath(ClientInfo ci,
 String parentId,
 Sord[] sords,
 SordZ sordZ)
                      throws byps.RemoteException

Description copied from interface: IXServicePortIF

Checks the existence of an archive path and creates missing entries if necessary by traversing top-down through the Sords array.

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

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

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

Specified by:

checkinSordPath in interface IXServicePortIF

Parameters:

ci - ClientInfo object with language, country and ticket

parentId - ID expression (see checkoutSord) that references the start point of the path.

sords - Top-down sorted array of indexing information, where the predecessor of an array element is its main parent object

sordZ - Determines, which members of sord to save.

Returns:

Array of integer values representing the top-down sorted object IDs

Throws:

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

checkinSordTypes

public void checkinSordTypes(ClientInfo ci,
 SordType[] sordTypes,
 LockZ unlockZ)
                      throws byps.RemoteException

Description copied from interface: IXServicePortIF

Write or insert sord type information.

Specified by:

checkinSordTypes in interface IXServicePortIF

Parameters:

ci - ClientInfo object with language, country and ticket.

sordTypes - Array of type information to be written or null, if only lock should be removed.

unlockZ - Removes a lock previously set by checkoutSordTypes.

Throws:

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

checkinStorage

public StoreInfo[] checkinStorage(ClientInfo ci,
 StoreInfo[] storeInfos,
 LockZ unlockZ)
                           throws byps.RemoteException

Description copied from interface: IXServicePortIF

This method passes path information to the document manager.

Specified by:

checkinStorage in interface IXServicePortIF

Parameters:

ci - ClientInfo object with language, country and ticket

storeInfos - path information for the Document Manager

unlockZ - Unlock path data

Returns:

success

Throws:

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

checkinSubs

public void checkinSubs(ClientInfo ci,
 SubsInfo[] deps,
 LockZ unlockZ)
                 throws byps.RemoteException

Description copied from interface: IXServicePortIF

Insert deputy/substitute information.

Specified by:

checkinSubs in interface IXServicePortIF

Parameters:

ci - ClientInfo

deps - SubsInfo[]

unlockZ - Unlock user data

Throws:

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

checkinUserProfile

public void checkinUserProfile(ClientInfo ci,
 UserProfile userProfile,
 LockZ unlockZ)
                        throws byps.RemoteException

Description copied from interface: IXServicePortIF

Write (add) user profile options.

Specified by:

checkinUserProfile in interface IXServicePortIF

Parameters:

ci - ClientInfo object with language, country and ticket

userProfile - Options of a specific user or default options for all users.

unlockZ - Remove lock - locking is currently not supported but may be added in future.

Throws:

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

See Also:

• IXServicePortIF.deleteUserProfile(ClientInfo, UserProfile, LockZ)

checkinUsers

public int[] checkinUsers(ClientInfo ci,
 UserInfo[] userInfos,
 CheckinUsersZ checkinUsersZ,
 LockZ unlockZ)
                   throws byps.RemoteException

Description copied from interface: IXServicePortIF

Updates or inserts users or groups.

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

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

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

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

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

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

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

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

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

Specified by:

checkinUsers in interface IXServicePortIF

Parameters:

ci - ClientInfo object with language, country and ticket

userInfos - User objects or null if you only want to unlock.

checkinUsersZ - Combinations of CheckinUsersC values.

unlockZ - Unlock user data or force access.

Returns:

Array of user IDs

Throws:

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

See Also:

• createUser
• checkinUsers

checkinOrgUnits

public Map<Integer,OrgUnitInfo> checkinOrgUnits(ClientInfo ci,
 OrgUnitInfo[] orgUnitInfos,
 CheckinOrgUnitInfo checkinOrgUnitInfo,
 LockZ unlockZ)
                                         throws byps.RemoteException

Description copied from interface: IXServicePortIF

Inserts or updates organizational units.

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

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

Specified by:

checkinOrgUnits in interface IXServicePortIF

Parameters:

ci - ClientInfo object with language, country and ticket

orgUnitInfos - OU objects

checkinOrgUnitInfo - This parameter must be null.

unlockZ - Unlock user data or force access.

Returns:

OUs (with the result ID if an ID is -1)

Throws:

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

checkinWorkFlow

public int checkinWorkFlow(ClientInfo ci,
 WFDiagram wf,
 WFDiagramZ workFlowDiagramZ,
 LockZ unlockZ)
                    throws byps.RemoteException

Description copied from interface: IXServicePortIF

Write/create a workflow.

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

Specified by:

checkinWorkFlow in interface IXServicePortIF

Parameters:

ci - ClientInfo object with language, country and ticket

wf - WFDiagram

workFlowDiagramZ - WFDiagramZ

unlockZ - Unlock workflow.

Returns:

int workflow ID.

Throws:

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

See Also:

• IXServicePortIF.checkinWorkflowTemplate(ClientInfo, WFDiagram, WFDiagramZ, LockZ)

checkoutColors

public ColorData[] checkoutColors(ClientInfo ci,
 LockZ lockZ)
                           throws byps.RemoteException

Description copied from interface: IXServicePortIF

Checkout the markers definitions (colors of archive entries). This function returns only visible and non-deleted colors. It returns the same result as IXServicePortIF.checkoutColors2(ClientInfo, int, LockZ) passing ColorDataC.SORD_COLORS in options parameter. In order to receive all colors, call function IXServicePortIF.checkoutColors2(ClientInfo, int, LockZ).

Specified by:

checkoutColors in interface IXServicePortIF

Parameters:

ci - ClientInfo object with language, country and ticket

lockZ - Lock against concurrent modification.

Returns:

Array of Color objects sorted by name

Throws:

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

checkoutConfigFiles

public ConfigFile[] checkoutConfigFiles(ClientInfo ci,
 String[] names,
 ConfigFileZ configFileZ,
 LockZ lockZ)
                                 throws byps.RemoteException

Description copied from interface: IXServicePortIF

Read config file names and file data.

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

Usage

Example	Description
name[.]=peter/template/*	Selects all private document templates of user peter (document templates are currently not supported!)
name[.]=peter/postbox/*	Selects peters server side postbox files
name[.]=template/*	Selects all document templates available for all users (document templates are currently not supported!)
name[.]=eloscripts/*	Selects all scripts

Specified by:

checkoutConfigFiles in interface IXServicePortIF

Parameters:

ci - ClientInfo object with language, country and ticket

names - Array of filter specifications to select the files to return.

configFileZ - Specifies wich data is to return.

lockZ - reserved

Returns:

Array of file names and file data.

Throws:

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

checkoutCounters

public CounterInfo[] checkoutCounters(ClientInfo ci,
 String[] counterNames,
 boolean incrementCounters,
 LockZ lockZ)
                               throws byps.RemoteException

Description copied from interface: IXServicePortIF

Get counter information.

Specified by:

checkoutCounters in interface IXServicePortIF

Parameters:

ci - ClientInfo object with language, country and ticket

counterNames - Array of counter names to be read. If null, all counters are returned.

incrementCounters - If true the given counters are incremented. This parameter is ignored, if counterNames=null.

lockZ - LockZ Locks against concurrent modifications.

Returns:

CounterInfo[] Array of counter objects with values BEFORE being incremented.

Throws:

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

checkoutDoc

public EditInfo checkoutDoc(ClientInfo ci,
 String objId,
 String docId,
 EditInfoZ editInfoZ,
 LockZ lockZ)
                     throws byps.RemoteException

Description copied from interface: IXServicePortIF

Reads the indexing information and the download URL of a document.

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

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

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

Specified by:

checkoutDoc in interface IXServicePortIF

Parameters:

ci - ClientInfo object with language, country and ticket

objId - Object ID, null or empty string

docId - Document ID, null or empty string

editInfoZ - Determines, which members of EditInfo to return. Reasonable predefined values are EditInfoC.mbOnlyId, EditInfoC.mbSordLean, EditInfoC.mbSord, EditInfoC.mbDocument, EditInfoC.mbSordDocAtt. Be aware of the performance effects of this parameter: avoid using EditInfoC.mbAll.

lockZ - Lock archive entry.

Returns:

Data to edit an archive entry.

Throws:

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

See Also:

• checkoutSord
• checkinDocBegin

checkoutDocMask

public DocMask checkoutDocMask(ClientInfo ci,
 String maskId,
 DocMaskZ docMaskZ,
 LockZ lockZ)
                        throws byps.RemoteException

Description copied from interface: IXServicePortIF

Reads a storage mask from the database.

Specified by:

checkoutDocMask in interface IXServicePortIF

Parameters:

ci - ClientInfo object with language, country and ticket

maskId - Mask ID (DocMask.no) or name (DocMask.name)

docMaskZ - Members to be read.

lockZ - Lock masks against concurrent modification.

Returns:

Mask object

Throws:

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

See Also:

• DocMaskC
• checkinDocMask

checkoutKeys

public KeyInfo[] checkoutKeys(ClientInfo ci,
 String[] ids,
 LockZ lockZ)
                       throws byps.RemoteException

Description copied from interface: IXServicePortIF

Reads a list of key objects.

Specified by:

checkoutKeys in interface IXServicePortIF

Parameters:

ci - ClientInfo object with language, country and ticket

ids - Array of key IDs or names or null to read all keys.

lockZ - Lock key data.

Returns:

Array of key objects

Throws:

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

See Also:

• checkinKeys

checkoutKeywords

public Keyword[] checkoutKeywords(ClientInfo ci,
 String[] kwids,
 KeywordZ keywordZ,
 int max,
 LockZ lockZ)
                           throws byps.RemoteException

Description copied from interface: IXServicePortIF

Collects keywords and their children.

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

Parameter kwids

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

The parameter max controls how many keywords will be read.

Parameter max

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

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

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

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

Specified by:

checkoutKeywords in interface IXServicePortIF

Parameters:

ci - ClientInfo object with language, country and ticket

kwids - String IDs of keywords to checkout.

keywordZ - If KeywordC.mbEdit, the place-holders in keywords texts are not substituted. If KeywordC.mbView the place-holders except KeywordC.PLACEHOLDER_COUNTER are replaced.

max - int Read up to this number of keywords and keyword children.

lockZ - Lock against concurrent modification.

Returns:

Keyword[] List of keywords

Throws:

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

See Also:

• KeywordC
• Keyword

checkoutNotes

public Note[] checkoutNotes(ClientInfo ci,
 String objId,
 String[] noteIds,
 NoteZ noteZ,
 LockZ lockZ)
                     throws byps.RemoteException

Description copied from interface: IXServicePortIF

Read notes of a given Sord.

Specified by:

checkoutNotes in interface IXServicePortIF

Parameters:

ci - ClientInfo object with language, country and ticket.

objId - String ID or GUID of associated Sord. If objId==null, parameter noteId must be set.

noteIds - String GUIDs of notes to be returned. If noteIds==null, parameter objId must be set and the function returns all notes associated to the Sord object referenced by objId.

noteZ - NoteZ Controls the members to be returned.

lockZ - LockZ Locks the note object against concurrent modification.

Returns:

Note[] Array of note objects ordered by Note.createDate

Throws:

byps.RemoteException

See Also:

• NoteC
• IXServicePortIF.checkinNotes(de.elo.ix.client.ClientInfo, java.lang.String, de.elo.ix.client.Note[], de.elo.ix.client.NoteZ, de.elo.ix.client.LockZ)

checkoutReminders

public Reminder[] checkoutReminders(ClientInfo ci,
 int[] reminderIds,
 LockZ lockZ)
                             throws byps.RemoteException

Description copied from interface: IXServicePortIF

Reads and locks a reminder object.

Specified by:

checkoutReminders in interface IXServicePortIF

Parameters:

ci - ClientInfo object with language, country and ticket.

reminderIds - Reminder IDs

lockZ - Locks against concurrent modification.

Returns:

Reminder objects

Throws:

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

checkoutReplNames

public ReplSetName[] checkoutReplNames(ClientInfo ci,
 LockZ lockZ)
                                throws byps.RemoteException

Description copied from interface: IXServicePortIF

Reads replication set names.

Specified by:

checkoutReplNames in interface IXServicePortIF

Parameters:

ci - ClientInfo object with language, country and ticket

lockZ - Lock against concurrent modification.

Returns:

Array of replication set names.

Throws:

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

checkoutReportOptions

public ReportOptions checkoutReportOptions(ClientInfo ci,
 LockZ lockZ)
                                    throws byps.RemoteException

Description copied from interface: IXServicePortIF

Reads the report options.

Specified by:

checkoutReportOptions in interface IXServicePortIF

Parameters:

ci - ClientInfo object with language, country and ticket

lockZ - Lock report data.

Returns:

Report options

Throws:

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

checkoutSord

public EditInfo checkoutSord(ClientInfo ci,
 String objId,
 EditInfoZ editInfoZ,
 LockZ lockZ)
                      throws byps.RemoteException

Description copied from interface: IXServicePortIF

Reads the data needed to edit an existing archive entry.

Possible object identifiers (parameter objId)

ID	A numeric object number corresponding to Sord.getId() converted to string
GUID	A GUID corresponding to Sord.getGuid()
Index value	Use "OKEY:<index-group-name>=<index-value>" to select an object by an index value, example: "OKEY:SAPPATH=123124109824123/data". The wildcards "%" or "*" can be used in <index-group-name> or <index-value> to return all or any data that matches.
Index match value	Use "LMATCH:<index-group-name>=<fix-value>%<match-value>" to select an object by an index value that starts with <fix-value> and might be followed by <match-value>. The object that fits most characters in <match-value> is selected. Example: "LMATCH:ELOINDEX=S%CH". The wildcards "%" or "*" can be used in <index-group-name> or <match-value> to return all or any data that matches. This selection mode only be utilized on non-deleted Sords.
Archive path	Use "ARCPATH:<delim-char><SordName1><delim-char><SordName2>..." to select an object by an archive path. This selection mode only be utilized on non-deleted Sords.
Archive path with base ID	Use "ARCPATH[<ID>]:<delim-char><SordName1><delim-char><SordName2>..." to select an object by an archive path
MD5 hash	Use "MD5:<MD5-hash-hex-string>" to select an object by an MD5 hash. Use upper case letters for hexadecimal characters for the hash value.

The object can be locked against concurrent modification if lockZ is set to lockZ.YES.

Specified by:

checkoutSord in interface IXServicePortIF

Parameters:

ci - ClientInfo object with language, country and ticket

objId - Object identifier. The table above gives possible types of identifiers.

editInfoZ - Determines, which members of EditInfo to return. Reasonable predefined values are EditInfoC.mbOnlyId, EditInfoC.mbSordLean, EditInfoC.mbSord. Be aware of the perfomance effects of this parameter: avoid using EditInfoC.mbAll.

lockZ - Lock archive entry. Default is LockC.NO.

Returns:

Data to edit an archive entry.

Throws:

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

See Also:

• createSord
• checkinSord

checkoutSordHistory

public SordHist[] checkoutSordHistory(ClientInfo ci,
 String objId)
                               throws byps.RemoteException

Description copied from interface: IXServicePortIF

checkoutSordHistory retrieves all history entries related to a given object.

Specified by:

checkoutSordHistory in interface IXServicePortIF

Parameters:

ci - ClientInfo object with language, country and ticket

objId - Object identifier. This may be the simple numeric identifier or the associated global unique identifier (GUID)

Returns:

SordHist[] An array of all sord history entries sorted by its creation date.

Throws:

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

checkoutSordTypes

public SordType[] checkoutSordTypes(ClientInfo ci,
 int[] sordTypeIds,
 SordTypeZ sordTypeZ,
 LockZ lockZ)
                             throws byps.RemoteException

Description copied from interface: IXServicePortIF

Get sord type information.

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

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

Specified by:

checkoutSordTypes in interface IXServicePortIF

Parameters:

ci - ClientInfo object with language, country and ticket.

sordTypeIds - Array of Sord type IDs that specify the Objects to return. Or null to return all Objects.

sordTypeZ - Controls the data to be returned.

lockZ - Locks against concurrent modification.

Returns:

SordType[] Array of sord type information.

Throws:

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

See Also:

• checkinSordTypes
• deleteSordTypes

checkoutStorage

public StoreInfo[] checkoutStorage(ClientInfo ci,
 String[] ids,
 LockZ lockZ)
                            throws byps.RemoteException

Description copied from interface: IXServicePortIF

checkoutStorage retrieves an array of configured paths from the Document Manager. The contents matches the table elodmpath.

Specified by:

checkoutStorage in interface IXServicePortIF

Parameters:

ci - ClientInfo object with language, country and ticket

ids - array of IDs for the desired storage paths; pass null or an array of zero length to retrieve all

lockZ - Lock path data

Returns:

path information from the Document Manager

Throws:

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

checkoutSubs

public SubsInfo[] checkoutSubs(ClientInfo ci,
 String userId,
 LockZ lockZ)
                        throws byps.RemoteException

Description copied from interface: IXServicePortIF

Read the substitute information for the given user.

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

Specified by:

checkoutSubs in interface IXServicePortIF

Parameters:

ci - ClientInfo object with language, country and ticket

userId - User name or ID, only main administrators are allowed to collect substitute relationships for other users. Non-administrators must set this parameter to null or to their user ID.

lockZ - Lock user data

Returns:

SubsInfo[]

Throws:

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

checkoutUserProfile

public UserProfile checkoutUserProfile(ClientInfo ci,
 UserProfile userProfile,
 LockZ lockZ)
                                throws byps.RemoteException

Description copied from interface: IXServicePortIF

Read user profile options.

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

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

Specified by:

checkoutUserProfile in interface IXServicePortIF

Parameters:

ci - ClientInfo object with language, country and ticket

userProfile - Options of a specific user or default options for all users. If the userProfile.options array is null, all options are returned. Otherwise the keys in the option array select the options to return. A key might end with wildcard "*" in which case all options are selected that begin with the key.

lockZ - Lock against concurrent modification - locking is currently not supported but may be added in future.

Returns:

User profile options.

Throws:

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

checkoutUsers

public UserInfo[] checkoutUsers(ClientInfo ci,
 String[] ids,
 CheckoutUsersZ checkoutUsersZ,
 LockZ lockZ)
                         throws byps.RemoteException

Description copied from interface: IXServicePortIF

Reads the user data for users or groups.

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

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

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

Specified by:

checkoutUsers in interface IXServicePortIF

Parameters:

ci - ClientInfo object with language, country and ticket

ids - User or group IDs, GUIDs or names.

checkoutUsersZ - Controls the users or groups to retrieve.

lockZ - Lock user data.

Returns:

List of users or groups sorted by name.

Throws:

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

See Also:

• getUserNames
• checkinUsers

checkoutOrgUnits

public Map<Integer,OrgUnitInfo> checkoutOrgUnits(ClientInfo ci,
 CheckoutOrgUnitInfo checkoutOrgUnitInfo,
 LockZ lockZ)
                                          throws byps.RemoteException

Description copied from interface: IXServicePortIF

Read the data of all OUs.

Specified by:

checkoutOrgUnits in interface IXServicePortIF

Parameters:

ci - ClientInfo object with language, country and ticket

checkoutOrgUnitInfo - This parameter must be null.

lockZ - Lock OU data.

Returns:

Map of OUs, key is OrgUnitInfo.id

Throws:

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

See Also:

• checkinOrgUnits

checkoutWorkFlow

public WFDiagram checkoutWorkFlow(ClientInfo ci,
 String flowId,
 WFTypeZ typeZ,
 WFDiagramZ workFlowDiagramZ,
 LockZ lockZ)
                           throws byps.RemoteException

Description copied from interface: IXServicePortIF

Reads a workflow definition.

Specified by:

checkoutWorkFlow in interface IXServicePortIF

Parameters:

ci - ClientInfo object with language, country and ticket

flowId - Workflow name or ID

typeZ - Workflow type: active flow, finished flow, template.

workFlowDiagramZ - Members to return.

lockZ - Lock workflow.

Returns:

Workflow definition

Throws:

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

See Also:

• WFTypeC

cleanupStart

public boolean cleanupStart(ClientInfo ci,
 DeleteOptions deleteOptions)
                     throws byps.RemoteException

Description copied from interface: IXServicePortIF

cleanupStart(ClientInfo ci) removes all deleted objects and related entries from the archive database.

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

Specified by:

cleanupStart in interface IXServicePortIF

Parameters:

ci - ClientInfo object with language, country and ticket

deleteOptions - DeleteOptions object contains options for deleting archive SORDs.

Returns:

true, if the background cleaner can be started, false otherwise

Throws:

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

See Also:

• cleanupStop
• cleanupState

cleanupState

public JobState cleanupState(ClientInfo ci)
                      throws byps.RemoteException

Description copied from interface: IXServicePortIF

cleanupState(ClientInfo ci) returns state information in a BackgroundThreadInfo.

Specified by:

cleanupState in interface IXServicePortIF

Parameters:

ci - ClientInfo object with language, country and ticket

Returns:

JobState

Throws:

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

See Also:

• cleanupStart
• cleanupStop

cleanupStop

public boolean cleanupStop(ClientInfo ci)
                    throws byps.RemoteException

Description copied from interface: IXServicePortIF

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

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

Specified by:

cleanupStop in interface IXServicePortIF

Parameters:

ci - ClientInfo object with language, country and ticket

Returns:

true, if the background cleaner can be stopped, false otherwise

Throws:

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

See Also:

• cleanupStart
• cleanupState

collectJobStates

public JobState[] collectJobStates(ClientInfo ci,
 boolean activeJobs,
 boolean finishedJobs,
 boolean fullInfo)
                            throws byps.RemoteException

Description copied from interface: IXServicePortIF

collectJobStates lists all the states of currently existing jobs from the IX backround job pool running or finished, but still listed.

Specified by:

collectJobStates in interface IXServicePortIF

Parameters:

ci - ClientInfo object with language, country and ticket

activeJobs - Currently running jobs will be collected (filter information)

finishedJobs - Finished jobs, that are still queued for state evaluation will be collectred (filter information)

fullInfo - The procInfo member of JobState will be filled by jobs that support the member procInfo

Returns:

Array of background job states

Throws:

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

collectWorkFlowNodes

public WFCollectNode[] collectWorkFlowNodes(ClientInfo ci,
 String flowName,
 WFTypeZ wfTypeZ,
 String nodeName,
 int nodeType,
 String objId,
 String enterDateIso,
 String exitDateIso,
 String[] userIds,
 boolean onlyActive,
 boolean onlyStartNodes)
                                     throws byps.RemoteException

Description copied from interface: IXServicePortIF

Collect workflow nodes.

Specified by:

collectWorkFlowNodes in interface IXServicePortIF

Parameters:

ci - ClientInfo object with language, country and ticket.

flowName - restricts the search to workflows named like this string. It may contain wildcards, e. g. *bill*.

wfTypeZ - This parameter controls the search for nodes of either active or finished workflows. If this parameter is null, the search is performed on active workflows.

nodeName - restricts the search to nodes named like this string. It may contain wildcards, e. g. *bill*.

nodeType - One of the TYPE_* constants defined in WFNodeC can be assigned. TYPE_NOTHING or 0 means that all node types will be returned.

objId - Return nodes of the object specified by this ID. Can be null to return nodes of all objects.

enterDateIso - Return nodes of this activation date. The value is an ISO date in the clients time zone. It can be a single date value or a time span of two ISO dates separated by "...". To return nodes with an activation date up to a given time, set enterDateIso="..."+time (the first time value can be omitted).

exitDateIso - Return nodes of this exit date. The format used is the same as for enterDateIso.

userIds - If not null and not empty, the search is restricted to nodes for these users. It may be an array of IDs, GUIDs or names.

onlyActive - If true, the result is restricted to active nodes.

onlyStartNodes - If true, only the start nodes of the matching workflows are returned - instead of the matching nodes.

Returns:

Array of node information objects.

Throws:

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

See Also:

• WFNodeC
• CONST.WORKFLOW_NODE
• WFTypeC.FINISHED
• CONST.WORKFLOW_TYPE

collectWorkFlows

public IdName[] collectWorkFlows(ClientInfo ci,
 WFTypeZ typeZ)
                          throws byps.RemoteException

Description copied from interface: IXServicePortIF

Collects workflow names.

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

Specified by:

collectWorkFlows in interface IXServicePortIF

Parameters:

ci - ClientInfo object with language, country and ticket.

typeZ - Workflow type: active flow, finished flow, template.

Returns:

Array of workfow names and IDs.

Throws:

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

See Also:

• findFirstTasks(...)
• findNextTasks(...)

findFirstWorkflows

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

Description copied from interface: IXServicePortIF

Finds active workflows.

This method returns all active workflows for the current user.

Specified by:

findFirstWorkflows in interface IXServicePortIF

Parameters:

ci - ClientInfo object with language, country and ticket

findInfo - FindTasksInfo information about the current search

max - int maximal count of Workflow-Objects

wfDiagramZ - WFDiagramZ needed elements

Returns:

FindResult

Throws:

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

findNextWorkflows

public FindResult findNextWorkflows(ClientInfo ci,
 String searchId,
 int index,
 int maxResults)
                             throws byps.RemoteException

Description copied from interface: IXServicePortIF

Finds more active workflows.

This method returns all active workflows for the current user.

Specified by:

findNextWorkflows in interface IXServicePortIF

Parameters:

ci - ClientInfo object with language, country and ticket

searchId - String Id of the current search

index - int startindex for the current search

maxResults - int maximal count of Workflow-Objects

Returns:

FindResult

Throws:

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

cookKeyword

public String cookKeyword(ClientInfo ci,
 String kwid)
                   throws byps.RemoteException

Description copied from interface: IXServicePortIF

Replaces control sequences in the text of a keyword.

Specified by:

cookKeyword in interface IXServicePortIF

Parameters:

ci - ClientInfo object with language, country and ticket

kwid - Keyword ID

Returns:

Keyword

Throws:

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

copySord

public int copySord(ClientInfo ci,
 String newParentId,
 String objId,
 CopyInfo copyInfo,
 CopySordZ copySordZ)
             throws byps.RemoteException

Description copied from interface: IXServicePortIF

Moves an archive entry or creates a relation (logical copy).

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

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

References can be deleted with deleteSord

Specified by:

copySord in interface IXServicePortIF

Parameters:

ci - ClientInfo object with language, country and ticket

newParentId - ID or -GUID of the parent entry in the archive hierarchy.

objId - ID or -GUID of the existing object.

copyInfo - Special options, e. g. manually sort order.

copySordZ - One of the CopySordC constants.

Returns:

ID of the moved/referenced object or the new id of the copied object objId.

Throws:

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

See Also:

• CopySordC
• Sord.parentIds
• refSord
• linkSords

createDoc

public EditInfo createDoc(ClientInfo ci,
 String parentId,
 String maskId,
 String docTemplate,
 EditInfoZ editInfoZ)
                   throws byps.RemoteException

Description copied from interface: IXServicePortIF

Creates a new document with indexing information.

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

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

Specified by:

createDoc in interface IXServicePortIF

Parameters:

ci - ClientInfo object with language, country and ticket

parentId - ID or GUID of parent entry.

maskId - ID or name of storage mask.

docTemplate - CURRENTLY NOT SUPPORTED! must be null

editInfoZ - Determines, which members of EditInfo to return. Reasonable predefined values are EditInfoC.mbSord or EditInfoC.mbSordDocAtt. Be aware of the performance effects of this parameter: avoid using EditInfoC.mbAll.

Returns:

Data to edit a new archive entry.

Throws:

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

See Also:

• createSord
• checkinDocBegin

createDocMask

public DocMask createDocMask(ClientInfo ci,
 String maskId)
                      throws byps.RemoteException

Description copied from interface: IXServicePortIF

Creates a storage mask object and assigns default values.

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

Specified by:

createDocMask in interface IXServicePortIF

Parameters:

ci - ClientInfo object with language, country and ticket

maskId - Mask ID (DocMask.no) or name (DocMask.name) or null

Returns:

Storage mask object.

Throws:

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

See Also:

• checkinDocMask

createKey

public KeyInfo createKey(ClientInfo ci)
                  throws byps.RemoteException

Description copied from interface: IXServicePortIF

Creates and initializes a key object.

Specified by:

createKey in interface IXServicePortIF

Parameters:

ci - ClientInfo object with language, country and ticket

Returns:

Key object

Throws:

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

See Also:

• checkinKeys

createNote

public Note createNote(ClientInfo ci,
 String objId)
                throws byps.RemoteException

Description copied from interface: IXServicePortIF

Returns an initialized, temporary Note object.

Specified by:

createNote in interface IXServicePortIF

Parameters:

ci - ClientInfo object with language, country and ticket.

objId - String ID or GUID of associated Sord.

Returns:

Note object

Throws:

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

createNote2

public Note createNote2(ClientInfo ci,
 String objId,
 int noteType,
 String templId)
                 throws byps.RemoteException

Description copied from interface: IXServicePortIF

Returns an initialized, temporary Note object.

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

Specified by:

createNote2 in interface IXServicePortIF

Parameters:

ci - ClientInfo object with language, country and ticket.

objId - String ID or GUID of associated Sord.

noteType - Type of the node. Ignored, if parameter templId is set.

templId - ID of a note template.

Returns:

Note object

Throws:

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

createReminder

public Reminder createReminder(ClientInfo ci,
 String objId)
                        throws byps.RemoteException

Description copied from interface: IXServicePortIF

Creates a reminder for the Sord specified by objId.

Specified by:

createReminder in interface IXServicePortIF

Parameters:

ci - ClientInfo object with language, country and ticket.

objId - String ID or GUID of an existing Sord.

Returns:

Reminder Initialized Reminder object.

Throws:

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

createSord

public EditInfo createSord(ClientInfo ci,
 String parentId,
 String maskId,
 EditInfoZ editInfoZ)
                    throws byps.RemoteException

Description copied from interface: IXServicePortIF

Creates an object containing all the data needed to edit the indexing information of a new archive entry.

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

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

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

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

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

Specified by:

createSord in interface IXServicePortIF

Parameters:

ci - ClientInfo object with language, country and ticket

parentId - ID or GUID of parent entry.

maskId - ID or name of a storage mask.

editInfoZ - Determines, which members of EditInfo to return.

Returns:

Data to edit a new archive entry.

Throws:

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

See Also:

• checkinSord

createUser

public UserInfo createUser(ClientInfo ci,
 String rightsAsUserId)
                    throws byps.RemoteException

Description copied from interface: IXServicePortIF

Creates an object for user data.

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

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

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

Specified by:

createUser in interface IXServicePortIF

Parameters:

ci - ClientInfo object with language, country and ticket

rightsAsUserId - User ID or name of an user. The initial rights are copied from this user.

Returns:

user data

Throws:

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

See Also:

• checkinUsers

createWFNode

public WFNode createWFNode(ClientInfo ci,
 int nodeId,
 int nodeTypeC)
                    throws byps.RemoteException

Description copied from interface: IXServicePortIF

Initalizes a WFNode object.

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

Specified by:

createWFNode in interface IXServicePortIF

Parameters:

ci - ClientInfo object with language, country and ticket.

nodeId - int ID to be assigned to the new node.

nodeTypeC - int One of the WFNodeC.TYPE_* constants.

Returns:

Note

Throws:

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

See Also:

• WFNodeC

createWorkFlow

public WFDiagram createWorkFlow(ClientInfo ci,
 String wfName,
 WFTypeZ typeZ)
                         throws byps.RemoteException

Description copied from interface: IXServicePortIF

Prepares a WFDiagram structure.

Specified by:

createWorkFlow in interface IXServicePortIF

Parameters:

ci - ClientInfo object with language, country and ticket

wfName - Workflow name

typeZ - WFTypeZ Workflow type, must be WFTypeC.TEMPLATE or WFTypeC.ACTIVE

Returns:

WFDiagram

Throws:

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

deleteConfigFiles

public void deleteConfigFiles(ClientInfo ci,
 String[] names,
 LockZ unlockZ)
                       throws byps.RemoteException

Description copied from interface: IXServicePortIF

Deletes configuration files.

Specified by:

deleteConfigFiles in interface IXServicePortIF

Parameters:

ci - ClientInfo object with language, country and ticket

names - Configuration file names (incl. directory)

unlockZ - reserved

Throws:

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

deleteCounters

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

Description copied from interface: IXServicePortIF

Delete counters.

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

Specified by:

deleteCounters in interface IXServicePortIF

Parameters:

ci - ClientInfo object with language, country and ticket.

counterNames - Array of counter names to be deleted.

unlockZ - Removes a lock previously set by checkoutCounters.

Throws:

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

deleteDocMask

public boolean deleteDocMask(ClientInfo ci,
 String maskId,
 String assignMaskId,
 LockZ unlockZ)
                      throws byps.RemoteException

Description copied from interface: IXServicePortIF

Deletes a storage mask.

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

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

Specified by:

deleteDocMask in interface IXServicePortIF

Parameters:

ci - ClientInfo object with language, country and ticket

maskId - Mask ID (DocMask.no) or name (DocMask.name) of the mask to delete.

assignMaskId - Mask ID (DocMask.no) or name (DocMask.name) of the mask to assign.

unlockZ - Unlock masks.

Returns:

If mask not found the return value is false.

Throws:

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

See Also:

• checkinDocMask

deleteKeys

public void deleteKeys(ClientInfo ci,
 String[] ids,
 LockZ unlockZ)
                throws byps.RemoteException

Description copied from interface: IXServicePortIF

Deletes keys.

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

Specified by:

deleteKeys in interface IXServicePortIF

Parameters:

ci - ClientInfo object with language, country and ticket

ids - Array of key IDs or names or null to read all keys.

unlockZ - Unlock key data or force access.

Throws:

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

See Also:

• checkinKeys

deleteKeywords

public void deleteKeywords(ClientInfo ci,
 String[] kwids,
 LockZ unlockZ)
                    throws byps.RemoteException

Description copied from interface: IXServicePortIF

Deletes the keywords with the given IDs.

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

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

Specified by:

deleteKeywords in interface IXServicePortIF

Parameters:

ci - ClientInfo object with language, country and ticket

kwids - String[] Array of keyword IDs.

unlockZ - Remove lock.

Throws:

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

deleteNotes

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

Description copied from interface: IXServicePortIF

Deletes notes.

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

Specified by:

deleteNotes in interface IXServicePortIF

Parameters:

ci - ClientInfo object with language, country and ticket.

noteIds - String[] GUIDs of notes to delete.

unlockZ - Removes a lock.createso

Throws:

byps.RemoteException

See Also:

• IXServicePortIF.checkinNotes(de.elo.ix.client.ClientInfo, java.lang.String, de.elo.ix.client.Note[], de.elo.ix.client.NoteZ, de.elo.ix.client.LockZ)

deleteReminders

public void deleteReminders(ClientInfo ci,
 int[] reminderIds,
 LockZ unlockZ)
                     throws byps.RemoteException

Description copied from interface: IXServicePortIF

Deletes the reminders (logically) with the the given IDs.

Specified by:

deleteReminders in interface IXServicePortIF

Parameters:

ci - ClientInfo object with language, country and ticket.

reminderIds - String[]

unlockZ - Removes a lock.

Throws:

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

deleteReport

public void deleteReport(ClientInfo ci,
 String endDateISO)
                  throws byps.RemoteException

Description copied from interface: IXServicePortIF

Deletes report entries until endDateISO.

Specified by:

deleteReport in interface IXServicePortIF

Parameters:

ci - ClientInfo object with language, country and ticket

endDateISO - Delete entries until this date based on the local time zone of the country specified in ci.

Throws:

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

deleteSord

public boolean deleteSord(ClientInfo ci,
 String parentId,
 String objId,
 LockZ unlockZ,
 DeleteOptions deleteOptions)
                   throws byps.RemoteException

Description copied from interface: IXServicePortIF

Deletes an archive entry and all child entries or deletes a relation (logical copy).

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

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

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

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

Specified by:

deleteSord in interface IXServicePortIF

Parameters:

ci - ClientInfo object with language, country and ticket

parentId - ID or GUID of the parent entry in the archive hierarchy. May be null.

objId - Object-ID or -GUID of the entry to delete.

unlockZ - Unlock archive entry.

deleteOptions - e. g. delete finally, delete until a given date. If null, the object will be delete logically.

Returns:

true, when all traversed SORDs have been deleted successfully.
false, when at least one removal failed

Throws:

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

See Also:

• createSord

deleteSordTypes

public void deleteSordTypes(ClientInfo ci,
 int[] sordTypeIds,
 LockZ unlockZ)
                     throws byps.RemoteException

Description copied from interface: IXServicePortIF

Delete sord type information.

Specified by:

deleteSordTypes in interface IXServicePortIF

Parameters:

ci - ClientInfo object with language, country and ticket.

sordTypeIds - Array of type IDs to delete.

unlockZ - Removes a lock previously set by checkoutSordTypes.

Throws:

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

deleteSubs

public void deleteSubs(ClientInfo ci,
 SubsInfo[] deps,
 LockZ unlockZ)
                throws byps.RemoteException

Description copied from interface: IXServicePortIF

Delete deputy information.

Specified by:

deleteSubs in interface IXServicePortIF

Parameters:

ci - ClientInfo

deps - SubsInfo[]

unlockZ - Unlock user data

Throws:

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

deleteUserProfile

public void deleteUserProfile(ClientInfo ci,
 UserProfile userProfile,
 LockZ unlockZ)
                       throws byps.RemoteException

Description copied from interface: IXServicePortIF

Deletes profile options.

Specified by:

deleteUserProfile in interface IXServicePortIF

Parameters:

ci - ClientInfo object with language, country and ticket

userProfile - Options of a specific user or default options for all users. If the userProfile.options array is null, all options are deleted. Otherwise the keys in the option array select the options to return. A key might contain the wildcard "*". It is a placeholder for 0, 1 or many arbitrary characters.

unlockZ - Remove lock - locking is currently not supported but may be added in future.

Throws:

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

deleteUsers

public void deleteUsers(ClientInfo ci,
 String[] ids,
 LockZ unlockZ)
                 throws byps.RemoteException

Description copied from interface: IXServicePortIF

Deletes users or groups.

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

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

Specified by:

deleteUsers in interface IXServicePortIF

Parameters:

ci - ClientInfo object with language, country and ticket

ids - User or group IDs or names.

unlockZ - Unlock user data or force access.

Throws:

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

See Also:

• checkinUsers
• checkinUsers

deleteOrgUnits

public void deleteOrgUnits(ClientInfo ci,
 String[] ids,
 LockZ unlockZ)
                    throws byps.RemoteException

Description copied from interface: IXServicePortIF

Delete OUs.

Specified by:

deleteOrgUnits in interface IXServicePortIF

Parameters:

ci - ClientInfo object with language, country and ticket

ids - IDs or names of OUs to be deleted.

unlockZ - Unlock OU data or force access.

Throws:

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

See Also:

• checkinOrgUnits

deleteWorkFlow

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

Description copied from interface: IXServicePortIF

Deletes a workflow.

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

Specified by:

deleteWorkFlow in interface IXServicePortIF

Parameters:

ci - ClientInfo object with language, country and ticket

flowId - Workflow name or ID

typeZ - Workflow type: active flow, finished flow, template.

unlockZ - Remove lock

Throws:

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

endEditWorkFlowNode

public void endEditWorkFlowNode(ClientInfo ci,
 int nFlowId,
 int nNodeId,
 boolean bTerminate,
 boolean bCancel,
 String sName,
 String sComment,
 int[] arrEnterNodesIds)
                         throws byps.RemoteException

Description copied from interface: IXServicePortIF

Stores an edited person node of an active workflow into the database and unlocks the workflow.

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

Specified by:

endEditWorkFlowNode in interface IXServicePortIF

Parameters:

ci - ClientInfo object with language, country and ticket.

nFlowId - Workflow ID.

nNodeId - Workflow node ID.

bTerminate - If true, the workflow will be terminated.

bCancel - If true, no data is stored. The nodes will be unlocked.

sName - New node name to store.

sComment - New node comment to store.

arrEnterNodesIds - The nodes to activate next.

Throws:

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

findClose

public void findClose(ClientInfo ci,
 String searchId)
               throws byps.RemoteException

Description copied from interface: IXServicePortIF

Deletes the search results explicitly in the Indexserver process to save memory.

Specified by:

findClose in interface IXServicePortIF

Parameters:

ci - ClientInfo object with language, country and ticket

searchId - Search ID returned from findFirstSords

Throws:

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

findFirstConfigFiles

public FindResult findFirstConfigFiles(ClientInfo ci,
 FindConfigFileInfo findInfo,
 int max,
 ConfigFileZ configFileZ)
                                throws byps.RemoteException

Description copied from interface: IXServicePortIF

Finds configuration or postbox files.

Specified by:

findFirstConfigFiles in interface IXServicePortIF

Parameters:

ci - ClientInfo object with language, country and ticket

findInfo - Find object.

max - Maximum number of objects to be returned from this call.

configFileZ - Members to return. ConfigFile.mbFileData is ignored.

Returns:

FindResult object

Throws:

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

See Also:

• findFirstSords
• findNextConfigFiles

findFirstReportInfos

public FindResult findFirstReportInfos(ClientInfo ci,
 FindReportInfo opts,
 int max)
                                throws byps.RemoteException

Description copied from interface: IXServicePortIF

Finds report entries.

Specified by:

findFirstReportInfos in interface IXServicePortIF

Parameters:

ci - ClientInfo object with language, country and ticket

opts - Selection criteria for report entries

max - Maximum number of entries to be returned. This is internally limited to 1000.

Returns:

Array of report entries

Throws:

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

findFirstSords

public FindResult findFirstSords(ClientInfo ci,
 FindInfo findInfo,
 int max,
 SordZ sordZ)
                          throws byps.RemoteException

Description copied from interface: IXServicePortIF

Find archive entries and retrieve the first max objects.

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

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

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

Specified by:

findFirstSords in interface IXServicePortIF

Parameters:

ci - ClientInfo object with language, country and ticket

findInfo - Object contains search criteria.

max - Maximum number of result objects to return. The value is internally limited to 1000.

sordZ - Members to read into the returned Sord object Array. If this bit set only contains either SordC.mbId or SordC.mbGuid the returned FindResult contains an ID array FindResult.ids instead of a Sord object array.

Returns:

Search result.

Throws:

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

See Also:

• findNextSords
• SordC

findFirstTasks

public FindResult findFirstTasks(ClientInfo ci,
 FindTasksInfo findInfo,
 int max)
                          throws byps.RemoteException

Description copied from interface: IXServicePortIF

Finds reminders, activities and active workflow nodes.

Specified by:

findFirstTasks in interface IXServicePortIF

Parameters:

ci - ClientInfo object with language, country and ticket.

findInfo - FindTasksInfo

max - int

Returns:

FindResult

Throws:

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

See Also:

• findNextTasks
• findClose

findNextConfigFiles

public FindResult findNextConfigFiles(ClientInfo ci,
 String searchId,
 int idx,
 int max,
 ConfigFileZ configFileZ)
                               throws byps.RemoteException

Description copied from interface: IXServicePortIF

Finds next configuration files.

Specified by:

findNextConfigFiles in interface IXServicePortIF

Parameters:

ci - ClientInfo object with language, country and ticket

searchId - Search-ID returned from a previous call to findFirstConfigFiles.

idx - In the list of found files, return files starting from this index.

max - Return at most max file objects.

configFileZ - Members to return. ConfigFile.mbFileData is ignored.

Returns:

FindResult

Throws:

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

findNextReportInfos

public FindResult findNextReportInfos(ClientInfo ci,
 String searchId,
 int idx,
 int max)
                               throws byps.RemoteException

Description copied from interface: IXServicePortIF

Finds report entries.

Specified by:

findNextReportInfos in interface IXServicePortIF

Parameters:

ci - ClientInfo object with language, country and ticket

searchId - Search ID returned from findFirstReportInfos

idx - Start index of results

max - Maximum number of results

Returns:

Array of report entries

Throws:

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

findNextSords

public FindResult findNextSords(ClientInfo ci,
 String searchId,
 int idx,
 int max,
 SordZ sordZ)
                         throws byps.RemoteException

Description copied from interface: IXServicePortIF

Retrieves further results of a previous search with findFirstSords.

Specified by:

findNextSords in interface IXServicePortIF

Parameters:

ci - ClientInfo object with language, country and ticket

searchId - Search ID returned from findFirstSords

idx - Start index at which result objects are returned.

max - Maximum number of result objects to return. The value is internally limited to 1000.

sordZ - Members to read into the returned Sord object Array. If this bit set only contains either SordC.mbId or SordC.mbGuid the returned FindResult object contains an ID array FindResult.ids instead of a Sord object array.

Returns:

Search result.

Throws:

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

See Also:

• SordC

findNextTasks

public FindResult findNextTasks(ClientInfo ci,
 String searchId,
 int idx,
 int max)
                         throws byps.RemoteException

Description copied from interface: IXServicePortIF

Continues the find process started with findFirstTasks.

Specified by:

findNextTasks in interface IXServicePortIF

Parameters:

ci - ClientInfo object with language, country and ticket.

searchId - String

idx - int

max - int

Returns:

FindResult

Throws:

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

See Also:

• findFirstTasks

finishExport

public void finishExport(ClientInfo ci,
 String exportId)
                  throws byps.RemoteException

Description copied from interface: IXServicePortIF

Removes temp-files after an export.

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

Specified by:

finishExport in interface IXServicePortIF

Parameters:

ci - ClientInfo object with language, country and ticket.

exportId - String the exportId (GUID) of the export.

Throws:

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

getConstants

public IXServicePortC getConstants(ClientInfo ci)
                            throws byps.RemoteException

Description copied from interface: IXServicePortIF

Retrieves the constants.

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

Specified by:

getConstants in interface IXServicePortIF

Parameters:

ci - ClientInfo object with language, country and ticket

Returns:

Constant objects.

Throws:

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

getExportZipUrl

public String getExportZipUrl(ClientInfo ci,
 String exportId)
                       throws byps.RemoteException

Description copied from interface: IXServicePortIF

Gets the URL for downloading the generated ZIP-archive of this export.

Specified by:

getExportZipUrl in interface IXServicePortIF

Parameters:

ci - ClientInfo object with language, country and ticket.

exportId - String the exportId (GUID) of the export.

Returns:

String with the URL

Throws:

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

getImportZipUrl

public String getImportZipUrl(ClientInfo ci,
 String importId)
                       throws byps.RemoteException

Description copied from interface: IXServicePortIF

Retrieves the URL for uploading the ZIP-archive for this import.

Specified by:

getImportZipUrl in interface IXServicePortIF

Parameters:

ci - ClientInfo object with language, country and ticket.

importId - String the importId (GUID) of the import.

Returns:

String the URL

Throws:

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

getServerInfo

public ServerInfo getServerInfo(ClientInfo ci)
                         throws byps.RemoteException

Description copied from interface: IXServicePortIF

Retrieves configurational information, e.g. license key, additional Indexservers, etc. In order to update the current license information call IXServicePortIF.configureLicense(ClientInfo, String).

Specified by:

getServerInfo in interface IXServicePortIF

Parameters:

ci - ClientInfo object with language, country and ticket

Returns:

Indexserver configuration.

Throws:

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

setServerInfo

public void setServerInfo(ClientInfo ci,
 ServerInfo serverInfo)
                   throws byps.RemoteException

Description copied from interface: IXServicePortIF

Sets the writable members of ServerInfo.

Specified by:

setServerInfo in interface IXServicePortIF

Parameters:

ci - ClientInfo object with language, country and ticket

serverInfo - ServerInfo object.

Throws:

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

getServerInfoDM

public ServerInfoDM getServerInfoDM(ClientInfo ci)
                             throws byps.RemoteException

Description copied from interface: IXServicePortIF

Gets DM configuration information.

Specified by:

getServerInfoDM in interface IXServicePortIF

Parameters:

ci - ClientInfo object with language, country and ticket

Returns:

DM configuration

Throws:

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

See Also:

• IXServicePortIF.setServerInfoDM(ClientInfo, ServerInfoDM)

setServerInfoDM

public void setServerInfoDM(ClientInfo ci,
 ServerInfoDM serverInfo)
                     throws byps.RemoteException

Description copied from interface: IXServicePortIF

Sets the writable members of the DM configuration.

Specified by:

setServerInfoDM in interface IXServicePortIF

Parameters:

ci - ClientInfo object with language, country and ticket

serverInfo - DM configuration

Throws:

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

See Also:

• IXServicePortIF.getServerInfoDM(ClientInfo)

getSessionOptions

public SessionOptions getSessionOptions(ClientInfo ci)
                                 throws byps.RemoteException

Description copied from interface: IXServicePortIF

Retrieve the current session options.

Specified by:

getSessionOptions in interface IXServicePortIF

Parameters:

ci - ClientInfo

Returns:

SessionOptions

Throws:

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

getUserNames

public UserName[] getUserNames(ClientInfo ci,
 String[] ids,
 CheckoutUsersZ checkoutUsersZ)
                        throws byps.RemoteException

Description copied from interface: IXServicePortIF

Reads user or group names and IDs.

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

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

Specified by:

getUserNames in interface IXServicePortIF

Parameters:

ci - ClientInfo object with language, country and ticket

ids - User or group IDs or names.

checkoutUsersZ - See checkoutUsers.

Returns:

Array of Names and IDs

Throws:

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

See Also:

• checkoutUsers

importWorkFlow

public int importWorkFlow(ClientInfo ci,
 String flowName,
 byte[] fileData)
                   throws byps.RemoteException

Description copied from interface: IXServicePortIF

Imports a workflow template from a file.

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

Specified by:

importWorkFlow in interface IXServicePortIF

Parameters:

ci - ClientInfo object with language, country and ticket

flowName - Workflow name

fileData - File content

Returns:

Workflow ID

Throws:

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

linkSords

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

Description copied from interface: IXServicePortIF

Links archive entries.

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

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

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

Specified by:

linkSords in interface IXServicePortIF

Parameters:

ci - ClientInfo object with language, country and ticket

fromId - Object ID or GUID the links start from.

toIds - Object IDs or GUIDs the links point to.

linkZ - Controls how the objects are connected. If null or LinkSordC.PAIR, the function builds pairs of linked objects from fromId to toIds[.]. E.g. {fromId, toIds[0]}, {fromId, toIds[1]}. If LinkSordC.CROSS_LINK is passed, the function builds a cross-link with the associations: {fromId, toIds[0]}, { fromId, toIds[1] }, {toIds[0], toIds[1]}.

Throws:

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

See Also:

• LinkSordC
• Sord.linksGoOut
• Sord.linksComeIn
• unlinkSords

lockArchive

public int lockArchive(ClientInfo ci,
 String keyId)
                throws byps.RemoteException

Description copied from interface: IXServicePortIF

Locks the archive for users or retrieves the lock on the archive. The behavior of this function has changed with ELO11 since the security concept of keys is no more supported. In order to prevent particular users from using the archive, constrain the usage to members of a group. If all users should be able to login, pass UserInfoC.UNLOCK_ARCHIVE.

Specified by:

lockArchive in interface IXServicePortIF

Parameters:

ci - ClientInfo object with language, country and ticket

keyId - Group ID, GUID or name. Members of this group are allowed to login. If empty, return the current lock. If set as UserInfoC.UNLOCK_ARCHIVE, all users are allowed to access the archive.

Returns:

Previous lock. All users can login, if UserInfoC.ID_EVERYONE_GROUP is returned.

Throws:

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

login

public LoginResult login(ClientInfo ci,
 String userName,
 String userPwd,
 String clientComputer,
 String runAsUser)
                  throws byps.RemoteException

Description copied from interface: IXServicePortIF

Log on to Indexserver.

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

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

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

Specified by:

login in interface IXServicePortIF

Parameters:

ci - ClientInfo object with language, country and ticket

userName - user name

userPwd - password

clientComputer - client computer name for reporting

runAsUser - if not null, use the security context of this user instead of the user specified in userName

Returns:

login information. Never null - if log-on fails, an exception is thrown.

Throws:

byps.RemoteException - Exception with message text of format "[ELOIX:number] text". The number is one of the constants defined in IXExceptionC. if user name and password is not a valid account, the message starts with "[ELOIX:3002]".

See Also:

• alive
• logout

loginAdmin

public LoginResult loginAdmin(ClientInfo ci,
 String userName,
 String userPwd,
 String clientComputer,
 String reportAsUser)
                       throws byps.RemoteException

Description copied from interface: IXServicePortIF

Login any user as an administrator.

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

Specified by:

loginAdmin in interface IXServicePortIF

Parameters:

ci - ClientInfo object with language, country and ticket

userName - user name, must have FLAG_ADMIN and FLAG_IGNOREACL rights.

userPwd - password

clientComputer - client computer name for reporting

reportAsUser - if not null, this user is used as owner of created objects. In contrast to login(), the security context is not constrained to the users rights. It is set to the rights of the account given by userName. Thus the resulting session works with the rights of userName but under the name and group associations of reportAsUser.

Returns:

login information. Never null - if log-on fails, an exception is thrown.

Throws:

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

See Also:

• login

loginEloProf

public LoginResult loginEloProf(ClientInfo ci,
 int userId,
 String certificate,
 String clientComputer)
                         throws byps.RemoteException

Description copied from interface: IXServicePortIF

This login is used by ELOprofessional applications if the Indexserver is used to forward workflows (WorkflowServer).

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

Specified by:

loginEloProf in interface IXServicePortIF

Parameters:

ci - ClientInfo object with language, country and ticket

userId - User ID

certificate - This string is checked against the wf-certificate parameter in web.xml for authentication.

clientComputer - client computer name for reporting

Returns:

login information. Never null - if log-on fails, an exception is thrown.

Throws:

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

loginKerberos

public LoginResult loginKerberos(ClientInfo ci,
 byte[] ticket,
 String clientComputer)
                          throws byps.RemoteException

Description copied from interface: IXServicePortIF

Login using Kerberos ticket.

Specified by:

loginKerberos in interface IXServicePortIF

Parameters:

ci - ClientInfo object with language, country and ticket

ticket - The KRB_AP_REQ Message as defined in RFC 1510

clientComputer - client computer name for reporting

Returns:

This function does always throw Exception "[EIX:9999]...unsupported function".

Throws:

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

logout

public void logout(ClientInfo ci)
            throws byps.RemoteException

Description copied from interface: IXServicePortIF

Log out user.

The ticket contained in ci becomes invalid.

Specified by:

logout in interface IXServicePortIF

Parameters:

ci - ClientInfo object with language, country and ticket

Throws:

byps.RemoteException - Exception with message text of format "[ELOIX:number] text". The number is one of the constants defined in IXExceptionC. does never throw an exception

See Also:

• login

parseException

public IXExceptionData parseException(ClientInfo ci,
 String exceptionString)
                               throws byps.RemoteException

Description copied from interface: IXServicePortIF

Parses the given string of an exception into a structured IXExceptionData object.

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

Specified by:

parseException in interface IXServicePortIF

Parameters:

ci - ClientInfo object with language, country and ticket.

exceptionString - String the exception as a string.

Returns:

parsed Exception Data.

Throws:

byps.RemoteException

processFindResult

public JobState processFindResult(ClientInfo ci,
 String searchId,
 ProcessInfo procInfo)
                           throws byps.RemoteException

Description copied from interface: IXServicePortIF

Executes the processing information given by processInfo for all objects found by a findFirstSords call.

Specified by:

processFindResult in interface IXServicePortIF

Parameters:

ci - ClientInfo object with language, country and ticket

searchId - Search ID returned in FindResult.searchId from a previous call to findFirstSords

procInfo - holds the specific operations applied to each traversed tree node; the first member not null will be used

Returns:

The current job state

Throws:

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

See Also:

• IXServicePortIF.findFirstSords(ClientInfo, FindInfo, int, SordZ)

processTrees

public JobState processTrees(ClientInfo ci,
 NavigationInfo navigationInfo,
 ProcessInfo procInfo)
                      throws byps.RemoteException

Description copied from interface: IXServicePortIF

processTrees extends ValueClass implements a generic tree walk for all subtrees specified in navInfo.

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

Specified by:

processTrees in interface IXServicePortIF

Parameters:

ci - ClientInfo object with language, country and ticket

navigationInfo - specifies limits to scale the tree traversals

procInfo - holds the specific operations applied to each traversed tree node; the first member not null will be used

Returns:

The current job state or null, if the process is finished before the function returns.

Throws:

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

queryJobState

public JobState queryJobState(ClientInfo ci,
 String jobGuid,
 boolean activeJobs,
 boolean finishedJobs,
 boolean fullInfo)
                       throws byps.RemoteException

Description copied from interface: IXServicePortIF

Returns the job state for a given job GUID.

Specified by:

queryJobState in interface IXServicePortIF

Parameters:

ci - ClientInfo object with language, country and ticket

activeJobs - Currently running jobs will be searched for jobGuid

finishedJobs - Finished jobs will be searched for jobGuid

fullInfo - Requests the full job state information, if the job supports the member procInfo

Returns:

list of current job states

Throws:

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

refSord

public void refSord(ClientInfo ci,
 String oldParentId,
 String newParentId,
 String objId,
 int manSortIdx)
             throws byps.RemoteException

Description copied from interface: IXServicePortIF

Creates a new object relationship.

Specified by:

refSord in interface IXServicePortIF

Parameters:

ci - ClientInfo object with language, country and ticket

oldParentId - ID or -GUID of the old parent entry in the archive hierarchy

newParentId - ID or -GUID of the new parent entry in the archive hierarchy, must be valid.

objId - ID or -GUID of the existing object, must be valid

manSortIdx - The position where the object will be inserted/moved to in the parent hierarchy. Values at -1 or -2 inserts it at the last position (see throws description).

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

Throws:

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

restoreSord

public boolean restoreSord(ClientInfo ci,
 String objId,
 RestoreOptions restoreOptions)
                    throws byps.RemoteException

Description copied from interface: IXServicePortIF

Restores an archive entry, its references and notes.

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

Specified by:

restoreSord in interface IXServicePortIF

Parameters:

ci - ClientInfo object with language, country and ticket

objId - Object-ID or -GUID of the entry to restore.

restoreOptions - further options to control the restore process.

Returns:

true, when all visited SORDs have been restored successfully.
false, when at least one intended restore failed

Throws:

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

See Also:

• deleteSord

setSessionOptions

public void setSessionOptions(ClientInfo ci,
 SessionOptions opts)
                       throws byps.RemoteException

Description copied from interface: IXServicePortIF

This function sets options related to the session identified by the given ticket.

Specified by:

setSessionOptions in interface IXServicePortIF

Parameters:

ci - ClientInfo object with language, country and ticket.

opts - Session options to be set.

Throws:

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

startAdHocWorkFlow

public int startAdHocWorkFlow(ClientInfo ci,
 String name,
 String objId,
 String[] arrUserIds,
 String nodeName,
 boolean forValidation,
 boolean serialFlow,
 String cancelUserId,
 String cancelMessage,
 String finishedUserId,
 String finishedMessage,
 String finishedScript)
                       throws byps.RemoteException

Description copied from interface: IXServicePortIF

Starts an Ad Hoc Workflow.

Specified by:

startAdHocWorkFlow in interface IXServicePortIF

Parameters:

ci - ClientInfo object with language, country and ticket.

name - Workflow name

objId - ID of the object for which the workflow is started.

arrUserIds - IDs of users who receive the workflow nodes.

nodeName - Start node name.

forValidation - If true, the workflow comes back to the user who started it.

serialFlow - If true, the workflow routes the object from user to user. The workflow finishes when the last user has edited their node. If serialFlow is false, the workflow routes the object to all users. The first user who edits their node terminates the workflow.

cancelUserId - If the workflow is canceled, this user receives a message, cancelMessage.

cancelMessage - The message that is send to the user specified with cancelUserId, if the workflow is canceled.

finishedUserId - If the workflow is finished, this user receives a message, finishedMessage.

finishedMessage - The message that is send to the user specified with cancelUserId, if the workflow is finished.

finishedScript - This script is executed, when the workflow is finished.

Returns:

Workflow ID

Throws:

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

startExport

public String startExport(ClientInfo ci,
 String[] topLevelIDs,
 long options)
                   throws byps.RemoteException

Description copied from interface: IXServicePortIF

Starts an export-job.

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

Specified by:

startExport in interface IXServicePortIF

Parameters:

ci - ClientInfo object with language, country and ticket.

topLevelIDs - String[] the IDs to export.

options - long the options for this export coded as flags specified in ExportOptionsC.

Returns:

String the exportId (GUID) of the started export.

Throws:

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

See Also:

• IXServicePortIF.startExportExt(de.elo.ix.client.ClientInfo, de.elo.ix.client.ExportExtOptions)

startExportExt

public String startExportExt(ClientInfo ci,
 ExportExtOptions options)
                      throws byps.RemoteException

Description copied from interface: IXServicePortIF

Starts an export-job.

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

Specified by:

startExportExt in interface IXServicePortIF

Parameters:

ci - ClientInfo object with language, country and ticket.

Returns:

String the exportId (GUID) of the started export.

Throws:

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

startImport

public String startImport(ClientInfo ci,
 String filingPath,
 int guidMethod,
 long options)
                   throws byps.RemoteException

Description copied from interface: IXServicePortIF

Starts an import-job.

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

Specified by:

startImport in interface IXServicePortIF

Parameters:

ci - ClientInfo object with language, country and ticket.

filingPath - String the archive-path that should be used as target for the import.

guidMethod - The method determining how to handle the assignement for guids.

options - (long) The options for this import coded as flags specified in ImportOptionsC.

Returns:

String the importId (GUID) of the started export.

Throws:

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

startWorkFlow

public int startWorkFlow(ClientInfo ci,
 String templFlowId,
 String flowName,
 String objId)
                  throws byps.RemoteException

Description copied from interface: IXServicePortIF

Starts a workflow from a workflow template.

Specified by:

startWorkFlow in interface IXServicePortIF

Parameters:

ci - ClientInfo object with language, country and ticket.

templFlowId - Name or ID of the workflow template.

flowName - Name of the new workflow.

objId - ID of the object for which the workflow is started.

Returns:

workflow ID

Throws:

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

takeWorkFlowNode

public void takeWorkFlowNode(ClientInfo ci,
 int nFlowId,
 int nNodeId,
 String sUserId,
 int nFlags,
 LockZ lockZ)
                      throws byps.RemoteException

Description copied from interface: IXServicePortIF

Assign a node to a user.

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

The function assigns in addition to the given node all nodes with the same WFNode.departmentGroup.

Specified by:

takeWorkFlowNode in interface IXServicePortIF

Parameters:

ci - ClientInfo object with language, country and ticket.

nFlowId - Workflow ID.

nNodeId - Workflow node ID.

sUserId - ID or name of the user who receives the task. If null or empty, the task is assigned to the current user.

nFlags - Combination of WFTakeNodeC values.

lockZ - LockZ Specifies the lock mode used to access the workflow. Only administrators can use FORCE. The current lock is not changed.

Throws:

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

terminateWorkFlow

public int terminateWorkFlow(ClientInfo ci,
 String flowId,
 LockZ unlockZ)
                      throws byps.RemoteException

Description copied from interface: IXServicePortIF

Terminates a workflow.

Specified by:

terminateWorkFlow in interface IXServicePortIF

Parameters:

ci - ClientInfo object with language, country and ticket.

flowId - Workflow ID or name.

unlockZ - Unlocks the nodes.

Returns:

int Workflow ID of finished workflow.

Throws:

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

delegateWorkFlowNode

public void delegateWorkFlowNode(ClientInfo ci,
 WFDelegateNodeInfo delegateNodeInfo,
 LockZ lockZ)
                          throws byps.RemoteException

Description copied from interface: IXServicePortIF

Delegates the specified workflow node to another user.

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

Specified by:

delegateWorkFlowNode in interface IXServicePortIF

Parameters:

ci - ClientInfo object with language, country and ticket.

delegateNodeInfo - Object describes the delegation node.

lockZ - LockZ Specifies the lock mode used to access the workflow. Should be set to LockC.YES. Only administrators can use LockC.FORCE. The current lock is not changed.

Throws:

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

deferWorkFlowNode

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

Description copied from interface: IXServicePortIF

Sets the value userDelayDateIso of the given node.

Specified by:

deferWorkFlowNode in interface IXServicePortIF

Parameters:

ci - ClientInfo object with language, country and ticket.

flowId - Workflow ID or name.

nodeId - Node ID of a person node. The current user must be the owner of the node.

userDelayDateIso - This date is set for Node.userDelayDateIso. Supply null or an empty string to delete the value.

lockZ - LockZ Specifies the lock mode used to access the workflow. Only administrators can use FORCE. The current lock is not changed.

Throws:

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

See Also:

• WFNode.userDelayDateIso

testAdapter

public String[] testAdapter(ClientInfo ci,
 String fn,
 String[] params)
                     throws byps.RemoteException

Description copied from interface: IXServicePortIF

This function is used for testing.

In productive environments it always throws an exception.

Specified by:

testAdapter in interface IXServicePortIF

Parameters:

ci - ClientInfo

fn - String

params - String[]

Returns:

String[]

Throws:

byps.RemoteException

unlinkSords

public void unlinkSords(ClientInfo ci,
 String fromId,
 String[] toIds,
 LinkSordZ linkZ)
                 throws byps.RemoteException

Description copied from interface: IXServicePortIF

Remove links between archive entries.

Specified by:

unlinkSords in interface IXServicePortIF

Parameters:

ci - ClientInfo object with language, country and ticket

fromId - Object ID or GUID the links start from

toIds - Object IDs or GUIDs the links point to

linkZ - reserved, must be null

Throws:

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

See Also:

• LinkSordC.PAIR or LinkSordC.CROSS_LINK behave the same. If the link {fromId, toIds[.]} is a cross-link, then object toIds[.] is removed from the cross-link.
• linkSords

checkoutCryptInfos

public CryptInfo[] checkoutCryptInfos(ClientInfo ci,
 String[] ids,
 LockZ lockZ)
                               throws byps.RemoteException

Description copied from interface: IXServicePortIF

Read and optionally lock the password information for document encryption.

Specified by:

checkoutCryptInfos in interface IXServicePortIF

Parameters:

ci - ClientInfo

ids - An array of numeric IDs or names to identify the encryption information to be returned.

lockZ - Lock mode.

Returns:

Array of encryption information objects.

Throws:

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

See Also:

• provideCryptPassword
• checkinCryptInfos

checkinCryptInfos

public void checkinCryptInfos(ClientInfo ci,
 CryptInfo[] cryptInfos,
 LockZ unlockZ)
                       throws byps.RemoteException

Description copied from interface: IXServicePortIF

Write and optionally unlock encryption information.

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

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

Usage of CryptInfo.keyInfo

cryptInfos[.].keyInfo	Description
*	Generate new internal keys and set cryptInfos[.].pwd as external password.
Value from another ELO system	Set this value as internal and external key pair. cryptInfos[.].pwd is ignored.

Specified by:

checkinCryptInfos in interface IXServicePortIF

Parameters:

ci - ClientInfo

cryptInfos - Array of encrytion objects to be written.

unlockZ - Remove lock.

Throws:

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

See Also:

• provideCryptPassword

createNewEncryptionSet

public void createNewEncryptionSet(ClientInfo ci,
 CryptInfo cryptInfo,
 LockZ unlockZ)
                            throws byps.RemoteException

Description copied from interface: IXServicePortIF

ToBeFilled

Specified by:

createNewEncryptionSet in interface IXServicePortIF

Parameters:

ci - ClientInfo

cryptInfo - encryption object to be written.

unlockZ - Remove lock.

Throws:

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

provideCryptPassword

public void provideCryptPassword(ClientInfo ci,
 String encryptionSet,
 String pwd)
                          throws byps.RemoteException

Description copied from interface: IXServicePortIF

Provide a password to be used in the current session for encrypting and decrypting of documents.

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

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

Be aware of the fact that encryption/decryption happens between Indexserver and Document Manager communication and not between Indexserver and the client application. Thus it is strongly recommended to use HTTPS between the client application and Indexserver. The Indexserver configuration option "ixUrlBase" can be helpful to achieve this.

Specified by:

provideCryptPassword in interface IXServicePortIF

Parameters:

ci - ClientInfo

encryptionSet - Encryption set ID or name.

pwd - Encrypted password.

Throws:

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

See Also:

• SessionOptionsC
• checkinCryptInfos

provideSystemCryptPassword

public void provideSystemCryptPassword(ClientInfo ci,
 String encryptionSet,
 String pwd)
                                throws byps.RemoteException

Description copied from interface: IXServicePortIF

Provide a system password to be used in the current session for encrypting and decrypting of documents.

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

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

Be aware of the fact that encryption/decryption happens between Indexserver and Document Manager communication and not between Indexserver and the client application. Thus it is strongly recommended to use HTTPS between the client application and Indexserver. The Indexserver configuration option "ixUrlBase" can be helpful to achieve this.

Specified by:

provideSystemCryptPassword in interface IXServicePortIF

Parameters:

ci - ClientInfo

encryptionSet - Encryption set ID or name.

pwd - Encrypted password.

Throws:

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

See Also:

• SessionOptionsC
• checkinCryptInfos

invalidateCache

public void invalidateCache(ClientInfo ci,
 int flags)
                     throws byps.RemoteException

Description copied from interface: IXServicePortIF

Invalidate the internally used caches for users, storage masks, etc.

Specified by:

invalidateCache in interface IXServicePortIF

Parameters:

ci - ClientInfo

flags - Set this value to 65535 (Hex: 0xFFFF) to invalidate all caches.

Throws:

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

See Also:

• InvalidateCacheC.MASKS

invalidateCache2

public InvalidateCacheResult invalidateCache2(ClientInfo ci,
 InvalidateCacheInfo info)
                                       throws byps.RemoteException

Description copied from interface: IXServicePortIF

Invalidate the internally used caches.

Specified by:

invalidateCache2 in interface IXServicePortIF

Parameters:

ci - ClientInfo

info - Parameter object

Returns:

Result object

Throws:

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

findFirstTranslateTerms

public FindResult findFirstTranslateTerms(ClientInfo ci,
 FindTranslateTermInfo findInfo,
 int max)
                                   throws byps.RemoteException

Description copied from interface: IXServicePortIF

Find terms for which a translation is available.

Close the search results with a call to findClose.

Specified by:

findFirstTranslateTerms in interface IXServicePortIF

Parameters:

ci - ClientInfo

findInfo - Search criteria.

max - Maximum terms to be returned by this call.

Returns:

FindResult object. Terms are returned in FindResult.terms.

Throws:

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

See Also:

• FindResult.translateTerms

findNextTranslateTerms

public FindResult findNextTranslateTerms(ClientInfo ci,
 String searchId,
 int idx,
 int max)
                                  throws byps.RemoteException

Description copied from interface: IXServicePortIF

Find next terms.

Specified by:

findNextTranslateTerms in interface IXServicePortIF

Parameters:

ci - ClientInfo

searchId - String Id of a search opened by findFirstTranslateTerms.

idx - In the list of found objects, return objects starting from this index.

max - Return at most max objects.

Returns:

FindResult object. Terms are returned in FindResult.terms.

Throws:

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

See Also:

• IXServicePortIF.findFirstTranslateTerms(ClientInfo, FindTranslateTermInfo, int)

checkoutTranslateTerms

public TranslateTerm[] checkoutTranslateTerms(ClientInfo ci,
 String[] termIds,
 LockZ lockZ)
                                       throws byps.RemoteException

Description copied from interface: IXServicePortIF

Read terms from translation table for viewing or editing.

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

Specified by:

checkoutTranslateTerms in interface IXServicePortIF

Parameters:

ci - ClientInfo

termIds - Term-GUIDs for which translations should be selected. If a term-GUID cannot be found, an exception is thrown (IXExceptionC.NOT_FOUND). Set this element to null, if all terms should be returned. Set this element to an empty string, if only the lock should be applied. To retrieve the supported languages, set this parameter to TranslateTermC.GUID_SYSTEM_LANGUAGES. In this case the function returns one object whose only valid member is TranslateTerm.langs.

lockZ - Set LockC.YES, LockC.IF_FREE or LockC.FORCE to lock for editing - locking is currently not supported but may be added in future.

Returns:

Array of TranslateTerm objects filled with terms in all available languages.

Throws:

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

See Also:

• IXServicePortIF.findNextTranslateTerms(ClientInfo, String, int, int)
• IXServicePortIF.checkinTranslateTerms(ClientInfo, TranslateTerm[], LockZ)
• IXServicePortIF.deleteTranslateTerms(ClientInfo, String[], LockZ)

checkinTranslateTerms

public String[] checkinTranslateTerms(ClientInfo ci,
 TranslateTerm[] tterms,
 LockZ unlockZ)
                               throws byps.RemoteException

Description copied from interface: IXServicePortIF

Write or insert terms into the translation table.

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

Specified by:

checkinTranslateTerms in interface IXServicePortIF

Parameters:

ci - ClientInfo

tterms - TranslateTerm objects to be written or inserted. If the terms[.].guid is not found, the term is inserted. Otherwise the term is updated. To set the supported system languages, supply an object with guid TranslateTermC.GUID_SYSTEM_LANGUAGES. The system languages can only be set if there are no translations.

unlockZ - Set LockC.YES to remove the lock. Use LockC.NO to keep the lock - locking is currently not supported but may be added in future.

Returns:

Term-GUIDs of written or created terms.

Throws:

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

See Also:

• IXServicePortIF.checkoutTranslateTerms(ClientInfo, String[], LockZ)

deleteTranslateTerms

public void deleteTranslateTerms(ClientInfo ci,
 String[] termIds,
 LockZ unlockZ)
                          throws byps.RemoteException

Description copied from interface: IXServicePortIF

Delete terms from the translation table.

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

Specified by:

deleteTranslateTerms in interface IXServicePortIF

Parameters:

ci - ClientInfo

termIds - Term-GUIDs to be deleted. The termIds that cannot be found are ignored.

unlockZ - Set LockC.YES to remove the lock. Use LockC.NO to keep the lock - locking is currently not supported but may be added in future.

Throws:

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

See Also:

• IXServicePortIF.checkoutTranslateTerms(ClientInfo, String[], LockZ)

getWorkflowTemplateVersions

public WFVersion[] getWorkflowTemplateVersions(ClientInfo ci,
 String flowId,
 boolean onlyDeleted)
                                        throws byps.RemoteException

Description copied from interface: IXServicePortIF

Reads the version information of all versions of the given workflow.

Specified by:

getWorkflowTemplateVersions in interface IXServicePortIF

Parameters:

ci - ClientInfo

flowId - Workflow ID or name

onlyDeleted - true, if only deleted versions should be returned.

Returns:

Array of version information objects.

Throws:

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

checkoutWorkflowTemplate

public WFDiagram checkoutWorkflowTemplate(ClientInfo ci,
 String flowId,
 String versionId,
 WFDiagramZ wfZ,
 LockZ lockZ)
                                   throws byps.RemoteException

Description copied from interface: IXServicePortIF

Check out versions of a workflow template.

Specified by:

checkoutWorkflowTemplate in interface IXServicePortIF

Parameters:

ci - ClientInfo

flowId - Workflow name or ID.

versionId - null or "0" or "" returns the version information of the current version, an ID from WFVersion.id returns a specific version.

wfZ - Member selector

lockZ - Lock mode

Returns:

WFDiagram object

Throws:

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

See Also:

• IXServicePortIF.checkinWorkflowTemplate(ClientInfo, WFDiagram, WFDiagramZ, LockZ)
• IXServicePortIF.deleteWorkflowTemplate(ClientInfo, String, String, LockZ)

checkinWorkflowTemplate

public int[] checkinWorkflowTemplate(ClientInfo ci,
 WFDiagram wf,
 WFDiagramZ wfZ,
 LockZ unlockZ)
                              throws byps.RemoteException

Description copied from interface: IXServicePortIF

Check in a workflow template as a new version or overwrite an existing version.

Specified by:

checkinWorkflowTemplate in interface IXServicePortIF

Parameters:

ci - ClientInfo

wf - Workflow

wfZ - Member selector

unlockZ - Unlock mode

Returns:

Workflow and version ID of the template version

Throws:

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

See Also:

• IXServicePortIF.checkinWorkFlow(ClientInfo, WFDiagram, WFDiagramZ, LockZ)

deleteWorkflowTemplate

public void deleteWorkflowTemplate(ClientInfo ci,
 String flowId,
 String versionId,
 LockZ unlockZ)
                            throws byps.RemoteException

Description copied from interface: IXServicePortIF

Deletes a workflow template version.

Specified by:

deleteWorkflowTemplate in interface IXServicePortIF

Parameters:

ci - ClientInfo

flowId - Workflow name or ID.

versionId - An existing version ID to delete a specific version, or null, or "", or "0" to delete the workflow with all versions.

unlockZ - Unlock mode

Throws:

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

checkoutNoteTemplates

public NoteTemplate[] checkoutNoteTemplates(ClientInfo ci,
 String userId,
 String[] ids,
 NoteTemplateZ ntemplZ,
 LockZ lockZ)
                                     throws byps.RemoteException

Description copied from interface: IXServicePortIF

Read the stamp definitions from the users options.

Specified by:

checkoutNoteTemplates in interface IXServicePortIF

Parameters:

ci - ClientInfo

userId - Read stamps belonging to this user. If NoteTemplateC.USERID_ALL is supplied, the stamps shared by all users are returned. If null or an empty string is supplied, the stamps shared by all users and the stamps of the current user are returned. Furthermore the stamps that belong to the user's groups are returned.

ids - if not null, only the stamps referenced by this IDs are returned.

ntemplZ - Members to be returned.

lockZ - Currently ignored.

Returns:

Array of stamp definitions.

Throws:

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

See Also:

• NoteTemplateC.USERID_ALL

createNoteTemplate

public NoteTemplate createNoteTemplate(ClientInfo ci,
 String userId)
                                throws byps.RemoteException

Description copied from interface: IXServicePortIF

Initializes a new NoteTemplate object.

Specified by:

createNoteTemplate in interface IXServicePortIF

Parameters:

ci - ClientInfo

userId - If a user ID or name is specified, the note template is initialized for this user and only for this user is full access granted in the ACL. If NoteTemplateC.USERID_ALL is supplied, the note template ACL is initialized with access for everyone.

Returns:

NoteTemplate object.

Throws:

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

deleteNoteTemplates

public void deleteNoteTemplates(ClientInfo ci,
 String userId,
 String[] ids,
 LockZ unlockZ)
                         throws byps.RemoteException

Description copied from interface: IXServicePortIF

Delete the stamp definition with the given ID.

Specified by:

deleteNoteTemplates in interface IXServicePortIF

Parameters:

ci - ClientInfo

userId - Read stamps belonging to this user. If NoteTemplateC.USERID_ALL is supplied, the stamps shared by all users are deleted. If null or an empty string is supplied, the stamps of the current user are deleted

ids - Stamp IDs from NoteTemplate.id.

unlockZ - Currently ignored.

Throws:

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

checkinNoteTemplates

public int[] checkinNoteTemplates(ClientInfo ci,
 NoteTemplate[] noteTemplates,
 NoteTemplateZ ntemplZ,
 LockZ unlockZ)
                           throws byps.RemoteException

Description copied from interface: IXServicePortIF

Writes the given stamp definition into the database.

Specified by:

checkinNoteTemplates in interface IXServicePortIF

Parameters:

ci - ClientInfo

noteTemplates - Stamp objects to be written. Set noteTemplate.id=-1 to insert a new object.

ntemplZ - Must be set to mbAll.

unlockZ - Currently ignored.

Returns:

IDs of the stamp template.

Throws:

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

reload

public void reload(ClientInfo ci)
            throws byps.RemoteException

Description copied from interface: IXServicePortIF

This function reloads all internal objects.

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

Specified by:

reload in interface IXServicePortIF

Parameters:

ci - ClientInfo

Throws:

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

reloadScripts

public void reloadScripts(ClientInfo ci)
                   throws byps.RemoteException

Description copied from interface: IXServicePortIF

This function reloads all scripts.

Call this function with administrator privileges,

if some scripts are modified.

Specified by:

reloadScripts in interface IXServicePortIF

Parameters:

ci - ClientInfo

Throws:

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

getCompiledScripts

public Map<Integer,String> getCompiledScripts(ClientInfo ci)
                                       throws byps.RemoteException

Description copied from interface: IXServicePortIF

This function returns a map containing information of all compiled scripts.

Specified by:

getCompiledScripts in interface IXServicePortIF

Parameters:

ci - ClientInfo

Returns:

Map (key = script's ID | value = scripts' MD5)

Throws:

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

getScriptsToDebug

public String getScriptsToDebug(ClientInfo ci)
                         throws byps.RemoteException

Description copied from interface: IXServicePortIF

This function returns the list of the scripts which are currently debugged, i.e. the property "scriptsToDebug".

Specified by:

getScriptsToDebug in interface IXServicePortIF

Parameters:

ci - ClientInfo

Returns:

String

Throws:

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

setScriptsToDebug

public void setScriptsToDebug(ClientInfo ci,
 String scriptsToDebug)
                       throws byps.RemoteException

Description copied from interface: IXServicePortIF

This function allows to set the the property "scriptsToDebug".

Specified by:

setScriptsToDebug in interface IXServicePortIF

Parameters:

ci - ClientInfo

scriptsToDebug - String

Throws:

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

getDebuggerPort

public int getDebuggerPort(ClientInfo ci)
                    throws byps.RemoteException

Description copied from interface: IXServicePortIF

This function returns debugger's port.

Specified by:

getDebuggerPort in interface IXServicePortIF

Parameters:

ci - ClientInfo

Returns:

String

Throws:

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

deleteKeywordList

public void deleteKeywordList(ClientInfo ci,
 String kwid,
 LockZ unlockZ)
                       throws byps.RemoteException

Description copied from interface: IXServicePortIF

Deletes a keyword list.

Specified by:

deleteKeywordList in interface IXServicePortIF

Parameters:

ci - ClientInfo object

kwid - ID or GUID of the keyword list

unlockZ - Remove lock.

Throws:

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

checkoutKeywordList

public KeywordList checkoutKeywordList(ClientInfo ci,
 String kwid,
 KeywordZ keywordZ,
 int max,
 LockZ lockZ)
                                throws byps.RemoteException

Description copied from interface: IXServicePortIF

Reads a keyword list.

This function internally calls checkoutKeywords.

Specified by:

checkoutKeywordList in interface IXServicePortIF

Parameters:

ci - ClientInfo object

kwid - ID or GUID of the keyword list

keywordZ - Members to be read

max - Maximum members to read, see checkoutKeywords.

lockZ - Lock mode.

Returns:

Keyword list.

Throws:

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

See Also:

• KeywordC
• IXServicePortIF.checkoutKeywords(ClientInfo, String[], KeywordZ, int, LockZ)

checkinKeywordList

public void checkinKeywordList(ClientInfo ci,
 KeywordList kwList,
 LockZ unlockZ)
                        throws byps.RemoteException

Description copied from interface: IXServicePortIF

Write or insert a keyword list.

This function internally calls checkinKeywords.

Specified by:

checkinKeywordList in interface IXServicePortIF

Parameters:

ci - ClientInfo object.

kwList - Keyword list. Supply null to only unlock.

unlockZ - Remove lock.

Throws:

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

combineAcl

public CombineAclResult combineAcl(ClientInfo ci,
 AclItem[] lhs,
 AclItem[] rhs,
 CombineAclOptions options)
                            throws byps.RemoteException

Description copied from interface: IXServicePortIF

Compares the given ACLs and computes the sum, difference and intersection.

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

Specified by:

combineAcl in interface IXServicePortIF

Parameters:

ci - ClientInfo object.

lhs - Left operand

rhs - Right operand, can be null.

options - Options, can be null.

Returns:

Result object.

Throws:

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

getAclAccess

public AclAccessResult getAclAccess(ClientInfo ci,
 AclAccessInfo aai)
                             throws byps.RemoteException

Description copied from interface: IXServicePortIF

Returns the access of the given ACL.

Specified by:

getAclAccess in interface IXServicePortIF

Parameters:

ci - ClientInfo object.

aai - Options, can be null.

Returns:

Result object.

Throws:

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

getEditInfoFromESW

public EditInfo[] getEditInfoFromESW(ClientInfo ci,
 FileData[] fileDatas,
 EditInfoEswOptions eswOptions)
                              throws byps.RemoteException

Description copied from interface: IXServicePortIF

Returns the EditInfo-Objects from the FileData-Objects.

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

Specified by:

getEditInfoFromESW in interface IXServicePortIF

Parameters:

ci - ClientInfo object with current client information

fileDatas - List with FileData-Objects

eswOptions - EditInfoEswOptions Options for the esw-file

Returns:

EditInfo[] List with EditInfo-Objects

Throws:

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

getESWFromEditInfo

public FileData[] getESWFromEditInfo(ClientInfo ci,
 EditInfo[] editInfos,
 EditInfoEswOptions eswOptions)
                              throws byps.RemoteException

Description copied from interface: IXServicePortIF

Returns the FileData-Objects from the EditInfo-Objects.

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

Specified by:

getESWFromEditInfo in interface IXServicePortIF

Parameters:

ci - ClientInfo object with current client information

editInfos - EditInfo[] List with EditInfo-Objects

eswOptions - EditInfoEswOptions Options for the esw-file

Returns:

FileData[] List with FileData-Objects

Throws:

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

getSessionFromTicket

public LoginResult getSessionFromTicket(ClientInfo ci,
 int options)
                                 throws byps.RemoteException

Description copied from interface: IXServicePortIF

Returns the LoginResult object that represents the session of the ticket contained in the given ClientInfo object.

Specified by:

getSessionFromTicket in interface IXServicePortIF

Parameters:

ci - ClientInfo object

options - One of the SessionOptionsC.SESSION_FROM_* constants.

Returns:

LoginResult object

Throws:

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

See Also:

• SessionOptionsC.SESSION_FROM_IX
• SessionOptionsC.SESSION_FROM_AM

getSessionInfos

public SessionInfo[] getSessionInfos(ClientInfo ci,
 SessionInfoParams params)
                              throws byps.RemoteException

Description copied from interface: IXServicePortIF

Returns the SessionInfo-Objects about all the active connections.

Specified by:

getSessionInfos in interface IXServicePortIF

Parameters:

ci - ClientInfo object

params - Execution

Returns:

Array of SessionInfo

Throws:

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

executeScript

public ExecuteScriptResult executeScript(ClientInfo ci,
 ExecuteScriptParams params)
                                  throws byps.RemoteException

Description copied from interface: IXServicePortIF

Execute a script.

Specified by:

executeScript in interface IXServicePortIF

Parameters:

ci - ClientInfo object

params - Execution params (script code, etc.)

Returns:

Script result

Throws:

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

exportWorkflow

public FileData exportWorkflow(ClientInfo ci,
 WorkflowExportOptions wfExportOptions)
                        throws byps.RemoteException

Description copied from interface: IXServicePortIF

Exports the workflow-version.

Specified by:

exportWorkflow in interface IXServicePortIF

Parameters:

ci - ClientInfo object

wfExportOptions - Options for the workflow-export.

Returns:

de.elo.ix.client.FileData FileData-Object

Throws:

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

getDistinctValuesOfObjKey

public ValuesOfObjKey getDistinctValuesOfObjKey(ClientInfo ci,
 String okeyName,
 ValuesOfObjKeyOptions opts)
                                         throws byps.RemoteException

Description copied from interface: IXServicePortIF

Read all distinct values from the database that are used for the given ObjKey name, potentionally causing an enormous database load.

Specified by:

getDistinctValuesOfObjKey in interface IXServicePortIF

Parameters:

ci - ClientInfo object

okeyName - ObjKey name resp. DocMaksLine key.

opts - reserved, must be null

Returns:

Sorted array of values.

Throws:

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

See Also:

• IXServicePortIF.getSearchTerms(ClientInfo, FindInfo, int)

getArchiveStatistics

public ArchiveStatistics getArchiveStatistics(ClientInfo ci,
 long opts)
                                       throws byps.RemoteException

Description copied from interface: IXServicePortIF

Read characteristical properties of the archive.

Specified by:

getArchiveStatistics in interface IXServicePortIF

Parameters:

ci - ClientInfo object

opts - Combination of ArchiveStatisticsOptionsC constants.

Returns:

ArchiveStatistics object

Throws:

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

See Also:

• ArchiveStatisticsOptionsC

collectMapDomains

public MapDomain[] collectMapDomains(ClientInfo ci)
                              throws byps.RemoteException

Description copied from interface: IXServicePortIF

Collects the existing map domains.

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

Specified by:

collectMapDomains in interface IXServicePortIF

Parameters:

ci - ClientInfo object

Returns:

Array of domains.

Throws:

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

See Also:

• IXServicePortIF.checkinMap(de.elo.ix.client.ClientInfo, java.lang.String, java.lang.String, int, de.elo.ix.client.KeyValue[], de.elo.ix.client.LockZ)

checkinMapDomain

public void checkinMapDomain(ClientInfo ci,
 MapDomain mapDomain,
 LockZ unlockZ)
                      throws byps.RemoteException

Description copied from interface: IXServicePortIF

Creates or updates a map domain.

Specified by:

checkinMapDomain in interface IXServicePortIF

Parameters:

ci - ClientInfo object

mapDomain - MapDomain object

unlockZ - Remove lock

Throws:

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

checkoutMapDomain

public MapDomain checkoutMapDomain(ClientInfo ci,
 String domainName,
 LockZ lockZ)
                            throws byps.RemoteException

Description copied from interface: IXServicePortIF

Reads the data of a map domain.

Specified by:

checkoutMapDomain in interface IXServicePortIF

Parameters:

ci - ClientInfo object

domainName - map domain name; an arbitrary (existing name) or a predefined name from MapDomainC

lockZ - Lock mode

Returns:

MapDomain object

Throws:

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

deleteMapDomain

public void deleteMapDomain(ClientInfo ci,
 String domainName,
 LockZ unlockZ)
                     throws byps.RemoteException

Description copied from interface: IXServicePortIF

Deletes a map domain and removes the associated database tables.

Specified by:

deleteMapDomain in interface IXServicePortIF

Parameters:

ci - ClientInfo object

domainName - map domain name

unlockZ - Remove lock

Throws:

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

See Also:

• MapDomainC

checkinMap

public void checkinMap(ClientInfo ci,
 String domainName,
 String id,
 int objId,
 KeyValue[] data,
 LockZ unlockZ)
                throws byps.RemoteException

Description copied from interface: IXServicePortIF

Inserts or updates the given key-value-pairs in data in the map specified by id.

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

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

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

 
 InputStream istream = new FileInputStream(new File("c:\test.txt")); // is closed in checkinMap
 FileData fileData = new FileData();
 fileData.setContentType("text/plain");
 fileData.setStream(istream);
 MapValue mapValue = new MapValue();
 mapValue.setKey("myfile");
 mapValue.setBlobValue(fileData);
 conn.ix().checkinMap( "MyMapDomain", "1", 0, new KeyValue[] { mapValue }, LockC.NO );
 
 

Specified by:

checkinMap in interface IXServicePortIF

Parameters:

ci - ClientInfo object

domainName - map domain name; an arbitrary (existing name) or a predefined name from MapDomainC

id - map ID

objId - Sord ID, if the map should be attached to a Sord object; otherwise 0

data - map items

unlockZ - Remove lock

Throws:

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

See Also:

• MapDomain
• MapDomainC
• IXServicePortIF.checkoutMap(ClientInfo, String, String, String[], LockZ)

checkoutMap

public MapData checkoutMap(ClientInfo ci,
 String domainName,
 String id,
 String[] keyNames,
 LockZ lockZ)
                    throws byps.RemoteException

Description copied from interface: IXServicePortIF

Reads a map or parts of a map.

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

 
 MapData map = conn.ix().checkoutMap( mapDomainName, "1", new String[] {"myfile"}, LockC.NO );
 MapValue mapValue = map.getMapItems().get("myfile");
 InputStream istream = mapValueR.getBlobValue().getStream();
 try {
   ...
 } finally {
   istream.close();
 }
 
 

Specified by:

checkoutMap in interface IXServicePortIF

Parameters:

ci - ClientInfo object

domainName - map domain name; an arbitrary (existing name) or a predefined name from MapDomainC

id - map ID. In order to get the map values associated to a Sord object pass the numeric Sord ID (Sord#id).

keyNames - keys to be read; null to read all keys; wildcards allowed

lockZ - Lock mode

Returns:

MapData object that contains the map items

Throws:

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

See Also:

• IXServicePortIF.checkinMap(de.elo.ix.client.ClientInfo, java.lang.String, java.lang.String, int, de.elo.ix.client.KeyValue[], de.elo.ix.client.LockZ)

deleteMap

public void deleteMap(ClientInfo ci,
 String domainName,
 String id,
 String[] keyNames,
 LockZ unlockZ)
               throws byps.RemoteException

Description copied from interface: IXServicePortIF

Delete map items.

Specified by:

deleteMap in interface IXServicePortIF

Parameters:

ci - ClientInfo object

domainName - map domain name; an arbitrary (existing name) or a predefined name from MapDomainC

id - map ID. In order to delete the map values associated to a Sord object pass the numeric Sord ID (Sord#id).

keyNames - keys to be deleted; null to delete the entire map with all keys and history; wildcards allowed

unlockZ - Remove lock

Throws:

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

See Also:

• IXServicePortIF.checkinMap(de.elo.ix.client.ClientInfo, java.lang.String, java.lang.String, int, de.elo.ix.client.KeyValue[], de.elo.ix.client.LockZ)

getContextTerms

public ContextTerm[] getContextTerms(ClientInfo ci,
 FindInfo findInfo,
 String field,
 int max)
                              throws byps.RemoteException

Description copied from interface: IXServicePortIF

Find terms for faceted search.

Specified by:

getContextTerms in interface IXServicePortIF

Parameters:

ci - ClientInfo

findInfo - FindInfo

field - Find facets for this field.

max - Max number of terms to be returned.

Returns:

Array of context terms.

Throws:

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

executeRegisteredFunction

public Any executeRegisteredFunction(ClientInfo ci,
 String functionName,
 Any param)
                              throws byps.RemoteException

Description copied from interface: IXServicePortIF

Execute a registered function defined in a JavaScript or in an event handler.

Specified by:

executeRegisteredFunction in interface IXServicePortIF

Parameters:

ci - ClientInfo

functionName - Name of the function to be executed.

param - Function parameter

Returns:

Return value

Throws:

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

getSearchTerms

public String[] getSearchTerms(ClientInfo ci,
 FindInfo findInfo,
 int termType)
                        throws byps.RemoteException

Description copied from interface: IXServicePortIF

Get alternative terms for an iSearch search.

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

Specified by:

getSearchTerms in interface IXServicePortIF

findInfo - This object defines the search criteria.

termType - Use Constants in SearchTerms ( SearchTermsC.TERMS, SYNONYMS, CORRECTION )

Returns:

Array of search terms

Throws:

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

See Also:

• SearchTermsC

adminMode

public int adminMode(ClientInfo ci,
 int mode)
              throws byps.RemoteException

Description copied from interface: IXServicePortIF

Queries, enters or leaves the administration mode.

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

Specified by:

adminMode in interface IXServicePortIF

Parameters:

ci - ClientInfo object with language, country and ticket.

mode - One of the AdminModeC constants.

Returns:

The previous state of the administration mode (which is the equal to the current state, if mode == AdminModeC.QUERY).

Throws:

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

configureFulltext

public FulltextConfig configureFulltext(ClientInfo ci,
 String userId,
 FulltextConfig opts)
                                 throws byps.RemoteException

Description copied from interface: IXServicePortIF

Get or set the fulltext configuration. Note: deprecated. Use checkinEsSettings and checkoutEsSettings instead.

Specified by:

configureFulltext in interface IXServicePortIF

Parameters:

ci - ClientInfo object with language, country and ticket.

userId - reserved, must be null or empty.

opts - Fulltext configuration options. Set this parameter to null, if the configuraion should be read. Only main administrators can write the configuration.

Returns:

The previous fulltext configuration (which is the equal to the current configuration, if opts == null)

Throws:

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

notifyServer

public NotifyServerResult notifyServer(ClientInfo ci,
 NotifyServerInfo msg)
                                throws byps.RemoteException

Description copied from interface: IXServicePortIF

This function notifies the Indexserver about an operation of the client program.

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

Specified by:

notifyServer in interface IXServicePortIF

Parameters:

ci - ClientInfo object with language, country and ticket.

msg - NotifyServerInfo This object describes the executed operation.

Throws:

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

configureBackup

public BackupProfile[] configureBackup(ClientInfo ci,
 BackupProfile[] backupProfiles)
                                throws byps.RemoteException

Description copied from interface: IXServicePortIF

Query or send backup profile information of the ELOdm.

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

Specified by:

configureBackup in interface IXServicePortIF

Parameters:

ci - ClientInfo object with language, country and ticket.

backupProfiles - New backup profile settings. This array overwrites all current backup profiles. Supply null, if profile information should be read.

Returns:

Backup profiles

Throws:

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

controlBackup

public BackupPurgeStatus controlBackup(ClientInfo ci,
 ControlBackupInfo controlBackupInfo)
                                throws byps.RemoteException

Description copied from interface: IXServicePortIF

Query the status of the backup and purge tasks of the ELOdm.

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

Specified by:

controlBackup in interface IXServicePortIF

Parameters:

ci - ClientInfo object with language, country and ticket.

controlBackupInfo - mode for the ELOdm backup and purge tasks

Returns:

status of the ELOdm backup and purge tasks

Throws:

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

configurePurge

public PurgeSettings configurePurge(ClientInfo ci,
 PurgeSettings purgeSettings)
                             throws byps.RemoteException

Description copied from interface: IXServicePortIF

Query or send the purge task settings of the ELOdm.

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

Specified by:

configurePurge in interface IXServicePortIF

Parameters:

ci - ClientInfo object with language, country and ticket.

purgeSettings - new purge settings. Supply null, if information should be read.

Returns:

the purge settings (if purgeSettings is not null, the same object)

Throws:

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

addUrlParams

public String addUrlParams(ClientInfo ci,
 String url,
 UrlParams params)
                    throws byps.RemoteException

Description copied from interface: IXServicePortIF

Adds additional params to an upload or download URL.

Currently, additional params are only available for download URLs.

Specified by:

addUrlParams in interface IXServicePortIF

Parameters:

ci - ClientInfo object with language, country and ticket.

url - This URL is appended by the params

params - UrlParams to be added

Returns:

The new URL

Throws:

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

openEventBus

public long openEventBus(ClientInfo ci,
 EventBusParams params)
                  throws byps.RemoteException

Description copied from interface: IXServicePortIF

Open a new event bus.

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

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

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

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

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

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

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

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

Specified by:

openEventBus in interface IXServicePortIF

Parameters:

ci - ClientInfo object with language, country and ticket.

params - Data which is used to build the bus ID.

Returns:

Event bus ID

Throws:

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

See Also:

• EventBusC
• IXServicePortIF.createEventBusSubscriber(ClientInfo)
• IXServicePortIF.sendEvents(ClientInfo, long, Event[])
• IXServicePortIF.createEventBusListener(ClientInfo, long, EventListener)
• IXServicePortIF.closeEventBus(ClientInfo, long)
• IXEventBusHandler
• IXConnection

closeEventBus

public void closeEventBus(ClientInfo ci,
 long busId)
                   throws byps.RemoteException

Description copied from interface: IXServicePortIF

Close an event bus opened by openEventBus.

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

Specified by:

closeEventBus in interface IXServicePortIF

Parameters:

ci - ClientInfo object with language, country and ticket.

busId - Event bus ID. A value returned from a call to openEventBus.

Throws:

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

See Also:

• IXServicePortIF.openEventBus(ClientInfo, EventBusParams)

createEventBusSubscriber

public long createEventBusSubscriber(ClientInfo ci)
                              throws byps.RemoteException

Description copied from interface: IXServicePortIF

Create an event bus subscriber.

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

Specified by:

createEventBusSubscriber in interface IXServicePortIF

Parameters:

ci - ClientInfo object with language, country and ticket.

Returns:

Subscriber ID

Throws:

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

See Also:

• IXServicePortIF.openEventBus(ClientInfo, EventBusParams)
• IXServicePortIF.deleteEventBusSubscriber(ClientInfo, long)

deleteEventBusSubscriber

public void deleteEventBusSubscriber(ClientInfo ci,
 long subsId)
                              throws byps.RemoteException

Description copied from interface: IXServicePortIF

Deletes an event bus subscriber.

This function deletes a subscriber an all its event listeners.

Specified by:

deleteEventBusSubscriber in interface IXServicePortIF

Parameters:

ci - ClientInfo object with language, country and ticket.

subsId - Subscriber ID

Throws:

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

See Also:

• IXServicePortIF.createEventBusSubscriber(ClientInfo)

createEventBusListener

public long createEventBusListener(ClientInfo ci,
 long subsId,
 EventListener eventListener)
                            throws byps.RemoteException

Description copied from interface: IXServicePortIF

Creates an event bus listener.

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

Specified by:

createEventBusListener in interface IXServicePortIF

Parameters:

ci - ClientInfo object with language, country and ticket.

eventListener - Event listener ID

Throws:

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

See Also:

• IXServicePortIF.deleteEventBusListener(ClientInfo, long)
• IXServicePortIF.deleteEventBusSubscriber(ClientInfo, long)

deleteEventBusListener

public void deleteEventBusListener(ClientInfo ci,
 long lsnId)
                            throws byps.RemoteException

Description copied from interface: IXServicePortIF

Deletes an event bus listener.

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

Specified by:

deleteEventBusListener in interface IXServicePortIF

Parameters:

ci - ClientInfo object with language, country and ticket.

lsnId - Listener ID

Throws:

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

See Also:

• IXServicePortIF.createEventBusListener(ClientInfo, long, EventListener)

internalReceiveEvents

public Event[] internalReceiveEvents(ClientInfo ci,
 long subsId,
 long timeoutMillis)
                              throws byps.RemoteException

Description copied from interface: IXServicePortIF

Read events from the server.

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

Specified by:

internalReceiveEvents in interface IXServicePortIF

Parameters:

ci - ClientInfo object with language, country and ticket.

subsId - Subscriber ID

timeoutMillis - Return after this time, even if no events are available. If set to 0, return the currently available events.

Returns:

Received events.

Throws:

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

See Also:

• IXServicePortIF.openEventBus(ClientInfo, EventBusParams)

sendEvents

public void sendEvents(ClientInfo ci,
 long subsId,
 Event[] events)
                throws byps.RemoteException

Description copied from interface: IXServicePortIF

Send events to event busses.

Call this function to send events to event busses.

Specified by:

sendEvents in interface IXServicePortIF

Parameters:

ci - ClientInfo object with language, country and ticket.

subsId - Subscriber ID

events - Events to be sent.

Throws:

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

See Also:

• IXServicePortIF.createEventBusSubscriber(ClientInfo)
• IXServicePortIF.openEventBus(ClientInfo, EventBusParams)

createRsaKeys

public String[] createRsaKeys(ClientInfo ci)
                       throws byps.RemoteException

Description copied from interface: IXServicePortIF

Helper function to create a RSA key pair.

Specified by:

createRsaKeys in interface IXServicePortIF

Parameters:

ci - ClientInfo object with language, country and ticket.

Returns:

RSA key pair. String[0] contains a string representation of the public key, String[1] contains the private key.

Throws:

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

See Also:

• IXServicePortIF.encryptStringRsa(ClientInfo, String, String, boolean)

encryptStringRsa

public String encryptStringRsa(ClientInfo ci,
 String key,
 String data,
 boolean encryptNotDecrypt)
                        throws byps.RemoteException

Description copied from interface: IXServicePortIF

Encrypt or decrypt a string using the RSA algorithm.

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

Specified by:

encryptStringRsa in interface IXServicePortIF

Parameters:

ci - ClientInfo object with language, country and ticket.

key - Public or private RSA key

data - String to be encrypted or decrypted

encryptNotDecrypt - true, if the should be encrypted.

Returns:

Encrypted or decrypted string.

Throws:

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

See Also:

• IXServicePortIF.createRsaKeys(ClientInfo)

createActivityProject

public ActivityProject createActivityProject(ClientInfo ci,
 String projectName)
                                      throws byps.RemoteException

Description copied from interface: IXServicePortIF

This function creates an activity project in memory.

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

Specified by:

createActivityProject in interface IXServicePortIF

Parameters:

ci - ClientInfo object with language, country and ticket.

projectName - Name of the new activity project or null or empty.

Returns:

ActivityProject object.

Throws:

byps.RemoteException - Exception with message text of format "[ELOIX:number] text". The number is one of the constants defined in IXExceptionC. IXExceptionC.ALREADY_EXISTS if the given project name does already exists.

checkinActivityProject

public String checkinActivityProject(ClientInfo ci,
 ActivityProject actProj,
 LockZ unlockZ)
                              throws byps.RemoteException

Description copied from interface: IXServicePortIF

This function writes an activity project into the database.

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

Specified by:

checkinActivityProject in interface IXServicePortIF

Parameters:

ci - ClientInfo object with language, country and ticket.

actProj - ActivityProject

unlockZ - Unlock project

Returns:

Activity project name

Throws:

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

checkoutActivityProject

public ActivityProject checkoutActivityProject(ClientInfo ci,
 String projectName,
 LockZ lockZ)
                                        throws byps.RemoteException

Description copied from interface: IXServicePortIF

This function reads and optionally locks an activity project.

Specified by:

checkoutActivityProject in interface IXServicePortIF

Parameters:

ci - ClientInfo object with language, country and ticket.

projectName - GUID of an existing activity project.

lockZ - Lock project

Returns:

ActivityProject object.

Throws:

byps.RemoteException - Exception with message text of format "[ELOIX:number] text". The number is one of the constants defined in IXExceptionC. IXExceptionC.NOT_FOUND if the activity does not exist.

deleteActivityProject

public void deleteActivityProject(ClientInfo ci,
 String projectName,
 LockZ unlockZ)
                           throws byps.RemoteException

Description copied from interface: IXServicePortIF

This function deletes an activity project from the database.

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

Specified by:

deleteActivityProject in interface IXServicePortIF

Parameters:

ci - ClientInfo object with language, country and ticket.

projectName - GUID of an existing activity project.

unlockZ - Unlock project

Throws:

byps.RemoteException - Exception with message text of format "[ELOIX:number] text". The number is one of the constants defined in IXExceptionC. IXExceptionC.NOT_FOUND if the activity does not exist.

findActivityProjects

public ActivityProject[] findActivityProjects(ClientInfo ci,
 FindActivityProjectsInfo findInfo)
                                       throws byps.RemoteException

Description copied from interface: IXServicePortIF

This function reads all activity projects.

Specified by:

findActivityProjects in interface IXServicePortIF

Parameters:

ci - ClientInfo object with language, country and ticket.

findInfo - Reserved.

Returns:

ActivityProject array.

Throws:

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

createActivity

public Activity createActivity(ClientInfo ci,
 String projectName,
 String objId)
                        throws byps.RemoteException

Description copied from interface: IXServicePortIF

This function creates an activity in memory based on the given project and assigned to the given object.

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

Specified by:

createActivity in interface IXServicePortIF

Parameters:

ci - ClientInfo object with language, country and ticket.

projectName - Activity project name.

objId - Optional Sord ID.

Returns:

Activity object

Throws:

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

checkinActivity

public String checkinActivity(ClientInfo ci,
 Activity act,
 LockZ unlockZ)
                       throws byps.RemoteException

Description copied from interface: IXServicePortIF

This function inserts or updates an activity.

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

Specified by:

checkinActivity in interface IXServicePortIF

Parameters:

ci - ClientInfo object with language, country and ticket.

act - Activity object

unlockZ - Unlock mode

Returns:

Activity GUID

Throws:

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

deleteActivity

public void deleteActivity(ClientInfo ci,
 String actGuid,
 DeleteActivityOptions deleteOptions,
 LockZ unlockZ)
                    throws byps.RemoteException

Description copied from interface: IXServicePortIF

This function deletes an activity.

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

Specified by:

deleteActivity in interface IXServicePortIF

Parameters:

ci - ClientInfo object with language, country and ticket.

actGuid - Activity ID

deleteOptions - Optional. If this member is null, the activity is deleted logically. Thereby member Activity.backAt is set to the current date.

unlockZ - Unlock mode

Throws:

byps.RemoteException - Exception with message text of format "[ELOIX:number] text". The number is one of the constants defined in IXExceptionC. IXExceptionC.NOT_FOUND if the activity does not exist.

checkoutActivity

public Activity checkoutActivity(ClientInfo ci,
 String actGuid,
 LockZ lockZ)
                          throws byps.RemoteException

Description copied from interface: IXServicePortIF

This function reads and optionally locks an activity.

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

Specified by:

checkoutActivity in interface IXServicePortIF

Parameters:

ci - ClientInfo object with language, country and ticket.

actGuid - Activity ID

lockZ - Lock mode

Returns:

Activity object.

Throws:

byps.RemoteException - Exception with message text of format "[ELOIX:number] text". The number is one of the constants defined in IXExceptionC. IXExceptionC.NOT_FOUND if the activity does not exist.

findFirstActivities

public FindResult findFirstActivities(ClientInfo ci,
 FindActivityInfo findInfo,
 int max,
 ActivityZ activityZ)
                               throws byps.RemoteException

Description copied from interface: IXServicePortIF

This function reads the activities of an object.

Specified by:

findFirstActivities in interface IXServicePortIF

Parameters:

ci - ClientInfo object with language, country and ticket.

findInfo - This parameter is used to define the object for which activities should be returned.

max - Maximum number of objects to be returned in this call.

activityZ - Element selector. This parameter defines, which Activity members have to be returned.

Returns:

FindResult object, activities are returned in FindResult.userTasks[.].activity

Throws:

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

findNextActivities

public FindResult findNextActivities(ClientInfo ci,
 String searchId,
 int idx,
 int max,
 ActivityZ activityZ)
                              throws byps.RemoteException

Description copied from interface: IXServicePortIF

This function reads the next activites of an object.

Specified by:

findNextActivities in interface IXServicePortIF

Parameters:

ci - ClientInfo object with language, country and ticket.

searchId - A Search ID received from a previous call to findFirstActivities in FindResult.searchId.

idx - Return results from this start index.

max - Maximum number of objects to be returned in this call.

activityZ - Element selector. This parameter defines, which Activity members have to be returned.

Returns:

FindResult object, activities are returned in FindResult.userTasks[.].activity

Throws:

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

registerOcrWorker

public OcrWorker registerOcrWorker(ClientInfo ci,
 OcrWorker ocrWorker)
                            throws byps.RemoteException

Description copied from interface: IXServicePortIF

This function is called from an OCR worker process to notify Indexserver about its state.

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

Specified by:

registerOcrWorker in interface IXServicePortIF

Parameters:

ci - ClientInfo object with language, country and ticket.

ocrWorker - An object that describes the worker.

Returns:

Reserved.

Throws:

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

processOcr

public OcrResult processOcr(ClientInfo ci,
 OcrInfo ocrInfo)
                     throws byps.RemoteException

Description copied from interface: IXServicePortIF

Compute OCR on the given image data or on an archived document.

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

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

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

This is a simple example for synchronous OCR processing:

 
 IXConnection conn = ...
 String imageFile = ... // Input file in TIFF, etc. format
 String textFile = ... // Output file in text format
 

 // Is OCR via IX available? - Pass an empty OcrInfo object to processOcr in order to find it out. 
 OcrInfo ocrInfo = new OcrInfo();
 bool isOcrAvail = conn.Ix.processOcr(ocrInfo) != null;
 if (!isOcrAvail) return;
 

 // Query the languages supported by the OCR Engine
 OcrInfo ocrInfoLangs = new OcrInfo();
 ocrInfoLangs.queryLanguages = new OcrInfoQueryLanguages();
 OcrResult ocrResultLangs = conn.Ix.processOcr(ocrInfoLangs);
 

 // Anaylze file
 // Load entire image into memory
 OcrInfo ocrInfo = new OcrInfo();
 ocrInfo.recognizeFile = new OcrInfoRecognizeFile();
 ocrInfo.recognizeFile.imageData = new FileData();
 ocrInfo.recognizeFile.imageData.data = File.ReadAllBytes(imageFile);
 ocrInfo.recognizeFile.imageData.contentType = Path.GetExtension(imageFile);
 ocrInfo.recognizeFile.pageNo = -1; // analyze all pages
 ocrInfo.recognizeFile.outputFormat = OcrInfoC.TEXT; // return result as String
 ocrInfo.recognizeFile.recognizeLangs = new String[] {"German", "Czech"}; // Choosen from ocrResultLangs.internalLangs  
 

 // Process OCR
 OcrResult ocrResult = conn.Ix.processOcr(ocrInfo);
 

 // Write text output to file
 File.WriteAllText(textFile, ocrResult.recognizeFile.text, Encoding.UTF8);
 
 

Specified by:

processOcr in interface IXServicePortIF

Parameters:

ci - ClientInfo object with language, country and ticket.

ocrInfo - Contains the image data, etc.

Returns:

Reserved (currently always null)

Throws:

byps.RemoteException - Exception with message text of format "[ELOIX:number] text". The number is one of the constants defined in IXExceptionC. If ELO OCR Service 8.0 is not installed or all OCR workers have been busy for more than 2min, IXExceptionC.TEMP_PROBLEM is thrown (ELOIX:2002). IF OCR processing fails, IXExceptionC.SERVER_ERROR is thrown (ELOIX:1000).

evalAutoFiling

public AutoFilingResult evalAutoFiling(ClientInfo ci,
 String maskId,
 Sord sord,
 AutoFilingOptions opts)
                                throws byps.RemoteException

Description copied from interface: IXServicePortIF

Evaluate the destination archive path based on filing definitions of a keywording from.

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

Specified by:

evalAutoFiling in interface IXServicePortIF

Parameters:

ci - ClientInfo object with language, country and ticket.

maskId - Keywording form ID with filing definition. This paramter can be null, if AutoFilingOptions.autoFilingDefinition is supplied.

sord - Sord object

opts - reserved

Returns:

Archive destination

Throws:

byps.RemoteException - Exception with message text of format "[ELOIX:number] text". The number is one of the constants defined in IXExceptionC. If the Sord object does not contain all information required to replace the placeholders in the filing definition, IXExceptionC.INVALID_PARAM is thrown.

checkoutMapHistory

public MapHist[] checkoutMapHistory(ClientInfo ci,
 String domainName,
 String mapId,
 MapHistZ membersZ)
                             throws byps.RemoteException

Description copied from interface: IXServicePortIF

Reads the history entries for the given map.

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

Specified by:

checkoutMapHistory in interface IXServicePortIF

Parameters:

ci - ClientInfo object

domainName - map domain name; an arbitrary (existing name) or a predefined name from MapDomainC

mapId - map ID. In order to get the map values associated to a Sord object pass the numeric Sord ID (Sord#id).

membersZ - Members to be returned. E.g. MapHistC.mbAll or MapHistC.mbAllNoItems.

Returns:

MapHist Object that contains the map items.

Throws:

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

See Also:

• IXServicePortIF.checkinMap(de.elo.ix.client.ClientInfo, java.lang.String, java.lang.String, int, de.elo.ix.client.KeyValue[], de.elo.ix.client.LockZ)

checkinDocBegin2

public Document checkinDocBegin2(ClientInfo ci,
 Sord sord,
 Document document,
 CheckinDocOptions opts)
                          throws byps.RemoteException

Description copied from interface: IXServicePortIF

Prepares the Indexserver to enable a document to be checked in.

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

Specified by:

checkinDocBegin2 in interface IXServicePortIF

Parameters:

ci - ClientInfo object with language, country and ticket

sord - Sord object

document - Document object

opts - CheckinDocOptions (with member "keepIds")

Returns:

Document object with upload URL.

Throws:

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

See Also:

• checkinDocBegin

controlBackgroundThread

public JobState controlBackgroundThread(ClientInfo ci,
 JobState jobState)
                                 throws byps.RemoteException

Description copied from interface: IXServicePortIF

Query the status of the job and control its state.

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

Specified by:

controlBackgroundThread in interface IXServicePortIF

Parameters:

ci - ClientInfo object with language, country and ticket.

jobState - JobState object with job and controlling information.

Returns:

status of the job after executing the controlling informations.

Throws:

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

findBackgroundThreads

public FindResult findBackgroundThreads(ClientInfo ci,
 FindBackgroundThreadOptions findBackgroundThreadOptions)
                                 throws byps.RemoteException

Description copied from interface: IXServicePortIF

Query all jobs executed in the background.

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

Specified by:

findBackgroundThreads in interface IXServicePortIF

Parameters:

ci - ClientInfo object with language, country and ticket.

findBackgroundThreadOptions - FindBackgroundThreadOptions object with filter informations.

Returns:

FindResult containing the found jobs.

Throws:

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

queryJobProtocol

public QueryJobProtocolResult queryJobProtocol(ClientInfo ci,
 QueryJobProtocolInfo queryJobProtocolInfo)
                                        throws byps.RemoteException

Description copied from interface: IXServicePortIF

Query the protocol of a background thread.

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

Specified by:

queryJobProtocol in interface IXServicePortIF

Parameters:

ci - ClientInfo object with language, country and ticket.

queryJobProtocolInfo - QueryJobProtocolInfo object containing the jobGuid and optional filters.

Returns:

QueryJobProtocolResult containing all cached log messages according to the filters set by queryJobProtocolInfo. If uncached log messages exists, the value downloadUrl is set.

Throws:

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

checkoutKeywordsDynamic

public KeywordsDynamicResult checkoutKeywordsDynamic(ClientInfo ci,
 KeywordsDynamicInfo keywordsDynamicInfo)
                                              throws byps.RemoteException

Description copied from interface: IXServicePortIF

Queries dynamic keyword lists.

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

Specified by:

checkoutKeywordsDynamic in interface IXServicePortIF

Parameters:

ci - ClientInfo object with language, country and ticket.

keywordsDynamicInfo - KeywordsDynamicInfo contains the parameters like the sord, and the focused mask line.

Returns:

KeywordsDynamicResult containing the result as a table with some metadata.

Throws:

byps.RemoteException - Exception with message text of format "[ELOIX:number] text". The number is one of the constants defined in IXExceptionC. i.e. if the script was not found or required parameters are not provided.

checkoutPreviewImageURLs

public PreviewImageResult checkoutPreviewImageURLs(ClientInfo ci,
 PreviewImageInfo previewImageInfo)
                                            throws byps.RemoteException

Description copied from interface: IXServicePortIF

Generates URLs for preview images of documents.

Specified by:

checkoutPreviewImageURLs in interface IXServicePortIF

Parameters:

ci - ClientInfo object with language, country and ticket.

previewImageInfo - PreviewImageInfo containing documentIds, page information, etc.

Returns:

Map from document id Strings to its corresponding PreviewImageResult.

Throws:

byps.RemoteException - Exception with message text of format "[ELOIX:number] text". The number is one of the constants defined in IXExceptionC. if the provided parameters were wrong or incomplete; during processing if a document format is not supported or the document itself is errorneous.

checkoutSordPath

public SordPaths checkoutSordPath(ClientInfo ci,
 String objId,
 SordZ sordZ,
 CheckoutSordPathInfo csi)
                           throws byps.RemoteException

Description copied from interface: IXServicePortIF

Gets the list of Sord object which are the predecessors of the sord given by the objId.

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

Specified by:

checkoutSordPath in interface IXServicePortIF

Parameters:

ci - ClientInfo object with language, country and ticket.

objId - Sord ID

sordZ - Elements of sord to be stored into the database.

csi - Options for this function

Returns:

The list of sords that lead to the sord given by the objId.

Throws:

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

applyForNotifications

public ApplyForNotificationsInfo applyForNotifications(ClientInfo ci,
 ApplyForNotificationsInfo info)
                                                throws byps.RemoteException

Description copied from interface: IXServicePortIF

Specify, which notifications should be sent by the server.

Specified by:

applyForNotifications in interface IXServicePortIF

Parameters:

ci - ClientInfo object with language, country and ticket.

info - parameter object or null, if only the current settings should be returned.

Returns:

previous settings

Throws:

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

See Also:

• IXConnection.applyForNotifications(de.elo.ix.client.ApplyForNotificationsInfo, de.elo.ix.client.notify.BSkeleton_ClientNotification)

getPublicDownloads

public List<PublicDownload> getPublicDownloads(ClientInfo ci,
 PublicDownloadOptions opts)
                                        throws byps.RemoteException

Description copied from interface: IXServicePortIF

Gets the public downloads.

Specified by:

getPublicDownloads in interface IXServicePortIF

Parameters:

ci - ClientInfo object with language, country and ticket.

opts - PublicDownloadOptions object to get the downloads. If opts is null, the public downloads created by current user are returned.

Returns:

the public download list

Throws:

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

terminatePublicDownloadUrls

public void terminatePublicDownloadUrls(ClientInfo ci,
 PublicDownloadOptions opts)
                                 throws byps.RemoteException

Description copied from interface: IXServicePortIF

Deletes the public downloads

Specified by:

terminatePublicDownloadUrls in interface IXServicePortIF

Parameters:

ci - ClientInfo object with language, country and ticket.

opts - PublicDownloadOptions object to delete the downloads. If opts is null, no download will be deleted.

Throws:

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

resolveRights

public List<ResolveRightsResult> resolveRights(ClientInfo ci,
 UserInfo ui,
 ResolveRightsInfo info)
                                        throws byps.RemoteException

Description copied from interface: IXServicePortIF

Resolves the rights of a user.

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

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

Specified by:

resolveRights in interface IXServicePortIF

Parameters:

ci - ClientInfo object with language, country and ticket.

ui - UserInfo with username groups and rights. If the user does not yet exist, provide a (new, nonexisting) username and set id=-1.

info - ResolveRightsInfo optional parameters.

Returns:

List of ResolveRightsResult for each right, the user got directly or by inheritance. Please note that the same right may appear more than one in this list as it is possible to inherit a right by multiple ways.

Throws:

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

startAdHocWorkFlow2

public int startAdHocWorkFlow2(ClientInfo ci,
 String name,
 String objId,
 UserNodeInfo[] userNodeInfo,
 StartAdHocWorkflowInfo startWfInfo)
                        throws byps.RemoteException

Description copied from interface: IXServicePortIF

Starts an Ad Hoc Workflow.

Specified by:

startAdHocWorkFlow2 in interface IXServicePortIF

Parameters:

ci - ClientInfo object with language, country and ticket.

name - Workflow name

objId - ID of the object for which the workflow is started.

userNodeInfo - The information of all user nodes in the workflow.

startWfInfo - The parameters to pass to the workflow.

Returns:

Workflow ID

Throws:

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

editPublicDownloadUrls

public void editPublicDownloadUrls(ClientInfo ci,
 PublicDownloadOptions opts)
                            throws byps.RemoteException

Description copied from interface: IXServicePortIF

Edits the public downloads

Specified by:

editPublicDownloadUrls in interface IXServicePortIF

Parameters:

ci - ClientInfo object with language, country and ticket.

opts - PublicDownloadOptions object to delete the downloads. If opts is null, no download will be edited. The remaining download and the expiration are editable.

Throws:

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

insertPublicDownload

public PublicDownload insertPublicDownload(ClientInfo ci,
 PublicDownloadOptions opts)
                                    throws byps.RemoteException

Description copied from interface: IXServicePortIF

Creates and inserts a new public download

Specified by:

insertPublicDownload in interface IXServicePortIF

Parameters:

ci - ClientInfo object with language, country and ticket.

opts - PublicDownloadOptions object to create the downloads.

Throws:

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

findFirstSubscriptions

public FindResult findFirstSubscriptions(ClientInfo ci,
 FindSubscriptionInfo findInfo,
 int max,
 SubscriptionZ subsZ)
                                  throws byps.RemoteException

Description copied from interface: IXServicePortIF

Find first max subscriptions. This function finds the subscriptions of the current user.

Specified by:

findFirstSubscriptions in interface IXServicePortIF

Parameters:

ci - ClientInfo object with language, country and ticket.

subsZ - Bitset of valid elements, must be SubscriptionC.mbAll

Returns:

FindResult

Throws:

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

findNextSubscriptions

public FindResult findNextSubscriptions(ClientInfo ci,
 String searchId,
 int idx,
 int max,
 SubscriptionZ subsZ)
                                 throws byps.RemoteException

Description copied from interface: IXServicePortIF

Find next max subscriptions beginning at index idx.

Specified by:

findNextSubscriptions in interface IXServicePortIF

Parameters:

ci - ClientInfo object with language, country and ticket.

searchId - Search-ID returned from previous call to IXServicePortIF.findFirstSubscriptions(ClientInfo, FindSubscriptionInfo, int, SubscriptionZ)

idx - Return results starting at this index.

max - Return not more than this number of results.

subsZ - Bitset of valid elements, must be SubscriptionC.mbAll

Returns:

FindResult

Throws:

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

createSubscription

public Subscription createSubscription(ClientInfo ci,
 String watchGuid)
                                throws byps.RemoteException

Description copied from interface: IXServicePortIF

Initialize a subscription object.

Specified by:

createSubscription in interface IXServicePortIF

Parameters:

ci - ClientInfo object with language, country and ticket.

watchGuid - GUID of object to be watched.

Returns:

Subscription

Throws:

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

checkinSubscription

public Subscription checkinSubscription(ClientInfo ci,
 Subscription subs,
 SubscriptionZ subsZ)
                                 throws byps.RemoteException

Description copied from interface: IXServicePortIF

Add a subscription.

Specified by:

checkinSubscription in interface IXServicePortIF

Parameters:

ci - ClientInfo object with language, country and ticket.

subs - Subscription

subsZ - Bitset of valid elements, must be SubscriptionC.mbAll

Returns:

Subscription

Throws:

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

deleteSubscription

public void deleteSubscription(ClientInfo ci,
 Subscription subs)
                        throws byps.RemoteException

Description copied from interface: IXServicePortIF

Delete a subscription.

Specified by:

deleteSubscription in interface IXServicePortIF

Parameters:

ci - ClientInfo object with language, country and ticket.

subs - Subscription.

Throws:

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

findFirstNotes

public FindResult findFirstNotes(ClientInfo ci,
 FindInfo findInfo,
 int max,
 NoteZ noteZ)
                          throws byps.RemoteException

Description copied from interface: IXServicePortIF

Find first notes. This function starts a search for Note object and returns the first objects found in FindResult.notes. At least FindInfo.findByNotes must be set. The member FindInfo.findChildren optionally constrain the results to a folder. The search must be closed with IXServicePortIF.findClose(ClientInfo, String) in order to release internally cached data.

Specified by:

findFirstNotes in interface IXServicePortIF

Parameters:

ci - ClientInfo object with language, country and ticket.

findInfo - FindInfo object that contains the search criterias.

max - Return up to this number of result objects.

noteZ - Element selector for Note objects.

Returns:

FindResult object

Throws:

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

See Also:

• IXServicePortIF.findNextNotes(ClientInfo, String, int, int, NoteZ)

findNextNotes

public FindResult findNextNotes(ClientInfo ci,
 String searchId,
 int idx,
 int max,
 NoteZ noteZ)
                         throws byps.RemoteException

Description copied from interface: IXServicePortIF

Find next notes. This function continues a search for Note objects startet with function IXServicePortIF.findFirstNotes(ClientInfo, FindInfo, int, NoteZ).

Specified by:

findNextNotes in interface IXServicePortIF

Parameters:

ci - ClientInfo object with language, country and ticket.

searchId - Search ID from FindResult.searchId

idx - Start index in the result set.

max - Return up to this number of result objects.

noteZ - Element selector for Note objects.

Returns:

FindResult object.

Throws:

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

See Also:

• IXServicePortIF.findFirstNotes(ClientInfo, FindInfo, int, NoteZ)

checkinReport

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

Description copied from interface: IXServicePortIF

Inserts custom report entries.

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

Specified by:

checkinReport in interface IXServicePortIF

Parameters:

ci - ClientInfo object with language, country and ticket.

report - The report to write.

reserved - This parameter must be null.

Throws:

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

See Also:

• IXServicePortIF.findFirstReportInfos(ClientInfo, FindReportInfo, int)

linkSords2

public void linkSords2(ClientInfo ci,
 String fromId,
 String[] toIds,
 LinkSordZ linkSordZ,
 LinkSordInfo linkSordInfo)
                throws byps.RemoteException

Description copied from interface: IXServicePortIF

Links archive entries like IXServicePortIF.linkSords(de.elo.ix.client.ClientInfo, java.lang.String, java.lang.String[], de.elo.ix.client.LinkSordZ).

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

Specified by:

linkSords2 in interface IXServicePortIF

Parameters:

ci - ClientInfo object with language, country and ticket

fromId - Object ID or GUID the links start from.

toIds - Object IDs or GUIDs the links point to.

linkSordZ - Controls how the objects are connected. If null or LinkSordC.PAIR, the function builds pairs of linked objects from fromId to toIds[.]. E.g. {fromId, toIds[0]}, {fromId, toIds[1]}. If LinkSordC.CROSS_LINK is passed, the function builds a cross-link with the associations: {fromId, toIds[0]}, { fromId, toIds[1] }, {toIds[0], toIds[1]}.

linkSordInfo - Controls link generation.

Throws:

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

See Also:

• LinkSordC
• Sord.linksGoOut
• Sord.linksComeIn
• unlinkSords

getWebDAVPathFromObjID

public String getWebDAVPathFromObjID(ClientInfo ci,
 String objId)
                              throws byps.RemoteException

Description copied from interface: IXServicePortIF

Returns the WebDAV path from an Object ID.

Specified by:

getWebDAVPathFromObjID in interface IXServicePortIF

Parameters:

ci - ClientInfo object with language, country and ticket

objId - ObjectId or GUID of the sord to get the path.

Returns:

WebDAV path of the give Object ID.

Throws:

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

importWorkFlow2

public int importWorkFlow2(ClientInfo ci,
 String flowName,
 byte[] fileData,
 WorkflowImportOptions importOptions)
                    throws byps.RemoteException

Description copied from interface: IXServicePortIF

Imports a workflow template from a file.

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

Specified by:

importWorkFlow2 in interface IXServicePortIF

Parameters:

ci - ClientInfo object with language, country and ticket

flowName - Workflow name

fileData - File content

importOptions - Import options.

Returns:

Workflow ID

Throws:

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

checkinNotification

public Notification checkinNotification(ClientInfo ci,
 Notification notif,
 NotificationZ notiZ)
                                 throws byps.RemoteException

Description copied from interface: IXServicePortIF

Inserts or updates a Notification object if userGuid is null, the own Guid will be taken if userGuid is not the own Guid, admin rights are needed

Specified by:

checkinNotification in interface IXServicePortIF

Parameters:

ci - ClientInfo object with language, country and ticket.

notif - Notification object which should be updated or inserted

notiZ - Determines, which members of Notification to save. currently only mbPrio supported

Returns:

Notification

Throws:

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

checkoutNotification

public Notification checkoutNotification(ClientInfo ci,
 String watchGuid,
 String userGuid)
                                  throws byps.RemoteException

Description copied from interface: IXServicePortIF

Reads Notification for a watchGuid / userGuid combination if userGuid is null, the own Guid will be taken if userGuid is not the own Guid, admin rights are needed

Specified by:

checkoutNotification in interface IXServicePortIF

Parameters:

ci - ClientInfo object with language, country and ticket.

watchGuid - String

userGuid - String Guid or ID or Name of the user to which the Notification belongs

Returns:

Notification if found

Throws:

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

deleteNotification

public int deleteNotification(ClientInfo ci,
 String objGuid,
 String userGuid)
                       throws byps.RemoteException

Description copied from interface: IXServicePortIF

Deleting the Notification identified by objGuid / userGuid combination if the Notification has child Notifications, they will be deleted as well.

Specified by:

deleteNotification in interface IXServicePortIF

Parameters:

ci - ClientInfo object with language, country and ticket.

objGuid - String

userGuid - String Guid or ID or Name of the User to which the Notification belongs

Returns:

int number of deleted Notifications

Throws:

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

executeRegisteredFunctionString

public String executeRegisteredFunctionString(ClientInfo ci,
 String functionName,
 String param)
                                       throws byps.RemoteException

Description copied from interface: IXServicePortIF

Execute a registered function defined in a JavaScript or in an event handler.

Specified by:

executeRegisteredFunctionString in interface IXServicePortIF

Parameters:

ci - ClientInfo

functionName - Name of the function to be executed.

param - Function parameter as String

Returns:

Return value as String

Throws:

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

checkoutWorkflowHistory

public CheckoutWorkflowHistoryResult checkoutWorkflowHistory(ClientInfo ci,
 CheckoutWorkflowHistoryParams checkoutWorkflowHistoryParams)
                                                      throws byps.RemoteException

Description copied from interface: IXServicePortIF

Reads the histories of a node or a whole workflow.

Specified by:

checkoutWorkflowHistory in interface IXServicePortIF

Parameters:

ci - ClientInfo object with language, country and ticket

checkoutWorkflowHistoryParams - workflow Guid

Returns:

CheckoutWorkflowHistoryResult object

Throws:

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

getWebDAVPathFromObjID2

public GetWebDAVPathResult getWebDAVPathFromObjID2(ClientInfo ci,
 GetWebDAVPathOptions options)
                                            throws byps.RemoteException

Description copied from interface: IXServicePortIF

Returns the WebDAV path from an Object ID.

Specified by:

getWebDAVPathFromObjID2 in interface IXServicePortIF

Parameters:

ci - ClientInfo object with language, country and ticket

options - GetWebDAVPathOptions object

Returns:

GetWebDAVPathResult object which contains the WebDAV path

Throws:

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

checkinDocMaskLineTemplate

public int checkinDocMaskLineTemplate(ClientInfo ci,
 DocMaskLineTemplate dmlt,
 DocMaskLineTemplateZ dmltZ,
 CheckInDocMaskLineTemplateOptions options,
 LockZ lockZ)
                               throws byps.RemoteException

Description copied from interface: IXServicePortIF

Writes a keyword template into the database. If this keyword template is already used in keywording forms, these keywording forms will be updated. This function requires ELO 10 license.

Specified by:

checkinDocMaskLineTemplate in interface IXServicePortIF

Parameters:

ci - ClientInfo object with language, country and ticket.

dmlt - Template object.

dmltZ - Members to be written

options - Options object

lockZ - Unlock template or force access.

Throws:

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

checkoutDocMaskLineTemplates

public DocMaskLineTemplate[] checkoutDocMaskLineTemplates(ClientInfo ci,
 String[] groups,
 DocMaskLineTemplateZ dmltZ,
 LockZ lockZ)
                                                   throws byps.RemoteException

Description copied from interface: IXServicePortIF

Check out keyword templates. This function requires ELO 10 license.

Specified by:

checkoutDocMaskLineTemplates in interface IXServicePortIF

Parameters:

ci - ClientInfo object with language, country and ticket.

groups - Groups to be checked out. If groups is null, all template are checked out.

dmltZ - Member to be read.

lockZ - Unlock templates.

Returns:

Keyword templates

Throws:

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

deleteDocMaskLineTemplates

public void deleteDocMaskLineTemplates(ClientInfo ci,
 String[] groups,
 LockZ unlockZ)
                                throws byps.RemoteException

Description copied from interface: IXServicePortIF

Delete keyword templates This function requires ELO 10 license.

Specified by:

deleteDocMaskLineTemplates in interface IXServicePortIF

Parameters:

ci - ClientInfo object with language, country and ticket.

groups - Groups to be deleted.

unlockZ - Unlock template or force access

Throws:

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

beginForwardWorkflowNode

public WFEditNode beginForwardWorkflowNode(ClientInfo ci,
 int flowId,
 int nodeId,
 BeginForwardWorkflowNodeInfo forwardNodeInfo,
 LockZ lockZ)
                                    throws byps.RemoteException

Description copied from interface: IXServicePortIF

Prepare forwarding of a workflow node. Use this function to lock a workflow and get the data required for forwarding a node.

Specified by:

beginForwardWorkflowNode in interface IXServicePortIF

Parameters:

ci - ClientInfo object with language, country and ticket.

flowId - Workflow ID

nodeId - Workflow node ID. The node must be active and assigned to the current user.

forwardNodeInfo - reserved, must be null

lockZ - Lock workflow

Returns:

Node data

Throws:

byps.RemoteException

forwardWorkflowNode

public ForwardWorkflowNodeResult forwardWorkflowNode(ClientInfo ci,
 int flowId,
 int nodeId,
 ForwardWorkflowNodeInfo forwardNodeInfo,
 LockZ unlockZ)
                                              throws byps.RemoteException

Description copied from interface: IXServicePortIF

Forward a workflow node, terminate a workflow or modify node data.

Example 1: Forward a workflow node:

// Lock workflow and read node data WFEditNode editNode = conn.ix().beginForwardWorkflowNode(flowId, nodeId, null, LockC.IF_FREE); // Select successor nodes to be activated // Make sure to select only one successor if: (editNode.getNode().getFlags() & WFNodeC.FLAG_ONE_SUCCESSOR) != 0 List succNodes = Arrays.asList(editNode.getSuccNodes()[0].getId()); // Optionally: change node name and comment WFNode activeNode = editNode.getNode(); activeNode.setName("new name"); activeNode.setComment("new comment"); // Forward ForwardWorkflowNodeInfo fwdInfo = new ForwardWorkflowNodeInfo(); fwdInfo.setNode(activeNode); fwdInfo.setSuccessorNodesToActivate(succNodes); connU.ix().forwardWorkflowNode(flowId, nodeId, fwdInfo, LockC.YES);

Example 2: Cancel forwarding after beginForwardWorkflowNode has locked the workflow

// Lock workflow and read node data WFEditNode editNode = conn.ix().beginForwardWorkflowNode(flowId, nodeId, null, LockC.IF_FREE); // Cancel forward ForwardWorkflowNodeInfo fwdInfo = null; connU.ix().forwardWorkflowNode(flowId, nodeId, fwdInfo, LockC.YES);

Example 3: Change node priority, name and comment

// Lock workflow WFEditNode editNode = conn.ix().beginForwardWorkflowNode(flowId, nodeId, null, LockC.IF_FREE); // Change node priority, name and comment WFNode activeNode = editNode.getNode(); activeNode.setPrio(UserTaskPriorityC.HIGHEST); activeNode.setName("new name"); activeNode.setComment("new comment"); // Update node and unlock ForwardWorkflowNodeInfo fwdInfo = new ForwardWorkflowNodeInfo(); fwdInfo.setNode(activeNode); connU.ix().forwardWorkflowNode(flowId, nodeId, fwdInfo, LockC.YES);

Specified by:

forwardWorkflowNode in interface IXServicePortIF

Parameters:

ci - ClientInfo object with language, country and ticket.

flowId - Workflow ID

nodeId - Workflow node ID. The node must be active and assigned to the current user.

forwardNodeInfo - reserved, must be null

unlockZ - Unlock worfklow

Returns:

reserved

Throws:

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

findFirstUsers

public FindResult findFirstUsers(ClientInfo ci,
 FindUserInfo findUserInfo,
 int max)
                          throws byps.RemoteException

Description copied from interface: IXServicePortIF

Find user data. This function allows to find users by their name, description, or one of their properties. Wildcards can be used as defined in the session options, see SessionOptionsC.DB_WILDCARDS. Example:

 
 FindUserInfo findUserInfo = new FindUserInfo();
 findUserInfo.setName("testFind?sers-*");
 int idx = 0, max = 100;
 FindResult fr = conn.ix().findFirstUsers(findUserInfo, max);
 try {
   while (true) {
     for (UserName userName : fr.getUserNames().values()) {
       // process userName object
     }
    
     if (!fr.isMoreResults()) break;
   
     idx += fr.getUserNames().length;
     fr = conn.ix().findNextUsers(fr.getSearchId(), idx, max);
   }
 }
 catch (RemoteException e) {
   // process exception
   throw e;
 }
 finally {
   conn.ix().findClose(fr.getSearchId());
 }
 
 

Additionally, FindResult#sortedResult returns a sorted list of either UserInfo or UserName objects, depending on FindUserInfo.returnUserInfoMap.

Specified by:

findFirstUsers in interface IXServicePortIF

Parameters:

ci - ClientInfo object with language, country and ticket

findUserInfo - Search criteria.

max - Maximum number of users to return.

Returns:

FindResult object.

Throws:

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

findNextUsers

public FindResult findNextUsers(ClientInfo ci,
 String searchId,
 int idx,
 int max)
                         throws byps.RemoteException

Description copied from interface: IXServicePortIF

Find next user data.

Specified by:

findNextUsers in interface IXServicePortIF

Parameters:

ci - ClientInfo object with language, country and ticket

searchId - Search ID received from the FindResult.searchId returned from IXServicePortIF.findFirstUsers(ClientInfo, FindUserInfo, int).

idx - Start index.

max - Maximum number of users to return.

Returns:

FindResult object.

Throws:

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

startAdHocWorkFlow3

public int startAdHocWorkFlow3(ClientInfo ci,
 String name,
 String objId,
 StartAdHocWorkflowInfo startWfInfo)
                        throws byps.RemoteException

Description copied from interface: IXServicePortIF

Starts an Ad Hoc Workflow.

Specified by:

startAdHocWorkFlow3 in interface IXServicePortIF

Parameters:

ci - ClientInfo object with language, country and ticket.

name - Workflow name

objId - ID of the object for which the workflow is started.

startWfInfo - The parameters to pass to the workflow.

Returns:

Workflow ID

Throws:

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

checkLicense

public LicenseResult checkLicense(ClientInfo ci,
 LicenseInfo licenseInfo)
                           throws byps.RemoteException

Description copied from interface: IXServicePortIF

Check licensing information. This function checks the given license information using proprietary algorithms.

Specified by:

checkLicense in interface IXServicePortIF

Parameters:

ci - ClientInfo object with language, country and ticket

licenseInfo - License information.

Returns:

Reserved.

Throws:

byps.RemoteException - If the license information is invalid, this function throws an exception with code IXExceptionC.ACCESS_DENIED.

moveDocuments

public JobState moveDocuments(ClientInfo ci,
 MoveDocumentsInfo moveDocumentsInfo)

Description copied from interface: IXServicePortIF

Move documents from one storage path to another storage path.

Specified by:

moveDocuments in interface IXServicePortIF

Parameters:

ci - ClientInfo object with language, country and ticket

moveDocumentsInfo - Parameter of this function.

Returns:

Background job state

findContextTerms

public FindResult findContextTerms(ClientInfo ci,
 FindInfo findInfo,
 int maxTermsPerField)
                            throws byps.RemoteException

Description copied from interface: IXServicePortIF

Find terms for faceted search.

Specified by:

findContextTerms in interface IXServicePortIF

Parameters:

ci - ClientInfo

findInfo - This parameter is used to define the search.

maxTermsPerField - Max number of terms per field to be returned.

Returns:

FindResult

Throws:

byps.RemoteException

findAggregations

public FindResult findAggregations(ClientInfo ci,
 FindInfo findInfo)
                            throws byps.RemoteException

Description copied from interface: IXServicePortIF

Find aggregation data for dashboards and statistics.

Specified by:

findAggregations in interface IXServicePortIF

Parameters:

ci - ClientInfo

findInfo - Defines search and aggregation parameters.

Returns:

FindResult

Throws:

byps.RemoteException

findSearchTerms

public FindResult findSearchTerms(ClientInfo ci,
 FindInfo findInfo,
 int max)
                           throws byps.RemoteException

Description copied from interface: IXServicePortIF

Corrections and synonyms.

Specified by:

findSearchTerms in interface IXServicePortIF

Returns:

FindResult

Throws:

byps.RemoteException

findCompletion

public FindResult findCompletion(ClientInfo ci,
 FindInfo findInfo,
 int max)
                          throws byps.RemoteException

Description copied from interface: IXServicePortIF

Autocompletion/ Type as you search
Use CompletionOptions in findInfo.indByElastic.eSearchOptions.

Specified by:

findCompletion in interface IXServicePortIF

Parameters:

ci - ClientInfo object with language, country and ticket.

findInfo - Search criteria.

max - Maximum number of objects to return.

Returns:

FindResult

Throws:

byps.RemoteException

startWorkFlow2

public int startWorkFlow2(ClientInfo ci,
 String objId,
 StartWorkflowInfo startWorkflowInfo)
                   throws byps.RemoteException

Description copied from interface: IXServicePortIF

Starts a workflow from a workflow template.

Specified by:

startWorkFlow2 in interface IXServicePortIF

Parameters:

ci - ClientInfo object with language, country and ticket.

objId - ID of the object for which the workflow is started.

startWorkflowInfo - Parameter of this function

Returns:

workflow ID

Throws:

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

checkinUser

public int checkinUser(ClientInfo ci,
 UserInfo userInfo,
 CheckinUsersZ checkinUsersZ,
 LockZ unlockZ)
                throws byps.RemoteException

Description copied from interface: IXServicePortIF

Update or insert a user or group. This function internally calls IXServicePortIF.checkinUsers(ClientInfo, UserInfo[], CheckinUsersZ, LockZ) for one user object.

Specified by:

checkinUser in interface IXServicePortIF

Parameters:

ci - ClientInfo object with language, country and ticket

userInfo - User object or null if you only want to unlock.

checkinUsersZ - Combinations of CheckinUsersC values.

unlockZ - Unlock user data or force access.

Returns:

Updated or inserted user ID.

Throws:

byps.RemoteException

checkoutUser

public UserInfo checkoutUser(ClientInfo ci,
 String id,
 CheckoutUsersZ checkoutUsersZ,
 LockZ lockZ)
                      throws byps.RemoteException

Description copied from interface: IXServicePortIF

Reads the user data for a user or group. This function internally calls IXServicePortIF.checkoutUsers(ClientInfo, String[], CheckoutUsersZ, LockZ)

Specified by:

checkoutUser in interface IXServicePortIF

Parameters:

ci - ClientInfo object with language, country and ticket

id - User or group ID, GUID or name.

checkoutUsersZ - Controls the users or groups to retrieve.

lockZ - Lock user data.

Returns:

User data.

Throws:

byps.RemoteException

deleteUser

public void deleteUser(ClientInfo ci,
 String id,
 LockZ unlockZ)
                throws byps.RemoteException

Description copied from interface: IXServicePortIF

Deletes user or group.

Specified by:

deleteUser in interface IXServicePortIF

Parameters:

ci - ClientInfo object with language, country and ticket

id - User or group ID, GUID or name.

unlockZ - Unlock user data or force access.

Throws:

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

checkoutEsStatus

public ESStatusObj checkoutEsStatus(ClientInfo ci)
                             throws byps.RemoteException

Description copied from interface: IXServicePortIF

Checkout status of iSearch and updaters and reindexers, for ESConfigPage only.

Specified by:

checkoutEsStatus in interface IXServicePortIF

Parameters:

ci - - ClientInfo object with language, country and ticket.

Returns:

ESStatusObj

Throws:

byps.RemoteException

checkoutEsInfo

public ESInfoObj checkoutEsInfo(ClientInfo ci)
                         throws byps.RemoteException

Description copied from interface: IXServicePortIF

Check out the ElasticSearch informations for ESConfigPage only. Note: For internal use only. Might change in the near future.

Specified by:

checkoutEsInfo in interface IXServicePortIF

Parameters:

ci - - ClientInfo object with language, country and ticket.

Returns:

ESInfoObj

Throws:

byps.RemoteException

checkoutEsSettings

public ESSettingsObj checkoutEsSettings(ClientInfo ci)
                                 throws byps.RemoteException

Description copied from interface: IXServicePortIF

Check out the ElasticSearch settings for ESConfigPage only. Note: For internal use only. Might change in the near future.

Specified by:

checkoutEsSettings in interface IXServicePortIF

Parameters:

ci - ClientInfo object with language, country and ticket.

Returns:

ESSettingsObj

Throws:

byps.RemoteException

checkinEsSettings

public ESSettingsObj checkinEsSettings(ClientInfo ci,
 ESSettingsObj settings)
                                throws byps.RemoteException

Description copied from interface: IXServicePortIF

Check in ElasticSearch settings for ESConfigPage only. Note: For internal use only. Might change in the near future.

Specified by:

checkinEsSettings in interface IXServicePortIF

Parameters:

ci - ClientInfo object with language, country and ticket.

Throws:

byps.RemoteException

runEsProcess

public boolean runEsProcess(ClientInfo ci,
 String processName,
 boolean startProcess)
                     throws byps.RemoteException

Description copied from interface: IXServicePortIF

Run a iSearch process now (if it is not running) or interrupt it if its running.

Specified by:

runEsProcess in interface IXServicePortIF

Parameters:

ci - ClientInfo object with language, country and ticket.

processName - either "update" or "reindex"

startProcess - true if process should be started, false if process should be interrupted

Returns:

true if process was changes status was changes, else false

Throws:

byps.RemoteException

checkinSubstitutions

public SubstitutionsResult checkinSubstitutions(ClientInfo ci,
 CheckinSubstitutionsInfo checkinSubstitutionsInfo,
 SubstitutionZ substitutionZ,
 LockZ unlockZ)
                                         throws byps.RemoteException

Description copied from interface: IXServicePortIF

Insert new substitutions or update existing ones.

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

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

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

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

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

Specified by:

checkinSubstitutions in interface IXServicePortIF

Parameters:

ci - ClientInfo object with language, country and ticket.

checkinSubstitutionsInfo - Substitutions to be checked in

substitutionZ - Determines, which members of Substitution to save

unlockZ - unlock substitutions

Returns:

GUIDs of checked in substitutions in SubstitutionsResult.substitutionGuids, SubstitutionsResult.substitutions is empty.

Throws:

byps.RemoteException - If the current user is not allowed to checkin any of the provided substitutions, a IXExceptionC.ACCESS_DENIED exception is thrown and none are saved.

checkoutSubstitutions

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

Description copied from interface: IXServicePortIF

Checkout substitutions.

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

Every user is allowed to checkout any substitution.

Specified by:

checkoutSubstitutions in interface IXServicePortIF

Parameters:

ci - ClientInfo object with language, country and ticket.

checkoutSubstitutionsInfo - Define which substitutions should be returned.

substitutionZ - Determines, which members of Substitution to return

lockZ - Lock substitutions

Returns:

List of substitutions

Throws:

byps.RemoteException

deleteSubstitutions

public boolean deleteSubstitutions(ClientInfo ci,
 DeleteSubstitutionsInfo deleteSubstitutionsInfo,
 LockZ unlockZ)
                            throws byps.RemoteException

Description copied from interface: IXServicePortIF

Delete substitutions by its GUIDs.

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

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

Specified by:

deleteSubstitutions in interface IXServicePortIF

Parameters:

ci - ClientInfo object with language, country and ticket.

deleteSubstitutionsInfo - Determines which substitutions should be deleted

unlockZ - Unlock substitutions before deleting it. A substitution can only be deleted if it is unlocked or locked by the current user. LockC.FORCE can only be used by a user with main administrator rights.

Returns:

true if deleting was successful, false if not

Throws:

byps.RemoteException - If the current user is not allowed to delete any of the provided substitutions, a IXExceptionC.ACCESS_DENIED exception is thrown and none are deleted.

activateSubstitution

public boolean activateSubstitution(ClientInfo ci,
 String substituionGuid,
 LockZ unlockZ)
                             throws byps.RemoteException

Description copied from interface: IXServicePortIF

Activate the submitted substitution.

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

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

• The current user is the substitute (Substitution.substituteId
• The current user is member of the group who is the substitute
• The current user is sub administrator of the substitute
• The current user is the direct superior of the substitute (ignoring groups, UserInfo.superiorId of the substitute must be the current user)
• The current user has main administrator rights.

Specified by:

activateSubstitution in interface IXServicePortIF

Parameters:

ci - ClientInfo object with language, country and ticket.

substituionGuid - GUID of substitution to be activated

unlockZ - Unlock substitution before activating it. A substitution can only be activated if it is unlocked or locked by the current user. LockC.FORCE can only be used by a user with main administrator rights.

Returns:

true if activation was successful, else false

Throws:

byps.RemoteException -

• If the current user is not allowed to activate the provided substitution, a IXExceptionC.ACCESS_DENIED exception is thrown.
• If it is not possible to activate the provided substitution (the substitution is already activated or it is not allowed to activate the substitution manually) a IXExceptionC.PROHIBITED_OPERATION exception is thrown.

deactivateSubstitution

public boolean deactivateSubstitution(ClientInfo ci,
 String substituionGuid,
 LockZ unlockZ)
                               throws byps.RemoteException

Description copied from interface: IXServicePortIF

Deactivate the submitted substitution.

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

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

• The current user is the substitute (Substitution.substituteId
• The current user is member of the group who is the substitute
• The current user is sub administrator of the substitute
• The current user is the direct superior of the substitute (ignoring groups, UserInfo.superiorId of the substitute must be the current user)
• The current user has main administrator rights.

Specified by:

deactivateSubstitution in interface IXServicePortIF

Parameters:

ci - ClientInfo object with language, country and ticket.

substituionGuid - GUID of substitution to be deactivated

unlockZ - Unlock substitution before deactivating it. A substitution can only be deactived if it is unlocked or locked by the current user. LockC.FORCE can only be used by a user with main administrator rights.

Returns:

true if deactivation was successful, else false

Throws:

byps.RemoteException -

• If the current user is not allowed to deactivate the provided substitution, a IXExceptionC.ACCESS_DENIED exception is thrown.
• If it is not possible to deactivate the provided substitution (the substitution was not activated manually), a IXExceptionC.PROHIBITED_OPERATION exception is thrown.

createSuperiorSubstitution

public String createSuperiorSubstitution(ClientInfo ci,
 CreateSuperiorSubstitutionInfo createSuperiorSubstitutionInfo)
                                  throws byps.RemoteException

Description copied from interface: IXServicePortIF

Create a Substitution as a superior.

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

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

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

Specified by:

createSuperiorSubstitution in interface IXServicePortIF

Parameters:

ci - ClientInfo object with language, country and ticket.

createSuperiorSubstitutionInfo - Object to define the superior substitution

Returns:

created GUID of the created substitution

Throws:

byps.RemoteException - If the current user is not allowed to create the desired superior substitution, a IXExceptionC.ACCESS_DENIED exception is thrown.

forwardSubstitution

public String forwardSubstitution(ClientInfo ci,
 ForwardSubstitutionInfo forwardSubstitutionInfo,
 LockZ unlockZ)
                           throws byps.RemoteException

Description copied from interface: IXServicePortIF

Forward or transfer a substitution to an other user.

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

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

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

• The current user is the substitute (Substitution.substituteId
• The current user is member of the group who is the substitute
• The current user is sub administrator of the substitute
• The current user is the direct superior of the substitute (ignoring groups, UserInfo.superiorId of the substitute must be the current user)
• The current user has main administrator rights.

Specified by:

forwardSubstitution in interface IXServicePortIF

Parameters:

ci - ClientInfo object with language, country and ticket.

forwardSubstitutionInfo - Object to define how to forward the substitution

unlockZ - Unlock substitution before forwarding it. A substitution can only be forwarded if it is unlocked or locked by the current user. LockC.FORCE can only be used by a user with main administrator rights

Returns:

the GUID of the new substitution

Throws:

byps.RemoteException -

• IXExceptionC.ACCESS_DENIED if the current user is not allowed forward the substitution
• IXExceptionC.NOT_FOUND if the substitution does not exists or the new substitute does not exist
• IXExceptionC.PROHIBITED_OPERATION if the substitution cannot be forwarded

configureLicense

public License configureLicense(ClientInfo ci,
 String licenseData)
                         throws byps.RemoteException

Description copied from interface: IXServicePortIF

Read or update license information.

Specified by:

configureLicense in interface IXServicePortIF

Parameters:

ci - ClientInfo object with language, country and ticket.

licenseData - License file content. If null or empty, read current license information.

Returns:

Decoded license data.

Throws:

byps.RemoteException - IXExceptionC.INVALID_PARAM if license information is not valid.

computeDocumentHash

public ComputeDocumentHashResult computeDocumentHash(ClientInfo ci,
 ComputeDocumentHashInfo fileHashInfo)
                                              throws byps.RemoteException

Description copied from interface: IXServicePortIF

Compute the hash value of an archived document.

Specified by:

computeDocumentHash in interface IXServicePortIF

Parameters:

ci - ClientInfo object with language, country and ticket.

fileHashInfo - An object that defines the document ID.

Returns:

Computation result

Throws:

byps.RemoteException

checkoutColors2

public ColorData[] checkoutColors2(ClientInfo ci,
 int options,
 LockZ lockZ)
                            throws byps.RemoteException

Description copied from interface: IXServicePortIF

Checkout the markers definitions (colors of archive entries) for administration purposes. This function returns all colors, inclusive hidden and deleted colors.

Specified by:

checkoutColors2 in interface IXServicePortIF

Parameters:

ci - ClientInfo object with language, country and ticket

options - A combination of ColorDataC.INCLUSIVE_DELETED and ColorDataC.INCLUSIVE_HIDDEN. Pass ColorDataC.ALL_COLORS to receive all existing colors.

lockZ - Lock against concurrent modification.

Returns:

Array of Color objects sorted by name

Throws:

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

createAspect

public Aspect createAspect(ClientInfo ci,
 String name,
 List<AspectLine> lines)
                    throws byps.RemoteException

Description copied from interface: IXServicePortIF

Initialize an Aspect object. Note: The name and type of an aspect line is fixed with the initial value during the first check in and cannot be changed later.

Specified by:

createAspect in interface IXServicePortIF

Parameters:

ci - ClientInfo object with language, country and ticket.

name - Optional. This name is converted to upper case and used as aspect name.

lines - Optional. The objects of this list are completed with default values before they and are added to Aspect.lines in the returned object.

Returns:

Initialized object.

Throws:

byps.RemoteException

checkoutAspect

public Aspect checkoutAspect(ClientInfo ci,
 String aspectId,
 AspectZ aspectZ,
 LockZ lockZ)
                      throws byps.RemoteException

Description copied from interface: IXServicePortIF

Read and maybe lock an Aspect object. An exception is thrown, if access is denied or if the aspect does not exist.

Specified by:

checkoutAspect in interface IXServicePortIF

Parameters:

ci - ClientInfo object with language, country and ticket.

aspectId - Numeric ID, GUID or name of the aspect to read.

aspectZ - Members to be read.

lockZ - Lock mode.

Returns:

Aspect object.

Throws:

byps.RemoteException

checkoutAspects

public List<Aspect> checkoutAspects(ClientInfo ci,
 List<String> aspectIds,
 AspectZ aspectZ,
 LockZ lockZ)
                             throws byps.RemoteException

Description copied from interface: IXServicePortIF

Read and maybe lock a list of Aspect objects (EIX-2437). An exception is thrown, if access is denied or if one of the aspects does not exist.

Specified by:

checkoutAspects in interface IXServicePortIF

Parameters:

ci - ClientInfo object with language, country and ticket.

aspectIds - List of numeric IDs, GUIDs or names of the aspects to read.

aspectZ - Members to be read.

lockZ - Lock mode.

Returns:

List of Aspect objects.

Throws:

byps.RemoteException

checkinAspect

public int checkinAspect(ClientInfo ci,
 Aspect aspect,
 AspectZ aspectZ,
 LockZ lockZ)
                  throws byps.RemoteException

Description copied from interface: IXServicePortIF

Update or insert an Aspect object. This function requires permission AccessC.FLAG_EDITMASK. An exception is thrown, if access is denied or if the aspect does not exist. Note: The name and type of an aspect line is fixed with the initial value during the first check in and cannot be changed later.

Specified by:

checkinAspect in interface IXServicePortIF

Parameters:

ci - ClientInfo object with language, country and ticket.

aspect - Aspect object.

aspectZ - Members to be written.

lockZ - Remove lock using this mode.

Returns:

Aspect ID

Throws:

byps.RemoteException

deleteAspect

public boolean deleteAspect(ClientInfo ci,
 String aspectId,
 LockZ lockZ)
                     throws byps.RemoteException

Description copied from interface: IXServicePortIF

Delete an Aspect object. This function requires permission AccessC.FLAG_EDITMASK. An exception is thrown, if access is denied or if the aspect does not exist.

Specified by:

deleteAspect in interface IXServicePortIF

Parameters:

ci - ClientInfo object with language, country and ticket.

aspectId - Numeric ID, GUID or name of the aspect to read.

lockZ - Remove lock using this mode.

Returns:

If aspect not found the return value is false.

Throws:

byps.RemoteException

createAspectMask

public DocMask createAspectMask(ClientInfo ci,
 String name,
 List<AspectAssoc> aspectAssocs)
                         throws byps.RemoteException

Description copied from interface: IXServicePortIF

Initializes a DocMask object as a keywording form for aspects. Use IXServicePortIF.checkinDocMask(ClientInfo, DocMask, DocMaskZ, LockZ) to store the keywording form in the database. Note that the name of an aspect association can be set only initially. Aspect associations cannot be renamed via checkinDocMask.

Specified by:

createAspectMask in interface IXServicePortIF

Parameters:

ci - ClientInfo object with language, country and ticket.

name - Keywording form name.

aspectAssocs - Aspect associations. This objects are completed by default values and added to DocMask.localAspectAssocs in the returned object.

Returns:

DocMask object.

Throws:

byps.RemoteException

createAspectAssoc

public AspectAssoc createAspectAssoc(ClientInfo ci,
 String name,
 String aspectId,
 Cardinality cardinality)
                              throws byps.RemoteException

Description copied from interface: IXServicePortIF

Initializes an AspectAssoc object. All parameters are mandatory.

Specified by:

createAspectAssoc in interface IXServicePortIF

Parameters:

ci - ClientInfo object with language, country and ticket.

name - Aspect association name.

aspectId - Aspect name or ID.

cardinality - Aspect cardinality.

Returns:

AspectAssoc object.

Throws:

byps.RemoteException