SaClassicConnectorImpl (JCS Classic Connector Distribution 7.5.4 API)

java.lang.Object
- com.saperion.connector.SaClassicConnectorImpl

All Implemented Interfaces:

SaClassicConnector
```
public final class SaClassicConnectorImpl
extends Object
implements SaClassicConnector
```
The Class SaClassicConnectorImpl.

See Also:
SaClassicConnector

Constructor Summary

Constructors
Constructor and Description
`SaClassicConnectorImpl()` Constructs the `SaClassicConnectorImpl` instance which provides DMS functionality.
`SaClassicConnectorImpl(Properties configuration)` Constructs the `SaClassicConnectorImpl` instance which provides DMS functionality.
`SaClassicConnectorImpl(Properties configuration, com.saperion.cache.CacheManager cacheManager)` Constructs the `SaClassicConnectorImpl` instance which provides DMS functionality.
`SaClassicConnectorImpl(String configPath)` Constructs the `SaClassicConnectorImpl` instance which provides DMS functionality.

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addComment(String comment, String taskUID, int level)` Adds a comment to the task.
`void`	`addHistory(String description, String taskUID)` Adds a history entry to the task.
`void`	`addListener(SaEventListener listener)` Deprecated. event handling is deprecated
`void`	`addListener(SaStatusEventListener listener)` Deprecated. event handling is deprecated
`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.
`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
`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`	`executeCommand(ContextInfo contextInfo)` Performs the given command.
`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
`String`	`getAnnotations(String hDoc, int indexOfContentElement)` Deprecated. use `getAnnotations(String, int, boolean)` instead
`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.
`Long`	`getBoxCount(int boxId)` Reads the count (number of workflow item) of the inbox identified by the given id.
`List<BoxDefinition>`	`getBoxDefinitions()` Reads the box definitions.
`Collection<CommandInfo>`	`getCommandInfos(String docUID)` Reads all possible transitions for this task.
`Collection<CommandInfo>`	`getCommandInfos(String docUID, boolean transitionsOnly)` Reads all possible transitions and optional other possible commands for this task.
`List<CommentInfo>`	`getCommentInfos(String taskId)` Reads the comments for the given task.
`List<List<HistoryInfo>>`	`getCompleteHistoryInfos(String docId)` Reads the history and comments for the given 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 startNodeId, 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<HistoryInfo>`	`getHistoryInfos(String taskId)` Reads the history for the given task.
`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.
`WorkflowMember`	`getMember(WorkflowMember member, int depth, String filter)` Returns the workflow members by the given parameters. This method is considered as a search-method.
`WorkflowMember`	`getMembers()` Reads the workflow members in a full structured tree.
`boolean`	`getOutOfOffice()` Get the substitute for the logged on user.
`TaskInfo`	`getParentTask(String taskID)` Reads the parent task info for the given ID.
`String`	`getReleaseAclName()` Gets the release ACL name, configured in the program.ini in section [Release].
`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)`
`List<SaRMIServerInfo>`	`getServerInfos()`
`com.saperion.connector.authentication.Session`	`getSession()` Returns the session of the logged in user.
`Setting`	`getSetting(String name, String section, boolean isLong)` Retrieves a `Setting` identified by it's key and section from the database.
`String`	`getSubstitute()` Get the substitute for the logged on user.
`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.
`TaskInfo`	`getTask(String taskID)` Reads the task info for the given ID.
`List<TaskAuditInfo>`	`getTaskAuditList(int[] ids, String filter, Map<String,Object> parameter)` Reads the task audits for this user.
`List<TaskInfo>`	`getTaskList(int[] ids, String filter, Map<String,Object> parameter)` Reads the tasks for this user.
`byte[]`	`getThumbnail(String hDoc, int widthX, int widthY, boolean color)` Reads the thumbnail of the given document.
`int`	`getToken()`
`List<String>`	`getUsers(String filter)` Reads a list of filtered users.
`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.
`String`	`getWorkflowDdcName()` Gets the workflow ddc name.
`List<String>`	`getWorkflowDefinitions()` Reads all available workflow definitions.
`List<ProcessDefinitionDescriptor>`	`getWorkflowDefinitions(String ddcName)` Returns the workflow definitions that are allowed to be used for documents contained in the specified DDC.
`int`	`hashCode()`
`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`	`isActive()` Checks, if the connector is logged on.
`boolean`	`isAlive()` Test the lifetime of this connector.
`boolean`	`isReleaseActive()` Checks if is release feature in the program.ini in section [Release] is active.
`Map<String,String>`	`loadLocalize(String language)` Load localize.
`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.x
`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 docHdoc, boolean currentRevision, int elementNumber)` Loads a document's content from the backend system.
`String`	`readDocumentFilename(String docHdoc, boolean currentRevision, int elementNumber)` Reads the filenames of the application data of the document with the given ID.
`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 docHdoc, int elementNumber)` Loads a document version from the backend system.
`String`	`readVersionDocumentFilename(String docHdoc, int elementNumber)` Reads the filenames of the application data of the document with the given ID.
`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. event handling is deprecated
`void`	`removeFromFolder(String folderTableDDC, String documentSysRowId, String documentDDC, String folderId)` Removes the document from the given folder.
`void`	`removeListener(SaEventListener listener)` Deprecated. event handling is deprecated
`void`	`removeListener(SaStatusEventListener listener)` Deprecated. event handling is deprecated
`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(SaQueryInfo)` instead
`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)` Sets whether the current user is present.
`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`	`setOutOfOffice(boolean isOutOfOffice)` set the out of office status for the logged on user.
`void`	`setSetting(Setting setting)` Stores a `Setting` in the database.
`void`	`setSubstitute(String name)` Set the substitute for the logged on user.
`boolean`	`setUsedLicense(int type, int count)` Set the count of used licenses.
`void`	`setUserSetting(SaUserSetting setting)` Persists a user-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.
`void`	`storeBpmn(BpmnImportDescription bpmnDescription, BpmnImportCallback callback)` Transforms the bpmn model to a saperion process and stores it to the system.
`void`	`storeSystemFile(SystemFileKind kind, String name, InputStream data)` Stores a system file of a specific kind.
`String`	`toString()`
`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(UpdateDocumentInfo)` 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.0deprecated 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.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - SaClassicConnectorImpl
```
public SaClassicConnectorImpl()
```
    Constructs the SaClassicConnectorImpl instance which provides DMS functionality.
  - SaClassicConnectorImpl
```
public SaClassicConnectorImpl(String configPath)
```
    Constructs the SaClassicConnectorImpl instance which provides DMS functionality.
    
    Parameters:
    configPath - Configuration path
  - SaClassicConnectorImpl
```
public SaClassicConnectorImpl(Properties configuration)
```
    Constructs the SaClassicConnectorImpl instance which provides DMS functionality.
    
    Parameters:
    configuration - Configuration properties
  - SaClassicConnectorImpl
```
public SaClassicConnectorImpl(Properties configuration,
                      com.saperion.cache.CacheManager cacheManager)
```
    Constructs the SaClassicConnectorImpl instance which provides DMS functionality.
    
    Parameters:
    configuration - Configuration properties
    cacheManager - an instance of CacheManager
- Method Detail
  - getConfiguration
```
public Properties getConfiguration(String section)
                            throws SaSystemException,
                                   SaAuthenticationException
```
    Reads the application configuration properties from the backend system.
    
    Specified by:
    
    getConfiguration in interface SaClassicConnector
    
    Parameters:
    section - Section in archief.ini to load configuration properties
    
    Returns:
    Configuration properties as key-value pairs
    
    Throws:
    
    SaSystemException - SaSystemException
    
    SaAuthenticationException - SaAuthenticationException
    See Also:
    SaClassicConnector.getConfiguration(java.lang.String)
  - stopServer
```
@Deprecated
public 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.
    
    Stops the remote server.
    
    Specified by:
    
    stopServer in interface SaClassicConnector
    
    Throws:
    
    SaSystemException - SaSystemException
    
    SaAuthenticationException - SaAuthenticationException
    See Also:
    SaClassicConnector.stopServer()
  - getDefinitions
```
public String[] getDefinitions()
                        throws SaSystemException,
                               SaAuthenticationException
```
    Reads the registered DDC names from the repository.
    
    Specified by:
    
    getDefinitions in interface SaClassicConnector
    
    Returns:
    Array of DDC names
    
    Throws:
    
    SaSystemException - SaSystemException
    
    SaAuthenticationException - SaAuthenticationException
    See Also:
    SaClassicConnector.getDefinitions()
  - getFolderDefinitions
```
public String[] getFolderDefinitions()
                              throws SaSystemException,
                                     SaAuthenticationException
```
    Reads the registered folder DDC names from the repository.
    
    Specified by:
    
    getFolderDefinitions in interface SaClassicConnector
    
    Returns:
    Array of folder DDC names
    
    Throws:
    
    SaSystemException - SaSystemException
    
    SaAuthenticationException - SaAuthenticationException
    See Also:
    SaClassicConnector.getFolderDefinitions()
  - getDBDefinition
```
public SaFieldDescription[] getDBDefinition(String name)
                                     throws SaSystemException,
                                            SaAuthenticationException
```
    Reads the definitions of a database definition (DDC) for the given name.
    
    Specified by:
    
    getDBDefinition in interface SaClassicConnector
    
    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
    See Also:
    SaClassicConnector.getDBDefinition(java.lang.String)
  - logon
```
public int logon(String username,
        String password,
        int type,
        String client)
          throws SaAuthenticationException,
                 SaSystemException
```
    performs logon to the backend system.
    
    Specified by:
    
    logon in interface SaClassicConnector
    
    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
    See Also:
    SaClassicConnector.logon(java.lang.String, java.lang.String, int, java.lang.String)
  - logon
```
@Deprecated
public int logon(jcifs.smb.NtlmPasswordAuthentication auth,
                   int type,
                   String client)
          throws SaAuthenticationException,
                 SaSystemException
```
    Deprecated. will be removed with version 8.x
    
    Performs a logon with NTLM authentication.
    
    Specified by:
    
    logon in interface SaClassicConnector
    
    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 - SaAuthenticationException
    
    SaSystemException - SaSystemException
  - logon
```
@Deprecated
public int logon(byte[] token,
                   int type,
                   String client)
          throws SaAuthenticationException,
                 SaSystemException
```
    Deprecated. will be removed with version 8.0
    
    Performs a logon with Kerberos authentication.
    
    Specified by:
    
    logon in interface SaClassicConnector
    
    Parameters:
    token - Kerberos 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 - SaAuthenticationException
    
    SaSystemException - SaSystemException
  - logon
```
public com.saperion.connector.authentication.Session logon(com.saperion.connector.authentication.Credentials credentials)
                                                    throws SaAuthenticationException,
                                                           SaSystemException
```
    Description copied from interface: SaClassicConnector
    
    Performs a logon with the given Credentials and returns the information about the open session.
    
    Specified by:
    
    logon in interface SaClassicConnector
    
    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:
    SaClassicConnector.logon(com.saperion.connector.authentication.Credentials)
  - logoff
```
public boolean logoff()
               throws SaAuthenticationException,
                      SaSystemException
```
    Log off from the system.
    
    Specified by:
    
    logoff in interface SaClassicConnector
    
    Returns:
    true if logging off was successful
    
    Throws:
    
    SaAuthenticationException - user was not logged in
    
    SaSystemException - remote exception
    See Also:
    SaClassicConnector.logoff()
  - readReleasedDocument
```
public InputStream readReleasedDocument(String docHdoc,
                               boolean currentRevision,
                               int elementNumber)
                                 throws SaSystemException,
                                        SaAuthenticationException
```
    Read released document if the release feature is active.
    
    Specified by:
    
    readReleasedDocument in interface SaClassicConnector
    
    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
    See Also:
    SaClassicConnector.readReleasedDocument(java.lang.String, boolean, int)
  - readDocument
```
public InputStream readDocument(String docHdoc,
                       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()
    
    Specified by:
    
    readDocument in interface SaClassicConnector
    
    Parameters:
    docHdoc - 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.
    See Also:
    SaClassicConnector.readDocument(java.lang.String, boolean, int)
  - readDocumentMetadata
```
public SaPropertyValue[] readDocumentMetadata(String documentSysRowID,
                                     String ddcName,
                                     String[] fields)
                                       throws SaSystemException,
                                              SaAuthenticationException
```
    Reads the metadata of the document with the given ID.
    
    Specified by:
    
    readDocumentMetadata in interface SaClassicConnector
    
    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
    See Also:
    SaClassicConnector.readDocumentMetadata(java.lang.String, java.lang.String, java.lang.String[])
  - getFulltext
```
@Deprecated
public 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.
    
    Specified by:
    
    getFulltext in interface SaClassicConnector
    
    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
    See Also:
    SaClassicConnector.getFulltext(java.lang.String, java.lang.String)
  - getFulltext
```
public 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.
    
    Specified by:
    
    getFulltext in interface SaClassicConnector
    
    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
    See Also:
    SaClassicConnector.getFulltext(java.lang.String, java.lang.String, java.lang.String, long)
  - getThumbnail
```
public 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.
    
    Specified by:
    
    getThumbnail in interface SaClassicConnector
    
    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
    See Also:
    SaClassicConnector.getThumbnail(java.lang.String, int, int, boolean)
  - createDocument
```
@Deprecated
public 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.
    
    Specified by:
    
    createDocument in interface SaClassicConnector
    
    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
    See Also:
    SaClassicConnector.createDocument(java.lang.String, java.util.Properties, java.io.InputStream[], java.lang.String)
  - createDocument
```
@Deprecated
public SaSaveInfo createDocument(String ddcName,
                                   Properties namevaluePairs,
                                   InputStream[] content,
                                   String versionComment,
                                   String acls)
                          throws SaSystemException,
                                 SaAuthenticationException,
                                 SaDDCException
```
    Deprecated.
    
    Creates a new document on the backend system with the given metadata, acl's and content.
    
    Specified by:
    
    createDocument in interface SaClassicConnector
    
    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
    See Also:
    SaClassicConnector.createDocument(java.lang.String, java.util.Properties, java.io.InputStream[], java.lang.String, java.lang.String)
  - createDocument
```
public SaSaveInfo createDocument(DocumentInfo document)
                          throws SaSystemException,
                                 SaAuthenticationException,
                                 SaDDCException
```
    Creates a new document on the backend system with the given DocumentInfo.
    
    Specified by:
    
    createDocument in interface SaClassicConnector
    
    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
    See Also:
    createDocument(com.saperion.structures.DocumentInfo)
  - createLink
```
public 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.
    
    Specified by:
    
    createLink in interface SaClassicConnector
    
    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
    See Also:
    SaClassicConnector.createLink(com.saperion.structures.LinkInfo)
  - updateDocument
```
@Deprecated
public 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(UpdateDocumentInfo) 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.
    
    Specified by:
    
    updateDocument in interface SaClassicConnector
    
    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
    See Also:
    SaClassicConnector.updateDocument(java.lang.String, java.lang.String, java.util.Properties, java.io.InputStream[], java.lang.String)
  - lockDocument
```
public boolean lockDocument(String sysRowId,
                   String ddcName)
                     throws SaSystemException,
                            SaAuthenticationException,
                            SaLockException
```
    Locks a document.
    
    Specified by:
    
    lockDocument in interface SaClassicConnector
    
    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
    See Also:
    SaClassicConnector.lockDocument(java.lang.String, java.lang.String)
  - unlockDocument
```
public boolean unlockDocument(String sysRowId,
                     String ddcName)
                       throws SaSystemException,
                              SaAuthenticationException,
                              SaLockException
```
    Unlocks a document.
    
    Specified by:
    
    unlockDocument in interface SaClassicConnector
    
    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
    See Also:
    SaClassicConnector.unlockDocument(java.lang.String,java.lang.String)
  - getDocumentInfo
```
public 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.
    
    Specified by:
    
    getDocumentInfo in interface SaClassicConnector
    
    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:
    SaClassicConnector.getDocumentInfo(java.lang.String, boolean, boolean)
  - getDocumentInfo
```
public 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.
    
    Specified by:
    
    getDocumentInfo in interface SaClassicConnector
    
    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
    See Also:
    SaClassicConnector.getDocumentInfo(java.lang.String, boolean, boolean, boolean)
  - updateDocument
```
@Deprecated
public 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.
    
    Specified by:
    
    updateDocument in interface SaClassicConnector
    
    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
    See Also:
    SaClassicConnector.updateDocument(java.lang.String, java.lang.String, java.util.Properties, java.io.InputStream[], java.lang.String, java.lang.String)
  - updateDocument
```
@Deprecated
public 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.
    
    Specified by:
    
    updateDocument in interface SaClassicConnector
    
    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
    See Also:
    SaClassicConnector.updateDocument(java.lang.String, java.lang.String, java.util.Properties, java.io.InputStream[], java.lang.String, java.lang.String, boolean)
  - updateDocument
```
@Deprecated
public 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.0deprecated 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.
    
    Specified by:
    
    updateDocument in interface SaClassicConnector
    
    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
    See Also:
    SaClassicConnector.updateDocument(java.lang.String, java.lang.String, java.util.Properties, java.io.InputStream[], java.lang.String, java.lang.String, boolean, boolean)
  - updateDocument
```
public 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.
    This method behaves like the following:
    - If the given ContentStream[] of the updateInfo is NOT NULL BUT EMPTY, all document structure will be deleted. The same behaviour is achieved if the ContentStream[] carries as ContentStream with the position -2.
    Meaning of the position numbers of the given ContentSream[]:
    - -2: This ContentStream deletes the whole document structure leaving an empty document. All further information of the ContentStream object is ignored.
    - -1: This ContentStream deletes the whole document structure. If it also carries an InputStream with itself, this content will be created as the first element of the document. If it additionally carries variables with itself, these variables will be stored for the created content.
    - 0: The ContentStream appends it’s given InputStream to the last existing content element in the document structure. If it additionally carries variables, these variables will be stored for the created content.
    - >0: The ContentStream replaces the existing document content with its own InputStream at the given position, if not null. If it additionally carries variables, these variables will be stored for the created content. The overall number of document elements remains the same.
    Specified by:
    
    updateDocument in interface SaClassicConnector
    
    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
    See Also:
    SaClassicConnector.updateDocument(com.saperion.bean.UpdateDocumentInfo)
  - checkoutDocument
```
public void checkoutDocument(String hDoc)
                      throws SaSystemException,
                             SaAuthenticationException,
                             SaGetNodeException
```
    Checkouts a document for the given document id (hdoc).
    
    Specified by:
    
    checkoutDocument in interface SaClassicConnector
    
    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
    See Also:
    SaClassicConnector.checkoutDocument(java.lang.String)
  - discardCheckout
```
public void discardCheckout(String hDoc)
                     throws SaSystemException,
                            SaAuthenticationException,
                            SaGetNodeException
```
    Discards the checkout of the given document.
    
    Specified by:
    
    discardCheckout in interface SaClassicConnector
    
    Parameters:
    hDoc - Document HDOC
    
    Throws:
    
    SaSystemException - SaRMICommandException
    
    SaAuthenticationException - when the user is not logged in or has insufficient rights
    
    SaGetNodeException - SaGetNodeException
    See Also:
    SaClassicConnector.discardCheckout(java.lang.String)
  - releaseDocument
```
public void releaseDocument(String ddcName,
                   String hDoc,
                   String versionComment)
                     throws SaSystemException,
                            SaAuthenticationException,
                            SaGetNodeException,
                            SaSetNodeException,
                            SaDDCException
```
    Release the given document.
    
    Specified by:
    
    releaseDocument in interface SaClassicConnector
    
    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
    See Also:
    TODO fix workaround with double revision tag by calling backend method
  - isReleaseActive
```
public boolean isReleaseActive()
                        throws SaAuthenticationException,
                               SaSystemException
```
    Checks if is release feature in the program.ini in section [Release] is active.
    
    Specified by:
    
    isReleaseActive in interface SaClassicConnector
    
    Returns:
    true, if is release active
    
    Throws:
    
    SaAuthenticationException - when the user is not logged in or has insufficient rights
    
    SaSystemException - the sa system exception
    See Also:
    SaClassicConnector.isReleaseActive()
  - getReleasedHdoc
```
public 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.
    
    Specified by:
    
    getReleasedHdoc in interface SaClassicConnector
    
    Parameters:
    oldHdoc - the hdoc to lookup released hdoc
    
    Returns:
    the released hdoc
    
    Throws:
    
    SaAuthenticationException - if authentication fails
    
    SaSystemException - the sa system exception
    See Also:
    SaClassicConnector.getReleasedHdoc(java.lang.String)
  - getReleaseAclName
```
public String getReleaseAclName()
                         throws SaSystemException,
                                SaAuthenticationException
```
    Gets the release ACL name, configured in the program.ini in section [Release].
    
    Returns:
    the release ACL name which can see released documents.
    
    Throws:
    
    SaSystemException - the sa system exception
    
    SaAuthenticationException - the sa authentication exception
  - restoreVersion
```
public SaSaveInfo restoreVersion(String versionID)
                          throws SaSystemException,
                                 SaAuthenticationException,
                                 SaDDCException
```
    Restores the version with the given HDOC.
    
    Specified by:
    
    restoreVersion in interface SaClassicConnector
    
    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
    See Also:
    SaClassicConnector.restoreVersion(java.lang.String)
  - deleteDocument
```
public void deleteDocument(String documentHDOC,
                  int deleteType)
                    throws SaSystemException,
                           SaAuthenticationException,
                           SaDDCException
```
    Deletes a document from the backend system with the given strategy.
    
    Specified by:
    
    deleteDocument in interface SaClassicConnector
    
    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
    See Also:
    SaClassicConnector.deleteDocument(java.lang.String, int)
  - getVersionIDs
```
public 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).
    
    Specified by:
    
    getVersionIDs in interface SaClassicConnector
    
    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
    See Also:
    SaClassicConnector.getVersionIDs(java.lang.String,java.lang.String)
  - readVersionDocument
```
public InputStream readVersionDocument(String docHdoc,
                              int elementNumber)
                                throws SaSystemException,
                                       SaAuthenticationException
```
    Loads a document version from the backend system.
    
    Specified by:
    
    readVersionDocument in interface SaClassicConnector
    
    Parameters:
    docHdoc - 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
    See Also:
    SaClassicConnector.readVersionDocument(java.lang.String, int)
  - readVersionMetadata
```
public SaVersionData readVersionMetadata(String versionID)
                                  throws SaSystemException,
                                         SaAuthenticationException,
                                         SaDDCException
```
    Reads the version metadata of the document with the given ID.
    
    Specified by:
    
    readVersionMetadata in interface SaClassicConnector
    
    Parameters:
    versionID - Version ID (XHDOC is the revision number of the document)
    
    Returns:
    Metadata of the document
    
    Throws:
    
    SaSystemException - SaSystemException
    
    SaAuthenticationException - SaAuthenticationException
    
    SaDDCException - SaDDCException
    See Also:
    SaClassicConnector.readVersionMetadata(java.lang.String)
  - readVersionDocumentFilename
```
public String readVersionDocumentFilename(String docHdoc,
                                 int elementNumber)
                                   throws SaSystemException,
                                          SaAuthenticationException,
                                          SaDDCException
```
    Reads the filenames of the application data of the document with the given ID.
    
    Specified by:
    
    readVersionDocumentFilename in interface SaClassicConnector
    
    Parameters:
    docHdoc - 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
    See Also:
    SaClassicConnector.readVersionDocumentFilename(java.lang.String, int)
  - search
```
@Deprecated
public List<SaPropertyValue[]> search(String hqlQuery)
                               throws SaSystemException,
                                      SaAuthenticationException,
                                      SaDBException
```
    Deprecated. use searchHQL(SaQueryInfo) instead
    
    Performs a search with the given hql query (hibernate query language).
    
    Specified by:
    
    search in interface SaClassicConnector
    
    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:
    
    SaDBException
    
    SaSystemException - SaSystemException
    
    SaAuthenticationException - when the user is not logged in or has insufficient rights
    See Also:
    SaClassicConnector.search(java.lang.String)
  - searchHQL
```
public List<SaDocumentInfo> searchHQL(SaQueryInfo hqlQuery)
                               throws SaSystemException,
                                      SaAuthenticationException,
                                      SaDBException
```
    Performs a search with the given hql query (hibernate query language).
    
    Specified by:
    
    searchHQL in interface SaClassicConnector
    
    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
    See Also:
    (com.saperion.rmi.SaQueryInfo)
  - removeEvent
```
@Deprecated
public boolean removeEvent(SaEvent event)
                    throws SaSystemException
```
    Deprecated. event handling is deprecated
    
    Deletes the row from XEvents for the given event.
    
    Specified by:
    
    removeEvent in interface SaClassicConnector
    
    Parameters:
    event - Event object
    
    Returns:
    boolean true deleted
    
    Throws:
    
    SaSystemException - SaSystemException
    See Also:
    SaClassicConnector.removeEvent(com.saperion.intf.SaEvent)
  - addListener
```
@Deprecated
public void addListener(SaEventListener listener)
                 throws SaSystemException,
                        SaAuthenticationException
```
    Deprecated. event handling is deprecated
    
    Adds a new listener to the handler.
    
    Specified by:
    
    addListener in interface SaClassicConnector
    
    Parameters:
    listener - Event listener
    
    Throws:
    
    SaSystemException - SaSystemException
    
    SaAuthenticationException - SaAuthenticationException
    See Also:
    SaClassicConnector.addListener(com.saperion.intf.SaEventListener)
  - removeListener
```
@Deprecated
public void removeListener(SaEventListener listener)
                    throws SaSystemException
```
    Deprecated. event handling is deprecated
    
    Removes a listener from the handler.
    
    Specified by:
    
    removeListener in interface SaClassicConnector
    
    Parameters:
    listener - Event listener
    
    Throws:
    
    SaSystemException - SaSystemException
    See Also:
    SaClassicConnector.removeListener(com.saperion.intf.SaEventListener)
  - addListener
```
@Deprecated
public void addListener(SaStatusEventListener listener)
                 throws SaAuthenticationException,
                        SaSystemException
```
    Deprecated. event handling is deprecated
    
    Adds a new listener to the handler.
    
    Specified by:
    
    addListener in interface SaClassicConnector
    
    Parameters:
    listener - Event listener
    
    Throws:
    
    SaAuthenticationException - SaAuthenticationException
    
    SaSystemException - SaSystemException
    See Also:
    SaClassicConnector.addListener(com.saperion.intf.SaStatusEventListener)
  - removeListener
```
@Deprecated
public void removeListener(SaStatusEventListener listener)
                    throws SaSystemException
```
    Deprecated. event handling is deprecated
    
    Removes a listener from the handler.
    
    Specified by:
    
    removeListener in interface SaClassicConnector
    
    Parameters:
    listener - Event listener
    
    Throws:
    
    SaSystemException - SaSystemException
    See Also:
    SaClassicConnector.removeListener(com.saperion.intf.SaStatusEventListener)
  - readDocumentFilename
```
public String readDocumentFilename(String docHdoc,
                          boolean currentRevision,
                          int elementNumber)
                            throws SaSystemException,
                                   SaAuthenticationException,
                                   SaDDCException
```
    Reads the filenames of the application data of the document with the given ID.
    
    Specified by:
    
    readDocumentFilename in interface SaClassicConnector
    
    Parameters:
    docHdoc - 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
    See Also:
    SaClassicConnector.readDocumentFilename(java.lang.String, boolean, int)
  - getACLNames
```
public String getACLNames(String documentHDOC)
                   throws SaSystemException,
                          SaAuthenticationException,
                          SaDDCException
```
    Reads the ACL's for the given document.
    
    Specified by:
    
    getACLNames in interface SaClassicConnector
    
    Parameters:
    documentHDOC - The ID of the document (XHDOC)
    
    Returns:
    ACL name string
    
    Throws:
    
    SaDDCException
    
    SaSystemException - RemoteException
    
    SaAuthenticationException - SaAuthenticationException
    See Also:
    SaClassicConnector.getACLNames(java.lang.String)
  - getAllACLs
```
@Deprecated
public List<String> getAllACLs()
                        throws SaSystemException,
                               SaAuthenticationException
```
    Deprecated. use getAcls() instead
    
    Reads all existing ACL names.
    
    Specified by:
    
    getAllACLs in interface SaClassicConnector
    
    Returns:
    List of ACL names
    
    Throws:
    
    SaSystemException - Remote exception
    
    SaAuthenticationException - SaAuthenticationException
    See Also:
    SaClassicConnector.getAllACLs()
  - getInvolvedUsers
```
public List<String> getInvolvedUsers(String documentHDOC)
                              throws SaSystemException,
                                     SaAuthenticationException,
                                     SaDDCException
```
    Reads all users involved in the set of ACL's.
    
    Specified by:
    
    getInvolvedUsers in interface SaClassicConnector
    
    Parameters:
    documentHDOC - The ID of the document (XHDOC)
    
    Returns:
    List of user names
    
    Throws:
    
    SaSystemException - SaSystemException
    
    SaAuthenticationException - SaAuthenticationException
    
    SaDDCException - SaDDCException
    See Also:
    SaClassicConnector.getInvolvedUsers(java.lang.String)
  - setACLName
```
public SaSaveInfo setACLName(String ddcname,
                    String documentHDOC,
                    String acl,
                    String versionComment)
                      throws SaSystemException,
                             SaAuthenticationException,
                             SaDDCException,
                             SaSetACLException
```
    Adds the given ACL to the node.
    
    Specified by:
    
    setACLName in interface SaClassicConnector
    
    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
    See Also:
    SaClassicConnector.setACLName(java.lang.String, java.lang.String, java.lang.String, java.lang.String)
  - getDocumentAccessData
```
public SaDocAccessData getDocumentAccessData(String documentHDOC)
                                      throws SaSystemException,
                                             SaAuthenticationException
```
    Reads the access rights of the given document.
    
    Specified by:
    
    getDocumentAccessData in interface SaClassicConnector
    
    Parameters:
    documentHDOC - The ID of the document (XHDOC)
    
    Returns:
    Access rigths of this document
    
    Throws:
    
    SaSystemException - Remote exception
    
    SaAuthenticationException - SaAuthenticationException
    See Also:
    SaClassicConnector.getDocumentAccessData(java.lang.String)
  - getLockInfo
```
public SaLockInfo getLockInfo(String sysRowId)
                       throws SaSystemException,
                              SaAuthenticationException,
                              SaLockException
```
    Returns the locking informations for a given document.
    
    Specified by:
    
    getLockInfo in interface SaClassicConnector
    
    Parameters:
    sysRowId - Document SysRowId
    
    Returns:
    Lockin informations
    
    Throws:
    
    SaSystemException - Remote exception
    
    SaAuthenticationException - Authentification error
    
    SaLockException - Locking error
    See Also:
    SaClassicConnector.getLockInfo(java.lang.String)
  - isActive
```
public boolean isActive()
```
    Checks, if the connector is logged on.
    
    Returns:
    True, if active
  - getCurrentUserName
```
public String getCurrentUserName()
```
    Returns the name of the current user.
    
    Specified by:
    
    getCurrentUserName in interface SaClassicConnector
    
    Returns:
    name of current user logged in.
  - getWorkflowConnector
```
public SaWFConnector getWorkflowConnector()
                                   throws SaAuthenticationException,
                                          SaSystemException
```
    Returns a workflow connector based on this classic connector.
    
    Specified by:
    
    getWorkflowConnector in interface SaClassicConnector
    
    Returns:
    Workflow connector
    
    Throws:
    
    SaAuthenticationException - Authentification error
    
    SaSystemException - Remote exception
    See Also:
    SaClassicConnector.getWorkflowConnector()
  - getTaskList
```
public List<TaskInfo> getTaskList(int[] ids,
                         String filter,
                         Map<String,Object> parameter)
                           throws SaAuthenticationException,
                                  SaSystemException
```
    Reads the tasks for this user.
    
    Parameters:
    ids - Box ID's
    filter - HQL filter
    parameter - Filter parameter
    
    Returns:
    List of TaskInfo objects
    
    Throws:
    
    SaAuthenticationException - SaAuthenticationException
    
    SaSystemException - SaSystemException
  - getTaskAuditList
```
public List<TaskAuditInfo> getTaskAuditList(int[] ids,
                                   String filter,
                                   Map<String,Object> parameter)
                                     throws SaAuthenticationException,
                                            SaSystemException
```
    Reads the task audits for this user.
    
    Parameters:
    ids - Box ID's
    filter - HQL filter
    parameter - Filter parameter
    
    Returns:
    List of TaskInfo objects
    
    Throws:
    
    SaAuthenticationException - SaAuthenticationException
    
    SaSystemException - SaSystemException
  - getTask
```
public TaskInfo getTask(String taskID)
                 throws SaAuthenticationException,
                        SaSystemException
```
    Reads the task info for the given ID.
    
    Parameters:
    taskID - Task ID
    
    Returns:
    Task info
    
    Throws:
    
    SaAuthenticationException - SaAuthenticationException
    
    SaSystemException - SaSystemException
  - getParentTask
```
public TaskInfo getParentTask(String taskID)
                       throws SaAuthenticationException,
                              SaSystemException
```
    Reads the parent task info for the given ID.
    
    Parameters:
    taskID - Task ID
    
    Returns:
    Task info
    
    Throws:
    
    SaAuthenticationException - SaAuthenticationException
    
    SaSystemException - SaSystemException
  - getCommandInfos
```
public Collection<CommandInfo> getCommandInfos(String docUID)
                                        throws SaAuthenticationException,
                                               SaSystemException
```
    Reads all possible transitions for this task.
    
    Parameters:
    docUID - Document UID of task
    
    Returns:
    Command list
    
    Throws:
    
    SaAuthenticationException - SaAuthenticationException
    
    SaSystemException - SaSystemException
  - getCommandInfos
```
public Collection<CommandInfo> getCommandInfos(String docUID,
                                      boolean transitionsOnly)
                                        throws SaAuthenticationException,
                                               SaSystemException
```
    Reads all possible transitions and optional other possible commands for this task.
    
    Parameters:
    docUID - Document UID of task
    transitionsOnly - if true, only transition commands will be returned
    
    Returns:
    Command list
    
    Throws:
    
    SaAuthenticationException - SaAuthenticationException
    
    SaSystemException - SaSystemException
  - getBoxDefinitions
```
public List<BoxDefinition> getBoxDefinitions()
                                      throws SaAuthenticationException,
                                             SaSystemException
```
    Reads the box definitions.
    
    Returns:
    Box definitions
    
    Throws:
    
    SaAuthenticationException - SaAuthenticationException
    
    SaSystemException - SaSystemException
  - getBoxCount
```
public Long getBoxCount(int boxId)
                 throws SaAuthenticationException,
                        SaSystemException
```
    Reads the count (number of workflow item) of the inbox identified by the given id.
    
    Parameters:
    boxId - the workflow box id
    
    Returns:
    the count of the inbox as Long.
    
    Throws:
    
    SaAuthenticationException - if an error occurs.
    
    SaSystemException - if an error occurs.
  - executeCommand
```
public String executeCommand(ContextInfo contextInfo)
                      throws SaAuthenticationException,
                             SaSystemException,
                             SaWorkflowException
```
    Performs the given command. The parameters must fit to the given parameter. Unneeded parameters can be set to null.
    
    Parameters:
    contextInfo - Context info
    
    Returns:
    New TaskID
    
    Throws:
    
    SaAuthenticationException - SaAuthenticationException
    
    SaSystemException - SaSystemException
    
    SaWorkflowException - Workflow exception
  - getCommentInfos
```
public List<CommentInfo> getCommentInfos(String taskId)
                                  throws SaAuthenticationException,
                                         SaSystemException,
                                         SaWorkflowException
```
    Reads the comments for the given task.
    
    Parameters:
    taskId - Task ID
    
    Returns:
    List of comments
    
    Throws:
    
    SaAuthenticationException - SaAuthenticationException
    
    SaSystemException - SaSystemException
    
    SaWorkflowException - Workflow exception
  - getHistoryInfos
```
public List<HistoryInfo> getHistoryInfos(String taskId)
                                  throws SaAuthenticationException,
                                         SaSystemException,
                                         SaWorkflowException
```
    Reads the history for the given task.
    
    Parameters:
    taskId - Task ID
    
    Returns:
    History list
    
    Throws:
    
    SaAuthenticationException - SaAuthenticationException
    
    SaSystemException - SaSystemException
    
    SaWorkflowException - Workflow exception
  - getCompleteHistoryInfos
```
public List<List<HistoryInfo>> getCompleteHistoryInfos(String docId)
                                                throws SaAuthenticationException,
                                                       SaSystemException,
                                                       SaWorkflowException
```
    Reads the history and comments for the given document.
    
    Parameters:
    docId - Document ID
    
    Returns:
    CompleteHistoryInfo
    
    Throws:
    
    SaAuthenticationException - SaAuthenticationException
    
    SaSystemException - SaSystemException
    
    SaWorkflowException - Workflow exception
  - getWorkflowDefinitions
```
public List<String> getWorkflowDefinitions()
                                    throws SaAuthenticationException,
                                           SaSystemException,
                                           SaWorkflowException
```
    Reads all available workflow definitions.
    
    Returns:
    Workflowdefinition list
    
    Throws:
    
    SaAuthenticationException - SaAuthenticationException
    
    SaSystemException - SaSystemException
    
    SaWorkflowException - Workflow exception
  - getWorkflowDefinitions
```
public List<ProcessDefinitionDescriptor> getWorkflowDefinitions(String ddcName)
                                                         throws SaAuthenticationException,
                                                                SaSystemException,
                                                                SaWorkflowException
```
    Returns the workflow definitions that are allowed to be used for documents contained in the specified DDC. If no restrictions are configured, all workflow definitions will be returned.
    
    Parameters:
    ddcName - name of the DDC
    
    Returns:
    Workflowdefinition list
    
    Throws:
    
    SaAuthenticationException - authentication error when loading definitions
    
    SaSystemException - system error when loading definitions
    
    SaWorkflowException - workflow error when loading definitions
  - getWorkflowDdcName
```
public String getWorkflowDdcName()
                          throws SaSystemException
```
    Gets the workflow ddc name.
    
    Returns:
    the name of the workflow ddc
    
    Throws:
    
    SaSystemException - SaSystemException
  - addComment
```
public void addComment(String comment,
              String taskUID,
              int level)
                throws SaAuthenticationException,
                       SaSystemException,
                       SaWorkflowException
```
    Adds a comment to the task.
    
    Parameters:
    comment - Comment
    taskUID - Task UID
    level - Level
    
    Throws:
    
    SaAuthenticationException - SaAuthenticationException
    
    SaSystemException - SaSystemException
    
    SaWorkflowException - Workflow exception
  - addHistory
```
public void addHistory(String description,
              String taskUID)
                throws SaAuthenticationException,
                       SaSystemException,
                       SaWorkflowException
```
    Adds a history entry to the task.
    
    Parameters:
    description - Comment
    taskUID - Task UID
    
    Throws:
    
    SaAuthenticationException - SaAuthenticationException
    
    SaSystemException - SaSystemException
    
    SaWorkflowException - Workflow exception
  - getOutOfOffice
```
public boolean getOutOfOffice()
                       throws SaAuthenticationException,
                              SaSystemException
```
    Get the substitute for the logged on user.
    
    Returns:
    Substitute name
    
    Throws:
    
    SaAuthenticationException - SaAuthenticationException
    
    SaSystemException - SaSystemException
  - getSubstitute
```
public String getSubstitute()
                     throws SaAuthenticationException,
                            SaSystemException
```
    Get the substitute for the logged on user.
    
    Returns:
    Substitute name
    
    Throws:
    
    SaAuthenticationException - SaAuthenticationException
    
    SaSystemException - SaSystemException
  - setOutOfOffice
```
public void setOutOfOffice(boolean isOutOfOffice)
                    throws SaAuthenticationException,
                           SaSystemException
```
    set the out of office status for the logged on user.
    
    Parameters:
    isOutOfOffice - is OutOfOffice
    
    Throws:
    
    SaAuthenticationException - SaAuthenticationException
    
    SaSystemException - SaSystemException
  - setSubstitute
```
public void setSubstitute(String name)
                   throws SaAuthenticationException,
                          SaSystemException
```
    Set the substitute for the logged on user.
    
    Parameters:
    name - Substitute name
    
    Throws:
    
    SaAuthenticationException - SaAuthenticationException
    
    SaSystemException - SaSystemException
  - getMembers
```
public WorkflowMember getMembers()
                          throws SaAuthenticationException,
                                 SaSystemException
```
    Reads the workflow members in a full structured tree.
    
    Returns:
    Member
    
    Throws:
    
    SaAuthenticationException - SaAuthenticationException
    
    SaSystemException - SaSystemException
  - getMember
```
public WorkflowMember getMember(WorkflowMember member,
                       int depth,
                       String filter)
                         throws SaAuthenticationException,
                                SaSystemException
```
    Returns the workflow members by the given parameters.
    This method is considered as a search-method. Thus, the result is a flat list of search results. The real SAPERION group, org unit, roles and user structure is not returned. The depth parameter of the given options has a special meaning: depth = 1 will return the same result as depth = 0. A negative depth will result in a full-depth search. A positive depth parameter will cause the search to be performed on the structure tree until the given tree-depth.
    The resulting members always include the user specific workflow favorites. An empty User marks the border between favorites and real search results.
    
    Parameters:
    member - Starting member
    depth - Depth to read
    filter - filter string
    
    Returns:
    Member Filled starting member
    
    Throws:
    
    SaAuthenticationException - SaAuthenticationException
    
    SaSystemException - SaSystemException
  - isAlive
```
public boolean isAlive()
                throws SaSystemException
```
    Test the lifetime of this connector.
    
    Specified by:
    
    isAlive in interface SaClassicConnector
    
    Returns:
    True if alive
    
    Throws:
    
    SaSystemException - System exception
    See Also:
    SaClassicConnector.isAlive()
  - getUsers
```
public List<String> getUsers(String filter)
                      throws SaSystemException,
                             SaAuthenticationException
```
    Reads a list of filtered users.
    
    Parameters:
    filter - Filter
    
    Returns:
    List of users
    
    Throws:
    
    SaSystemException - SaSystemException
    
    SaAuthenticationException - SaAuthenticationException
  - getAnnotations
```
@Deprecated
public String getAnnotations(String hDoc,
                               int indexOfContentElement)
                      throws SaAuthenticationException,
                             SaSystemException
```
    Deprecated. use getAnnotations(String, int, boolean) instead
    
    Reads the annotations from the given document.
    
    Specified by:
    
    getAnnotations in interface SaClassicConnector
    
    Parameters:
    hDoc - Document HDOC
    indexOfContentElement - the index of the chosen context element
    
    Returns:
    Annotation string
    
    Throws:
    
    SaAuthenticationException - Authentication error
    
    SaSystemException - Remote exception
  - getAnnotations
```
public String getAnnotations(String hDoc,
                    int indexOfContentElement,
                    boolean currentRevision)
                      throws SaAuthenticationException,
                             SaSystemException
```
    Reads the annotations from the given document.
    
    Specified by:
    
    getAnnotations in interface SaClassicConnector
    
    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
```
public void setAnnotations(String hDoc,
                  int indexOfContentElement,
                  String annotations)
                    throws SaAuthenticationException,
                           SaSystemException
```
    Sets the given annotations to the document. This method creates a new revision.
    
    Specified by:
    
    setAnnotations in interface SaClassicConnector
    
    Parameters:
    hDoc - Document HDOC
    indexOfContentElement - the index of the chosen context element
    annotations - Annotation string
    
    Throws:
    
    SaAuthenticationException - Authentication error
    
    SaSystemException - Remote exception
  - getSystemSetting
```
public SaSystemSetting getSystemSetting(String accessKey)
                                 throws SaSystemException,
                                        SaAuthenticationException
```
    Retrieves a system setting object.
    
    Specified by:
    
    getSystemSetting in interface SaClassicConnector
    
    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
```
public SaSystemInfo getSystemInfo()
                           throws SaSystemException
```
    Reads the system informations.
    
    Specified by:
    
    getSystemInfo in interface SaClassicConnector
    
    Returns:
    System informations SaSystemInfo
    
    Throws:
    
    SaSystemException - System exception
    See Also:
    SaClassicConnector.getSystemInfo()
  - getFeatures
```
public SaFeature getFeatures()
                      throws SaSystemException
```
    Reads the features.
    
    Specified by:
    
    getFeatures in interface SaClassicConnector
    
    Returns:
    Features
    
    Throws:
    
    SaSystemException - System exception
    See Also:
    SaClassicConnector.getFeatures()
  - getUserSetting
```
public SaUserSetting getUserSetting(String accessKey)
                             throws SaSystemException,
                                    SaAuthenticationException
```
    Retrieves a user-specific setting object. User-specific settings are stored in the system's ini-files.
    
    Specified by:
    
    getUserSetting in interface SaClassicConnector
    
    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
```
public void setUserSetting(SaUserSetting setting)
                    throws SaSystemException,
                           SaAuthenticationException
```
    Persists a user-specific setting object. User-specific settings are stored in the system's ini-files.
    
    Specified by:
    
    setUserSetting in interface SaClassicConnector
    
    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
```
public Setting getSetting(String name,
                 String section,
                 boolean isLong)
                   throws SaSystemException,
                          SaAuthenticationException
```
    Retrieves a Setting identified by it's key and section from the database.
    
    Specified by:
    
    getSetting in interface SaClassicConnector
    
    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
    See Also:
    SaClassicConnector.getSetting(java.lang.String, java.lang.String, boolean)
  - searchSettings
```
public SettingSearchResult searchSettings(SettingSearchInfo searchInfo)
                                   throws SaSystemException,
                                          SaAuthenticationException
```
    Searches for settings.
    
    Specified by:
    
    searchSettings in interface SaClassicConnector
    
    Parameters:
    searchInfo - SettingSearchInfo containing information about what to search
    
    Returns:
    a SettingSearchResult
    
    Throws:
    
    SaSystemException - system error when searching
    
    SaAuthenticationException - authentication error
    See Also:
    SaClassicConnector.searchSettings(com.saperion.settings.SettingSearchInfo)
  - setSetting
```
public void setSetting(Setting setting)
                throws SaSystemException,
                       SaAuthenticationException
```
    Stores a Setting in the database.
    
    Specified by:
    
    setSetting in interface SaClassicConnector
    
    Parameters:
    setting - the setting to store
    
    Throws:
    
    SaSystemException - system error when storing the setting
    
    SaAuthenticationException - authentication error when storing the setting
    See Also:
    SaClassicConnector.setSetting(com.saperion.settings.Setting)
  - deleteSetting
```
public boolean deleteSetting(String name,
                    String section,
                    boolean isLong)
                      throws SaSystemException,
                             SaAuthenticationException
```
    Deletes a setting in the database.
    
    Specified by:
    
    deleteSetting in interface SaClassicConnector
    
    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
    See Also:
    SaClassicConnector.deleteSetting(java.lang.String, java.lang.String, boolean)
  - loadLocalize
```
public Map<String,String> loadLocalize(String language)
                                throws SaWorkflowException
```
    Load localize.
    
    Parameters:
    language - Langage
    
    Returns:
    Localisation map
    
    Throws:
    
    SaWorkflowException - Workflow exception
  - setLocale
```
public void setLocale(Locale locale)
               throws SaAuthenticationException,
                      SaSystemException
```
    Set the localization information for this user.
    
    Specified by:
    
    setLocale in interface SaClassicConnector
    
    Parameters:
    locale - Localization information
    
    Throws:
    
    SaAuthenticationException - when the user is not logged in or has insufficient rights
    
    SaSystemException - SaSystemException
    See Also:
    SaClassicConnector.setLocale(java.util.Locale)
  - addToFolder
```
public 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.
    
    Specified by:
    
    addToFolder in interface SaClassicConnector
    
    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
    See Also:
    SaClassicConnector.addToFolder(java.lang.String, java.lang.String, java.lang.String, java.lang.String)
  - copyFolder
```
public 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.
    
    Specified by:
    
    copyFolder in interface SaClassicConnector
    
    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
    See Also:
    SaClassicConnector.copyFolder(java.lang.String, java.lang.String, java.lang.String, java.lang.String, boolean)
  - createFolder
```
@Deprecated
public 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
    
    Creates a new folder below a given folder. The parent folder can be the root node (empty id).
    
    Specified by:
    
    createFolder in interface SaClassicConnector
    
    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
    
    SaFolderNameException - when the folder name contained an invalid character
    
    SaAuthenticationException - Authentication error
    
    SaDDCException - Database exception
    See Also:
    SaClassicConnector.createFolder(java.lang.String, java.lang.String, java.lang.String, java.lang.String, SaFolderConstants.FOLDER_TYPE, java.util.Properties)
  - createFolder
```
public 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).
    
    Specified by:
    
    createFolder in interface SaClassicConnector
    
    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
    
    SaFolderNameException - when the folder name contained an invalid character
    
    SaAuthenticationException - Authentication error
    
    SaDDCException - Database exception
    See Also:
    SaClassicConnector.createFolder(com.saperion.intf.SaFolderSaveInfo, java.util.Properties)
  - deleteFolder
```
public 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.
    
    Specified by:
    
    deleteFolder in interface SaClassicConnector
    
    Parameters:
    folderTableDDC - Folder table
    folderId - Folder ID to delete
    
    Throws:
    
    SaSystemException - Remote exception
    
    SaAuthenticationException - Authentication error
    
    SaDDCException - Database exception
    See Also:
    SaClassicConnector.deleteFolder(java.lang.String, java.lang.String)
  - getDocumentFolders
```
public 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.
    
    Specified by:
    
    getDocumentFolders in interface SaClassicConnector
    
    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
    See Also:
    SaClassicConnector.getDocumentFolders(java.lang.String, java.lang.String,java.lang.String)
  - getDocumentFolderCount
```
public long getDocumentFolderCount(String folderTableDDC,
                          String documentDDC,
                          String sysRowId)
                            throws SaAuthenticationException,
                                   SaSetNodeException,
                                   SaSystemException,
                                   SaDDCException
```
    Returns the total count over all folders from all users in which the specified document is contained in.
    
    Specified by:
    
    getDocumentFolderCount in interface SaClassicConnector
    
    Parameters:
    folderTableDDC - Folder table
    documentDDC - Document DDC
    sysRowId - Document SysRowId
    
    Returns:
    folder count
    
    Throws:
    
    SaAuthenticationException - Authentication error
    
    SaSetNodeException - DDC not fileable
    
    SaSystemException - Remote exception
    
    SaDDCException - Database exception
    See Also:
    SaClassicConnector.getDocumentFolderCount(java.lang.String, java.lang.String, java.lang.String)
  - getFolderChildren
```
public 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.
    
    Specified by:
    
    getFolderChildren in interface SaClassicConnector
    
    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
    See Also:
    SaClassicConnector.getFolderChildren(java.lang.String, java.lang.String, int, com.saperion.rmi.SaQueryInfo, int)
  - getFolderInfo
```
@Deprecated
public 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.
    
    Specified by:
    
    getFolderInfo in interface SaClassicConnector
    
    Parameters:
    folderTableDDC - Folder table
    folderId - Folder ID
    
    Returns:
    Folder information
    
    Throws:
    
    SaSystemException - Remote exception
    
    SaAuthenticationException - Authentication error
    
    SaDBException - Database exception
    
    SaFolderException - Folder exception
    See Also:
    SaClassicConnector.getFolderInfo(java.lang.String, java.lang.String)
  - getFolderInfo
```
public SaDocumentInfo getFolderInfo(String folderTableDDC,
                           String folderId,
                           boolean forceLoadVariables)
                             throws SaSystemException,
                                    SaAuthenticationException,
                                    SaDBException,
                                    SaFolderException
```
    Returns the folder information object for the given folder.
    
    Specified by:
    
    getFolderInfo in interface SaClassicConnector
    
    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
    See Also:
    SaClassicConnector.getFolderInfo(java.lang.String, java.lang.String, boolean)
  - getFolderFromPath
```
public List<SaDocumentInfo> getFolderFromPath(String folderTableDDC,
                                     String startNodeId,
                                     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 SaClassicConnector.getFolderByPath(String, String, String) to retrieve a single folder.
    
    Specified by:
    
    getFolderFromPath in interface SaClassicConnector
    
    Parameters:
    folderTableDDC - Folder table
    startNodeId - 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
    See Also:
    SaClassicConnector.getFolderFromPath(java.lang.String, java.lang.String, java.lang.String)
  - getFolderByPath
```
public 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.
    
    Specified by:
    
    getFolderByPath in interface SaClassicConnector
    
    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
    See Also:
    SaClassicConnector.getFolderByPath(java.lang.String, java.lang.String, java.lang.String)
  - getFolderParent
```
public 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.
    
    Specified by:
    
    getFolderParent in interface SaClassicConnector
    
    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
    See Also:
    SaClassicConnector.getFolderParent(java.lang.String, java.lang.String)
  - getFolderRights
```
public 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.
    
    Specified by:
    
    getFolderRights in interface SaClassicConnector
    
    Parameters:
    folderTableDDC - Folder table
    folderId - Folder ID
    
    Returns:
    Folder access data
    
    Throws:
    
    SaSystemException - Remote exception
    
    SaAuthenticationException - Authentication error
    
    SaDDCException - Database exception
    See Also:
    SaClassicConnector.getFolderRights(java.lang.String, java.lang.String)
  - moveFolder
```
public 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.
    
    Specified by:
    
    moveFolder in interface SaClassicConnector
    
    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
    See Also:
    SaClassicConnector.moveFolder(java.lang.String, java.lang.String, java.lang.String, java.lang.String)
  - moveToFolder
```
public 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.
    
    Specified by:
    
    moveToFolder in interface SaClassicConnector
    
    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
    See Also:
    SaClassicConnector.moveToFolder(java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String)
  - removeFromFolder
```
public void removeFromFolder(String folderTableDDC,
                    String documentSysRowId,
                    String documentDDC,
                    String folderId)
                      throws SaSystemException,
                             SaAuthenticationException,
                             SaDDCException
```
    Removes the document from the given folder.
    
    Specified by:
    
    removeFromFolder in interface SaClassicConnector
    
    Parameters:
    folderTableDDC - Folder table
    documentSysRowId - Document SysRowId
    documentDDC - Document DDC name
    folderId - Folder ID
    
    Throws:
    
    SaSystemException - Remote exception
    
    SaAuthenticationException - Authentication error
    
    SaDDCException - Database exception
    See Also:
    SaClassicConnector.removeFromFolder(java.lang.String, java.lang.String, java.lang.String, java.lang.String)
  - searchFolderDocuments
```
public List<SaDocumentInfo> searchFolderDocuments(String folderTableDDC,
                                         String folderId,
                                         SaQueryInfo hqlFilter)
                                           throws SaSystemException,
                                                  SaAuthenticationException,
                                                  SaDDCException
```
    HQL search extended with additional folder informations and depth.
    
    Specified by:
    
    searchFolderDocuments in interface SaClassicConnector
    
    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
    See Also:
    SaClassicConnector.searchFolderDocuments(java.lang.String, java.lang.String, com.saperion.rmi.SaQueryInfo)
  - setFolderAcl
```
public 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.
    
    Specified by:
    
    setFolderAcl in interface SaClassicConnector
    
    Parameters:
    folderTableDDC - Folder table
    folderId - Folder ID
    aclName - ACL name
    
    Throws:
    
    SaSystemException - Remote exception
    
    SaAuthenticationException - Authentication error
    
    SaDDCException - Database exception
  - updateFolder
```
public 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.
    
    Specified by:
    
    updateFolder in interface SaClassicConnector
    
    Parameters:
    folderTableDDC - name of folder table (DDC)
    folderId - id of folder to update
    namevaluePairs - Folder properties to update
    
    Throws:
    
    SaSystemException - Remote exception
    
    SaFolderNameException - when the folder name contained an invalid character
    
    SaAuthenticationException - Authentication error
    
    SaDDCException - Database exception
    See Also:
    SaFolderConstants.FIELD_SYSNODETYPE, SaFolderConstants.FOLDER_TYPE, SaClassicConnector.updateFolder(java.lang.String, java.lang.String, java.util.Properties)
  - getFolderClass
```
public SaFolderClass getFolderClass(String className)
                             throws SaSystemException,
                                    SaAuthenticationException,
                                    SaDDCException
```
    Reads the folder class with the given name.
    
    Specified by:
    
    getFolderClass in interface SaClassicConnector
    
    Parameters:
    className - Class name in dotted notation
    
    Returns:
    Folder class
    
    Throws:
    
    SaSystemException - Remote exception
    
    SaAuthenticationException - authentication error
    
    SaDDCException - Database exception
    See Also:
    SaClassicConnector.getFolderClass(java.lang.String)
  - searchFolderClass
```
public Set<SaFolderClass> searchFolderClass(SaFolderClassSearchInfo searchInfo)
                                     throws SaSystemException,
                                            SaAuthenticationException
```
    Searches for folder classes that match the specified propertied.
    
    Specified by:
    
    searchFolderClass in interface SaClassicConnector
    
    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
    See Also:
    SaClassicConnector.searchFolderClass(com.saperion.rmi.SaFolderClassSearchInfo)
  - getSystemFiles
```
public List<String> getSystemFiles(SystemFileKind kind,
                          String filter)
                            throws SaAuthenticationException,
                                   SaSystemException
```
    Gets the system files of a specific kind.
    
    Specified by:
    
    getSystemFiles in interface SaClassicConnector
    
    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
    See Also:
    SaClassicConnector.getSystemFiles(com.saperion.settings.SystemFileKind, java.lang.String)
  - logClientEvent
```
public void logClientEvent(String hdoc,
                  SaConstants.ProtoEvents event,
                  String remark)
                    throws SaSystemException,
                           SaAuthenticationException
```
    Adds an audit log event.
    
    Specified by:
    
    logClientEvent in interface SaClassicConnector
    
    Parameters:
    hdoc - Document HDOC
    event - Event type
    remark - Remark
    
    Throws:
    
    SaSystemException - general error
    
    SaAuthenticationException - error on the authentification / insufficient rights
    See Also:
    SaClassicConnector.logClientEvent(java.lang.String, com.saperion.constants.SaConstants.ProtoEvents, java.lang.String)
  - getAcls
```
public List<SaAcl> getAcls()
                    throws SaSystemException,
                           SaAuthenticationException
```
    Reads all existing ACLs.
    
    Specified by:
    
    getAcls in interface SaClassicConnector
    
    Returns:
    List of ACLs
    
    Throws:
    
    SaSystemException - Remote exception
    
    SaAuthenticationException - SaAuthenticationException
  - getACLRights
```
public SaACLRights getACLRights(String[] acls)
                         throws SaSystemException,
                                SaAuthenticationException
```
    Read the rights for the given ACL's.
    
    Specified by:
    
    getACLRights in interface SaClassicConnector
    
    Parameters:
    acls - array of ACL name to get rights for
    
    Returns:
    Rights
    
    Throws:
    
    SaSystemException - Remote exception
    
    SaAuthenticationException - SaAuthenticationException
    See Also:
    SaClassicConnector.getACLRights(java.lang.String[])
  - storeBpmn
```
public void storeBpmn(BpmnImportDescription bpmnDescription,
             BpmnImportCallback callback)
               throws SaAuthenticationException,
                      SaSystemException
```
    Transforms the bpmn model to a saperion process and stores it to the system.
    
    Parameters:
    bpmnDescription - The description of the model to import.
    callback - The callback object that is notified when the transformation succeeds or fails.
    
    Throws:
    
    SaAuthenticationException - authentication error
    
    SaSystemException - remote exception
  - changePassword
```
public void changePassword(String user,
                  String oldPassword,
                  String client,
                  String newPassword)
                    throws SaSystemException,
                           SaAuthenticationException
```
    Changes the password of an existing user.
    
    Specified by:
    
    changePassword in interface SaClassicConnector
    
    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 SaClassicConnector.logon(String, String, int, String) was successfully invoked.
    See Also:
    SaClassicConnector.changePassword(String, String, String, String)
  - getAuthorizedUsers
```
public List<UsersRights> getAuthorizedUsers(String hDoc,
                                   String rights,
                                   MatchKind match)
                                     throws SaSystemException,
                                            SaAuthenticationException
```
    Returns the users, that have specific rights on a document.
    
    Specified by:
    
    getAuthorizedUsers in interface SaClassicConnector
    
    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
    See Also:
    SaClassicConnector.getAuthorizedUsers(String, String, MatchKind)
  - getArchivedSize
```
public int getArchivedSize(String hDoc)
                    throws SaSystemException,
                           SaAuthenticationException
```
    Returns the total document size in the archive.
    
    Specified by:
    
    getArchivedSize in interface SaClassicConnector
    
    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
    See Also:
    SaClassicConnector.getArchivedSize(String)
  - createLookupEntry
```
@Deprecated
public 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.
    
    Specified by:
    
    createLookupEntry in interface SaClassicConnector
    
    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
    See Also:
    SaClassicConnector.createLookupEntry(java.lang.String, java.util.Properties)
  - deleteLookupEntry
```
@Deprecated
public 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.
    
    Specified by:
    
    deleteLookupEntry in interface SaClassicConnector
    
    Parameters:
    ddc - Lookup DDC name
    id - SYSROWID of the existing entry
    
    Throws:
    
    SaSystemException - Remote exception
    
    SaAuthenticationException - Authentication error
    
    SaDDCException - Database exception
    See Also:
    SaClassicConnector.deleteLookupEntry(java.lang.String, java.lang.String)
  - updateLookupEntry
```
@Deprecated
public 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.
    
    Specified by:
    
    updateLookupEntry in interface SaClassicConnector
    
    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
    See Also:
    SaClassicConnector.updateLookupEntry(java.lang.String, java.lang.String, java.util.Properties)
  - storeSystemFile
```
public void storeSystemFile(SystemFileKind kind,
                   String name,
                   InputStream data)
                     throws SaAuthenticationException,
                            SaSystemException
```
    Stores a system file of a specific kind.
    
    Specified by:
    
    storeSystemFile in interface SaClassicConnector
    
    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
    See Also:
    SaClassicConnector.storeSystemFile(SystemFileKind, String, InputStream)
  - loadSystemFile
```
public InputStream loadSystemFile(SystemFileKind kind,
                         String name)
                           throws SaAuthenticationException,
                                  SaSystemException
```
    Loads a system file of a specific kind.
    
    Specified by:
    
    loadSystemFile in interface SaClassicConnector
    
    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
    See Also:
    SaClassicConnector.loadSystemFile(com.saperion.settings.SystemFileKind, java.lang.String)
  - getFolderUpdateInfo
```
public Set<FolderUpdateInfo> getFolderUpdateInfo(Map<String,Long> folderIds)
                                          throws SaAuthenticationException,
                                                 SaSystemException
```
    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.
    
    Specified by:
    
    getFolderUpdateInfo in interface SaClassicConnector
    
    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:
    
    SaAuthenticationException - when the user is not logged in or has insufficient rights
    
    SaSystemException - when a system error occured
    See Also:
    SaClassicConnector.getFolderUpdateInfo(java.util.Map)
  - checkSapUrl
```
public 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.
    
    Specified by:
    
    checkSapUrl in interface SaClassicConnector
    
    Parameters:
    url - SAP URL
    
    Returns:
    Document Info
    
    Throws:
    
    SaSystemException - when a system error occured
    
    SaAuthenticationException - when the user is not logged in or has insufficient rights
    
    SaSapUrlException
    See Also:
    SaClassicConnector.checkSapUrl(java.lang.String)
  - cacheDocument
```
public 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.
    
    Specified by:
    
    cacheDocument in interface SaClassicConnector
    
    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
    See Also:
    SaClassicConnector.cacheDocument(java.lang.String, com.saperion.structures.DocumentInfo)
  - resolveLatestHDoc
```
public String resolveLatestHDoc(String oldHdoc)
                         throws SaSystemException,
                                SaAuthenticationException
```
    Resolves and returns the XHDOC of the latest version of the document identified by the given HDOC.
    
    Specified by:
    
    resolveLatestHDoc in interface SaClassicConnector
    
    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
    See Also:
    SaClassicConnector.resolveLatestHDoc(java.lang.String)
  - cacheDocument
```
public 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.
    
    Specified by:
    
    cacheDocument in interface SaClassicConnector
    
    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
    See Also:
    SaClassicConnector.cacheDocument(java.lang.String, java.lang.String, java.util.Properties, java.io.InputStream[], java.lang.String, java.lang.String)
  - getCurrentUserInfo
```
public SaUserInfo getCurrentUserInfo()
                              throws SaAuthenticationException,
                                     SaSystemException
```
    Gets detailed info about the current user.
    
    Specified by:
    
    getCurrentUserInfo in interface SaClassicConnector
    
    Returns:
    detailed info about the current user.
    
    Throws:
    
    SaAuthenticationException - If not properly logged in
    
    SaSystemException - SaSystemException
    See Also:
    SaClassicConnector.getCurrentUserInfo()
  - setCurrentUserPresent
```
public void setCurrentUserPresent(boolean present)
                           throws SaAuthenticationException,
                                  SaSystemException
```
    Sets whether the current user is present.
    
    Specified by:
    
    setCurrentUserPresent in interface SaClassicConnector
    
    Parameters:
    present - whether the current user is present
    
    Throws:
    
    SaSystemException - system error
    
    SaAuthenticationException - authentication error
    See Also:
    SaClassicConnector.setCurrentUserPresent(boolean)
  - updateCurrentUserInformation
```
public void updateCurrentUserInformation(MutableUserInformation user)
                                  throws SaAuthenticationException,
                                         SaSystemException
```
    Description copied from interface: SaClassicConnector
    
    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.
    
    Specified by:
    
    updateCurrentUserInformation in interface SaClassicConnector
    
    Parameters:
    user - - the information to change
    
    Throws:
    
    SaAuthenticationException - authentication error
    
    SaSystemException - system error
  - invoke
```
public <T extends Serializable> T invoke(Operation<T> operation)
                              throws SaAuthenticationException,
                                     SaSystemException
```
    Description copied from interface: SaClassicConnector
    
    Invokes the given Operation on the server side.
    
    Specified by:
    
    invoke in interface SaClassicConnector
    
    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.
  - getRendition
```
public List<Rendition> getRendition(Element element,
                           Options options)
                             throws FormatNotSupportedException,
                                    PreconditionFailedException,
                                    TimeoutException,
                                    RenderingException,
                                    SaAuthenticationException,
                                    SaSystemException
```
    Specified by:
    
    getRendition in interface SaClassicConnector
    
    Parameters:
    element - an Element object that represents an object in the archived document.
    
    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
    See Also:
    SaClassicConnector.getRendition(com.saperion.connector.structures.Element, com.saperion.connector.options.Options)
  - sendBarcode
```
public void sendBarcode(String indexMask,
               String docUid,
               String contentRep,
               String sid,
               String docType,
               String value,
               int mandant)
                 throws SaBarcodeException
```
    Send barcode to SAP.
    
    Specified by:
    
    sendBarcode in interface SaClassicConnector
    
    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
    See Also:
    SaClassicConnector.sendBarcode(java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String, int)
  - getToken
```
public int getToken()
```
    Returns:
    the token used to identify this connector instance in the backend
  - getSession
```
public com.saperion.connector.authentication.Session getSession()
                                                         throws SaAuthenticationException
```
    Returns the session of the logged in user. In other case a SaAuthenticationException will be thrown;
    
    Returns:
    a session if connector was successfully logged in.
    
    Throws:
    
    SaAuthenticationException - if no successful login was done
  - getServerInfos
```
public List<SaRMIServerInfo> getServerInfos()
                                     throws SaAuthenticationException,
                                            SaSystemException
```
    Returns:
    list of SaRMIServerInfo instances describing the servers configured in saperion.properties
    
    Throws:
    
    SaAuthenticationException - user is not logged in
    
    SaSystemException - system exception
  - getLicenseCount
```
public int getLicenseCount(int type)
                    throws SaSystemException
```
    Read the licence count for the given user.
    
    Specified by:
    
    getLicenseCount in interface SaClassicConnector
    
    Parameters:
    type - Client type
    
    Returns:
    License count
    
    Throws:
    
    SaSystemException - Error on the saperion system
    See Also:
    SaClassicConnector.getLicenseCount(int)
  - setUsedLicense
```
public boolean setUsedLicense(int type,
                     int count)
                       throws SaSystemException
```
    Set the count of used licenses.
    
    Specified by:
    
    setUsedLicense in interface SaClassicConnector
    
    Parameters:
    type - Client type
    count - Number of licenses
    
    Returns:
    True, if success
    
    Throws:
    
    SaSystemException - Error on the saperion system
    See Also:
    SaClassicConnector.setUsedLicense(int, int)
  - hasRenderEngine
```
public boolean hasRenderEngine()
```
    Checks wether this classic connector has a render engine.
    
    Specified by:
    
    hasRenderEngine in interface SaClassicConnector
    
    Returns:
    if there is a render engine true, otherwise false
    See Also:
    SaClassicConnector.hasRenderEngine()
  - getSupportedRenderSourceFormats
```
public Set<SourceFormat> getSupportedRenderSourceFormats()
```
    Gets the supported source formats from the render engine.
    
    Specified by:
    
    getSupportedRenderSourceFormats in interface SaClassicConnector
    
    Returns:
    set of supported source formats (empty if there is no render engine)
    See Also:
    SaClassicConnector.getSupportedRenderSourceFormats()
  - getSupportedRenderTargetFormats
```
public Set<TargetFormat> getSupportedRenderTargetFormats()
```
    Gets the supported target formats from the render engine.
    
    Specified by:
    
    getSupportedRenderTargetFormats in interface SaClassicConnector
    
    Returns:
    set of supported target formats (empty if there is no render engine)
    See Also:
    SaClassicConnector.getSupportedRenderTargetFormats()
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - setEventsEnabled
```
public void setEventsEnabled(boolean enabled)
                      throws SaSystemException,
                             SaAuthenticationException
```
    Description copied from interface: SaClassicConnector
    
    Sets whether events (e.g. for the Integration Server) should be enabled for the current session.
    
    Specified by:
    
    setEventsEnabled in interface SaClassicConnector
    
    Parameters:
    enabled - true, to enable events, otherwise false.
    
    Throws:
    
    SaSystemException - system error
    
    SaAuthenticationException - authentication error
  - getEventsEnabled
```
public boolean getEventsEnabled()
                         throws SaSystemException,
                                SaAuthenticationException
```
    Description copied from interface: SaClassicConnector
    
    Returns whether events (e.g. for the Integration Server) are enabled for the current session.
    
    Specified by:
    
    getEventsEnabled in interface SaClassicConnector
    
    Returns:
    true, if events are enabled for the current session, otherwise false.
    
    Throws:
    
    SaSystemException - system error
    
    SaAuthenticationException - authentication error
  - getDDC
```
public DDC getDDC(String ddcName)
           throws SaSystemException,
                  SaAuthenticationException
```
    Description copied from interface: SaClassicConnector
    
    Returns information about the requested DDC.
    
    Specified by:
    
    getDDC in interface SaClassicConnector
    
    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

Class SaClassicConnectorImpl

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

SaClassicConnectorImpl

SaClassicConnectorImpl

SaClassicConnectorImpl

SaClassicConnectorImpl

Method Detail

getConfiguration

stopServer

getDefinitions

getFolderDefinitions

getDBDefinition

logon

logon

logon

logon

logoff

readReleasedDocument

readDocument

readDocumentMetadata

getFulltext

getFulltext

getThumbnail

createDocument

createDocument

createDocument

createLink

updateDocument

lockDocument

unlockDocument

getDocumentInfo

getDocumentInfo

updateDocument

updateDocument

updateDocument

updateDocument

checkoutDocument

discardCheckout

releaseDocument

isReleaseActive

getReleasedHdoc

getReleaseAclName

restoreVersion

deleteDocument

getVersionIDs

readVersionDocument

readVersionMetadata

readVersionDocumentFilename

search

searchHQL

removeEvent

addListener

removeListener

addListener

removeListener

readDocumentFilename

getACLNames

getAllACLs

getInvolvedUsers

setACLName

getDocumentAccessData

getLockInfo

isActive

getCurrentUserName

getWorkflowConnector

getTaskList

getTaskAuditList

getTask

getParentTask

getCommandInfos

getCommandInfos

getBoxDefinitions

getBoxCount

executeCommand

getCommentInfos

getHistoryInfos

getCompleteHistoryInfos