Package com.saperion.connector.rmi

Interface SaRMIClientCommand

    • Method Summary

      All Methods Instance Methods Abstract Methods Default Methods Deprecated Methods 
      Modifier and Type Method Description
      void addComment​(java.lang.String comment, java.lang.String taskUID, int level)  
      void addHistory​(java.lang.String description, java.lang.String taskUID)  
      void addToFolder​(java.lang.String folderTableDDC, java.lang.String documentId, java.lang.String documentDDC, java.lang.String folderId)
      Adds the document to a given folder.
      SaSaveInfo cacheDocument​(boolean isNew, int commitMode, java.lang.String versionComment, java.lang.String xhDoc, java.lang.String ddcName, java.lang.String acls)
      Stores the actual document to the backend.
      void changePassword​(java.lang.String user, java.lang.String oldPassword, java.lang.String client, java.lang.String newPassword)
      Changes the password of an existing user.
      void checkoutDocument​(java.lang.String hDoc)
      Checkout the given document.
      SapDocInfo checkSapUrl​(java.lang.String url)
      Checks the given SAP URL on the R/Link server and returns, if successfull, the HDOC and the DDC.
      void clearContent()
      Clears all content of the opened document.
      void closeDocument​(com.saperion.jni.SaJNIDocHandle handle)
      Manually closing of a open document.
      boolean closeSession​(com.saperion.connector.authentication.Session session)
      Close the given Session
      java.lang.String copyFolder​(java.lang.String folderTableDDC, java.lang.String folderId, java.lang.String destinationId, java.lang.String beforeChild, boolean withDocuments)
      Copies the given node and all it’s children to the destination.
      SaSaveInfo createDocument​(java.lang.String ddcName, java.util.List<SaPropertyValue> values)
      Creates a new document with the given parameters.
      java.lang.String createFolder​(SaFolderSaveInfo info)
      Creates a new node below a given node.
      SaSaveInfo createLink​(LinkInfo link)
      Creates a SAPERION Link into one Archive for an existing Document.
      SaSaveInfo deleteDocument​(int mode, java.lang.String hdoc)
      Delete a document.
      void deleteFolder​(java.lang.String folderTableDDC, java.lang.String folderId)
      Deletes a given node.
      boolean deleteSetting​(java.lang.String name, java.lang.String section, boolean isLong)
      Deletes a setting in the database.
      void discardDocument()
      Discards the document identified by the tokens handle.
      void dsicardCheckout​(java.lang.String hDoc)
      Discards the checkout of the given document.
      java.lang.String executeCommand​(ContextInfo contextInfo)
      Performs the given command.
      void finishSQLTransaction​(boolean commit, java.lang.String ddcName)
      Finish SQL transaction.
      void finishTransaction​(boolean commit)
      Finish the transaction in the backend system.
      java.lang.String getACLNames​(java.lang.String hDoc)
      Reads the ACL's for the given document.
      SaACLRights getACLRights​(java.lang.String[] acls)
      Reads the rights for the given acl's.
      java.util.List<SaAcl> getAcls()
      Reads all existing ACLs.
      java.util.List<java.lang.String> getAllACLs()
      Deprecated.
      java.lang.String getAnnotations​(java.lang.String hDoc, int indexOfContentElement, boolean currentRevision)
      Reads the annotations from the given document.
      int getArchivedSize​(java.lang.String hDoc)
      Returns the total document size in archive.
      java.util.List<UsersRights> getAuthorizedUsers​(java.lang.String hDoc, java.lang.String rights, MatchKind match)
      Returns the users, that have specific rights on a document.
      BoxCount getBoxCount​(int boxId, BoxCountType type, java.util.Map<java.lang.String,​java.lang.Object> parameters)
      Returns the number of all elements and of all unread elements of the inbox identified by the given id.
      java.util.List<BoxDefinition> getBoxDefinitions()
      Reads the box definitions.
      java.util.Collection<CommandInfo> getCommandInfos​(java.lang.String taskUID)
      Reads all possible transitions for this task.
      java.util.Collection<CommandInfo> getCommandInfos​(java.lang.String taskUID, boolean transitionsOnly)
      Reads all possible transitions and optional other possible commands for this task.
      java.util.List<CommentInfo> getCommentInfos​(java.lang.String taskUID)
      Reads the comments for the given task.
      int getCommitMode()  
      java.util.List<java.util.List<HistoryInfo>> getCompleteHistoryInfos​(java.lang.String docUID)
      Reads the history for the given task.
      com.lexmark.saperion.administration.RoleType getCurrentUserRole()  
      DDC getDDC​(java.lang.String ddcName)
      Returns information about the specified DDC.
      int getDeleteMode()  
      long getDocumentFolderCount​(java.lang.String folderTableDDC, java.lang.String documentDDC, java.lang.String sysRowId)
      Returns the total count over all folders from all users in which the specified document is countained in.
      java.util.List<SaDocumentInfo> getDocumentFolders​(java.lang.String folderTableDDC, java.lang.String documentDDC, java.lang.String sysRowId)
      Returns a list of folder properties which contains all nodes the document is contained in.
      boolean getEventsEnabled()
      Returns whether events (e.g.
      SaFeature getFeatures()
      Read the features.
      SaFieldDescription[] getFieldDescriptions​(java.lang.String ddcName)
      Reads the field descriptions for a given DDC.
      SaFieldDescription[] getFieldDescriptions​(java.lang.String ddcName, java.lang.String mandant)
      Reads the field descriptions for a given DDC.
      java.util.List<SaDocumentInfo> getFolderChildren​(java.lang.String folderTableDDC, java.lang.String folderId, int depth, SaQueryInfo filter, int allowedMaxNrOfChildFolders)
      Returns a cursor with the children of the given node.
      SaFolderClass getFolderClass​(java.lang.String className)
      Reads the folder class with the given name.
      java.util.List<SaDocumentInfo> getFolderFromPath​(java.lang.String folderTableDDC, java.lang.String startNodeId, java.lang.String folderPath, boolean exact)
      Returns the node(s) which match to the given path.
      SaDocumentInfo getFolderInfo​(java.lang.String folderTableDDC, java.lang.String folderId, boolean forceLoadVariables)
      Reads the folder info object for the given folder.
      SaDocumentInfo getFolderParent​(java.lang.String folderTableDDC, java.lang.String folderId)
      Returns the parent of the given node.
      SaDocAccessData getFolderRights​(java.lang.String folderTableDDC, java.lang.String folderId)
      Returns the rights mask for the given folder and user.
      java.util.Set<FolderUpdateInfo> getFolderUpdateInfo​(java.util.Map<java.lang.String,​java.lang.Long> folderIds)
      Get the Set of folders that shall be refreshed.
      java.lang.String getFulltext​(java.lang.String ddcName, java.lang.String sysRowId, java.lang.String hdoc, java.lang.String fieldName, long length)
      Reads the fulltext information for the given document with the given SYSROWID in the given DDC.
      java.util.Set<java.util.Map.Entry<java.lang.String,​java.lang.String>> getFullTextFields​(java.lang.String ddcName, java.util.List<java.lang.String> fullTextFields, java.lang.String hdoc)
      Fetches values of Full text columns
      java.lang.String getHDocForSysRowId​(java.lang.String sysRowId, java.lang.String ddcName)
      Searchs the HDOC for the given SysRowId.
      java.util.List<HistoryInfo> getHistoryInfos​(java.lang.String taskUID)
      Reads the history for the given task.
      java.util.List<java.lang.String> getIdsFromQuery​(java.lang.String query)
      Executes a HQL query and returns the results as a string list.
      java.util.List<java.lang.String> getInvolvedUsers​(java.lang.String hDoc)
      Reads all users involved in the set of ACL's.
      int getLicenseCount​(int type)
      Read the licence count for the given user.
      SaLockInfo getLockInfo​(java.lang.String sysRowId)
      Gets the lock info for a given node.
      java.util.List<java.lang.String> getLocks​(java.lang.String ddcName)
      Reads all locks from the given DDC.
      java.util.List<java.lang.String> getLocks​(java.lang.String ddcName, java.lang.String mandant)
      Reads all locks from the given DDC.
      java.lang.String getMandant()  
      WorkflowMember getMember​(WorkflowMember member, int depth, java.lang.String filter)
      Reads the member.
      WorkflowMember getMembers()
      Reads the member.
      com.saperion.jni.SaJNIDocAccessData getNodeAccessData​(java.lang.String hdoc)
      Opens the document identified by hdoc and returns an object containing all access right data information for the session user.
      boolean getOutOfOffice()
      Get the out of office status for the logged on user.
      TaskInfo getParentTask​(java.lang.String taskID)
      Reads the parent task info for the given ID.
      java.lang.String getRealDBName​(java.lang.String ddcName, java.lang.String field, java.lang.String mandant)
      returns the real database table name for a given DDC.
      java.lang.String getRMIVersion()
      Get the RMI interface version from java core server.
      java.util.List<SaRMIServerInfo> getServerInfos()
      Returns a list of objects describing the servers this connector is connected to.
      com.saperion.connector.authentication.Session getSession()  
      Setting getSetting​(java.lang.String name, java.lang.String section, boolean isLong)
      Retrieves a setting from the database.
      java.util.List<SaDocumentInfo> getStringQueryResult​(SaQueryInfo queryInfo)
      Executes a given HQL string and returns the results as list.
      java.lang.String getSubstitute()
      Get the substitute for the logged on user.
      SaRMISystemConnector getSystemConnector()  
      java.util.List<java.lang.String> getSystemFiles​(SystemFileKind kind, java.lang.String filter)
      Gets the system files of a specific kind.
      SaSystemInfo getSystemInfo()
      Reads system info.
      SaSystemSetting getSystemSetting​(java.lang.String accessKey)
      Retrieves a system setting object.
      TaskInfo getTask​(java.lang.String taskID)
      Reads the task info for the given ID.
      java.util.List<TaskAuditInfo> getTaskAuditList​(int[] ids, java.lang.String filter, java.util.Map<java.lang.String,​java.lang.Object> parameter)
      Reads the task audit for this user.
      java.util.List<TaskInfo> getTaskList​(int[] ids, java.lang.String filter, java.util.Map<java.lang.String,​java.lang.Object> parameter)
      Reads the task for this user.
      byte[] getThumbnail​(java.lang.String hDoc, int widthX, int widthY, boolean color)
      Reads the thumbnail of the given document.
      int getToken()  
      int[] getUserIdsForQuery()
      Read the userids.
      java.util.List<java.lang.String> getUsers​(java.lang.String filter)
      Reads a list of filtered users.
      SaUserSetting getUserSetting​(java.lang.String accessKey)
      Retrieves a user setting object.
      java.util.List<java.lang.String> getVersionList​(java.lang.String ddcName, java.lang.String sysrowID)
      Reads the versionlist for the given document.
      java.util.List<java.lang.String> getWorkflowDefinitions()
      Reads all available workflow definitions.
      <T extends java.io.Serializable>
      T      		 invoke​(com.lexmark.saperion.remote.common.operations.Operation<T,​SaBasicException,​LegacyConnection> operation)
      This method invokes a Operation on the backend.
      boolean isAlive()
      Test the lifetime of this token.
      boolean isRevisionEnabled​(int mandant, java.lang.String ddcName)
      Gets the information whether the provided ddc table contains the fields required for revisions.
      java.util.List<com.saperion.connector.authentication.Session> listActiveSessions()
      List the active sessions of the logged in user.
      java.lang.String[] loadDDCNames()
      Retrieves the available DDC names.
      java.lang.String[] loadFolderDDCNames()
      Retrieves the available folder DDC names.
      java.util.Properties loadSettings​(java.lang.String section)
      Load settings from backend.
      java.io.InputStream loadSystemFile​(SystemFileKind kind, java.lang.String name)
      Loads a system file of a specific kind.
      java.lang.String loadWorkflowDDCName()
      Retrieves the workflow DDC name.
      boolean lockNode​(java.lang.String sysRowId, java.lang.String ddcName, int lockType, boolean sessionScoped)
      Locks a node.
      void logClientEvent​(java.lang.String hdoc, SaConstants.ProtoEvents event, java.lang.String remark)
      Adds an audit log event.
      boolean logoff()
      Log off the user from the server instance.
      default com.saperion.connector.authentication.Session logon​(int rmiToken)
      Deprecated.
      com.saperion.connector.authentication.Session logon​(com.lexmark.saperion.remote.common.authentication.Credentials credentials)
      Logon with the passed credentials.
      com.saperion.connector.authentication.Session logon​(com.lexmark.saperion.remote.common.authentication.Credentials credentials, com.saperion.connector.authentication.SessionInfo sessionInfo)
      Logon with the passed credentials and associate the given session information.
      void moveFolder​(java.lang.String folderTableDDC, java.lang.String folderId, java.lang.String destinationId, java.lang.String beforeChild)
      Moves the given node to a new destination.
      void moveToFolder​(java.lang.String folderTableDDC, java.lang.String documentId, java.lang.String documentDDC, java.lang.String folderId, java.lang.String destinationId)
      Moves the document’s filing to the given node.
      <ResultType extends java.io.Serializable,​ExceptionType extends com.lexmark.saperion.exceptions.EcmException>
      ResultType      		 newInvoke​(com.lexmark.saperion.remote.common.operations.EcmOperation<ResultType,​ExceptionType> operation)
      This method invokes a EcmOperation in the backend.
      com.saperion.jni.SaJNIReadBuffer readDocumentFirst​(java.lang.String hdoc, boolean currentRevision, int element)
      Opens an existing document with the given hdoc and returns a document handle for the specified element (= sub-document) as well as the buffer containing the content data of the element.
      com.saperion.jni.SaJNIReadBuffer readDocumentFirst​(java.lang.String hdoc, boolean currentRevision, int element, boolean withAnnotations)
      Opens an existing document with the given hdoc and returns a document handle for the specified element (= sub-document) as well as the buffer containing the content data of the element.
      SaPropertyValue[] readDocumentMetadata​(java.lang.String sysRowId, java.lang.String ddcName, java.lang.String[] fields)
      Reads the meta data of the document with the given ID.
      com.saperion.jni.SaJNIReadBuffer readDocumentNext​(com.saperion.jni.SaJNIDocHandle handle)
      Reads the next bytes from the open document, described in the handle.
      SaVersionData readVersionMetadata​(java.lang.String versionID)
      Reads the version meta data of the document with the given ID.
      SaVersionData readVersionMetadata​(java.lang.String versionID, boolean resolveLinks)
      Reads the version meta data of the document with the given ID.
      void releaseDocument​(java.lang.String hDoc, java.lang.String comment)
      Release the given document.
      void removeElement​(int element)
      Removes a existing content element.
      void removeElement​(java.lang.Integer[] elements)
      Removes a series of existing content elements.
      void removeFromFolder​(java.lang.String folderTableDDC, java.lang.String documentSysRowId, java.lang.String documentDDC, java.lang.String folderId)
      Remove the document filing from the given node.
      java.lang.String resolveLatestHdoc​(java.lang.String oldHdoc)
      Resolves the hdoc of the latest version of the document identified by the given hdoc.
      SaSaveInfo restoreVersion​(java.lang.String versionID)
      Restores the given version to the actual version.
      SaSaveInfo saveDocument​(java.lang.String nodeHdoc, java.lang.String ddcName, java.util.List<SaPropertyValue> values)
      Saves the document paramaters to the document.
      SaSaveInfo saveDocument​(java.lang.String nodeHdoc, java.lang.String ddcName, java.util.List<SaPropertyValue> values, boolean resolveLinks)
      Saves the document paramaters to the document.
      java.util.Set<SaFolderClass> searchFolderClass​(SaFolderClassSearchInfo searchInfo)
      Searches for folder classes with the specified properties.
      java.util.List<SaDocumentInfo> searchFolderDocuments​(java.lang.String folderTableDDC, java.lang.String folderId, SaQueryInfo hqlFilter)
      HQL search extended with additional folder informations and depth.
      SettingSearchResult searchSettings​(SettingSearchInfo searchInfo)
      Searches for settings.
      void sendBarcode​(java.lang.String indexMask, java.lang.String docUid, java.lang.String contentRep, java.lang.String sid, java.lang.String docType, java.lang.String value, int mandant)
      Send barcode to SAP.
      SaSaveInfo setACLName​(java.lang.String ddcname, java.lang.String hDoc, java.lang.String acl, int commitMode, java.lang.String versionComment)
      Sets the given ACL to the node.
      void setAnnotations​(java.lang.String hDoc, int indexOfContentElement, java.lang.String annotations)
      Sets the given annotations to the document.
      void setElementMark​(int element)
      Mark the content element.
      void setEventsEnabled​(boolean enabled)
      Sets whether events (e.g.
      void setFolderAcl​(java.lang.String folderTableDDC, java.lang.String folderId, java.lang.String aclName)
      Sets an ACL for the given folder.
      void setLocale​(java.util.Locale local)
      Set the locale for localization.
      void setOutOfOffice​(boolean isOutOfOffice)
      Set the out of office status for the logged on user.
      void setSetting​(Setting setting)
      Persists a setting in the database.
      void setSubstitute​(java.lang.String name)
      Set the substitute for the logged on user.
      boolean setUsedLicense​(int type, int count)
      Set the count of used licenses.
      void setUserSetting​(SaUserSetting setting)
      Persists a user setting object.
      void setVariables​(int element, java.util.Map<java.lang.String,​java.lang.String> variables)
      Method to set the Variables for an Content-Object or the Structure itself.
      void startSQLTransaction​(java.lang.String ddcName)
      Start SQL transaction.
      void startTransaction()
      Starts a transaction in the backend system.
      SaSaveInfo storeDocument​(boolean isNew, int commitMode, java.lang.String versionComment, java.lang.String ddcName, java.lang.String acls)
      Stores the actual document to the backend.
      SaSaveInfo storeDocument​(boolean isNew, int commitMode, java.lang.String versionComment, java.lang.String ddcName, java.lang.String acls, boolean checkin)
      Stores the actual document to the backend.
      void storeSystemFile​(SystemFileKind kind, java.lang.String name, java.io.InputStream data)
      Stores a system file of a specific kind.
      boolean unlockNode​(java.lang.String sysRowId, java.lang.String ddcName)
      Unlocks a node.
      void updateFolder​(java.lang.String folderTableDDC, java.lang.String folderId, java.util.List<SaPropertyValue> values)
      Updates a given node with the given properties.
      long writeContent​(ContentStream contentStream)
      Writes the content of the document.
      long writeContent​(java.io.InputStream stream)
      Writes the content of the document.
      long writeContent​(java.io.InputStream stream, java.lang.String fileName, int element)  
      long writeContent​(java.io.InputStream stream, java.lang.String fileName, int element, boolean doStreaming)
      Writes the content of the document.
      If the document size is less than SaConstants.JNI_BUFFER_SIZE than the default buffer size will be reduced and only one JNI call is initiated.