SaRMIClientCommand (JCS Classic Connector Module 8.2.0-0 API)

All Known Implementing Classes:

AbstractDocRMIClientCommand, AbstractFolderRMIClientCommand, AbstractQueryRMIClientCommand, AbstractRMIClientCommand, AbstractWfRMIClientCommand, SaRMIClientCommandImpl
```
public interface SaRMIClientCommand
```
The interface for the RMI Client.

Method Summary

All Methods Instance Methods Abstract Methods Default Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`addComment(String comment, String taskUID, int level)`
`void`	`addHistory(String description, String taskUID)`
`void`	`addToFolder(String folderTableDDC, String documentId, String documentDDC, String folderId)` Adds the document to a given folder.
`SaSaveInfo`	`cacheDocument(boolean isNew, int commitMode, String versionComment, String xhDoc, String ddcName, String acls)` Stores the actual document to the backend.
`void`	`changePassword(String user, String oldPassword, String client, String newPassword)` Changes the password of an existing user.
`void`	`checkoutDocument(String hDoc)` Checkout the given document.
`SapDocInfo`	`checkSapUrl(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`
`String`	`copyFolder(String folderTableDDC, String folderId, String destinationId, String beforeChild, boolean withDocuments)` Copies the given node and all it’s children to the destination.
`SaSaveInfo`	`createDocument(String ddcName, List<SaPropertyValue> values)` Creates a new document with the given parameters.
`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, String hdoc)` Delete a document.
`void`	`deleteFolder(String folderTableDDC, String folderId)` Deletes a given node.
`boolean`	`deleteSetting(String name, String section, boolean isLong)` Deletes a setting in the database.
`void`	`discardDocument()` Discards the document identified by the tokens handle.
`void`	`dsicardCheckout(String hDoc)` Discards the checkout of the given document.
`String`	`executeCommand(ContextInfo contextInfo)` Performs the given command.
`void`	`finishSQLTransaction(boolean commit, String ddcName)` Finish SQL transaction.
`void`	`finishTransaction(boolean commit)` Finish the transaction in the backend system.
`String`	`getACLNames(String hDoc)` Reads the ACL's for the given document.
`SaACLRights`	`getACLRights(String[] acls)` Reads the rights for the given acl's.
`List<SaAcl>`	`getAcls()` Reads all existing ACLs.
`List<String>`	`getAllACLs()` Deprecated.
`String`	`getAnnotations(String hDoc, int indexOfContentElement, boolean currentRevision)` Reads the annotations from the given document.
`int`	`getArchivedSize(String hDoc)` Returns the total document size in archive.
`List<UsersRights>`	`getAuthorizedUsers(String hDoc, String rights, MatchKind match)` Returns the users, that have specific rights on a document.
`BoxCount`	`getBoxCount(int boxId, BoxCountType type, Map<String,Object> parameters)` Returns the number of all elements and of all unread elements of the inbox identified by the given id.
`List<BoxDefinition>`	`getBoxDefinitions()` Reads the box definitions.
`Collection<CommandInfo>`	`getCommandInfos(String taskUID)` Reads all possible transitions for this task.
`Collection<CommandInfo>`	`getCommandInfos(String taskUID, boolean transitionsOnly)` Reads all possible transitions and optional other possible commands for this task.
`List<CommentInfo>`	`getCommentInfos(String taskUID)` Reads the comments for the given task.
`int`	`getCommitMode()`
`List<List<HistoryInfo>>`	`getCompleteHistoryInfos(String docUID)` Reads the history for the given task.
`DDC`	`getDDC(String ddcName)` Returns information about the specified DDC.
`int`	`getDeleteMode()`
`long`	`getDocumentFolderCount(String folderTableDDC, String documentDDC, String sysRowId)` Returns the total count over all folders from all users in which the specified document is countained in.
`List<SaDocumentInfo>`	`getDocumentFolders(String folderTableDDC, String documentDDC, 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(String ddcName)` Reads the field descriptions for a given DDC.
`SaFieldDescription[]`	`getFieldDescriptions(String ddcName, String mandant)` Reads the field descriptions for a given DDC.
`List<SaDocumentInfo>`	`getFolderChildren(String folderTableDDC, String folderId, int depth, SaQueryInfo filter, int allowedMaxNrOfChildFolders)` Returns a cursor with the children of the given node.
`SaFolderClass`	`getFolderClass(String className)` Reads the folder class with the given name.
`List<SaDocumentInfo>`	`getFolderFromPath(String folderTableDDC, String startNodeId, String folderPath, boolean exact)` Returns the node(s) which match to the given path.
`SaDocumentInfo`	`getFolderInfo(String folderTableDDC, String folderId, boolean forceLoadVariables)` Reads the folder info object for the given folder.
`SaDocumentInfo`	`getFolderParent(String folderTableDDC, String folderId)` Returns the parent of the given node.
`SaDocAccessData`	`getFolderRights(String folderTableDDC, String folderId)` Returns the rights mask for the given folder and user.
`Set<FolderUpdateInfo>`	`getFolderUpdateInfo(Map<String,Long> folderIds)` Get the Set of folders that shall be refreshed.
`String`	`getFulltext(String ddcName, String sysRowId, String hdoc, String fieldName, long length)` Reads the fulltext information for the given document with the given SYSROWID in the given DDC.
`Set<Map.Entry<String,String>>`	`getFullTextFields(String ddcName, List<String> fullTextFields, String hdoc)` Fetches values of Full text columns
`String`	`getHDocForSysRowId(String sysRowId, String ddcName)` Searchs the HDOC for the given SysRowId.
`List<HistoryInfo>`	`getHistoryInfos(String taskUID)` Reads the history for the given task.
`List<String>`	`getIdsFromQuery(String query)` Executes a HQL query and returns the results as a string list.
`List<String>`	`getInvolvedUsers(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(String sysRowId)` Gets the lock info for a given node.
`List<String>`	`getLocks(String ddcName)` Reads all locks from the given DDC.
`List<String>`	`getLocks(String ddcName, String mandant)` Reads all locks from the given DDC.
`String`	`getMandant()`
`WorkflowMember`	`getMember(WorkflowMember member, int depth, String filter)` Reads the member.
`WorkflowMember`	`getMembers()` Reads the member.
`com.saperion.jni.SaJNIDocAccessData`	`getNodeAccessData(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(String taskID)` Reads the parent task info for the given ID.
`String`	`getRealDBName(String ddcName, String field, String mandant)` returns the real database table name for a given DDC.
`String`	`getRMIVersion()` Get the RMI interface version from java core server.
`List<SaRMIServerInfo>`	`getServerInfos()` Returns a list of objects describing the servers this connector is connected to.
`com.saperion.connector.authentication.Session`	`getSession()`
`Setting`	`getSetting(String name, String section, boolean isLong)` Retrieves a setting from the database.
`List<SaDocumentInfo>`	`getStringQueryResult(SaQueryInfo queryInfo)` Executes a given HQL string and returns the results as list.
`String`	`getSubstitute()` Get the substitute for the logged on user.
`SaRMISystemConnector`	`getSystemConnector()`
`List<String>`	`getSystemFiles(SystemFileKind kind, String filter)` Gets the system files of a specific kind.
`SaSystemInfo`	`getSystemInfo()` Reads system info.
`SaSystemSetting`	`getSystemSetting(String accessKey)` Retrieves a system setting object.
`TaskInfo`	`getTask(String taskID)` Reads the task info for the given ID.
`List<TaskAuditInfo>`	`getTaskAuditList(int[] ids, String filter, Map<String,Object> parameter)` Reads the task audit for this user.
`List<TaskInfo>`	`getTaskList(int[] ids, String filter, Map<String,Object> parameter)` Reads the task for this user.
`byte[]`	`getThumbnail(String hDoc, int widthX, int widthY, boolean color)` Reads the thumbnail of the given document.
`int`	`getToken()`
`int[]`	`getUserIdsForQuery()` Read the userids.
`List<String>`	`getUsers(String filter)` Reads a list of filtered users.
`SaUserSetting`	`getUserSetting(String accessKey)` Retrieves a user setting object.
`List<String>`	`getVersionList(String ddcName, String sysrowID)` Reads the versionlist for the given document.
`List<String>`	`getWorkflowDefinitions()` Reads all available workflow definitions.
`<T extends 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, String ddcName)` Gets the information whether the provided ddc table contains the fields required for revisions.
`List<com.saperion.connector.authentication.Session>`	`listActiveSessions()` List the active sessions of the logged in user.
`String[]`	`loadDDCNames()` Retrieves the available DDC names.
`String[]`	`loadFolderDDCNames()` Retrieves the available folder DDC names.
`Properties`	`loadSettings(String section)` Load settings from backend.
`InputStream`	`loadSystemFile(SystemFileKind kind, String name)` Loads a system file of a specific kind.
`String`	`loadWorkflowDDCName()` Retrieves the workflow DDC name.
`boolean`	`lockNode(String sysRowId, String ddcName, int lockType, boolean sessionScoped)` Locks a node.
`void`	`logClientEvent(String hdoc, SaConstants.ProtoEvents event, String remark)` Adds an audit log event.
`boolean`	`logoff()` Log off the user from the server instance.
`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.
`default com.saperion.connector.authentication.Session`	`logon(int rmiToken)` Deprecated.
`void`	`moveFolder(String folderTableDDC, String folderId, String destinationId, String beforeChild)` Moves the given node to a new destination.
`void`	`moveToFolder(String folderTableDDC, String documentId, String documentDDC, String folderId, String destinationId)` Moves the document’s filing to the given node.
`<ResultType extends 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(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(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(String sysRowId, String ddcName, 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(String versionID)` Reads the version meta data of the document with the given ID.
`SaVersionData`	`readVersionMetadata(String versionID, boolean resolveLinks)` Reads the version meta data of the document with the given ID.
`void`	`releaseDocument(String hDoc, String comment)` Release the given document.
`void`	`removeElement(int element)` Removes a existing content element.
`void`	`removeElement(Integer[] elements)` Removes a series of existing content elements.
`void`	`removeFromFolder(String folderTableDDC, String documentSysRowId, String documentDDC, String folderId)` Remove the document filing from the given node.
`String`	`resolveLatestHdoc(String oldHdoc)` Resolves the hdoc of the latest version of the document identified by the given hdoc.
`SaSaveInfo`	`restoreVersion(String versionID)` Restores the given version to the actual version.
`SaSaveInfo`	`saveDocument(String nodeHdoc, String ddcName, List<SaPropertyValue> values)` Saves the document paramaters to the document.
`SaSaveInfo`	`saveDocument(String nodeHdoc, String ddcName, List<SaPropertyValue> values, boolean resolveLinks)` Saves the document paramaters to the document.
`Set<SaFolderClass>`	`searchFolderClass(SaFolderClassSearchInfo searchInfo)` Searches for folder classes with the specified properties.
`List<SaDocumentInfo>`	`searchFolderDocuments(String folderTableDDC, String folderId, SaQueryInfo hqlFilter)` HQL search extended with additional folder informations and depth.
`SettingSearchResult`	`searchSettings(SettingSearchInfo searchInfo)` Searches for settings.
`void`	`sendBarcode(String indexMask, String docUid, String contentRep, String sid, String docType, String value, int mandant)` Send barcode to SAP.
`SaSaveInfo`	`setACLName(String ddcname, String hDoc, String acl, int commitMode, String versionComment)` Sets the given ACL to the node.
`void`	`setAnnotations(String hDoc, int indexOfContentElement, 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(String folderTableDDC, String folderId, String aclName)` Sets an ACL for the given folder.
`void`	`setLocale(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(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, Map<String,String> variables)` Method to set the Variables for an Content-Object or the Structure itself.
`void`	`startSQLTransaction(String ddcName)` Start SQL transaction.
`void`	`startTransaction()` Starts a transaction in the backend system.
`SaSaveInfo`	`storeDocument(boolean isNew, int commitMode, String versionComment, String ddcName, String acls)` Stores the actual document to the backend.
`SaSaveInfo`	`storeDocument(boolean isNew, int commitMode, String versionComment, String ddcName, String acls, boolean checkin)` Stores the actual document to the backend.
`void`	`storeSystemFile(SystemFileKind kind, String name, InputStream data)` Stores a system file of a specific kind.
`boolean`	`unlockNode(String sysRowId, String ddcName)` Unlocks a node.
`void`	`updateFolder(String folderTableDDC, String folderId, List<SaPropertyValue> values)` Updates a given node with the given properties.
`long`	`writeContent(ContentStream contentStream)` Writes the content of the document.
`long`	`writeContent(InputStream stream)` Writes the content of the document.
`long`	`writeContent(InputStream stream, String fileName, int element)`
`long`	`writeContent(InputStream stream, 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.

- Method Detail
  - logon
```
com.saperion.connector.authentication.Session logon(com.lexmark.saperion.remote.common.authentication.Credentials credentials)
                                             throws SaSystemException,
                                                    SaAuthenticationException
```
    Logon with the passed credentials.
    
    Parameters:
    
    credentials - credentials which should be used for logon
    
    Returns:
    
    Session which holds all information about the created session
    
    Throws:
    
    SaSystemException - SaRMICommandException
    
    SaAuthenticationException - SaAuthenticationException
  - logon
```
com.saperion.connector.authentication.Session logon(com.lexmark.saperion.remote.common.authentication.Credentials credentials,
                                                    com.saperion.connector.authentication.SessionInfo sessionInfo)
                                             throws SaSystemException,
                                                    SaAuthenticationException
```
    Logon with the passed credentials and associate the given session information.
    
    Parameters:
    
    credentials - credentials which should be used for logon
    
    sessionInfo - The session information like user agent, remote address etc.
    
    Returns:
    
    Session which holds all information about the created session
    
    Throws:
    
    SaSystemException - SaRMICommandException
    
    SaAuthenticationException - SaAuthenticationException
  - listActiveSessions
```
List<com.saperion.connector.authentication.Session> listActiveSessions()
                                                                throws SaSystemException
```
    List the active sessions of the logged in user.
    
    Returns:
    
    A list of Session
    
    Throws:
    
    SaSystemException
  - closeSession
```
boolean closeSession(com.saperion.connector.authentication.Session session)
              throws SaSystemException
```
    Close the given Session
    
    Parameters:
    
    session -
    
    Returns:
    
    true if successful, false otherwise
    
    Throws:
    
    SaSystemException
  - logon
```
@Deprecated
default com.saperion.connector.authentication.Session logon(int rmiToken)
                                                                  throws SaSystemException
```
    Deprecated.
    
    Logon with given rmi token.
    
    Parameters:
    
    rmiToken - The rmi token obtained from already logged in session
    
    Returns:
    
    the session information associated with given token
    
    Throws:
    
    SaSystemException - error on user login
  - logoff
```
boolean logoff()
        throws SaSystemException,
               SaAuthenticationException
```
    Log off the user from the server instance.
    
    Returns:
    
    True, if done. False if session is not alive.
    
    Throws:
    
    SaAuthenticationException - SaAuthenticationException
    
    SaSystemException - SaRMICommandException
  - getLicenseCount
```
int getLicenseCount(int type)
             throws SaSystemException
```
    Read the licence count for the given user.
    
    Parameters:
    
    type - Client type
    
    Returns:
    
    License count
    
    Throws:
    
    SaSystemException - Error on the saperion system
  - setUsedLicense
```
boolean setUsedLicense(int type,
                       int count)
                throws SaSystemException
```
    Set the count of used licenses.
    
    Parameters:
    
    type - Client type
    
    count - Number of licenses
    
    Returns:
    
    True, if success
    
    Throws:
    
    SaSystemException - Error on the saperion system
  - setLocale
```
void setLocale(Locale local)
        throws SaSystemException,
               SaAuthenticationException
```
    Set the locale for localization.
    
    Parameters:
    
    local - Locale
    
    Throws:
    
    SaAuthenticationException - SaAuthenticationException
    
    SaSystemException - SaRMICommandException
  - getMembers
```
WorkflowMember getMembers()
                   throws SaSystemException,
                          SaAuthenticationException
```
    Reads the member.
    
    Returns:
    
    Member tree
    
    Throws:
    
    SaAuthenticationException - SaAuthenticationException
    
    SaSystemException - SaRMICommandException
  - getMember
```
WorkflowMember getMember(WorkflowMember member,
                         int depth,
                         String filter)
                  throws SaSystemException,
                         SaAuthenticationException
```
    Reads the member.
    
    Parameters:
    
    member - workflow member, which direct children have to be returned.
    
    depth - depth of the returned children.
    
    filter - filter for search, only matching members will be found, leave empty to get all members.
    
    Returns:
    
    Member tree
    
    Throws:
    
    SaAuthenticationException - SaAuthenticationException
    
    SaSystemException - SaRMICommandException
  - getMandant
```
String getMandant()
```
    Returns:
    
    Mandant name
  - getUserIdsForQuery
```
int[] getUserIdsForQuery()
                  throws SaSystemException
```
    Read the userids.
    
    Returns:
    
    User ids
    
    Throws:
    
    SaSystemException - SaRMICommandException
  - loadDDCNames
```
String[] loadDDCNames()
               throws SaSystemException,
                      SaAuthenticationException
```
    Retrieves the available DDC names.
    
    Returns:
    
    Array of DDC names
    
    Throws:
    
    SaSystemException - SaRMICommandException
    
    SaAuthenticationException - SaAuthenticationException
  - loadFolderDDCNames
```
String[] loadFolderDDCNames()
                     throws SaSystemException,
                            SaAuthenticationException
```
    Retrieves the available folder DDC names.
    
    Returns:
    
    Array of folder DDC names
    
    Throws:
    
    SaSystemException - SaRMICommandException
    
    SaAuthenticationException - SaAuthenticationException
  - loadWorkflowDDCName
```
String loadWorkflowDDCName()
                    throws SaSystemException
```
    Retrieves the workflow DDC name.
    
    Returns:
    
    workflow DDC name
    
    Throws:
    
    SaSystemException - SaRMICommandException
  - getSystemSetting
```
SaSystemSetting getSystemSetting(String accessKey)
                          throws SaSystemException
```
    Retrieves a system setting object.
    
    Parameters:
    
    accessKey - key to get associated system setting
    
    Returns:
    
    SaSystemSetting
    
    Throws:
    
    SaSystemException - System exception
  - getSystemInfo
```
SaSystemInfo getSystemInfo()
                    throws SaSystemException
```
    Reads system info.
    
    Returns:
    
    System info
    
    Throws:
    
    SaSystemException - System exception
  - getFeatures
```
SaFeature getFeatures()
               throws SaSystemException
```
    Read the features.
    
    Returns:
    
    Features
    
    Throws:
    
    SaSystemException - System exception
  - getUserSetting
```
SaUserSetting getUserSetting(String accessKey)
                      throws SaSystemException,
                             SaAuthenticationException
```
    Retrieves a user setting object.
    
    Parameters:
    
    accessKey - key to get associated user setting
    
    Returns:
    
    SaUserSetting
    
    Throws:
    
    SaSystemException - System exception
    
    SaAuthenticationException - authentication exception
  - setUserSetting
```
void setUserSetting(SaUserSetting setting)
             throws SaSystemException,
                    SaAuthenticationException
```
    Persists a user setting object.
    
    Parameters:
    
    setting - the SaUserSetting object to be stored
    
    Throws:
    
    SaSystemException - System exception
    
    SaAuthenticationException - authentication exception
  - getSetting
```
Setting getSetting(String name,
                   String section,
                   boolean isLong)
            throws SaSystemException,
                   SaAuthenticationException
```
    Retrieves a setting from the database.
    
    Parameters:
    
    name - the setting's name
    
    section - the setting's section
    
    isLong - whether this is a setting with a long (>2KB) value or not
    
    Returns:
    
    the setting or null if no setting with the given key and section was found
    
    Throws:
    
    SaSystemException - system error when retrieving the setting
    
    SaAuthenticationException - authentication error
  - searchSettings
```
SettingSearchResult searchSettings(SettingSearchInfo searchInfo)
                            throws SaSystemException,
                                   SaAuthenticationException
```
    Searches for settings.
    
    Parameters:
    
    searchInfo - SettingSearchInfo containing information about what to search
    
    Returns:
    
    a SettingSearchResult
    
    Throws:
    
    SaSystemException - system error when searching
    
    SaAuthenticationException - authentication error
  - setSetting
```
void setSetting(Setting setting)
         throws SaSystemException,
                SaAuthenticationException
```
    Persists a setting in the database.
    
    Parameters:
    
    setting - the setting to persist
    
    Throws:
    
    SaSystemException - system error when persisting the setting
    
    SaAuthenticationException - authenticatin error when persisting the setting
  - deleteSetting
```
boolean deleteSetting(String name,
                      String section,
                      boolean isLong)
               throws SaSystemException,
                      SaAuthenticationException
```
    Deletes a setting in the database.
    
    Parameters:
    
    name - the name of the setting to delete
    
    section - the section of the setting to delete
    
    isLong - whether this is a setting with a long (>2KB) value or not
    
    Returns:
    
    true if setting was deleted, false if there was no such setting
    
    Throws:
    
    SaSystemException - system error when deleting the setting
    
    SaAuthenticationException - authentication error when deleting the setting
  - getFieldDescriptions
```
SaFieldDescription[] getFieldDescriptions(String ddcName)
                                   throws SaSystemException,
                                          SaAuthenticationException,
                                          SaDDCException
```
    Reads the field descriptions for a given DDC.
    
    Parameters:
    
    ddcName - DDC name
    
    Returns:
    
    Array of field description objects
    
    Throws:
    
    SaSystemException - SaRMICommandException
    
    SaAuthenticationException - SaAuthenticationException
    
    SaDDCException - SaDDCException
  - getRealDBName
```
String getRealDBName(String ddcName,
                     String field,
                     String mandant)
              throws SaSystemException
```
    returns the real database table name for a given DDC.
    
    Parameters:
    
    ddcName - DDC name
    
    field - field name
    
    mandant - Mandant
    
    Returns:
    
    Array of field description objects
    
    Throws:
    
    SaSystemException - SaRMICommandException
  - getFieldDescriptions
```
SaFieldDescription[] getFieldDescriptions(String ddcName,
                                          String mandant)
                                   throws SaSystemException
```
    Reads the field descriptions for a given DDC.
    
    Parameters:
    
    ddcName - DDC name
    
    mandant - Mandant
    
    Returns:
    
    Array of field description objects
    
    Throws:
    
    SaSystemException - SaRMICommandException
  - getDDC
```
DDC getDDC(String ddcName)
    throws SaSystemException,
           SaAuthenticationException
```
    Returns information about the specified DDC.
    
    Parameters:
    
    ddcName - the name of the DDC
    
    Returns:
    
    DDC information
    
    Throws:
    
    SaSystemException - system error when retrieving information about requested DDC
    
    SaAuthenticationException - authentication exception when retrieving information about requested DDC
  - isRevisionEnabled
```
boolean isRevisionEnabled(int mandant,
                          String ddcName)
                   throws SaSystemException,
                          SaAuthenticationException
```
    Gets the information whether the provided ddc table contains the fields required for revisions.
    
    Parameters:
    
    mandant - mandant number
    
    ddcName - table/jcr workspace name
    
    Returns:
    
    true, if the revision fields are present. False otherwise.
    
    Throws:
    
    SaSystemException - SaRMICommandException
    
    SaAuthenticationException - SaAuthenticationException
  - readDocumentMetadata
```
SaPropertyValue[] readDocumentMetadata(String sysRowId,
                                       String ddcName,
                                       String[] fields)
                                throws SaSystemException,
                                       SaAuthenticationException,
                                       SaGetNodeException
```
    Reads the meta data of the document with the given ID.
    
    Parameters:
    
    sysRowId - The ID of the document (SYSROWID)
    
    ddcName - The name of the database definition
    
    fields - Field names to be read. If empty or null, all fields will be read.
    
    Returns:
    
    The Meta data of the document represented as an array of SaPropertyValue instances.
    
    Throws:
    
    SaSystemException - SaRMICommandException
    
    SaAuthenticationException - SaAuthenticationException
    
    SaGetNodeException - SaGetNodeException
  - getFulltext
```
String getFulltext(String ddcName,
                   String sysRowId,
                   String hdoc,
                   String fieldName,
                   long length)
            throws SaSystemException,
                   SaAuthenticationException
```
    Reads the fulltext information for the given document with the given SYSROWID in the given DDC.
    
    Parameters:
    
    ddcName - DDC name of the document
    
    sysRowId - SYSROWID of the document. Can be null if hdoc is set. If both hdoc and sysRowId are set, hdoc will be used.
    
    hdoc - HDOC of the document. Can be null if sysRowId is set. If both hdoc and sysRowId are set, hdoc will be used.
    
    fieldName - name of the fulltext field to retrieve content from. If not set, the first fulltext field of the DDC will be used
    
    length - maximum length of content to retrieve. If -1, the complete content will be returned.
    
    Returns:
    
    Content of the fulltext for this document
    
    Throws:
    
    SaSystemException - SaSystemException
    
    SaAuthenticationException - SaAuthenticationException
  - getThumbnail
```
byte[] getThumbnail(String hDoc,
                    int widthX,
                    int widthY,
                    boolean color)
             throws SaSystemException,
                    SaAuthenticationException
```
    Reads the thumbnail of the given document.
    
    Parameters:
    
    hDoc - HDoc for the document.
    
    widthX - Width X
    
    widthY - Width Y
    
    color - True for colored
    
    Returns:
    
    Thumbnail BMP as byte array
    
    Throws:
    
    SaSystemException - System exception
    
    SaAuthenticationException - SaAuthenticationException
  - getIdsFromQuery
```
List<String> getIdsFromQuery(String query)
                      throws SaSystemException,
                             SaAuthenticationException
```
    Executes a HQL query and returns the results as a string list. Currently are only two queries in focus:
    - search for hDocs
    - search for sysRowIds
    Parameters:
    
    query - HQL query
    
    Returns:
    
    String result list
    
    Throws:
    
    SaSystemException - Error on the saperion system
    
    SaAuthenticationException - SaAuthenticationException
  - getStringQueryResult
```
List<SaDocumentInfo> getStringQueryResult(SaQueryInfo queryInfo)
                                   throws SaSystemException,
                                          SaAuthenticationException,
                                          SaDBException
```
    Executes a given HQL string and returns the results as list.
    
    Parameters:
    
    queryInfo - HQL query info
    
    Returns:
    
    Result list
    
    Throws:
    
    SaSystemException - Error on the saperion system
    
    SaAuthenticationException - SaAuthenticationException
    
    SaDBException - query execution exception
  - getVersionList
```
List<String> getVersionList(String ddcName,
                            String sysrowID)
                     throws SaSystemException,
                            SaAuthenticationException
```
    Reads the versionlist for the given document.
    
    Parameters:
    
    ddcName - DDC name
    
    sysrowID - SYSROWID
    
    Returns:
    
    List of HDOC's
    
    Throws:
    
    SaSystemException - SaRMICommandException
    
    SaAuthenticationException - SaAuthenticationException
  - getHDocForSysRowId
```
String getHDocForSysRowId(String sysRowId,
                          String ddcName)
                   throws SaSystemException,
                          SaAuthenticationException,
                          SaDDCException
```
    Searchs the HDOC for the given SysRowId.
    
    Parameters:
    
    sysRowId - SysRowId
    
    ddcName - DDC name
    
    Returns:
    
    Resultset for HDOC's
    
    Throws:
    
    SaSystemException - SaRMICommandException
    
    SaAuthenticationException - SaAuthenticationException
    
    SaDDCException - SaDDCException
  - isAlive
```
boolean isAlive()
         throws SaSystemException
```
    Test the lifetime of this token.
    
    Returns:
    
    True if alive
    
    Throws:
    
    SaSystemException - System exception
  - getTaskList
```
List<TaskInfo> getTaskList(int[] ids,
                           String filter,
                           Map<String,Object> parameter)
                    throws SaAuthenticationException,
                           SaSystemException
```
    Reads the task for this user.
    
    Parameters:
    
    ids - Array of ID's
    
    filter - HQL filter
    
    parameter - Filter parameter
    
    Returns:
    
    List of TaskInfo objects
    
    Throws:
    
    SaAuthenticationException - SaAuthenticationException
    
    SaSystemException - SaSystemException
  - getTaskAuditList
```
List<TaskAuditInfo> getTaskAuditList(int[] ids,
                                     String filter,
                                     Map<String,Object> parameter)
                              throws SaAuthenticationException,
                                     SaSystemException
```
    Reads the task audit for this user.
    
    Parameters:
    
    ids - Array of ID's
    
    filter - HQL filter
    
    parameter - Filter parameter
    
    Returns:
    
    List of TaskAuditInfo objects
    
    Throws:
    
    SaAuthenticationException - SaAuthenticationException
    
    SaSystemException - SaSystemException
  - getTask
```
TaskInfo getTask(String taskID)
          throws SaAuthenticationException,
                 SaSystemException
```
    Reads the task info for the given ID.
    
    Parameters:
    
    taskID - Task SysRowId
    
    Returns:
    
    Task info
    
    Throws:
    
    SaAuthenticationException - SaAuthenticationException
    
    SaSystemException - SaSystemException
  - getParentTask
```
TaskInfo getParentTask(String taskID)
                throws SaAuthenticationException,
                       SaSystemException
```
    Reads the parent task info for the given ID.
    
    Parameters:
    
    taskID - Task SysRowId
    
    Returns:
    
    Task info
    
    Throws:
    
    SaAuthenticationException - SaAuthenticationException
    
    SaSystemException - SaSystemException
  - getCommandInfos
```
Collection<CommandInfo> getCommandInfos(String taskUID)
                                 throws SaAuthenticationException,
                                        SaSystemException
```
    Reads all possible transitions for this task.
    
    Parameters:
    
    taskUID - Task UID
    
    Returns:
    
    Command list
    
    Throws:
    
    SaAuthenticationException - SaAuthenticationException
    
    SaSystemException - SaSystemException
  - getCommandInfos
```
Collection<CommandInfo> getCommandInfos(String taskUID,
                                        boolean transitionsOnly)
                                 throws SaAuthenticationException,
                                        SaSystemException
```
    Reads all possible transitions and optional other possible commands for this task.
    
    Parameters:
    
    taskUID - Task UID
    
    transitionsOnly - if true, only transition commands will be returned
    
    Returns:
    
    Command list
    
    Throws:
    
    SaAuthenticationException - SaAuthenticationException
    
    SaSystemException - SaSystemException
  - getBoxDefinitions
```
List<BoxDefinition> getBoxDefinitions()
                               throws SaAuthenticationException,
                                      SaSystemException
```
    Reads the box definitions.
    
    Returns:
    
    Box definitions
    
    Throws:
    
    SaAuthenticationException - SaAuthenticationException
    
    SaSystemException - SaSystemException
  - getBoxCount
```
BoxCount getBoxCount(int boxId,
                     BoxCountType type,
                     Map<String,Object> parameters)
              throws SaAuthenticationException,
                     SaSystemException
```
    Returns the number of all elements and of all unread elements of the inbox identified by the given id.
    
    Parameters:
    
    boxId - the workflow box id
    
    type - type of tasks to search for
    
    parameters - parameters needed for searching
    
    Returns:
    
    number of all elements and of all unread elements
    
    Throws:
    
    SaAuthenticationException - if an error occurs.
    
    SaSystemException - if an error occurs.
  - executeCommand
```
String executeCommand(ContextInfo contextInfo)
               throws SaAuthenticationException,
                      SaSystemException,
                      SaWorkflowException
```
    Performs the given command. The parameters must fit to the given parameter. Unneeded parameters can be set to null.
    
    Parameters:
    
    contextInfo - Context info
    
    Returns:
    
    New TaskID
    
    Throws:
    
    SaAuthenticationException - SaAuthenticationException
    
    SaSystemException - SaSystemException
    
    SaWorkflowException - Workflow exception
  - getCommentInfos
```
List<CommentInfo> getCommentInfos(String taskUID)
                           throws SaAuthenticationException,
                                  SaSystemException,
                                  SaWorkflowException
```
    Reads the comments for the given task.
    
    Parameters:
    
    taskUID - Task UID
    
    Returns:
    
    List of comments
    
    Throws:
    
    SaAuthenticationException - SaAuthenticationException
    
    SaSystemException - SaSystemException
    
    SaWorkflowException - Workflow exception
  - getHistoryInfos
```
List<HistoryInfo> getHistoryInfos(String taskUID)
                           throws SaAuthenticationException,
                                  SaSystemException,
                                  SaWorkflowException
```
    Reads the history for the given task.
    
    Parameters:
    
    taskUID - Task UID
    
    Returns:
    
    History list
    
    Throws:
    
    SaAuthenticationException - SaAuthenticationException
    
    SaSystemException - SaSystemException
    
    SaWorkflowException - Workflow exception
  - getCompleteHistoryInfos
```
List<List<HistoryInfo>> getCompleteHistoryInfos(String docUID)
                                         throws SaAuthenticationException,
                                                SaSystemException,
                                                SaWorkflowException
```
    Reads the history for the given task.
    
    Parameters:
    
    docUID - Document UID
    
    Returns:
    
    CompleteHistoryInfo
    
    Throws:
    
    SaAuthenticationException - SaAuthenticationException
    
    SaSystemException - SaSystemException
    
    SaWorkflowException - Workflow exception
  - getWorkflowDefinitions
```
List<String> getWorkflowDefinitions()
                             throws SaAuthenticationException,
                                    SaSystemException,
                                    SaWorkflowException
```
    Reads all available workflow definitions.
    
    Returns:
    
    Workflowdefinition list
    
    Throws:
    
    SaAuthenticationException - SaAuthenticationException
    
    SaSystemException - SaSystemException
    
    SaWorkflowException - Workflow exception
  - addComment
```
void addComment(String comment,
                String taskUID,
                int level)
         throws SaAuthenticationException,
                SaSystemException,
                SaWorkflowException
```
    Parameters:
    
    comment - Comment
    
    taskUID - Task UID
    
    level - Level
    
    Throws:
    
    SaAuthenticationException - SaAuthenticationException
    
    SaSystemException - SaSystemException
    
    SaWorkflowException - Workflow exception
  - addHistory
```
void addHistory(String description,
                String taskUID)
         throws SaAuthenticationException,
                SaSystemException,
                SaWorkflowException
```
    Parameters:
    
    description - Comment
    
    taskUID - Task UID
    
    Throws:
    
    SaAuthenticationException - SaAuthenticationException
    
    SaSystemException - SaSystemException
    
    SaWorkflowException - Workflow exception
  - getSubstitute
```
String getSubstitute()
              throws SaAuthenticationException,
                     SaSystemException
```
    Get the substitute for the logged on user.
    
    Returns:
    
    Substitute name
    
    Throws:
    
    SaAuthenticationException - SaAuthenticationException
    
    SaSystemException - SaSystemException
  - setSubstitute
```
void setSubstitute(String name)
            throws SaAuthenticationException,
                   SaSystemException
```
    Set the substitute for the logged on user.
    
    Parameters:
    
    name - Substitute name
    
    Throws:
    
    SaAuthenticationException - SaAuthenticationException
    
    SaSystemException - SaSystemException
  - getOutOfOffice
```
boolean getOutOfOffice()
                throws SaAuthenticationException,
                       SaSystemException
```
    Get the out of office status for the logged on user.
    
    Returns:
    
    is OutOfOffice
    
    Throws:
    
    SaAuthenticationException - SaAuthenticationException
    
    SaSystemException - SaSystemException
  - setOutOfOffice
```
void setOutOfOffice(boolean isOutOfOffice)
             throws SaAuthenticationException,
                    SaSystemException
```
    Set the out of office status for the logged on user.
    
    Parameters:
    
    isOutOfOffice - True, if is OutOfOffice
    
    Throws:
    
    SaAuthenticationException - SaAuthenticationException
    
    SaSystemException - SaSystemException
  - getUsers
```
List<String> getUsers(String filter)
               throws SaAuthenticationException,
                      SaSystemException
```
    Reads a list of filtered users.
    
    Parameters:
    
    filter - Filter
    
    Returns:
    
    List of users
    
    Throws:
    
    SaAuthenticationException - SaAuthenticationException
    
    SaSystemException - SaSystemException
  - loadSettings
```
Properties loadSettings(String section)
                 throws SaSystemException
```
    Load settings from backend.
    
    Parameters:
    
    section - Section
    
    Returns:
    
    Settings
    
    Throws:
    
    SaSystemException - Exception
  - getToken
```
int getToken()
```
    Returns:
    
    Token
  - getSession
```
com.saperion.connector.authentication.Session getSession()
```
    Returns:
    
    the actual valid session
  - getSystemConnector
```
SaRMISystemConnector getSystemConnector()
```
    Returns:
    
    System connector
  - getCommitMode
```
int getCommitMode()
```
    Returns:
    
    Commitmode from the configuration.
  - getDeleteMode
```
int getDeleteMode()
```
    Returns:
    
    Deletemode from the configuration.
  - writeContent
```
long writeContent(InputStream stream,
                  String fileName,
                  int element,
                  boolean doStreaming)
           throws SaSystemException,
                  SaAuthenticationException,
                  SaConnectException
```
    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. Because of the C# web services only chunks byte arrays with the size of 8192 a special handling is required.
    
    Parameters:
    
    stream - content stream
    
    fileName - the file name
    
    element -
    element = -2 : Deletes existing content, leaving an empty document structure
    element = -1 : Deletes existing content, adding given content as first element
    element = 0 : Given content is appended to the last existing content element in the document structure
    element > 0 : Replace the numbered content element with the given content. The overall number of content elements remains the same.
    
    doStreaming - set to true, if streaming option for the inputstream content should be activated.
    
    Returns:
    
    Actual element count
    
    Throws:
    
    SaSystemException - SaSystemException
    
    SaAuthenticationException - SaAuthenticationException
    
    SaConnectException - SaConnectException
  - writeContent
```
long writeContent(InputStream stream,
                  String fileName,
                  int element)
           throws SaSystemException,
                  SaAuthenticationException,
                  SaConnectException
```
    Throws:
    
    SaSystemException
    
    SaAuthenticationException
    
    SaConnectException
  - writeContent
```
long writeContent(InputStream stream)
           throws SaSystemException,
                  SaAuthenticationException,
                  SaConnectException
```
    Writes the content of the document.
    
    Parameters:
    
    stream - content stream
    
    Returns:
    
    Actual element count
    
    Throws:
    
    SaSystemException - SaSystemException
    
    SaAuthenticationException - SaAuthenticationException
    
    SaConnectException - SaConnectException
  - writeContent
```
long writeContent(ContentStream contentStream)
           throws SaSystemException,
                  SaAuthenticationException,
                  SaConnectException,
                  StreamVerificationException,
                  UploadLimitExceededException
```
    Writes the content of the document.
    
    Parameters:
    
    contentStream - content stream
    
    Returns:
    
    Actual element count
    
    Throws:
    
    SaSystemException - SaSystemException
    
    SaAuthenticationException - SaAuthenticationException
    
    SaConnectException - SaConnectException
    
    StreamVerificationException - if the content stream validation is enabled and the validation failed.
    
    UploadLimitExceededException
  - closeDocument
```
void closeDocument(com.saperion.jni.SaJNIDocHandle handle)
            throws SaSystemException,
                   SaAuthenticationException,
                   SaGetNodeException
```
    Manually closing of a open document.
    
    Parameters:
    
    handle - Document handle for a document, opend by readDocumentFirst
    
    Throws:
    
    SaAuthenticationException - SaAuthenticationException
    
    SaSystemException - SaRMICommandException
    
    SaGetNodeException - SaGetNodeException
  - deleteDocument
```
SaSaveInfo deleteDocument(int mode,
                          String hdoc)
                   throws SaSystemException,
                          SaAuthenticationException,
                          SaGetNodeException,
                          SaDDCException
```
    Delete a document.
    
    Parameters:
    
    mode - Delete mode may be set to the following values:
    SaConstant.JNI_DELETECONTENT_MODE_DBSIMPLE = 0 Set status to 65002
    SaConstant.JNI_DELETECONTENT_MODE_DBCOMPLETE = 1 - remove from DB
    SaConstant.JNI_DELETECONTENT_MODE_PURGEDOCUMENT = 2 -Final delete
    SaConstant.DELETEMODE = "deletemode" -Deletemode entry in archief.ini;
    
    hdoc - Document HDOC
    
    Returns:
    
    SaSaveInfo or null
    
    Throws:
    
    SaSystemException - Error on the saperion system
    
    SaAuthenticationException - SaAuthenticationException
    
    SaGetNodeException - SaGetNodeException
    
    SaDDCException - SaDDCException
  - readDocumentFirst
```
com.saperion.jni.SaJNIReadBuffer readDocumentFirst(String hdoc,
                                                   boolean currentRevision,
                                                   int element)
                                            throws SaSystemException,
                                                   SaAuthenticationException,
                                                   SaGetNodeException
```
    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. If this was the last block, the document is automatically closed.
    
    Parameters:
    
    hdoc - Document HDOC
    
    currentRevision - flag indicating that the current revision of the document should be retrieved by resolving hdoc
    
    element - Element number, starting with 1
    
    Returns:
    
    The document handle and the buffer with the content
    
    Throws:
    
    SaSystemException - SaRMICommandException
    
    SaAuthenticationException - SaAuthenticationException
    
    SaGetNodeException - SaGetNodeException
  - readDocumentFirst
```
com.saperion.jni.SaJNIReadBuffer readDocumentFirst(String hdoc,
                                                   boolean currentRevision,
                                                   int element,
                                                   boolean withAnnotations)
                                            throws SaSystemException,
                                                   SaAuthenticationException,
                                                   SaGetNodeException
```
    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. If this was the last block, the document is automatically closed.
    
    Parameters:
    
    hdoc - Document HDOC
    
    currentRevision - flag indicating that the current revision of the document should be retrieved by resolving hdoc
    
    element - Element number, starting with 1
    
    withAnnotations - if true, the annotations will be saved on the document
    
    Returns:
    
    The document handle and the buffer with the content
    
    Throws:
    
    SaSystemException - SaRMICommandException
    
    SaAuthenticationException - SaAuthenticationException
    
    SaGetNodeException - SaGetNodeException
  - readDocumentNext
```
com.saperion.jni.SaJNIReadBuffer readDocumentNext(com.saperion.jni.SaJNIDocHandle handle)
                                           throws SaSystemException,
                                                  SaAuthenticationException,
                                                  SaSetNodeException,
                                                  SaGetNodeException,
                                                  SaConnectException
```
    Reads the next bytes from the open document, described in the handle. If this was the last block, the document is automatically closed.
    
    Parameters:
    
    handle - Document handle for a document, opend by readDocumentFirst
    
    Returns:
    
    The document handle and the buffer with the content
    
    Throws:
    
    SaSystemException - SaRMICommandException
    
    SaAuthenticationException - SaAuthenticationException
    
    SaSetNodeException - SaSetNodeException
    
    SaGetNodeException - SaGetNodeException
    
    SaConnectException - SaConnectException
  - readVersionMetadata
```
SaVersionData readVersionMetadata(String versionID)
                           throws SaSystemException,
                                  SaAuthenticationException,
                                  SaDDCException,
                                  SaGetNodeException
```
    Reads the version meta data of the document with the given ID.
    
    Parameters:
    
    versionID - Version HDOC
    
    Returns:
    
    Document revision data
    
    Throws:
    
    SaSystemException - SaRMICommandException
    
    SaAuthenticationException - SaAuthenticationException
    
    SaDDCException - SaDDCException
    
    SaGetNodeException - SaGetNodeException
  - readVersionMetadata
```
SaVersionData readVersionMetadata(String versionID,
                                  boolean resolveLinks)
                           throws SaSystemException,
                                  SaAuthenticationException,
                                  SaDDCException,
                                  SaGetNodeException
```
    Reads the version meta data of the document with the given ID.
    
    Parameters:
    
    versionID - Version HDOC
    
    resolveLinks - If false will not resolve the link and show the metadata associated with the link itself.
    
    Returns:
    
    Document revision data
    
    Throws:
    
    SaSystemException - SaRMICommandException
    
    SaAuthenticationException - SaAuthenticationException
    
    SaDDCException - SaDDCException
    
    SaGetNodeException - SaGetNodeException
  - createDocument
```
SaSaveInfo createDocument(String ddcName,
                          List<SaPropertyValue> values)
                   throws SaSystemException,
                          SaAuthenticationException,
                          SaDDCException,
                          SaGetNodeException
```
    Creates a new document with the given parameters.
    
    Parameters:
    
    ddcName - Node database table name
    
    values - List of all values
    
    Returns:
    
    Node information object
    
    Throws:
    
    SaDDCException - Error on the saperion system
    
    SaAuthenticationException - Error on the saperion system
    
    SaSystemException - Error on the saperion system
    
    SaGetNodeException - SaGetNodeException
  - discardDocument
```
void discardDocument()
              throws SaSystemException
```
    Discards the document identified by the tokens handle. Cleans up temporary document resources and handles.
    
    Throws:
    
    SaSystemException
  - cacheDocument
```
SaSaveInfo cacheDocument(boolean isNew,
                         int commitMode,
                         String versionComment,
                         String xhDoc,
                         String ddcName,
                         String acls)
                  throws SaSystemException,
                         SaAuthenticationException,
                         SaGetNodeException,
                         SaSetNodeException,
                         SaDDCException
```
    Stores the actual document to the backend.
    
    Parameters:
    
    isNew - Is a new document
    
    commitMode - Commit mode
    
    versionComment - Version comment string
    
    xhDoc - the xh doc
    
    ddcName - DDC name
    
    acls - ACL name string
    
    Returns:
    
    Node information object
    
    Throws:
    
    SaSystemException - the system error exception
    
    SaAuthenticationException - the authentication error exception
    
    SaGetNodeException - the get node error exception
    
    SaSetNodeException - the set node error exception
    
    SaDDCException - the ddc error exception
  - createLink
```
SaSaveInfo createLink(LinkInfo link)
               throws SaSystemException,
                      SaAuthenticationException,
                      SaDDCException,
                      SaGetNodeException
```
    Creates a SAPERION Link into one Archive for an existing Document.
    
    Parameters:
    
    link - Link for the existing Document
    
    Returns:
    
    Save Info after the Link was created
    
    Throws:
    
    SaSystemException - SaRMICommandException
    
    SaAuthenticationException - SaAuthenticationException
    
    SaGetNodeException - SaGetNodeException
    
    SaDDCException - SaDDCException
  - saveDocument
```
SaSaveInfo saveDocument(String nodeHdoc,
                        String ddcName,
                        List<SaPropertyValue> values)
                 throws SaSystemException,
                        SaAuthenticationException,
                        SaGetNodeException,
                        SaDDCException
```
    Saves the document paramaters to the document.
    
    Parameters:
    
    nodeHdoc - Node HDOC
    
    ddcName - Database table name
    
    values - List of all values
    
    Returns:
    
    written node informations
    
    Throws:
    
    SaSystemException - SaRMICommandException
    
    SaAuthenticationException - SaAuthenticationException
    
    SaGetNodeException - SaGetNodeException
    
    SaDDCException - SaDDCException
  - saveDocument
```
SaSaveInfo saveDocument(String nodeHdoc,
                        String ddcName,
                        List<SaPropertyValue> values,
                        boolean resolveLinks)
                 throws SaSystemException,
                        SaAuthenticationException,
                        SaGetNodeException,
                        SaDDCException
```
    Saves the document paramaters to the document.
    
    Parameters:
    
    nodeHdoc - Node HDOC
    
    ddcName - Database table name
    
    values - List of all values
    
    resolveLinks - Resolve links
    
    Returns:
    
    written node informations
    
    Throws:
    
    SaSystemException - SaRMICommandException
    
    SaAuthenticationException - SaAuthenticationException
    
    SaGetNodeException - SaGetNodeException
    
    SaDDCException - SaDDCException
  - storeDocument
```
SaSaveInfo storeDocument(boolean isNew,
                         int commitMode,
                         String versionComment,
                         String ddcName,
                         String acls)
                  throws SaSystemException,
                         SaAuthenticationException,
                         SaGetNodeException,
                         SaSetNodeException,
                         SaDDCException
```
    Stores the actual document to the backend.
    
    Parameters:
    
    isNew - Is a new document
    
    commitMode - Commit mode
    
    versionComment - Version comment string
    
    ddcName - DDC name
    
    acls - ACL name string
    
    Returns:
    
    Node information object
    
    Throws:
    
    SaSystemException - SaRMICommandException
    
    SaAuthenticationException - SaAuthenticationException
    
    SaGetNodeException - SaGetNodeException
    
    SaSetNodeException - SaSetNodeException
    
    SaDDCException - SaDDCException
  - storeDocument
```
SaSaveInfo storeDocument(boolean isNew,
                         int commitMode,
                         String versionComment,
                         String ddcName,
                         String acls,
                         boolean checkin)
                  throws SaSystemException,
                         SaAuthenticationException,
                         SaGetNodeException,
                         SaSetNodeException,
                         SaDDCException
```
    Stores the actual document to the backend.
    
    Parameters:
    
    isNew - Is a new document
    
    commitMode - Commit mode
    
    versionComment - Version comment string
    
    ddcName - DDC name
    
    acls - ACL name string (semicolon separated)
    
    checkin - Checkin document
    
    Returns:
    
    Node information object
    
    Throws:
    
    SaSystemException - SaRMICommandException
    
    SaAuthenticationException - SaAuthenticationException
    
    SaGetNodeException - SaGetNodeException
    
    SaSetNodeException - SaSetNodeException
    
    SaDDCException - SaDDCException
  - checkoutDocument
```
void checkoutDocument(String hDoc)
               throws SaSystemException,
                      SaAuthenticationException,
                      SaGetNodeException
```
    Checkout the given document.
    
    Parameters:
    
    hDoc - Document HDOC
    
    Throws:
    
    SaSystemException - SaRMICommandException
    
    SaAuthenticationException - SaAuthenticationException
    
    SaGetNodeException - SaGetNodeException
  - dsicardCheckout
```
void dsicardCheckout(String hDoc)
              throws SaSystemException,
                     SaAuthenticationException,
                     SaGetNodeException
```
    Discards the checkout of the given document.
    
    Parameters:
    
    hDoc - Document HDOC
    
    Throws:
    
    SaSystemException - SaRMICommandException
    
    SaAuthenticationException - SaAuthenticationException
    
    SaGetNodeException - SaGetNodeException
  - releaseDocument
```
void releaseDocument(String hDoc,
                     String comment)
              throws SaSystemException,
                     SaAuthenticationException,
                     SaGetNodeException
```
    Release the given document.
    
    Parameters:
    
    hDoc - Document HDOC
    
    comment - the revision comment
    
    Throws:
    
    SaSystemException - SaRMICommandException
    
    SaAuthenticationException - SaAuthenticationException
    
    SaGetNodeException - SaGetNodeException
  - restoreVersion
```
SaSaveInfo restoreVersion(String versionID)
                   throws SaSystemException,
                          SaAuthenticationException,
                          SaDDCException,
                          SaGetNodeException
```
    Restores the given version to the actual version.
    
    Parameters:
    
    versionID - Version HDOC
    
    Returns:
    
    Document save info
    
    Throws:
    
    SaSystemException - SaRMICommandException
    
    SaAuthenticationException - SaAuthenticationException
    
    SaDDCException - SaDDCException
    
    SaGetNodeException - SaGetNodeException
  - clearContent
```
void clearContent()
           throws SaSystemException,
                  SaAuthenticationException,
                  SaGetNodeException,
                  SaSetContentException,
                  SaConnectException
```
    Clears all content of the opened document.
    
    Throws:
    
    SaSystemException - Error on the saperion system
    
    SaSetContentException - SaSetContentException
    
    SaGetNodeException - SaGetNodeException
    
    SaAuthenticationException - SaAuthenticationException
    
    SaConnectException - SaConnectException
  - setElementMark
```
void setElementMark(int element)
             throws SaSystemException,
                    SaAuthenticationException,
                    SaConnectException
```
    Mark the content element.
    
    Parameters:
    
    element - Element number to mark
    
    Throws:
    
    SaSystemException - Error on the saperion system
    
    SaAuthenticationException - SaAuthenticationException
    
    SaConnectException - SaConnectException
  - removeElement
```
void removeElement(int element)
            throws SaSystemException,
                   SaAuthenticationException,
                   SaGetNodeException,
                   SaSetContentException,
                   SaConnectException
```
    Removes a existing content element.
    
    Parameters:
    
    element - Element number
    
    Throws:
    
    SaSystemException - Error on the saperion system
    
    SaSetContentException - SaSetContentException
    
    SaGetNodeException - SaGetNodeException
    
    SaAuthenticationException - SaAuthenticationException
    
    SaConnectException - SaConnectException
  - removeElement
```
void removeElement(Integer[] elements)
            throws SaSystemException,
                   SaAuthenticationException,
                   SaGetNodeException,
                   SaSetContentException,
                   SaConnectException
```
    Removes a series of existing content elements.
    
    Parameters:
    
    elements - Array of element number
    
    Throws:
    
    SaSystemException - Error on the saperion system
    
    SaSetContentException - SaSetContentException
    
    SaGetNodeException - SaGetNodeException
    
    SaAuthenticationException - SaAuthenticationException
    
    SaConnectException - SaConnectException
  - getLockInfo
```
SaLockInfo getLockInfo(String sysRowId)
                throws SaSystemException,
                       SaAuthenticationException,
                       SaLockException,
                       SaGetNodeException
```
    Gets the lock info for a given node.
    
    Parameters:
    
    sysRowId - SysRowId
    
    Returns:
    
    Lockinfo
    
    Throws:
    
    SaLockException - Error on the saperion system
    
    SaAuthenticationException - Error on the saperion system
    
    SaSystemException - Error on the saperion system
    
    SaGetNodeException - SaGetNodeException
  - lockNode
```
boolean lockNode(String sysRowId,
                 String ddcName,
                 int lockType,
                 boolean sessionScoped)
          throws SaSystemException,
                 SaAuthenticationException,
                 SaLockException,
                 SaGetNodeException,
                 SaPropertyException
```
    Locks a node.
    
    Parameters:
    
    sysRowId - SysRowId
    
    ddcName - DDC name
    
    lockType - locking mode can be one of the following constants:
    SaConstant.LOCKING_LOCKTYPE_DEFAULT = 0;
    SaConstant.LOCKING_LOCKTYPE_JSRLOCK = 1;
    SaConstant.LOCKING_LOCKTYPE_JSRCHECKOUT = 2;
    
    sessionScoped - True, if session scoped
    
    Returns:
    
    True, if ok
    
    Throws:
    
    SaLockException - Error on the saperion system
    
    SaAuthenticationException - Error on the saperion system
    
    SaSystemException - Error on the saperion system
    
    SaGetNodeException - SaGetNodeException
    
    SaPropertyException - SaPropertyException
  - unlockNode
```
boolean unlockNode(String sysRowId,
                   String ddcName)
            throws SaSystemException,
                   SaAuthenticationException,
                   SaLockException,
                   SaGetNodeException
```
    Unlocks a node.
    
    Parameters:
    
    sysRowId - SysRowId
    
    ddcName - DDC name
    
    Returns:
    
    True, if ok
    
    Throws:
    
    SaSystemException - SaRMICommandException
    
    SaAuthenticationException - SaAuthenticationException
    
    SaLockException - SaLockException
    
    SaGetNodeException - SaGetNodeException
  - getNodeAccessData
```
com.saperion.jni.SaJNIDocAccessData getNodeAccessData(String hdoc)
                                               throws SaSystemException,
                                                      SaAuthenticationException,
                                                      SaGetNodeException
```
    Opens the document identified by hdoc and returns an object containing all access right data information for the session user.
    
    Parameters:
    
    hdoc - Document HDOC
    
    Returns:
    
    SaJNIDocAccessData Document access data for session user
    
    Throws:
    
    SaAuthenticationException - Error on the saperion system
    
    SaSystemException - Error on the saperion system
    
    SaGetNodeException - SaGetNodeException
  - finishTransaction
```
void finishTransaction(boolean commit)
                throws SaSystemException
```
    Finish the transaction in the backend system.
    
    Parameters:
    
    commit - True, if commit this transaction, false to rollback
    
    Throws:
    
    SaSystemException - Error on the saperion system
  - startTransaction
```
void startTransaction()
               throws SaSystemException
```
    Starts a transaction in the backend system.
    
    Throws:
    
    SaSystemException - SaRMICommandException
  - getAnnotations
```
String getAnnotations(String hDoc,
                      int indexOfContentElement,
                      boolean currentRevision)
               throws SaAuthenticationException,
                      SaSystemException
```
    Reads the annotations from the given document.
    
    Parameters:
    
    hDoc - Document HDOC
    
    indexOfContentElement - the index of the chosen context element
    
    currentRevision - true to get current revision
    
    Returns:
    
    Annotation string
    
    Throws:
    
    SaSystemException - Remote exception
    
    SaAuthenticationException - Authentication error
  - setAnnotations
```
void setAnnotations(String hDoc,
                    int indexOfContentElement,
                    String annotations)
             throws SaAuthenticationException,
                    SaSystemException
```
    Sets the given annotations to the document. This method creates a new revision.
    
    Parameters:
    
    hDoc - Document HDOC
    
    annotations - Annotation string
    
    indexOfContentElement - the index of the chosen context element
    
    Throws:
    
    SaSystemException - Remote exception
    
    SaAuthenticationException - Authentication error
  - getLocks
```
List<String> getLocks(String ddcName)
               throws SaSystemException
```
    Reads all locks from the given DDC.
    
    Parameters:
    
    ddcName - DDC name
    
    Returns:
    
    Locks as list
    
    Throws:
    
    SaSystemException - Remote exception
  - getLocks
```
List<String> getLocks(String ddcName,
                      String mandant)
               throws SaSystemException
```
    Reads all locks from the given DDC.
    
    Parameters:
    
    ddcName - DDC name
    
    mandant - internal saperion name of the current mandant
    
    Returns:
    
    Locks as list
    
    Throws:
    
    SaSystemException - Remote exception
  - getACLNames
```
String getACLNames(String hDoc)
            throws SaSystemException,
                   SaGetNodeException,
                   SaAuthenticationException,
                   SaDDCException
```
    Reads the ACL's for the given document.
    
    Parameters:
    
    hDoc - Document HDOC
    
    Returns:
    
    ACL name string
    
    Throws:
    
    SaSystemException - SaRMICommandException
    
    SaAuthenticationException - SaAuthenticationException
    
    SaDDCException - SaDDCException
    
    SaGetNodeException - SaGetNodeException
  - getInvolvedUsers
```
List<String> getInvolvedUsers(String hDoc)
                       throws SaSystemException,
                              SaAuthenticationException,
                              SaDDCException,
                              SaGetNodeException
```
    Reads all users involved in the set of ACL's.
    
    Parameters:
    
    hDoc - Document HDOC
    
    Returns:
    
    List of user names
    
    Throws:
    
    SaSystemException - SaRMICommandException
    
    SaAuthenticationException - SaAuthenticationException
    
    SaDDCException - SaDDCException
    
    SaGetNodeException - SaGetNodeException
  - setACLName
```
SaSaveInfo setACLName(String ddcname,
                      String hDoc,
                      String acl,
                      int commitMode,
                      String versionComment)
               throws SaSystemException,
                      SaAuthenticationException,
                      SaDDCException,
                      SaSetACLException,
                      SaSetNodeException,
                      SaGetNodeException
```
    Sets the given ACL to the node.
    
    Parameters:
    
    ddcname - implemented ddc in saperion
    
    hDoc - Document HDOC
    
    acl - ACL name string
    
    commitMode - Commit mode
    
    versionComment - Version comment string
    
    Returns:
    
    save info object
    
    Throws:
    
    SaSystemException - SaRMICommandException
    
    SaAuthenticationException - SaAuthenticationException
    
    SaDDCException - SaDDCException
    
    SaSetACLException - SaSetACLException
    
    SaSetNodeException - SaSetNodeException
    
    SaGetNodeException - SaGetNodeException
  - getAllACLs
```
@Deprecated
List<String> getAllACLs()
                              throws SaSystemException,
                                     SaAuthenticationException
```
    Deprecated.
    
    Reads all existing ACL names.
    
    Returns:
    
    List of ACL names
    
    Throws:
    
    SaSystemException - SaRMICommandException
    
    SaAuthenticationException - SaAuthenticationException
  - getACLRights
```
SaACLRights getACLRights(String[] acls)
                  throws SaSystemException,
                         SaAuthenticationException
```
    Reads the rights for the given acl's.
    
    Parameters:
    
    acls - ACL's
    
    Returns:
    
    Rights
    
    Throws:
    
    SaSystemException - System exception
    
    SaAuthenticationException - Authentication exception
  - startSQLTransaction
```
void startSQLTransaction(String ddcName)
                  throws SaSystemException
```
    Start SQL transaction.
    
    Parameters:
    
    ddcName - the name of the ddc
    
    Throws:
    
    SaSystemException - Error on the saperion system
  - finishSQLTransaction
```
void finishSQLTransaction(boolean commit,
                          String ddcName)
                   throws SaSystemException
```
    Finish SQL transaction.
    
    Parameters:
    
    commit - True, if commit, else rollback
    
    ddcName - the name of the ddc
    
    Throws:
    
    SaSystemException - Error on the saperion system
  - getFolderChildren
```
List<SaDocumentInfo> getFolderChildren(String folderTableDDC,
                                       String folderId,
                                       int depth,
                                       SaQueryInfo filter,
                                       int allowedMaxNrOfChildFolders)
                                throws SaSystemException,
                                       SaAuthenticationException,
                                       SaDBException,
                                       SaFolderException
```
    Returns a cursor with the children of the given node. The function accepts a depth parameter. In case of a depth greater than one, the returned nodes are ordered in a depth-first order, and the caller must detect parent-child relationship with the appropriate fields (SysParentID, SysRowID). Note that searching with a depth greater than one is not a fast operation. It is recommended to use depth = 1 and only load further levels on demand if required. The allowedMaxNrOfChildFolders parameter is used to restrict the absolute number of hits loaded from the database. It is intended to be used to protect the system from overload problems caused by very large query-results. The depth-filtering is done after the query has returned from the database. So keep in mind that children found on deeper levels than specified in the depth-parameter are relevant for the total number of children found.
    The default value for allowedMaxNrOfChildFolders can be configured with the setting rmi.getfolderchildren.maxresults in saperion.properties of JavaCoreServer. When this setting is set to a value > 0, it is not possible to search for an unlimited number of child nodes by passing a value of -1 for this parameter.
    
    Parameters:
    
    folderTableDDC - Folder table
    
    folderId - Folder ID
    
    depth - Depth
    
    filter - Additional HQL filter criteria
    
    allowedMaxNrOfChildFolders - allowed maximum number of results
    
    Returns:
    
    List of folder information
    
    Throws:
    
    SaSystemException - Remote exception
    
    SaAuthenticationException - Authentication error
    
    SaDBException - Database exception
    
    SaFolderException - Folder Exception
  - getFolderInfo
```
SaDocumentInfo getFolderInfo(String folderTableDDC,
                             String folderId,
                             boolean forceLoadVariables)
                      throws SaSystemException,
                             SaAuthenticationException,
                             SaDBException,
                             SaFolderException
```
    Reads the folder info object for the given folder.
    
    Parameters:
    
    folderTableDDC - Folder table
    
    folderId - Folder id
    
    forceLoadVariables - if true, variables will be loaded from medium if the DDC does not contain the SYSPROPERTIES field.
    
    Returns:
    
    Folder info object
    
    Throws:
    
    SaSystemException - Remote exception
    
    SaAuthenticationException - Authentication error
    
    SaDBException - Database exception
    
    SaFolderException - Folder Exception
  - getFolderParent
```
SaDocumentInfo getFolderParent(String folderTableDDC,
                               String folderId)
                        throws SaSystemException,
                               SaAuthenticationException,
                               SaDBException
```
    Returns the parent of the given node. Please note that in case of a node to which another node links, the real parent is returned, not the parent of the link.
    
    Parameters:
    
    folderTableDDC - Folder table
    
    folderId - Folder ID
    
    Returns:
    
    Properties of the folder or null, if not found
    
    Throws:
    
    SaSystemException - Remote exception
    
    SaAuthenticationException - Authentication error
    
    SaDBException - Database exception
  - getFolderFromPath
```
List<SaDocumentInfo> getFolderFromPath(String folderTableDDC,
                                       String startNodeId,
                                       String folderPath,
                                       boolean exact)
                                throws SaSystemException,
                                       SaAuthenticationException,
                                       SaDBException
```
    Returns the node(s) which match to the given path. Path names are built using the SysFolderName field of each node. As path separator, the backslash ('\') is used. The path can be searched relative to a given node, to allow for searching within Personal folders and the like. If exact is set to false, the folderPath can contain wildcards (%). Searching with wildcards can be slow depending on the number of entries in the folder-table and the database in use.
    
    Parameters:
    
    folderTableDDC - Folder table
    
    startNodeId - Startnode ID or null/empty if no relative search is required
    
    folderPath - Search path
    
    exact - if true, the path will be matched using '='. If false, LIKE will be used.
    
    Returns:
    
    Folder list
    
    Throws:
    
    SaSystemException - Remote exception
    
    SaAuthenticationException - Authentication error
    
    SaDBException - Database exception
  - createFolder
```
String createFolder(SaFolderSaveInfo info)
             throws SaSystemException,
                    SaAuthenticationException,
                    SaDDCException
```
    Creates a new node below a given node. The parent node can be the root node (empty id).
    
    Parameters:
    
    info - Folder save info
    
    Returns:
    
    Folder ID
    
    Throws:
    
    SaSystemException - Remote exception
    
    SaAuthenticationException - Authentication error
    
    SaDDCException - Database exception
  - updateFolder
```
void updateFolder(String folderTableDDC,
                  String folderId,
                  List<SaPropertyValue> values)
           throws SaSystemException,
                  SaAuthenticationException,
                  SaDDCException
```
    Updates a given node with the given properties.
    
    Parameters:
    
    folderTableDDC - Folder table
    
    folderId - Folder ID
    
    values - Values
    
    Throws:
    
    SaSystemException - Remote exception
    
    SaAuthenticationException - Authentication error
    
    SaDDCException - Database exception
  - searchFolderDocuments
```
List<SaDocumentInfo> searchFolderDocuments(String folderTableDDC,
                                           String folderId,
                                           SaQueryInfo hqlFilter)
                                    throws SaSystemException,
                                           SaAuthenticationException,
                                           SaDDCException
```
    HQL search extended with additional folder informations and depth.
    
    Parameters:
    
    folderTableDDC - Folder table
    
    folderId - Folder ID
    
    hqlFilter - HQL query for document tables. The DDC name must be defined as $DDC$.
    
    Returns:
    
    List of documents from each involved DDC's
    
    Throws:
    
    SaSystemException - Remote exception
    
    SaAuthenticationException - Authentication error
    
    SaDDCException - Database exception
  - deleteFolder
```
void deleteFolder(String folderTableDDC,
                  String folderId)
           throws SaSystemException,
                  SaAuthenticationException,
                  SaDDCException
```
    Deletes a given node. It must not have children or filed document, i.e. the user must delete/remove all these before deleting the node.
    
    Parameters:
    
    folderTableDDC - Folder table
    
    folderId - Folder ID
    
    Throws:
    
    SaSystemException - Remote exception
    
    SaAuthenticationException - Authentication error
    
    SaDDCException - Database exception
  - copyFolder
```
String copyFolder(String folderTableDDC,
                  String folderId,
                  String destinationId,
                  String beforeChild,
                  boolean withDocuments)
           throws SaSystemException,
                  SaAuthenticationException,
                  SaDDCException
```
    Copies the given node and all it’s children to the destination. Note that only real children are copied, so links are not followed. Document filings can optionally be copied too, however this is an expensive operation, as each document has to be updated.
    
    Parameters:
    
    folderTableDDC - Folder table
    
    folderId - Folder ID
    
    destinationId - Destination folder ID
    
    beforeChild - Child ID or empty for append
    
    withDocuments - True, if documents should be copied
    
    Returns:
    
    new folder id
    
    Throws:
    
    SaSystemException - Remote exception
    
    SaAuthenticationException - Authentication error
    
    SaDDCException - Database exception
  - moveFolder
```
void moveFolder(String folderTableDDC,
                String folderId,
                String destinationId,
                String beforeChild)
         throws SaSystemException,
                SaAuthenticationException,
                SaDDCException
```
    Moves the given node to a new destination. Document filings are always moved with the node. This is not a quick operation, as path and security information must be updated.
    
    Parameters:
    
    folderTableDDC - Folder table
    
    folderId - Folder ID
    
    destinationId - Destination folder ID
    
    beforeChild - Child ID or empty for append
    
    Throws:
    
    SaSystemException - Remote exception
    
    SaAuthenticationException - Authentication error
    
    SaDDCException - Database exception
  - addToFolder
```
void addToFolder(String folderTableDDC,
                 String documentId,
                 String documentDDC,
                 String folderId)
          throws SaSystemException,
                 SaAuthenticationException,
                 SaDDCException,
                 SaSetNodeException
```
    Adds the document to a given folder. A document can be filed in multiple folders, but each filing operation must be called separately.
    
    Parameters:
    
    folderTableDDC - Folder table
    
    documentId - Document SysRowId
    
    documentDDC - Document DDC name
    
    folderId - Destination folder ID
    
    Throws:
    
    SaSystemException - Remote exception
    
    SaAuthenticationException - Authentication error
    
    SaDDCException - Database exception
    
    SaSetNodeException - Document is not fileable
  - removeFromFolder
```
void removeFromFolder(String folderTableDDC,
                      String documentSysRowId,
                      String documentDDC,
                      String folderId)
               throws SaSystemException,
                      SaAuthenticationException,
                      SaDDCException
```
    Remove the document filing from the given node.
    
    Parameters:
    
    folderTableDDC - Folder table
    
    documentSysRowId - Document SysRowId
    
    documentDDC - Document DDC name
    
    folderId - Folder ID
    
    Throws:
    
    SaSystemException - Remote exception
    
    SaAuthenticationException - Authentication error
    
    SaDDCException - Database exception
  - moveToFolder
```
void moveToFolder(String folderTableDDC,
                  String documentId,
                  String documentDDC,
                  String folderId,
                  String destinationId)
           throws SaSystemException,
                  SaAuthenticationException,
                  SaDDCException
```
    Moves the document’s filing to the given node. It is removed from the original folder. Both source node and destination node must exist.
    
    Parameters:
    
    folderTableDDC - Folder table
    
    documentId - Document SysRowId
    
    documentDDC - Document DDC name
    
    folderId - Source folder ID
    
    destinationId - Destination folder ID
    
    Throws:
    
    SaSystemException - Remote exception
    
    SaAuthenticationException - Authentication error
    
    SaDDCException - Database exception
  - getDocumentFolders
```
List<SaDocumentInfo> getDocumentFolders(String folderTableDDC,
                                        String documentDDC,
                                        String sysRowId)
                                 throws SaSystemException,
                                        SaAuthenticationException,
                                        SaDDCException,
                                        SaSetNodeException
```
    Returns a list of folder properties which contains all nodes the document is contained in. The list is returned only for one node table, so if the document is filed in multiple node tables, this must be queried separately.
    
    Parameters:
    
    folderTableDDC - Folder table
    
    documentDDC - Document DDC
    
    sysRowId - Document sysrowid
    
    Returns:
    
    List of folder properties
    
    Throws:
    
    SaSystemException - Remote exception
    
    SaAuthenticationException - Authentication error
    
    SaDDCException - Database exception
    
    SaSetNodeException - Document is not fileable
  - getDocumentFolderCount
```
long getDocumentFolderCount(String folderTableDDC,
                            String documentDDC,
                            String sysRowId)
                     throws SaSystemException,
                            SaAuthenticationException,
                            SaDDCException,
                            SaSetNodeException
```
    Returns the total count over all folders from all users in which the specified document is countained in.
    
    Parameters:
    
    folderTableDDC - Folder table
    
    documentDDC - Document DDC
    
    sysRowId - Document sysrowid
    
    Returns:
    
    folder count
    
    Throws:
    
    SaSystemException - Remote exception
    
    SaAuthenticationException - Authentication error
    
    SaDDCException - Database exception
    
    SaSetNodeException - Document is not fileable
  - setFolderAcl
```
void setFolderAcl(String folderTableDDC,
                  String folderId,
                  String aclName)
           throws SaSystemException,
                  SaAuthenticationException,
                  SaDDCException
```
    Sets an ACL for the given folder. The node’s SysACLUserList is recalculated, and if the node has children, the same is true for all the node’s children.
    
    Parameters:
    
    folderTableDDC - Folder table
    
    folderId - Folder ID
    
    aclName - ACL name
    
    Throws:
    
    SaSystemException - Remote exception
    
    SaAuthenticationException - Authentication error
    
    SaDDCException - Database exception
  - getFolderRights
```
SaDocAccessData getFolderRights(String folderTableDDC,
                                String folderId)
                         throws SaSystemException,
                                SaAuthenticationException,
                                SaDDCException
```
    Returns the rights mask for the given folder and user. The effective rights are calculated by using ACL inheritance.
    
    Parameters:
    
    folderTableDDC - Folder table
    
    folderId - Folder ID
    
    Returns:
    
    Folder access data
    
    Throws:
    
    SaSystemException - Remote exception
    
    SaAuthenticationException - Authentication error
    
    SaDDCException - Database exception
  - getFolderClass
```
SaFolderClass getFolderClass(String className)
                      throws SaSystemException,
                             SaAuthenticationException,
                             SaDDCException
```
    Reads the folder class with the given name.
    
    Parameters:
    
    className - Class name in dotted notation
    
    Returns:
    
    Folder classs
    
    Throws:
    
    SaSystemException - Remote exception
    
    SaAuthenticationException - authentication error
    
    SaDDCException - Database exception
  - searchFolderClass
```
Set<SaFolderClass> searchFolderClass(SaFolderClassSearchInfo searchInfo)
                              throws SaSystemException,
                                     SaAuthenticationException
```
    Searches for folder classes with the specified properties.
    
    Parameters:
    
    searchInfo - bean with properties to search for
    
    Returns:
    
    set of classes that match the specified properties
    
    Throws:
    
    SaSystemException - system exception
    
    SaAuthenticationException - authentication error
  - resolveLatestHdoc
```
String resolveLatestHdoc(String oldHdoc)
                  throws SaSystemException,
                         SaAuthenticationException
```
    Resolves the hdoc of the latest version of the document identified by the given hdoc.
    
    Parameters:
    
    oldHdoc - the old hdoc
    
    Returns:
    
    the hdoc of the latest version of the document identified by the given hdoc.
    
    Throws:
    
    SaSystemException - the system error exception
    
    SaAuthenticationException - the authentication error exception
  - getSystemFiles
```
List<String> getSystemFiles(SystemFileKind kind,
                            String filter)
                     throws SaSystemException,
                            SaAuthenticationException
```
    Gets the system files of a specific kind.
    
    Parameters:
    
    kind - the kind of systemfiles to read.
    
    filter - A filter string. Only files will be returned, that match the filter. To get all systemfiles of a kind set filter to the empty string.
    
    Returns:
    
    The system files of a specific kind.
    
    Throws:
    
    SaAuthenticationException - error on the authentification / insufficient rights
    
    SaSystemException - general error
  - logClientEvent
```
void logClientEvent(String hdoc,
                    SaConstants.ProtoEvents event,
                    String remark)
             throws SaSystemException,
                    SaAuthenticationException
```
    Adds an audit log event.
    
    Parameters:
    
    hdoc - Document HDOC
    
    event - Event type
    
    remark - Remark
    
    Throws:
    
    SaAuthenticationException - error on the authentification / insufficient rights
    
    SaSystemException - general error
  - getAcls
```
List<SaAcl> getAcls()
             throws SaSystemException,
                    SaAuthenticationException
```
    Reads all existing ACLs.
    
    Returns:
    
    List of ACLs
    
    Throws:
    
    SaSystemException - SaRMICommandException
    
    SaAuthenticationException - SaAuthenticationException
  - changePassword
```
void changePassword(String user,
                    String oldPassword,
                    String client,
                    String newPassword)
             throws SaAuthenticationException,
                    SaSystemException
```
    Changes the password of an existing user. This has to be done before a call to logon(Credentials) was successfully invoked.
    
    Parameters:
    
    user - The name of the user.
    
    oldPassword - The old password. This parameter is required, since the password should only be changed by the user himself
    
    client - The client of the actions
    
    newPassword - The new password
    
    Throws:
    
    SaSystemException
    
    SaAuthenticationException
  - getAuthorizedUsers
```
List<UsersRights> getAuthorizedUsers(String hDoc,
                                     String rights,
                                     MatchKind match)
                              throws SaAuthenticationException,
                                     SaSystemException
```
    Returns the users, that have specific rights on a document.
    
    Parameters:
    
    hDoc - The id of the document.
    
    rights - The rights the requested users should have.
    
    match - How the rights are matched: MKONEOF - find all users that have one of the specified rights MKEXACT - find all users that have exactly the specified rights MKATLEAST - find all users that have at least the specified rights
    
    Returns:
    
    The users, that have specific rights on the document or null if the document has no acl set. In this case everyone has every right on the document.
    
    Throws:
    
    SaSystemException
    
    SaAuthenticationException
  - getArchivedSize
```
int getArchivedSize(String hDoc)
             throws SaAuthenticationException,
                    SaSystemException
```
    Returns the total document size in archive.
    
    Parameters:
    
    hDoc - The document whichs size is wanted.
    
    Returns:
    
    The total document size in archive.
    
    Throws:
    
    SaSystemException
    
    SaAuthenticationException
  - storeSystemFile
```
void storeSystemFile(SystemFileKind kind,
                     String name,
                     InputStream data)
              throws SaSystemException,
                     SaAuthenticationException
```
    Stores a system file of a specific kind.
    
    Parameters:
    
    kind - The kind of systemfile to store.
    
    name - The name of the file. This has to be a filename without path and extension.
    
    data - The content of the file to save.
    
    Throws:
    
    SaSystemException - Remote exception
    
    SaAuthenticationException - Authentication error
  - loadSystemFile
```
InputStream loadSystemFile(SystemFileKind kind,
                           String name)
                    throws SaSystemException,
                           SaAuthenticationException
```
    Loads a system file of a specific kind.
    
    Parameters:
    
    kind - The kind of system file to load
    
    name - The name of the file to load.
    
    Returns:
    
    an InputStream that holds the content of the file.
    
    Throws:
    
    SaAuthenticationException - error on the authentification / insufficient rights
    
    SaSystemException - general error
  - getRMIVersion
```
String getRMIVersion()
              throws SaSystemException
```
    Get the RMI interface version from java core server.
    
    Throws:
    
    SaSystemException
  - getFolderUpdateInfo
```
Set<FolderUpdateInfo> getFolderUpdateInfo(Map<String,Long> folderIds)
                                   throws SaSystemException,
                                          SaAuthenticationException
```
    Get the Set of folders that shall be refreshed.
    
    Parameters:
    
    folderIds - Map of SYSROWIDs with time stamps of last refresh to check.
    
    Returns:
    
    Set of folders that shall be refreshed.
    
    Throws:
    
    SaAuthenticationException - error on the authentification / insufficient rights
    
    SaSystemException - general error
  - setVariables
```
void setVariables(int element,
                  Map<String,String> variables)
           throws SaAuthenticationException,
                  SaSystemException
```
    Method to set the Variables for an Content-Object or the Structure itself.
    
    Parameters:
    
    element - Element Number where the Variables should be set to. (0 = Structure)
    
    variables - Map of Key-Value Pairs for setting Variables
    
    Throws:
    
    SaAuthenticationException - error on the authentification / insufficient rights
    
    SaSystemException - general error
  - checkSapUrl
```
SapDocInfo checkSapUrl(String url)
                throws SaSystemException,
                       SaSapUrlException,
                       SaAuthenticationException
```
    Checks the given SAP URL on the R/Link server and returns, if successfull, the HDOC and the DDC. If not, null will be returned.
    
    Parameters:
    
    url - SAP URL
    
    Returns:
    
    Document Info
    
    Throws:
    
    SaSystemException - when a system error occured
    
    SaSapUrlException - when checking the sap url failed in the RLINK server
    
    SaAuthenticationException - when the user is not logged in or has insufficient rights
  - invoke
```
<T extends Serializable> T invoke(com.lexmark.saperion.remote.common.operations.Operation<T,SaBasicException,LegacyConnection> operation)
                           throws SaSystemException,
                                  SaAuthenticationException
```
    This method invokes a Operation on the backend.
    
    Type Parameters:
    
    T - The return type
    
    Parameters:
    
    operation - The operation to invoke
    
    Returns:
    
    The result of the invocation
    
    Throws:
    
    SaSystemException
    
    SaAuthenticationException
  - newInvoke
```
<ResultType extends Serializable,ExceptionType extends com.lexmark.saperion.exceptions.EcmException> ResultType newInvoke(com.lexmark.saperion.remote.common.operations.EcmOperation<ResultType,ExceptionType> operation)
                                                                                                                   throws SaSystemException,
                                                                                                                          SaAuthenticationException
```
    This method invokes a EcmOperation in the backend.
    
    Parameters:
    
    operation - the operation to invoke
    
    Returns:
    
    the result of the operation
    
    Throws:
    
    SaSystemException
    
    SaAuthenticationException
  - sendBarcode
```
void sendBarcode(String indexMask,
                 String docUid,
                 String contentRep,
                 String sid,
                 String docType,
                 String value,
                 int mandant)
          throws SaSystemException,
                 SaAuthenticationException
```
    Send barcode to SAP.
    
    Parameters:
    
    indexMask - Index mask name
    
    docUid - Document UID
    
    contentRep - SAP Content repository
    
    sid - SAP ID
    
    docType - Document type
    
    value - Value
    
    mandant - Mandant name
    
    Throws:
    
    SaSystemException - when a system error occured
    
    SaAuthenticationException - when the user is not logged in or has insufficient rights
  - getServerInfos
```
List<SaRMIServerInfo> getServerInfos()
```
    Returns a list of objects describing the servers this connector is connected to.
    
    Returns:
    
    set of SaRMIServerInfo
  - setEventsEnabled
```
void setEventsEnabled(boolean enabled)
               throws SaSystemException,
                      SaAuthenticationException
```
    Sets whether events (e.g. for the IS) should be enabled for the current session.
    
    Parameters:
    
    enabled - true, if events should be enabled, otherwise false.
    
    Throws:
    
    SaSystemException - when a system error occured.
    
    SaAuthenticationException - when the user is not logged in or has insufficient rights.
  - getEventsEnabled
```
boolean getEventsEnabled()
                  throws SaSystemException,
                         SaAuthenticationException
```
    Returns whether events (e.g. for the IS) are enabled for the current session.
    
    Returns:
    
    true, if events are enabled, otherwise false.
    
    Throws:
    
    SaSystemException - when a system error occured.
    
    SaAuthenticationException - when the user is not logged in or has insufficient rights.
  - getFullTextFields
```
Set<Map.Entry<String,String>> getFullTextFields(String ddcName,
                                                List<String> fullTextFields,
                                                String hdoc)
                                         throws SaSystemException
```
    Fetches values of Full text columns
    
    Parameters:
    
    ddcName - name of the DDC
    
    fullTextFields - List of Fields which are of Text retrieval type. Make sure to prefix SaConstants.FULL_TEXT_COLUMN_PREFIX
    
    hdoc - hdoc of the document
    
    Returns:
    
    Set of entries containing full text coulmn and corresponding value
    
    Throws:
    
    SaSystemException

Interface SaRMIClientCommand

Method Summary

Method Detail

logon

logon

listActiveSessions

closeSession

logon

logoff

getLicenseCount

setUsedLicense

setLocale

getMembers

getMember

getMandant

getUserIdsForQuery

loadDDCNames

loadFolderDDCNames

loadWorkflowDDCName

getSystemSetting

getSystemInfo

getFeatures

getUserSetting

setUserSetting

getSetting

searchSettings

setSetting

deleteSetting

getFieldDescriptions

getRealDBName

getFieldDescriptions

getDDC

isRevisionEnabled

readDocumentMetadata

getFulltext

getThumbnail

getIdsFromQuery

getStringQueryResult

getVersionList

getHDocForSysRowId

isAlive

getTaskList

getTaskAuditList

getTask

getParentTask

getCommandInfos

getCommandInfos

getBoxDefinitions

getBoxCount

executeCommand

getCommentInfos

getHistoryInfos

getCompleteHistoryInfos

getWorkflowDefinitions

addComment

addHistory

getSubstitute

setSubstitute

getOutOfOffice

setOutOfOffice

getUsers

loadSettings

getToken

getSession

getSystemConnector

getCommitMode

getDeleteMode

writeContent

writeContent

writeContent

writeContent

closeDocument

deleteDocument

readDocumentFirst

readDocumentFirst

readDocumentNext

readVersionMetadata

readVersionMetadata

createDocument

discardDocument