SaClassicConnector (JCS Classic Connector Distribution 7.5.4 API)

All Known Implementing Classes:

SaClassicConnectorImpl
```
public interface SaClassicConnector
```
Connector interface for classic DMS functionalities.

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addListener(SaEventListener listener)` Deprecated. will be removed with version 8.0
`void`	`addListener(SaStatusEventListener listener)` Deprecated. will be removed with version 8.0
`void`	`addToFolder(String folderTableDDC, String documentId, String documentDDC, String folderId)` Adds the document with given documentId to a given folder with given folderId.
`SaSaveInfo`	`cacheDocument(String xhDoc, DocumentInfo document)` Caches the given document on the backend system.
`SaSaveInfo`	`cacheDocument(String xhDoc, String ddcName, Properties namevaluePairs, InputStream[] content, String versionComment, String strAcl)` Caches a new document on the backend system with the given metadata and content.
`void`	`changePassword(String user, String oldPassword, String client, String newPassword)` Changes the password of an existing user.
`void`	`checkoutDocument(String hDoc)` Checkouts a document for the given document id (hdoc).
`SapDocInfo`	`checkSapUrl(String url)` Checks the given SAP URL on the R/Link server and returns, if successfull, the HDOC and the DDC.
`String`	`copyFolder(String folderTableDDC, String folderId, String destinationId, String beforeChild, boolean withDocuments)` Copies the given folder and all it's children to the destination.
`SaSaveInfo`	`createDocument(DocumentInfo document)` Creates a new document on the backend system with the given `DocumentInfo`.
`SaSaveInfo`	`createDocument(String ddcName, Properties namevaluePairs, InputStream[] content, String versionComment)` Deprecated. will be removed with version 8.0, use `createDocument(DocumentInfo)` instead.
`SaSaveInfo`	`createDocument(String ddcName, Properties namevaluePairs, InputStream[] content, String versionComment, String acls)` Deprecated. will be removed with version 8.0, use `createDocument(DocumentInfo)` instead.
`String`	`createFolder(SaFolderSaveInfo info, Properties namevaluePairs)` Creates a new folder below a given folder.
`String`	`createFolder(String folderTableDDC, String parentId, String beforeChild, String folderName, SaFolderConstants.FOLDER_TYPE folderType, Properties namevaluePairs)` Deprecated. use `createFolder(SaFolderSaveInfo, Properties)` instead. Will be removed with version 8.0
`SaSaveInfo`	`createLink(LinkInfo link)` Creates a link to a document for given `LinkInfo`.
`String`	`createLookupEntry(String ddc, Properties props)` Deprecated. This method does not handle system fields and might be removed in a future version. Use `invoke(Operation)` with a `CreateLookupEntry` operation instead.
`void`	`deleteDocument(String documentHDOC, int deleteType)` Deletes a document from the backend system with the given strategy.
`void`	`deleteFolder(String folderTableDDC, String folderId)` Deletes an existing folder.
`void`	`deleteLookupEntry(String ddc, String id)` Deprecated. This method does not handle system fields and might be removed in a future version. Use `invoke(Operation)` with a `DeleteLookupEntry` operation instead.
`boolean`	`deleteSetting(String name, String section, boolean isLong)` Deletes a setting in the database.
`void`	`discardCheckout(String hDoc)` Discards the checkout of the given document.
`String`	`getACLNames(String documentHDOC)` Reads the ACL's for the given document.
`SaACLRights`	`getACLRights(String[] acls)` Read the rights for the given ACL's.
`List<SaAcl>`	`getAcls()` Reads all existing ACLs.
`List<String>`	`getAllACLs()` Deprecated. use `getAcls()` instead. Will be removed with version 8.0
`String`	`getAnnotations(String hDoc, int indexOfContentElement)` Deprecated. use `getAnnotations(String, int, boolean)` instead. Will be removed with version 8.0
`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 the archive.
`List<UsersRights>`	`getAuthorizedUsers(String hDoc, String rights, MatchKind match)` Returns the users, that have specific rights on a document.
`Properties`	`getConfiguration(String section)` Reads the application configuration properties from the backend system.
`SaUserInfo`	`getCurrentUserInfo()` Gets detailed info about the current user.
`String`	`getCurrentUserName()` Returns the name of the current user.
`SaFieldDescription[]`	`getDBDefinition(String name)` Reads the definitions of a database definition (DDC) for the given name.
`DDC`	`getDDC(String ddcName)` Returns information about the requested DDC.
`String[]`	`getDefinitions()` Reads the registered DDC names from the repository.
`SaDocAccessData`	`getDocumentAccessData(String documentHDOC)` Reads the access rights of the given document.
`long`	`getDocumentFolderCount(String folderTableDDC, String documentDDC, String sysRowId)` Returns the total count over all folders from all users in which the specified document is contained in.
`List<SaDocumentInfo>`	`getDocumentFolders(String folderTableDDC, String documentDDC, String sysRowId)` Returns a list of folder properties which contains all folders the document is contained in.
`SaDocInfo`	`getDocumentInfo(String hDoc, boolean currentRevision, boolean resolveLinks)` Reads the document information for the given document.
`SaDocInfo`	`getDocumentInfo(String hDoc, boolean currentRevision, boolean resolveLinks, boolean forceSizeDetermination)` Reads the document information for the given document.
`boolean`	`getEventsEnabled()` Returns whether events (e.g.
`SaFeature`	`getFeatures()` Reads the features.
`SaDocumentInfo`	`getFolderByPath(String folderTableDDC, String startFolderId, String folderPath)` Returns the folder which matches to the given path.
`List<SaDocumentInfo>`	`getFolderChildren(String folderTableDDC, String folderId, int depth, SaQueryInfo filter, int allowedMaxNrOfChildFolders)` Returns a list with the children of the given node.
`SaFolderClass`	`getFolderClass(String className)` Reads the folder class with the given name.
`String[]`	`getFolderDefinitions()` Reads the registered folder DDC names from the repository.
`List<SaDocumentInfo>`	`getFolderFromPath(String folderTableDDC, String startFolderId, String folderPath)` Returns the folders which match to the given path.
`SaDocumentInfo`	`getFolderInfo(String folderTableDDC, String folderId)` Deprecated. use `getFolderInfo(String, String, boolean)` instead
`SaDocumentInfo`	`getFolderInfo(String folderTableDDC, String folderId, boolean forceLoadVariables)` Returns the folder information object for the given folder.
`SaDocumentInfo`	`getFolderParent(String folderTableDDC, String folderId)` Returns the parent of the given folder.
`SaDocAccessData`	`getFolderRights(String folderTableDDC, String folderId)` Returns the rights mask for the given folder and user.
`Set<FolderUpdateInfo>`	`getFolderUpdateInfo(Map<String,Long> folderIds)` Generates the cut set of folders that are open on ngclient side and changed on rich client side over a specified period of time like the last 10 minutes.
`String`	`getFulltext(String ddcName, String sysRowId)` Deprecated. Will be removed in 8.0. Use `getFulltext(String, String, String, long)` instead.
`String`	`getFulltext(String ddcName, String hdoc, String fieldName, long length)` Reads the fulltext information for the given document with the given HDOC in the given DDC from the specified field.
`List<String>`	`getInvolvedUsers(String documentHDOC)` 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)` Returns the locking informations for a given document.
`String`	`getReleasedHdoc(String oldHdoc)` Gets the released hdoc for given hdoc if release feature is on and release tag is set, otherwise returns the given hDoc.
`List<Rendition>`	`getRendition(Element element, Options options)`
`Setting`	`getSetting(String name, String section, boolean isLong)` Retrieves a `Setting` identified by it's key and section from the database.
`Set<SourceFormat>`	`getSupportedRenderSourceFormats()` Gets the supported source formats from the render engine.
`Set<TargetFormat>`	`getSupportedRenderTargetFormats()` Gets the supported target formats from the render engine.
`List<String>`	`getSystemFiles(SystemFileKind kind, String filter)` Gets the system files of a specific kind.
`SaSystemInfo`	`getSystemInfo()` Reads the system informations.
`SaSystemSetting`	`getSystemSetting(String accessKey)` Retrieves a system setting object.
`byte[]`	`getThumbnail(String hDoc, int widthX, int widthY, boolean color)` Reads the thumbnail of the given document.
`SaUserSetting`	`getUserSetting(String accessKey)` Retrieves a user-specific setting object.
`List<String>`	`getVersionIDs(String ddcName, String sysrowID)` Reads the version IDs of the given document.
`SaWFConnector`	`getWorkflowConnector()` Returns a workflow connector based on this classic connector.
`boolean`	`hasRenderEngine()` Checks wether this classic connector has a render engine.
`<T extends Serializable> T`	`invoke(Operation<T> operation)` Invokes the given `Operation` on the server side.
`boolean`	`isAlive()` Test the lifetime of this connector.
`boolean`	`isReleaseActive()` Checks if is release feature in the program.ini in section [Release] is active.
`InputStream`	`loadSystemFile(SystemFileKind kind, String name)` Loads a system file of a specific kind.
`boolean`	`lockDocument(String sysRowId, String ddcName)` Locks a document.
`void`	`logClientEvent(String hdoc, SaConstants.ProtoEvents event, String remark)` Adds an audit log event.
`boolean`	`logoff()` Log off from the system.
`int`	`logon(byte[] token, int type, String client)` Deprecated. will be removed with version 8.0
`com.saperion.connector.authentication.Session`	`logon(com.saperion.connector.authentication.Credentials credentials)` Performs a logon with the given Credentials and returns the information about the open session.
`int`	`logon(jcifs.smb.NtlmPasswordAuthentication auth, int type, String client)` Deprecated. will be removed with version 8.0
`int`	`logon(String username, String password, int type, String client)` performs logon to the backend system.
`void`	`moveFolder(String folderTableDDC, String folderId, String destinationId, String beforeChild)` Moves the given folder to a new destination.
`void`	`moveToFolder(String folderTableDDC, String documentId, String documentDDC, String folderId, String destinationId)` Removes the document from the source folder and adds it to the source folder.
`InputStream`	`readDocument(String documentHDOC, boolean currentRevision, int elementNumber)` Loads a document's content from the backend system.
`String`	`readDocumentFilename(String documentHDOC, boolean currentRevision, int elementNumber)` Deprecated. will be removed with version 8.0
`SaPropertyValue[]`	`readDocumentMetadata(String documentSysRowID, String ddcName, String[] fields)` Reads the metadata of the document with the given ID.
`InputStream`	`readReleasedDocument(String docHdoc, boolean currentRevision, int elementNumber)` Read released document if the release feature is active.
`InputStream`	`readVersionDocument(String versionID, int elementNumber)` Loads a document version from the backend system.
`String`	`readVersionDocumentFilename(String documentHDOC, int elementNumber)` Deprecated. use getDocumentInfo.getFullName() instead. Will be removed with version 8.0
`SaVersionData`	`readVersionMetadata(String versionID)` Reads the version metadata of the document with the given ID.
`void`	`releaseDocument(String ddcName, String hDoc, String versionComment)` Release the given document.
`boolean`	`removeEvent(SaEvent event)` Deprecated. no longer supported. Will be removed with version 8.0
`void`	`removeFromFolder(String folderTableDDC, String documentSysRowId, String documentDDC, String folderId)` Removes the document from the given folder.
`void`	`removeListener(SaEventListener listener)` Deprecated. will be removed with version 8.0
`void`	`removeListener(SaStatusEventListener listener)` Deprecated. will be removed with version 8.0
`String`	`resolveLatestHDoc(String oldHdoc)` Resolves and returns the XHDOC of the latest version of the document identified by the given HDOC.
`SaSaveInfo`	`restoreVersion(String versionID)` Restores the version with the given HDOC.
`List<SaPropertyValue[]>`	`search(String hqlQuery)` Deprecated. Use searchHQL() instead. Will be removed with version 8.0
`Set<SaFolderClass>`	`searchFolderClass(SaFolderClassSearchInfo searchInfo)` Searches for folder classes that match the specified propertied.
`List<SaDocumentInfo>`	`searchFolderDocuments(String folderTableDDC, String folderId, SaQueryInfo hqlFilter)` HQL search extended with additional folder informations and depth.
`List<SaDocumentInfo>`	`searchHQL(SaQueryInfo hqlQuery)` Performs a search with the given hql query (hibernate query language).
`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 documentHDOC, String acl, String versionComment)` Adds the given ACL to the node.
`void`	`setAnnotations(String hDoc, int indexOfContentElement, String annotations)` Sets the given annotations to the document.
`void`	`setCurrentUserPresent(boolean present)` Deprecated. Use `updateCurrentUserInformation(MutableUserInformation)` instead. Will be removed with version 8.0.
`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 locale)` Set the localization information for this user.
`void`	`setSetting(Setting setting)` Stores a `Setting` in the database.
`boolean`	`setUsedLicense(int type, int count)` Set the count of used licenses.
`void`	`setUserSetting(SaUserSetting setting)` Persists a user-specific setting object.
`void`	`stopServer()` Deprecated. Functionality removed because of security-concerns. Method contained for compatibility only. Use windows service management tool or SAPERION MMC to stop the server. Will be removed with version 8.0.
`void`	`storeSystemFile(SystemFileKind kind, String name, InputStream data)` Stores a system file of a specific kind.
`boolean`	`unlockDocument(String sysRowId, String ddcName)` Unlocks a document.
`void`	`updateCurrentUserInformation(MutableUserInformation user)` Changes information about the current user.
`SaSaveInfo`	`updateDocument(String ddcName, String documentHDOC, Properties namevaluePairs, InputStream[] content, String versionComment)` Deprecated. will be removed with version 8.0, use `#updateDocument(DocumentInfo)` instead.
`SaSaveInfo`	`updateDocument(String ddcName, String documentHDOC, Properties namevaluePairs, InputStream[] content, String versionComment, String acls)` Deprecated. will be removed with version 8.0
`SaSaveInfo`	`updateDocument(String ddcName, String documentHDOC, Properties namevaluePairs, InputStream[] content, String versionComment, String acls, boolean resolveLinks)` Deprecated. will be removed with version 8.0
`SaSaveInfo`	`updateDocument(String ddcName, String documentHDOC, Properties namevaluePairs, InputStream[] content, String versionComment, String acls, boolean resolveLinks, boolean checkin)` Deprecated. will be removed with version 8.0
`SaSaveInfo`	`updateDocument(UpdateDocumentInfo updateInfo)` Updates a document in the backend system with the given metadata, acls and content.
`void`	`updateFolder(String folderTableDDC, String folderId, Properties namevaluePairs)` Updates an existing folder with the given properties.
`void`	`updateLookupEntry(String ddc, String id, Properties props)` Deprecated. This method does not handle system fields and might be removed in a future version. Use `invoke(Operation)` with a `UpdateLookupEntry` operation instead.

- Method Detail
  - getConfiguration
```
Properties getConfiguration(String section)
                            throws SaSystemException,
                                   SaAuthenticationException
```
    Reads the application configuration properties from the backend system.
    
    Parameters:
    section - Section in archief.ini to load configuration properties
    
    Returns:
    Configuration properties as key-value pairs
    
    Throws:
    
    SaSystemException - SaSystemException
    
    SaAuthenticationException - SaAuthenticationException
  - stopServer
```
@Deprecated
void stopServer()
                throws SaSystemException,
                       SaAuthenticationException
```
    Deprecated. Functionality removed because of security-concerns. Method contained for compatibility only. Use windows service management tool or SAPERION MMC to stop the server. Will be removed with version 8.0.
    
    Stops the remote server.
    
    Throws:
    
    SaSystemException - SaSystemException
    
    SaAuthenticationException - SaAuthenticationException
  - addListener
```
@Deprecated
void addListener(SaEventListener listener)
                 throws SaAuthenticationException,
                        SaSystemException
```
    Deprecated. will be removed with version 8.0
    
    Adds a new listener to the handler.
    
    Parameters:
    listener - Event listener
    
    Throws:
    
    SaAuthenticationException - SaAuthenticationException
    
    SaSystemException - SaSystemException
  - removeListener
```
@Deprecated
void removeListener(SaEventListener listener)
                    throws SaSystemException
```
    Deprecated. will be removed with version 8.0
    
    Removes a listener from the handler.
    
    Parameters:
    listener - Event listener
    
    Throws:
    
    SaSystemException - SaSystemException
  - addListener
```
@Deprecated
void addListener(SaStatusEventListener listener)
                 throws SaAuthenticationException,
                        SaSystemException
```
    Deprecated. will be removed with version 8.0
    
    Adds a new listener to the handler.
    
    Parameters:
    listener - Event listener
    
    Throws:
    
    SaAuthenticationException - SaAuthenticationException
    
    SaSystemException - SaSystemException
  - removeListener
```
@Deprecated
void removeListener(SaStatusEventListener listener)
                    throws SaSystemException
```
    Deprecated. will be removed with version 8.0
    
    Removes a listener from the handler.
    
    Parameters:
    listener - Event listener
    
    Throws:
    
    SaSystemException - SaSystemException
  - getDefinitions
```
String[] getDefinitions()
                        throws SaSystemException,
                               SaAuthenticationException
```
    Reads the registered DDC names from the repository.
    
    Returns:
    Array of DDC names
    
    Throws:
    
    SaSystemException - SaSystemException
    
    SaAuthenticationException - SaAuthenticationException
  - getFolderDefinitions
```
String[] getFolderDefinitions()
                              throws SaSystemException,
                                     SaAuthenticationException
```
    Reads the registered folder DDC names from the repository.
    
    Returns:
    Array of folder DDC names
    
    Throws:
    
    SaSystemException - SaSystemException
    
    SaAuthenticationException - SaAuthenticationException
  - getDBDefinition
```
SaFieldDescription[] getDBDefinition(String name)
                                     throws SaSystemException,
                                            SaAuthenticationException
```
    Reads the definitions of a database definition (DDC) for the given name.
    
    Parameters:
    name - name of the database definition (DDC) to get
    
    Returns:
    Array of field definitions SaFieldDescription represented as an array of SaJNIFieldDescription instances;
    
    Throws:
    
    SaSystemException - SaSystemException
    
    SaAuthenticationException - SaAuthenticationException
  - getSystemSetting
```
SaSystemSetting getSystemSetting(String accessKey)
                                 throws SaSystemException,
                                        SaAuthenticationException
```
    Retrieves a system setting object.
    
    Parameters:
    accessKey - key to get associated system setting
    
    Returns:
    SaSystemSetting
    
    Throws:
    
    SaSystemException - System exception
    
    SaAuthenticationException - when the user is not logged in or has insufficient rights
  - getSystemInfo
```
SaSystemInfo getSystemInfo()
                           throws SaSystemException
```
    Reads the system informations.
    
    Returns:
    System informations SaSystemInfo
    
    Throws:
    
    SaSystemException - System exception
  - getFeatures
```
SaFeature getFeatures()
                      throws SaSystemException
```
    Reads the features.
    
    Returns:
    Features
    
    Throws:
    
    SaSystemException - System exception
  - getUserSetting
```
SaUserSetting getUserSetting(String accessKey)
                             throws SaSystemException,
                                    SaAuthenticationException
```
    Retrieves a user-specific setting object. User-specific settings are stored in the system's ini-files.
    
    Parameters:
    accessKey - The key to get associated user setting. The key consists of the type of the setting and a key to identify the setting separated by '|'.
    
    Example: How to read a section from Saperion's ini-files:
    PROPERTIES|TheNameOfTheSection
    
    If the section's name contains a tenant-specific hex-id, you can use the placeholders $my_tenant$ , which will be replaced by the current tenant's ID and $all_tenants$ , which will be replaced by the ID representing all tenants.
    
    Returns:
    SaUserSetting
    
    Throws:
    
    SaSystemException - System exception
    
    SaAuthenticationException - when the user is not logged in or has insufficient rights
  - setUserSetting
```
void setUserSetting(SaUserSetting setting)
                    throws SaSystemException,
                           SaAuthenticationException
```
    Persists a user-specific setting object. User-specific settings are stored in the system's ini-files.
    
    Parameters:
    setting - the SaUserSetting object to be stored
    
    Throws:
    
    SaSystemException - System exception
    
    SaAuthenticationException - when the user is not logged in or has insufficient rights
  - getSetting
```
Setting getSetting(String name,
                 String section,
                 boolean isLong)
                   throws SaSystemException,
                          SaAuthenticationException
```
    Retrieves a Setting identified by it's key and section 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 specified key and section was found
    
    Throws:
    
    SaSystemException - system error when retrieving the setting
    
    SaAuthenticationException - authentication error when retrieving the setting
  - 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
```
    Stores a Setting in the database.
    
    Parameters:
    setting - the setting to store
    
    Throws:
    
    SaSystemException - system error when storing the setting
    
    SaAuthenticationException - authentication error when storing 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 the setting was deleted, false if there was no such setting
    
    Throws:
    
    SaSystemException - system exception when deleting the setting
    
    SaAuthenticationException - when the user is not logged in or has insufficient rights when deleting the setting
  - logon
```
int logon(String username,
        String password,
        int type,
        String client)
          throws SaAuthenticationException,
                 SaSystemException
```
    performs logon to the backend system.
    
    Parameters:
    username - User's full name
    password - Password
    type - User type that means client license type. There are possible the following integer values:
    1 = index
    2 = query
    3 = univeral administrator
    4 = web query
    7 = web index
    12 = workflow
    13 = scan
    14 = highend scan
    15 = API query
    16 = API index
    17 = API scan
    20 = basic administrator
    29 = web workflow
    client - client/mandant name, used in multi-client systems
    
    Returns:
    User token for the current session.
    
    Throws:
    
    SaAuthenticationException - when the user is not logged in or has insufficient rights
    
    SaSystemException - SaSystemException
  - logon
```
@Deprecated
int logon(jcifs.smb.NtlmPasswordAuthentication auth,
                   int type,
                   String client)
          throws SaAuthenticationException,
                 SaSystemException
```
    Deprecated. will be removed with version 8.0
    
    Performs a logon with NTLM authentication.
    
    Parameters:
    auth - Ntlm authentication object
    type - User type that means client license type. There are possible the following integer values:
    1 = index
    2 = query
    3 = univeral administrator
    4 = web query
    7 = web index
    12 = workflow
    13 = scan
    14 = highend scan
    15 = API query
    16 = API index
    17 = API scan
    20 = basic administrator
    29 = web workflow
    client - client/mandant name, used in multi-client systems
    
    Returns:
    User token for the current session.
    
    Throws:
    
    SaAuthenticationException - when the user is not logged in or has insufficient rights
    
    SaSystemException - SaSystemException
  - logon
```
@Deprecated
int logon(byte[] token,
                   int type,
                   String client)
          throws SaAuthenticationException,
                 SaSystemException
```
    Deprecated. will be removed with version 8.0
    
    Throws:
    
    SaSystemException - because it is not supported anymore.
    
    SaAuthenticationException
  - logon
```
com.saperion.connector.authentication.Session logon(com.saperion.connector.authentication.Credentials credentials)
                                                    throws SaAuthenticationException,
                                                           SaSystemException
```
    Performs a logon with the given Credentials and returns the information about the open session.
    
    Parameters:
    credentials -
    
    Returns:
    Informations about the created session.
    
    Throws:
    
    SaAuthenticationException - thrown if logon was not possible through wrong password or not existing user
    
    SaSystemException - thrown if the system is not reachable
    See Also:
    UsernamePasswordKey
  - logoff
```
boolean logoff()
               throws SaAuthenticationException,
                      SaSystemException
```
    Log off from the system.
    
    Returns:
    true if logging off was successful
    
    Throws:
    
    SaAuthenticationException - user was not logged in
    
    SaSystemException - remote exception
  - 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 locale)
               throws SaAuthenticationException,
                      SaSystemException
```
    Set the localization information for this user.
    
    Parameters:
    locale - Localization information
    
    Throws:
    
    SaAuthenticationException - when the user is not logged in or has insufficient rights
    
    SaSystemException - SaSystemException
  - readDocument
```
InputStream readDocument(String documentHDOC,
                       boolean currentRevision,
                       int elementNumber)
                         throws SaSystemException,
                                SaAuthenticationException
```
    Loads a document's content from the backend system.
    
    This method creates a document's InputStream instance from the appropriate document in the backend system. This document is specified by its UID (XHDOC).
    The actual content of the document can be read by using InputStream.read()
    
    Parameters:
    documentHDOC - The ID of the document (XHDOC)
    currentRevision - flag indicating that the current revision of the document should be retrieved by resolving the XHDOC.
    elementNumber - position in the document structure; 0 if the document is unstructured, -1 returns a single multi-page tif containing all content elements, but only for COLD and multi-page tif documents
    
    Returns:
    Input stream containing the document content
    
    Throws:
    
    SaSystemException - SaSystemException
    
    SaAuthenticationException - SaAuthenticationException InputStream.read(byte[]) or InputStream.read(byte[], int, int) methods.
  - readReleasedDocument
```
InputStream readReleasedDocument(String docHdoc,
                               boolean currentRevision,
                               int elementNumber)
                                 throws SaSystemException,
                                        SaAuthenticationException
```
    Read released document if the release feature is active.
    
    Parameters:
    docHdoc - the doc hdoc
    currentRevision - the current revision
    elementNumber - the element number
    
    Returns:
    the input stream
    
    Throws:
    
    SaSystemException - the sa system exception
    
    SaAuthenticationException - when the user is not logged in or has insufficient rights
  - readDocumentMetadata
```
SaPropertyValue[] readDocumentMetadata(String documentSysRowID,
                                     String ddcName,
                                     String[] fields)
                                       throws SaSystemException,
                                              SaAuthenticationException,
                                              SaDDCException
```
    Reads the metadata of the document with the given ID.
    
    Parameters:
    documentSysRowID - The ID of the document (SYSROWID)
    ddcName - The name of the database definition
    fields - Fieldnames to be read. If empty or null, all fields will be read.
    
    Returns:
    The Metadata of the document represented as an array of SaPropertyValue instances.
    
    Throws:
    
    SaSystemException - SaSystemException
    
    SaAuthenticationException - when the user is not logged in or has insufficient rights
    
    SaDDCException - SaDDCException
  - getFulltext
```
@Deprecated
String getFulltext(String ddcName,
                            String sysRowId)
                   throws SaSystemException,
                          SaAuthenticationException
```
    Deprecated. Will be removed in 8.0. Use getFulltext(String, String, String, long) instead.
    
    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
    
    Returns:
    Content of the fulltext for this document
    
    Throws:
    
    SaSystemException - SaSystemException
    
    SaAuthenticationException - when the user is not logged in or has insufficient rights
  - getFulltext
```
String getFulltext(String ddcName,
                 String hdoc,
                 String fieldName,
                 long length)
                   throws SaSystemException,
                          SaAuthenticationException
```
    Reads the fulltext information for the given document with the given HDOC in the given DDC from the specified field.
    
    Parameters:
    ddcName - DDC name of the document
    hdoc - HDOC of the document
    fieldName - name of the fulltext field to read from
    length - length of the content to return. If -1, the complete content will be returned.
    
    Returns:
    Content of the fulltext for this document
    
    Throws:
    
    SaSystemException - SaSystemException
    
    SaAuthenticationException - when the user is not logged in or has insufficient rights
  - getThumbnail
```
byte[] getThumbnail(String hDoc,
                  int widthX,
                  int widthY,
                  boolean color)
                    throws SaSystemException,
                           SaAuthenticationException
```
    Reads the thumbnail of the given document. It is possible to set either widthX or widthY to -1 to auto-calculate the value. An empty array is returned, when no thumbnail is available.
    
    Parameters:
    hDoc - HDoc for the document.
    widthX - Width X or -1 to auto-calculate
    widthY - Width Y or -1 to auto-calculate
    color - True for colored
    
    Returns:
    Thumbnail BMP as byte array
    
    Throws:
    
    SaSystemException - System exception
    
    SaAuthenticationException - when the user is not logged in or has insufficient rights
  - createDocument
```
@Deprecated
SaSaveInfo createDocument(String ddcName,
                                   Properties namevaluePairs,
                                   InputStream[] content,
                                   String versionComment)
                          throws SaSystemException,
                                 SaAuthenticationException,
                                 SaDDCException
```
    Deprecated. will be removed with version 8.0, use createDocument(DocumentInfo) instead.
    
    Creates a new document on the backend system with the given metadata and content.
    
    Parameters:
    ddcName - The name of the database definition
    namevaluePairs - A properties object containing the metadata of the document (e.g index fields and their values)
    content - Multiple content data (an array of InputStream instances)
    versionComment - The comment for the version
    
    Returns:
    SaSaveInfo SaSaveInfo object describing the document
    
    Throws:
    
    SaSystemException - SaSystemException
    
    SaAuthenticationException - when the user is not logged in or has insufficient rights
    
    SaDDCException - SaDDCException
  - updateDocument
```
@Deprecated
SaSaveInfo updateDocument(String ddcName,
                                   String documentHDOC,
                                   Properties namevaluePairs,
                                   InputStream[] content,
                                   String versionComment)
                          throws SaSystemException,
                                 SaAuthenticationException,
                                 SaDDCException
```
    Deprecated. will be removed with version 8.0, use #updateDocument(DocumentInfo) instead.
    
    Updates a document in the backend system with the given metadata and content. Only the attached metadata and elements are changed. If the document was checked out, it will be automatically checked in.
    
    Parameters:
    ddcName - The name of the database definition
    documentHDOC - The ID of the document (HDOC)
    namevaluePairs - A properties object containing the metadata
    content - Multiple content data
    versionComment - The comment for the version
    
    Returns:
    SaSaveInfo SaSaveInfo object describing the document
    
    Throws:
    
    SaSystemException - SaSystemException
    
    SaAuthenticationException - when the user is not logged in or has insufficient rights
    
    SaDDCException - SaDDCException
  - createDocument
```
@Deprecated
SaSaveInfo createDocument(String ddcName,
                                   Properties namevaluePairs,
                                   InputStream[] content,
                                   String versionComment,
                                   String acls)
                          throws SaSystemException,
                                 SaAuthenticationException,
                                 SaDDCException
```
    Deprecated. will be removed with version 8.0, use createDocument(DocumentInfo) instead.
    
    Creates a new document on the backend system with the given metadata, acl's and content.
    
    Parameters:
    ddcName - The name of the database definition
    namevaluePairs - A properties object containing the metadata of the document (e.g index fields and their values)
    content - Multiple content data (an array of InputStream instances)
    versionComment - The comment for the version
    acls - ACL name string (semicolon separated)
    
    Returns:
    SaSaveInfo SaSaveInfo object describing the new created document
    
    Throws:
    
    SaSystemException - SaSystemException
    
    SaAuthenticationException - when the user is not logged in or has insufficient rights
    
    SaDDCException - SaDDCException
  - createDocument
```
SaSaveInfo createDocument(DocumentInfo document)
                          throws SaSystemException,
                                 SaAuthenticationException,
                                 SaDDCException
```
    Creates a new document on the backend system with the given DocumentInfo.
    
    Parameters:
    document - the document
    
    Returns:
    SaSaveInfo SaSaveInfo object describing the new created document
    
    Throws:
    
    SaSystemException - the sa system exception
    
    SaAuthenticationException - when the user is not logged in or has insufficient rights
    
    SaDDCException - the sa ddc exception
  - createLink
```
SaSaveInfo createLink(LinkInfo link)
                      throws SaSystemException,
                             SaAuthenticationException,
                             SaDDCException
```
    Creates a link to a document for given LinkInfo.
    A link represents a reference to another document.
    
    Parameters:
    link - info LinkInfo to create a link
    
    Returns:
    SaSaveInfo of new created link
    
    Throws:
    
    SaSystemException - the sa system exception
    
    SaAuthenticationException - when the user is not logged in or has insufficient rights
    
    SaDDCException - the sa ddc exception
  - updateDocument
```
@Deprecated
SaSaveInfo updateDocument(String ddcName,
                                   String documentHDOC,
                                   Properties namevaluePairs,
                                   InputStream[] content,
                                   String versionComment,
                                   String acls)
                          throws SaSystemException,
                                 SaAuthenticationException,
                                 SaDDCException
```
    Deprecated. will be removed with version 8.0
    
    Updates a document in the backend system with the given metadata, acls and content. Only the attached metadata and elements are changed. If the document was checked out, it will be automatically checked in.
    
    Parameters:
    ddcName - The name of the database definition
    documentHDOC - The ID of the document (HDOC)
    namevaluePairs - A properties object containing the metadata
    content - Multiple content data
    versionComment - The comment for the version
    acls - ACL name string, if null it will be ignored, to delete existing ACLs set an empty string
    
    Returns:
    SaSaveInfo SaSaveInfo object describing the document
    
    Throws:
    
    SaSystemException - SaSystemException
    
    SaAuthenticationException - when the user is not logged in or has insufficient rights
    
    SaDDCException - SaDDCException
  - updateDocument
```
@Deprecated
SaSaveInfo updateDocument(String ddcName,
                                   String documentHDOC,
                                   Properties namevaluePairs,
                                   InputStream[] content,
                                   String versionComment,
                                   String acls,
                                   boolean resolveLinks)
                          throws SaSystemException,
                                 SaAuthenticationException,
                                 SaDDCException
```
    Deprecated. will be removed with version 8.0
    
    Updates a document in the backend system with the given metadata, acls and content. Only the attached metadata and elements are changed. If the document was checked out, it will be automatically checked in.
    
    Parameters:
    ddcName - The name of the database definition
    documentHDOC - The ID of the document (HDOC)
    namevaluePairs - A properties object containing the metadata
    content - Multiple content data
    versionComment - The comment for the version
    acls - ACL name string, if null it will be ignored, to delete existing ACLs set an empty string
    resolveLinks - Resolve links
    
    Returns:
    SaSaveInfo SaSaveInfo object describing the document
    
    Throws:
    
    SaSystemException - SaSystemException
    
    SaAuthenticationException - when the user is not logged in or has insufficient rights
    
    SaDDCException - SaDDCException
  - updateDocument
```
@Deprecated
SaSaveInfo updateDocument(String ddcName,
                                   String documentHDOC,
                                   Properties namevaluePairs,
                                   InputStream[] content,
                                   String versionComment,
                                   String acls,
                                   boolean resolveLinks,
                                   boolean checkin)
                          throws SaSystemException,
                                 SaAuthenticationException,
                                 SaDDCException
```
    Deprecated. will be removed with version 8.0
    
    Updates a document in the backend system with the given metadata, acls and content. Only the attached metadata and elements are changed. If the document was checked out, it will be automatically checked in.
    
    Parameters:
    ddcName - The name of the database definition
    documentHDOC - The ID of the document (HDOC)
    namevaluePairs - A properties object containing the metadata
    content - Multiple content data
    versionComment - The comment for the version
    acls - ACL name string, if null it will be ignored, to delete existing ACLs set an empty string
    resolveLinks - Resolve links
    checkin - Checkin document
    
    Returns:
    SaSaveInfo SaSaveInfo object describing the document
    
    Throws:
    
    SaSystemException - when a system error occured
    
    SaAuthenticationException - when the user is not logged in or has insufficient rights
    
    SaDDCException - when a database definition was invalid or not found
  - updateDocument
```
SaSaveInfo updateDocument(UpdateDocumentInfo updateInfo)
                          throws SaSystemException,
                                 SaAuthenticationException,
                                 SaDDCException
```
    Updates a document in the backend system with the given metadata, acls and content. Only the attached metadata and elements are changed.
    
    Parameters:
    updateInfo - updateInfo bean
    
    Returns:
    information about the saved document
    
    Throws:
    
    SaSystemException - when a system error occured
    
    SaAuthenticationException - when the user is not logged in or has insufficient rights
    
    SaDDCException - when a database definition was invalid or not found
  - checkoutDocument
```
void checkoutDocument(String hDoc)
                      throws SaSystemException,
                             SaAuthenticationException,
                             SaGetNodeException
```
    Checkouts a document for the given document id (hdoc).
    
    Parameters:
    hDoc - id (HDOC) of document to checkout
    
    Throws:
    
    SaSystemException - SaRMICommandException
    
    SaAuthenticationException - when the user is not logged in or has insufficient rights
    
    SaGetNodeException - SaGetNodeException
  - discardCheckout
```
void discardCheckout(String hDoc)
                     throws SaSystemException,
                            SaAuthenticationException,
                            SaGetNodeException
```
    Discards the checkout of the given document.
    
    Parameters:
    hDoc - Document HDOC
    
    Throws:
    
    SaSystemException - SaRMICommandException
    
    SaAuthenticationException - when the user is not logged in or has insufficient rights
    
    SaGetNodeException - SaGetNodeException
  - releaseDocument
```
void releaseDocument(String ddcName,
                   String hDoc,
                   String versionComment)
                     throws SaSystemException,
                            SaAuthenticationException,
                            SaGetNodeException,
                            SaSetNodeException,
                            SaDDCException
```
    Release the given document.
    
    Parameters:
    ddcName - the ddc name
    hDoc - Document HDOC
    versionComment - the version comment
    
    Throws:
    
    SaSystemException - SaRMICommandException
    
    SaAuthenticationException - when the user is not logged in or has insufficient rights
    
    SaGetNodeException - SaGetNodeException
    
    SaSetNodeException - the sa set node exception
    
    SaDDCException - the sa ddc exception
  - isReleaseActive
```
boolean isReleaseActive()
                        throws SaAuthenticationException,
                               SaSystemException
```
    Checks if is release feature in the program.ini in section [Release] is active.
    
    Returns:
    true, if is release active
    
    Throws:
    
    SaAuthenticationException - when the user is not logged in or has insufficient rights
    
    SaSystemException - the sa system exception
  - getReleasedHdoc
```
String getReleasedHdoc(String oldHdoc)
                       throws SaAuthenticationException,
                              SaSystemException
```
    Gets the released hdoc for given hdoc if release feature is on and release tag is set, otherwise returns the given hDoc.
    
    Parameters:
    oldHdoc - the hdoc to lookup released hdoc
    
    Returns:
    the released hdoc
    
    Throws:
    
    SaAuthenticationException - if authentication fails
    
    SaSystemException - the sa system exception
  - lockDocument
```
boolean lockDocument(String sysRowId,
                   String ddcName)
                     throws SaSystemException,
                            SaAuthenticationException,
                            SaLockException
```
    Locks a document.
    
    Parameters:
    sysRowId - SysRowId of document to lock
    ddcName - DDC name
    
    Returns:
    True, if document was locked succesfully, otherwise false
    
    Throws:
    
    SaSystemException - The SaSystemException
    
    SaAuthenticationException - The when the user is not logged in or has insufficient rights
    
    SaLockException - The SaLockException
  - unlockDocument
```
boolean unlockDocument(String sysRowId,
                     String ddcName)
                       throws SaSystemException,
                              SaAuthenticationException,
                              SaLockException
```
    Unlocks a document.
    
    Parameters:
    sysRowId - SysRowId of document to unlock
    ddcName - DDC name
    
    Returns:
    True, if document was unlocked successlully, otherwise false
    
    Throws:
    
    SaSystemException - The SaSystemException
    
    SaAuthenticationException - The when the user is not logged in or has insufficient rights
    
    SaLockException - The SaLockException
  - getDocumentInfo
```
SaDocInfo getDocumentInfo(String hDoc,
                        boolean currentRevision,
                        boolean resolveLinks)
                          throws SaSystemException,
                                 SaAuthenticationException
```
    Reads the document information for the given document. The backend is not forced to determine the size of each element, so sizes might not be available. ATTENTION! This method is slow because of full load of the document.
    
    Parameters:
    hDoc - Document HDOC
    currentRevision - True for current revision
    resolveLinks - True for resolve links
    
    Returns:
    Document information
    
    Throws:
    
    SaSystemException - The SaSystemException
    
    SaAuthenticationException - Authenication failure
    See Also:
    getDocumentInfo(String, boolean, boolean, boolean)
  - getDocumentInfo
```
SaDocInfo getDocumentInfo(String hDoc,
                        boolean currentRevision,
                        boolean resolveLinks,
                        boolean forceSizeDetermination)
                          throws SaSystemException,
                                 SaAuthenticationException
```
    Reads the document information for the given document. ATTENTION! This method is slow because of full load of the document.
    
    Parameters:
    hDoc - Document HDOC
    currentRevision - True for current revision
    resolveLinks - True for resolve links
    forceSizeDetermination - Forces the backend to determine the size of each element, even if it is not already available. Reqiures loading the document, so use only if really required.
    
    Returns:
    Document information
    
    Throws:
    
    SaSystemException - The SaSystemException
    
    SaAuthenticationException - Authenication failure
  - restoreVersion
```
SaSaveInfo restoreVersion(String versionID)
                          throws SaSystemException,
                                 SaAuthenticationException,
                                 SaDDCException
```
    Restores the version with the given HDOC.
    
    Parameters:
    versionID - Version HDOC
    
    Returns:
    SaSaveInfo object describing the new document
    
    Throws:
    
    SaSystemException - SaSystemException
    
    SaAuthenticationException - when the user is not logged in or has insufficient rights
    
    SaDDCException - SaDDCException
  - search
```
@Deprecated
List<SaPropertyValue[]> search(String hqlQuery)
                               throws SaSystemException,
                                      SaAuthenticationException,
                                      SaDBException
```
    Deprecated. Use searchHQL() instead. Will be removed with version 8.0
    
    Performs a search with the given hql query (hibernate query language).
    
    Parameters:
    hqlQuery - the Hibernate query - hql.
    
    Returns:
    a result list of values which are returned by the Hibernate. Each returned value represented as SaPropertyValue object.
    
    Throws:
    
    SaSystemException - SaSystemException
    
    SaAuthenticationException - when the user is not logged in or has insufficient rights
    
    SaDBException - exception thrown during query execution
  - searchHQL
```
List<SaDocumentInfo> searchHQL(SaQueryInfo hqlQuery)
                               throws SaSystemException,
                                      SaAuthenticationException,
                                      SaDBException
```
    Performs a search with the given hql query (hibernate query language).
    
    Parameters:
    hqlQuery - the Hibernate query info.
    
    Returns:
    a result list of document information objects
    
    Throws:
    
    SaSystemException - SaSystemException
    
    SaAuthenticationException - when the user is not logged in or has insufficient rights
    
    SaDBException - exception thrown during query execution
  - deleteDocument
```
void deleteDocument(String documentHDOC,
                  int deleteType)
                    throws SaSystemException,
                           SaAuthenticationException,
                           SaDDCException
```
    Deletes a document from the backend system with the given strategy.
    
    Parameters:
    documentHDOC - The HDoc of the document to delete.
    deleteType - Deletion strategy which may be set on one of 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
    Contains DBSIMPLE and "remove from medium"
    SaConstant.DELETEMODE = "deletemode" -Deletemode entry in archief.ini;
    
    Throws:
    
    SaSystemException - SaSystemException
    
    SaAuthenticationException - when the user is not logged in or has insufficient rights
    
    SaDDCException - SaDDCException
  - getVersionIDs
```
List<String> getVersionIDs(String ddcName,
                         String sysrowID)
                           throws SaSystemException,
                                  SaAuthenticationException
```
    Reads the version IDs of the given document. The versions (XHDOCs) are sorted descending (the most current version is the first element in the list).
    
    Parameters:
    ddcName - The name of the database definition
    sysrowID - The ID of the document
    
    Returns:
    Set of version IDs
    
    Throws:
    
    SaSystemException - SaSystemException
    
    SaAuthenticationException - when the user is not logged in or has insufficient rights
  - readVersionDocument
```
InputStream readVersionDocument(String versionID,
                              int elementNumber)
                                throws SaSystemException,
                                       SaAuthenticationException
```
    Loads a document version from the backend system.
    
    Parameters:
    versionID - Version ID (XHDOC is the revision number of the document)
    elementNumber - Element number
    
    Returns:
    Input stream with the document content
    
    Throws:
    
    SaSystemException - SaSystemException
    
    SaAuthenticationException - when the user of this session is not logged in (anymore) or has insufficient rights
  - readVersionMetadata
```
SaVersionData readVersionMetadata(String versionID)
                                  throws SaSystemException,
                                         SaAuthenticationException,
                                         SaDDCException
```
    Reads the version metadata of the document with the given ID.
    
    Parameters:
    versionID - Version ID (XHDOC is the revision number of the document)
    
    Returns:
    Metadata of the document
    
    Throws:
    
    SaSystemException - SaSystemException
    
    SaAuthenticationException - SaAuthenticationException
    
    SaDDCException - SaDDCException
  - resolveLatestHDoc
```
String resolveLatestHDoc(String oldHdoc)
                         throws SaSystemException,
                                SaAuthenticationException
```
    Resolves and returns the XHDOC of the latest version of the document identified by the given HDOC.
    
    Parameters:
    oldHdoc - the HDOC to identify the document
    
    Returns:
    The XHDOC of the latest version of the document identified by the given HDOC.
    
    Throws:
    
    SaSystemException - SaSystemException
    
    SaAuthenticationException - SaAuthenticationException
  - removeEvent
```
@Deprecated
boolean removeEvent(SaEvent event)
                    throws SaSystemException
```
    Deprecated. no longer supported. Will be removed with version 8.0
    
    Deletes the row from XEvents for the given event.
    
    Parameters:
    event - Event object
    
    Returns:
    boolean true deleted
    
    Throws:
    
    SaSystemException - SaSystemException
  - readDocumentFilename
```
@Deprecated
String readDocumentFilename(String documentHDOC,
                                     boolean currentRevision,
                                     int elementNumber)
                            throws SaSystemException,
                                   SaAuthenticationException,
                                   SaDDCException
```
    Deprecated. will be removed with version 8.0
    
    Reads the filenames of the application data of the document with the given ID.
    
    Parameters:
    documentHDOC - The ID of the document (XHDOC)
    currentRevision - flag indicating that the current revision of the document should be retrieved by resolving the HDoc.
    elementNumber - position in the document structure; 0 if the document is unstructured.
    
    Returns:
    Filenames of the application data
    
    Throws:
    
    SaSystemException - SaSystemException
    
    SaAuthenticationException - SaAuthenticationException
    
    SaDDCException - SaDDCException
  - readVersionDocumentFilename
```
@Deprecated
String readVersionDocumentFilename(String documentHDOC,
                                            int elementNumber)
                                   throws SaSystemException,
                                          SaAuthenticationException,
                                          SaDDCException
```
    Deprecated. use getDocumentInfo.getFullName() instead. Will be removed with version 8.0
    
    Reads the filenames of the application data of the document with the given ID.
    
    Parameters:
    documentHDOC - The ID of the document (XHDOC)
    elementNumber - position in the document structure; 0 if the document is unstructured.
    
    Returns:
    Filenames of the application data
    
    Throws:
    
    SaSystemException - SaSystemException
    
    SaAuthenticationException - SaAuthenticationException
    
    SaDDCException - SaDDCException
  - getACLNames
```
String getACLNames(String documentHDOC)
                   throws SaSystemException,
                          SaAuthenticationException,
                          SaDDCException
```
    Reads the ACL's for the given document.
    
    Parameters:
    documentHDOC - The ID of the document (XHDOC)
    
    Returns:
    ACL name string
    
    Throws:
    
    SaSystemException - RemoteException
    
    SaAuthenticationException - SaAuthenticationException
    
    SaDDCException - SaDDCException
  - setACLName
```
SaSaveInfo setACLName(String ddcname,
                    String documentHDOC,
                    String acl,
                    String versionComment)
                      throws SaSystemException,
                             SaAuthenticationException,
                             SaDDCException,
                             SaSetACLException
```
    Adds the given ACL to the node.
    
    Parameters:
    ddcname - the name of the ddc in saperion
    documentHDOC - The ID of the document (XHDOC)
    acl - ACL
    versionComment - Versioncomment
    
    Returns:
    save info object
    
    Throws:
    
    SaSystemException - RemoteException
    
    SaAuthenticationException - SaAuthenticationException
    
    SaDDCException - SaDDCException
    
    SaSetACLException - SaSetACLException
  - getInvolvedUsers
```
List<String> getInvolvedUsers(String documentHDOC)
                              throws SaSystemException,
                                     SaAuthenticationException,
                                     SaDDCException
```
    Reads all users involved in the set of ACL's.
    
    Parameters:
    documentHDOC - The ID of the document (XHDOC)
    
    Returns:
    List of user names
    
    Throws:
    
    SaSystemException - SaSystemException
    
    SaAuthenticationException - SaAuthenticationException
    
    SaDDCException - SaDDCException
  - getAllACLs
```
@Deprecated
List<String> getAllACLs()
                        throws SaSystemException,
                               SaAuthenticationException
```
    Deprecated. use getAcls() instead. Will be removed with version 8.0
    
    Reads all existing ACL names.
    
    Returns:
    List of ACL names
    
    Throws:
    
    SaSystemException - Remote exception
    
    SaAuthenticationException - SaAuthenticationException
  - getAcls
```
List<SaAcl> getAcls()
                    throws SaSystemException,
                           SaAuthenticationException
```
    Reads all existing ACLs.
    
    Returns:
    List of ACLs
    
    Throws:
    
    SaSystemException - Remote exception
    
    SaAuthenticationException - SaAuthenticationException
  - getACLRights
```
SaACLRights getACLRights(String[] acls)
                         throws SaSystemException,
                                SaAuthenticationException
```
    Read the rights for the given ACL's.
    
    Parameters:
    acls - array of ACL name to get rights for
    
    Returns:
    Rights
    
    Throws:
    
    SaSystemException - Remote exception
    
    SaAuthenticationException - SaAuthenticationException
  - getDocumentAccessData
```
SaDocAccessData getDocumentAccessData(String documentHDOC)
                                      throws SaSystemException,
                                             SaAuthenticationException
```
    Reads the access rights of the given document.
    
    Parameters:
    documentHDOC - The ID of the document (XHDOC)
    
    Returns:
    Access rigths of this document
    
    Throws:
    
    SaSystemException - Remote exception
    
    SaAuthenticationException - SaAuthenticationException
  - getLockInfo
```
SaLockInfo getLockInfo(String sysRowId)
                       throws SaSystemException,
                              SaAuthenticationException,
                              SaLockException
```
    Returns the locking informations for a given document.
    
    Parameters:
    sysRowId - Document SysRowId
    
    Returns:
    Lockin informations
    
    Throws:
    
    SaSystemException - Remote exception
    
    SaAuthenticationException - Authentification error
    
    SaLockException - Locking error
  - getWorkflowConnector
```
SaWFConnector getWorkflowConnector()
                                   throws SaAuthenticationException,
                                          SaSystemException
```
    Returns a workflow connector based on this classic connector.
    
    Returns:
    Workflow connector
    
    Throws:
    
    SaAuthenticationException - Authentification error
    
    SaSystemException - Remote exception
  - isAlive
```
boolean isAlive()
                throws SaSystemException
```
    Test the lifetime of this connector.
    
    Returns:
    True if alive
    
    Throws:
    
    SaSystemException - System exception
  - getAnnotations
```
@Deprecated
String getAnnotations(String hDoc,
                               int indexOfContentElement)
                      throws SaAuthenticationException,
                             SaSystemException
```
    Deprecated. use getAnnotations(String, int, boolean) instead. Will be removed with version 8.0
    
    Reads the annotations from the given document.
    
    Parameters:
    hDoc - Document HDOC
    indexOfContentElement - the index of the chosen context element
    
    Returns:
    Annotation string
    
    Throws:
    
    SaAuthenticationException - Authentication error
    
    SaSystemException - Remote exception
  - 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:
    
    SaAuthenticationException - Authentication error
    
    SaSystemException - Remote exception
  - 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
    indexOfContentElement - the index of the chosen context element
    annotations - Annotation string
    
    Throws:
    
    SaAuthenticationException - Authentication error
    
    SaSystemException - Remote exception
  - getFolderChildren
```
List<SaDocumentInfo> getFolderChildren(String folderTableDDC,
                                     String folderId,
                                     int depth,
                                     SaQueryInfo filter,
                                     int allowedMaxNrOfChildFolders)
                                       throws SaSystemException,
                                              SaAuthenticationException,
                                              SaDBException,
                                              SaFolderException
```
    Returns a list 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 to get children for. Needs to be gte 1.
    filter - Additional HQL filter criteria
    allowedMaxNrOfChildFolders - allowed maximum number of child folders per level or -1 for no limit
    
    Returns:
    List of folder information
    
    Throws:
    
    SaSystemException - Remote exception
    
    SaAuthenticationException - Authentication error
    
    SaDBException - Database exception
    
    SaFolderException - Folder exception
  - getFolderInfo
```
@Deprecated
SaDocumentInfo getFolderInfo(String folderTableDDC,
                                      String folderId)
                             throws SaSystemException,
                                    SaAuthenticationException,
                                    SaDBException,
                                    SaFolderException
```
    Deprecated. use getFolderInfo(String, String, boolean) instead
    
    Returns the folder information object for the given folder.
    
    Parameters:
    folderTableDDC - Folder table
    folderId - Folder ID
    
    Returns:
    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
```
    Returns the folder information 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 information
    
    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 folder. Please note that in case of a folder to which another folder 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 startFolderId,
                                     String folderPath)
                                       throws SaSystemException,
                                              SaAuthenticationException,
                                              SaDBException
```
    Returns the folders which match to the given path. Path names are built using the SysFolderName field of each folder. Either the slash ('/') or the backslash ('\') can be used as path separator. A path can be searched relative to a given folder, to allow for searching within Personal folders and the like. 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. Use getFolderByPath(String, String, String) to retrieve a single folder.
    
    Parameters:
    folderTableDDC - Folder table
    startFolderId - ID of folder to start with or null/empty if no relative search is required
    folderPath - Search path
    
    Returns:
    Folder list
    
    Throws:
    
    SaSystemException - Remote exception
    
    SaAuthenticationException - Authentication error
    
    SaDBException - Database exception
  - getFolderByPath
```
SaDocumentInfo getFolderByPath(String folderTableDDC,
                             String startFolderId,
                             String folderPath)
                               throws SaSystemException,
                                      SaAuthenticationException,
                                      SaDBException
```
    Returns the folder which matches to the given path. Path names are built using the SysFolderName field of each folder. Either the slash ('/') or the backslash ('\') can be used as path separator. A path can be searched relative to a given folder, to allow for searching within Personal folders and the like. If no folder with the specified path is found, null is returned.
    
    Parameters:
    folderTableDDC - Folder table
    startFolderId - ID of folder to start with or null/empty if no relative search is required
    folderPath - Search path
    
    Returns:
    Folder list
    
    Throws:
    
    SaSystemException - Remote exception
    
    SaAuthenticationException - Authentication error
    
    SaDBException - Database exception
  - createFolder
```
@Deprecated
String createFolder(String folderTableDDC,
                             String parentId,
                             String beforeChild,
                             String folderName,
                             SaFolderConstants.FOLDER_TYPE folderType,
                             Properties namevaluePairs)
                    throws SaSystemException,
                           SaAuthenticationException,
                           SaDDCException,
                           SaFolderNameException
```
    Deprecated. use createFolder(SaFolderSaveInfo, Properties) instead. Will be removed with version 8.0
    
    Creates a new folder below a given folder. The parent folder can be the root node (empty id).
    
    Parameters:
    folderTableDDC - Folder table
    parentId - Parent folder ID or empty
    beforeChild - ID of the child to add the new folder before or empty for append
    folderName - Folder name
    folderType - Type of the folder
    namevaluePairs - Folder properties
    
    Returns:
    Folder ID (SysRowId)
    
    Throws:
    
    SaSystemException - Remote exception
    
    SaAuthenticationException - Authentication error
    
    SaDDCException - Database exception
    
    SaFolderNameException - when the folder name contained an invalid character
  - createFolder
```
String createFolder(SaFolderSaveInfo info,
                  Properties namevaluePairs)
                    throws SaSystemException,
                           SaAuthenticationException,
                           SaDDCException,
                           SaFolderNameException
```
    Creates a new folder below a given folder. The parent folder can be the root node (empty id).
    
    Parameters:
    info - SaFolderSaveInfo of folder to create
    namevaluePairs - Folder properties (Attention: These properties will replace the property values in the SaFolderSaveInfo info above!)
    
    Returns:
    Folder ID (SysRowId)
    
    Throws:
    
    SaSystemException - Remote exception
    
    SaAuthenticationException - Authentication error
    
    SaDDCException - Database exception
    
    SaFolderNameException - when the folder name contained an invalid character
  - updateFolder
```
void updateFolder(String folderTableDDC,
                String folderId,
                Properties namevaluePairs)
                  throws SaSystemException,
                         SaAuthenticationException,
                         SaDDCException,
                         SaFolderNameException
```
    Updates an existing folder with the given properties. Be sure to set the node-type property in the folder's properties to enable special handling for certain types like registers.
    
    Parameters:
    folderTableDDC - name of folder table (DDC)
    folderId - id of folder to update
    namevaluePairs - Folder properties to update
    
    Throws:
    
    SaSystemException - Remote exception
    
    SaAuthenticationException - Authentication error
    
    SaDDCException - Database exception
    
    SaFolderNameException - when the folder name contained an invalid character
    See Also:
    SaFolderConstants.FIELD_SYSNODETYPE, SaFolderConstants.FOLDER_TYPE
  - 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 query text must be only the "where" filter. The main DDC is defined as "d".
    
    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 an existing folder. It must not have children or filed documents, i.e. the user must delete/remove all these before deleting the node.
    
    Parameters:
    folderTableDDC - Folder table
    folderId - Folder ID to delete
    
    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 folder 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 name
    folderId - tolder ID to copy
    destinationId - destination folder ID
    beforeChild - ID of the child to insert the folder before 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 folder to a new destination. Document filings are always moved with the folder. 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 with given documentId to a given folder with given folderId. A document can be filed in multiple folders, but each filing operation must be called separately.
    
    Parameters:
    folderTableDDC - name of the folder table to add document
    documentId - SysRowId of the document to add to folder
    documentDDC - DDC name of the document located in
    folderId - destination folder ID
    
    Throws:
    
    SaSystemException - Remote exception
    
    SaAuthenticationException - Authentication error
    
    SaDDCException - Database exception
    
    SaSetNodeException - DDC not fileable
  - removeFromFolder
```
void removeFromFolder(String folderTableDDC,
                    String documentSysRowId,
                    String documentDDC,
                    String folderId)
                      throws SaSystemException,
                             SaAuthenticationException,
                             SaDDCException
```
    Removes the document from the given folder.
    
    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
```
    Removes the document from the source folder and adds it to the source folder. Both source- and destination folder have to 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 folders the document is contained in. The list is returned only for one folder table, so if the document is filed in multiple folder 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 - DDC 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 contained 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 - DDC not fileable
  - setFolderAcl
```
void setFolderAcl(String folderTableDDC,
                String folderId,
                String aclName)
                  throws SaSystemException,
                         SaAuthenticationException,
                         SaDDCException
```
    Sets an ACL for the given folder. The folder’s SysACLUserList is recalculated, and if the folder has children, the same is true for all the folder’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 class
    
    Throws:
    
    SaSystemException - Remote exception
    
    SaAuthenticationException - authentication error
    
    SaDDCException - Database exception
  - searchFolderClass
```
Set<SaFolderClass> searchFolderClass(SaFolderClassSearchInfo searchInfo)
                                     throws SaSystemException,
                                            SaAuthenticationException
```
    Searches for folder classes that match the specified propertied.
    
    Parameters:
    searchInfo - bean that contains the properties to search for
    
    Returns:
    set of folder classes that match the properties or an empty set, if no class was found
    
    Throws:
    
    SaSystemException - Remote exception
    
    SaAuthenticationException - authentication error
  - getSystemFiles
```
List<String> getSystemFiles(SystemFileKind kind,
                          String filter)
                            throws SaAuthenticationException,
                                   SaSystemException
```
    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
  - storeSystemFile
```
void storeSystemFile(SystemFileKind kind,
                   String name,
                   InputStream data)
                     throws SaAuthenticationException,
                            SaSystemException
```
    Stores a system file of a specific kind.
    
    Parameters:
    kind - The kind of systemfile to store.
    name - The name of the file.
    data - The content of the file to save.
    
    Throws:
    
    SaAuthenticationException - error on the authentification / insufficient rights
    
    SaSystemException - general error
  - loadSystemFile
```
InputStream loadSystemFile(SystemFileKind kind,
                         String name)
                           throws SaAuthenticationException,
                                  SaSystemException
```
    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
  - 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:
    
    SaSystemException - general error
    
    SaAuthenticationException - error on the authentification / insufficient rights
  - changePassword
```
void changePassword(String user,
                  String oldPassword,
                  String client,
                  String newPassword)
                    throws SaSystemException,
                           SaAuthenticationException
```
    Changes the password of an existing user.
    
    Parameters:
    user - The name of the existing 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 - when a system error occured
    
    SaAuthenticationException - when the user is not logged in or has insufficient rights logon(String, String, int, String) was successfully invoked.
  - getAuthorizedUsers
```
List<UsersRights> getAuthorizedUsers(String hDoc,
                                   String rights,
                                   MatchKind match)
                                     throws SaSystemException,
                                            SaAuthenticationException
```
    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 - when a system error occured
    
    SaAuthenticationException - when the user is not logged in or has insufficient rights
  - getArchivedSize
```
int getArchivedSize(String hDoc)
                    throws SaSystemException,
                           SaAuthenticationException
```
    Returns the total document size in the archive.
    
    Parameters:
    hDoc - The document id whichs size is wanted.
    
    Returns:
    The total document size in archive.
    
    Throws:
    
    SaSystemException - when a system error occured
    
    SaAuthenticationException - when the user is not logged in or has insufficient rights
  - createLookupEntry
```
@Deprecated
String createLookupEntry(String ddc,
                                  Properties props)
                         throws SaSystemException,
                                SaAuthenticationException,
                                SaDDCException
```
    Deprecated. This method does not handle system fields and might be removed in a future version. Use invoke(Operation) with a CreateLookupEntry operation instead.
    
    Creates a new entry in the given lookup table and returns the SYSROWID of the new entry.
    
    Parameters:
    ddc - Lookup DDC name
    props - Properties for the new entry
    
    Returns:
    SYSROWID of the new entry
    
    Throws:
    
    SaSystemException - Remote exception
    
    SaAuthenticationException - Authentication error
    
    SaDDCException - Database exception
  - updateLookupEntry
```
@Deprecated
void updateLookupEntry(String ddc,
                                String id,
                                Properties props)
                       throws SaSystemException,
                              SaAuthenticationException,
                              SaDDCException
```
    Deprecated. This method does not handle system fields and might be removed in a future version. Use invoke(Operation) with a UpdateLookupEntry operation instead.
    
    Updates an existing lookup entry with the given properties.
    
    Parameters:
    ddc - Lookup DDC name
    id - SYSROWID of the existing entry
    props - Properties for the entry
    
    Throws:
    
    SaSystemException - Remote exception
    
    SaAuthenticationException - Authentication error
    
    SaDDCException - Database exception
  - deleteLookupEntry
```
@Deprecated
void deleteLookupEntry(String ddc,
                                String id)
                       throws SaSystemException,
                              SaAuthenticationException,
                              SaDDCException
```
    Deprecated. This method does not handle system fields and might be removed in a future version. Use invoke(Operation) with a DeleteLookupEntry operation instead.
    
    Deletes an existing lookup entry.
    
    Parameters:
    ddc - Lookup DDC name
    id - SYSROWID of the existing entry
    
    Throws:
    
    SaSystemException - Remote exception
    
    SaAuthenticationException - Authentication error
    
    SaDDCException - Database exception
  - getCurrentUserName
```
String getCurrentUserName()
```
    Returns the name of the current user.
    
    Returns:
    name of current user logged in.
  - getFolderUpdateInfo
```
Set<FolderUpdateInfo> getFolderUpdateInfo(Map<String,Long> folderIds)
                                          throws SaSystemException,
                                                 SaAuthenticationException
```
    Generates the cut set of folders that are open on ngclient side and changed on rich client side over a specified period of time like the last 10 minutes.
    
    Parameters:
    folderIds - Map of folderIds (simple, workflow, ..) with the time stamps of the last refresh to build the cut set of.
    
    Returns:
    List of FolderUpdateInfo objects that are changed during the last x minutes.
    
    Throws:
    
    SaSystemException - when a system error occured
    
    SaAuthenticationException - when the user is not logged in or has insufficient rights
  - 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
    
    SaSystemException - when checking the sap url by the RLINK server failed
    
    SaAuthenticationException - when the user is not logged in or has insufficient rights
    
    SaSapUrlException
  - cacheDocument
```
SaSaveInfo cacheDocument(String xhDoc,
                       String ddcName,
                       Properties namevaluePairs,
                       InputStream[] content,
                       String versionComment,
                       String strAcl)
                         throws SaSystemException,
                                SaAuthenticationException,
                                SaDDCException
```
    Caches a new document on the backend system with the given metadata and content.
    The document will not be persisted to a storage or medium.
    
    Parameters:
    xhDoc - The xhdoc of the Document to cache
    ddcName - The name of the database definition (DDC)
    namevaluePairs - A properties object containing the metadata of the document (e.g index fields and their values)
    content - Multiple content data (an array of InputStream instances)
    versionComment - The comment for the version
    strAcl - the names of acls (comma sessparated list)
    
    Returns:
    SaSaveInfo SaSaveInfo object describing the document
    
    Throws:
    
    SaSystemException - SaSystemException
    
    SaAuthenticationException - SaAuthenticationException
    
    SaDDCException - SaDDCException
  - cacheDocument
```
SaSaveInfo cacheDocument(String xhDoc,
                       DocumentInfo document)
                         throws SaSystemException,
                                SaAuthenticationException,
                                SaDDCException
```
    Caches the given document on the backend system.
    The document will not be persisted to storage or medium.
    
    Parameters:
    xhDoc - The xhdoc of the Document to cache
    document - the DocumentInfo about the document to cache
    
    Returns:
    the SaSaveInfo of the cached document
    
    Throws:
    
    SaSystemException - the sa system exception
    
    SaAuthenticationException - when the user is not logged in or has insufficient rights
    
    SaDDCException - the sa ddc exception
  - getCurrentUserInfo
```
SaUserInfo getCurrentUserInfo()
                              throws SaAuthenticationException,
                                     SaSystemException
```
    Gets detailed info about the current user.
    
    Returns:
    detailed info about the current user.
    
    Throws:
    
    SaAuthenticationException - If not properly logged in
    
    SaSystemException - SaSystemException
  - setCurrentUserPresent
```
@Deprecated
void setCurrentUserPresent(boolean present)
                           throws SaAuthenticationException,
                                  SaSystemException
```
    Deprecated. Use updateCurrentUserInformation(MutableUserInformation) instead. Will be removed with version 8.0.
    
    Sets whether the current user is present.
    
    Parameters:
    present - whether the current user is present
    
    Throws:
    
    SaSystemException - system error
    
    SaAuthenticationException - authentication error
  - updateCurrentUserInformation
```
void updateCurrentUserInformation(MutableUserInformation user)
                                  throws SaAuthenticationException,
                                         SaSystemException
```
    Changes information about the current user. Since not every information about a user is possible to change it takes a MutableUserInformation instance instead of an SaUserInfo instance as parameter.
    
    Parameters:
    user - - the information to change
    
    Throws:
    
    SaSystemException - system error
    
    SaAuthenticationException - authentication error
  - getRendition
```
List<Rendition> getRendition(Element element,
                           Options options)
                             throws FormatNotSupportedException,
                                    PreconditionFailedException,
                                    TimeoutException,
                                    RenderingException,
                                    SaAuthenticationException,
                                    SaSystemException
```
    Parameters:
    element - an Element object that represents an object in the archived document.
    options -
    
    Returns:
    list of Rendition instances.
    
    Throws:
    
    FormatNotSupportedException - if the input or output format is not supported
    
    PreconditionFailedException - if parts of the options are missing
    
    TimeoutException - if a timeout was specified and it was reached
    
    RenderingException - if engine is not available or internal initialization failures
    
    SaAuthenticationException - If not properly logged in
    
    SaSystemException
  - sendBarcode
```
void sendBarcode(String indexMask,
               String docUid,
               String contentRep,
               String sid,
               String docType,
               String value,
               int mandant)
                 throws SaBarcodeException
```
    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:
    
    SaBarcodeException - BarcodeException
  - hasRenderEngine
```
boolean hasRenderEngine()
```
    Checks wether this classic connector has a render engine.
    
    Returns:
    if there is a render engine true, otherwise false
  - getSupportedRenderSourceFormats
```
Set<SourceFormat> getSupportedRenderSourceFormats()
```
    Gets the supported source formats from the render engine.
    
    Returns:
    set of supported source formats (empty if there is no render engine)
  - getSupportedRenderTargetFormats
```
Set<TargetFormat> getSupportedRenderTargetFormats()
```
    Gets the supported target formats from the render engine.
    
    Returns:
    set of supported target formats (empty if there is no render engine)
  - setEventsEnabled
```
void setEventsEnabled(boolean enabled)
                      throws SaSystemException,
                             SaAuthenticationException
```
    Sets whether events (e.g. for the Integration Server) should be enabled for the current session.
    
    Parameters:
    enabled - true, to enable events, otherwise false.
    
    Throws:
    
    SaSystemException - system error
    
    SaAuthenticationException - authentication error
  - getEventsEnabled
```
boolean getEventsEnabled()
                         throws SaSystemException,
                                SaAuthenticationException
```
    Returns whether events (e.g. for the Integration Server) are enabled for the current session.
    
    Returns:
    true, if events are enabled for the current session, otherwise false.
    
    Throws:
    
    SaSystemException - system error
    
    SaAuthenticationException - authentication error
  - invoke
```
<T extends Serializable> T invoke(Operation<T> operation)
                              throws SaAuthenticationException,
                                     SaSystemException
```
    Invokes the given Operation on the server side.
    
    Type Parameters:
    T - The return type of the given operation
    Parameters:
    operation - The operation to invoke. After invocation calling operation.getResult() will yield the same as the return of this call.
    
    Returns:
    The result of the server side call of Operation.invoke()
    
    Throws:
    
    SaAuthenticationException - When the user is not correctly logged on, this may result from a session time out
    
    SaSystemException - When an error occurred in the operation.
  - getDDC
```
DDC getDDC(String ddcName)
           throws SaSystemException,
                  SaAuthenticationException
```
    Returns information about the requested DDC.
    
    Parameters:
    ddcName - name of the DDC
    
    Returns:
    information about the requested DDC. See DDC.
    
    Throws:
    
    SaSystemException - system error when retrieving information about the DDC
    
    SaAuthenticationException - not logged in

Interface SaClassicConnector

Method Summary

Method Detail

getConfiguration

stopServer

addListener

removeListener

addListener

removeListener

getDefinitions

getFolderDefinitions

getDBDefinition

getSystemSetting

getSystemInfo

getFeatures

getUserSetting

setUserSetting

getSetting

searchSettings

setSetting

deleteSetting

logon

logon

logon

logon

logoff

getLicenseCount

setUsedLicense

setLocale

readDocument

readReleasedDocument

readDocumentMetadata

getFulltext

getFulltext

getThumbnail

createDocument

updateDocument

createDocument

createDocument

createLink

updateDocument

updateDocument

updateDocument

updateDocument

checkoutDocument

discardCheckout

releaseDocument

isReleaseActive

getReleasedHdoc

lockDocument

unlockDocument

getDocumentInfo

getDocumentInfo

restoreVersion

search

searchHQL

deleteDocument

getVersionIDs

readVersionDocument

readVersionMetadata

resolveLatestHDoc

removeEvent

readDocumentFilename

readVersionDocumentFilename

getACLNames

setACLName

getInvolvedUsers

getAllACLs

getAcls

getACLRights

getDocumentAccessData

getLockInfo

getWorkflowConnector

isAlive

getAnnotations

getAnnotations

setAnnotations

getFolderChildren

getFolderInfo

getFolderInfo