| Package | Description |
|---|---|
| com.saperion.connector |
This package contains the main classic connector classes.
|
| com.saperion.connector.events | |
| com.saperion.connector.exceptions | |
| com.saperion.connector.ldap |
This package contains the classes for the LARIX LDAP Kerberos authentication components.
|
| com.saperion.connector.rmi |
Package for connector RMI client classes.
|
| com.saperion.connector.service |
This package contains the client-side implementations of services.
|
| com.saperion.connector.wf |
This package contains the main classic workflow connector classes.
|
| com.saperion.exception |
This package contains the classes for the global exceptions.
|
| com.saperion.jna.typemapping.database | |
| com.saperion.operations |
This package defines the different operations, that can be invoked by rmi.
|
| com.saperion.operations.lookup |
This package defines the different operations on lookup tables, that can be invoked by rmi.
|
| com.saperion.rmi |
This package contains the classes for the LARIX RMI client wrapper components.
|
| com.saperion.rmi.common |
This package contains the classes for the LARIX RMI Server.
|
| com.saperion.rmi.serverexception |
This package contains the exception classes for RMI client components.
|
| com.saperion.util |
This package contains the utility classes for the LARIX RMI Server.
|
| Modifier and Type | Method and Description |
|---|---|
void |
SaClassicConnectorImpl.addComment(String comment,
String taskUID,
int level)
Adds a comment to the task.
|
void |
SaClassicConnectorImpl.addHistory(String description,
String taskUID)
Adds a history entry to the task.
|
void |
SaClassicConnectorImpl.addListener(SaEventListener listener)
Deprecated.
|
void |
SaClassicConnector.addListener(SaEventListener listener)
Deprecated.
will be removed with version 8.1
|
void |
SaClassicConnectorImpl.addListener(SaStatusEventListener listener)
Deprecated.
|
void |
SaClassicConnector.addListener(SaStatusEventListener listener)
Deprecated.
will be removed with version 8.1
|
void |
SaClassicConnectorImpl.addToFolder(String folderTableDDC,
String documentId,
String documentDDC,
String folderId) |
void |
SaClassicConnector.addToFolder(String folderTableDDC,
String documentId,
String documentDDC,
String folderId)
Adds the document with given documentId to a given folder with given folderId.
|
SaSaveInfo |
SaClassicConnectorImpl.cacheDocument(String xhDoc,
DocumentInfo document) |
SaSaveInfo |
SaClassicConnector.cacheDocument(String xhDoc,
DocumentInfo document)
Caches a new document in the backend system with the given metadata and content.
|
SaSaveInfo |
SaClassicConnectorImpl.cacheDocument(String xhDoc,
String ddcName,
Properties namevaluePairs,
InputStream[] content,
String versionComment,
String strAcl) |
SaSaveInfo |
SaClassicConnector.cacheDocument(String xhDoc,
String ddcName,
Properties namevaluePairs,
InputStream[] content,
String versionComment,
String strAcl)
Caches a new document in the backend system with the given metadata and content.
|
void |
SaClassicConnectorImpl.changePassword(String user,
String oldPassword,
String tenant,
String newPassword) |
void |
SaClassicConnector.changePassword(String user,
String oldPassword,
String tenant,
String newPassword)
Changes the password of an existing user.
|
void |
SaClassicConnectorImpl.checkoutDocument(String hDoc) |
void |
SaClassicConnector.checkoutDocument(String hDoc)
Checks out a document for the given document id (hdoc).
|
SapDocInfo |
SaClassicConnectorImpl.checkSapUrl(String url) |
SapDocInfo |
SaClassicConnector.checkSapUrl(String url)
Checks the given SAP URL on the R/Link server and returns, if successfull, the HDOC and the
DDC.
|
boolean |
SaClassicConnectorImpl.closeSession(com.saperion.connector.authentication.Session session)
Close the given
Session of logged in user |
boolean |
SaClassicConnector.closeSession(com.saperion.connector.authentication.Session session)
Close the given
Session of logged in user |
String |
SaClassicConnectorImpl.copyFolder(String folderTableDDC,
String folderId,
String destinationId,
String beforeChild,
boolean withDocuments) |
String |
SaClassicConnector.copyFolder(String folderTableDDC,
String folderId,
String destinationId,
String beforeChild,
boolean withDocuments)
Copies the given folder and all it's children to the destination.
|
SaSaveInfo |
SaClassicConnectorImpl.createDocument(DocumentInfo document) |
SaSaveInfo |
SaClassicConnector.createDocument(DocumentInfo document)
Creates a new document on the backend system with the given
DocumentInfo. |
SaSaveInfo |
SaClassicConnectorImpl.createDocument(String ddcName,
Properties namevaluePairs,
InputStream[] content,
String versionComment)
Deprecated.
|
SaSaveInfo |
SaClassicConnector.createDocument(String ddcName,
Properties namevaluePairs,
InputStream[] content,
String versionComment)
Deprecated.
will be removed with version 8.1, use
SaClassicConnector.createDocument(DocumentInfo) instead. |
SaSaveInfo |
SaClassicConnectorImpl.createDocument(String ddcName,
Properties namevaluePairs,
InputStream[] content,
String versionComment,
String acls)
Deprecated.
|
SaSaveInfo |
SaClassicConnector.createDocument(String ddcName,
Properties namevaluePairs,
InputStream[] content,
String versionComment,
String acls)
Deprecated.
will be removed with version 8.1, use
SaClassicConnector.createDocument(DocumentInfo) instead. |
String |
SaClassicConnectorImpl.createFolder(SaFolderSaveInfo info,
Properties namevaluePairs) |
String |
SaClassicConnector.createFolder(SaFolderSaveInfo info,
Properties namevaluePairs)
Creates a new folder below a given folder.
|
String |
SaClassicConnectorImpl.createFolder(String folderTableDDC,
String parentId,
String beforeChild,
String folderName,
SaFolderConstants.FOLDER_TYPE folderType,
Properties namevaluePairs)
Deprecated.
|
String |
SaClassicConnector.createFolder(String folderTableDDC,
String parentId,
String beforeChild,
String folderName,
SaFolderConstants.FOLDER_TYPE folderType,
Properties namevaluePairs)
Deprecated.
use
SaClassicConnector.createFolder(SaFolderSaveInfo, Properties) instead. Will be removed with version 8.1 |
SaSaveInfo |
SaClassicConnectorImpl.createLink(LinkInfo link) |
SaSaveInfo |
SaClassicConnector.createLink(LinkInfo link)
Creates a link to a document for given
LinkInfo. |
void |
SaClassicConnectorImpl.deleteDocument(String documentHDOC,
int deleteType) |
void |
SaClassicConnector.deleteDocument(String documentHDOC,
int deleteType)
Deletes a document from the backend system with the given delete type strategy.
|
void |
SaClassicConnectorImpl.deleteFolder(String folderTableDDC,
String folderId) |
void |
SaClassicConnector.deleteFolder(String folderTableDDC,
String folderId)
Deletes an existing folder.
|
boolean |
SaClassicConnectorImpl.deleteSetting(String name,
String section,
boolean isLong) |
boolean |
SaClassicConnector.deleteSetting(String name,
String section,
boolean isLong)
This method deletes a setting in the database.
|
void |
SaClassicConnectorImpl.discardCheckout(String hDoc) |
void |
SaClassicConnector.discardCheckout(String hDoc)
Discards a checkout of a document which was performed via the method
SaClassicConnector.checkoutDocument(String). |
String |
SaClassicConnectorImpl.executeCommand(ContextInfo contextInfo)
Performs the given command.
|
String |
SaClassicConnectorImpl.getACLNames(String documentHDOC) |
String |
SaClassicConnector.getACLNames(String documentHDOC)
This method returns the names of the Access Control Lists that are assigned to this document.
|
SaACLRights |
SaClassicConnectorImpl.getACLRights(String[] acls) |
SaACLRights |
SaClassicConnector.getACLRights(String[] acls)
This method returns the access rights the current user has when in the context of the Access Controll Lists
given by name.
|
List<SaAcl> |
SaClassicConnectorImpl.getAcls() |
List<SaAcl> |
SaClassicConnector.getAcls()
This method returns all Access Control Lists in the current tenant.
|
List<String> |
SaClassicConnectorImpl.getAllACLs()
Deprecated.
|
List<String> |
SaClassicConnector.getAllACLs()
Deprecated.
use
SaClassicConnector.getAcls() instead. Will be removed with version 8.1 |
String |
SaClassicConnectorImpl.getAnnotations(String hDoc,
int indexOfContentElement)
Deprecated.
|
String |
SaClassicConnector.getAnnotations(String hDoc,
int indexOfContentElement)
Deprecated.
use
SaClassicConnector.getAnnotations(String, int, boolean) instead. Will be removed with version 8.1 |
String |
SaClassicConnectorImpl.getAnnotations(String hDoc,
int indexOfContentElement,
boolean currentRevision) |
String |
SaClassicConnector.getAnnotations(String hDoc,
int indexOfContentElement,
boolean currentRevision)
Reads the annotations of the document with the specified ID.
|
int |
SaClassicConnectorImpl.getArchivedSize(String hDoc) |
int |
SaClassicConnector.getArchivedSize(String hDoc)
Returns the total document size in the archive in bytes.
|
List<UsersRights> |
SaClassicConnectorImpl.getAuthorizedUsers(String hDoc,
String rights,
MatchKind match) |
List<UsersRights> |
SaClassicConnector.getAuthorizedUsers(String hDoc,
String rights,
MatchKind match)
This method returns the users that have specific rights on a document.
|
Long |
SaClassicConnectorImpl.getBoxCount(int boxId)
Reads the count (number of workflow item) of the inbox identified by the given id.
|
List<BoxDefinition> |
SaClassicConnectorImpl.getBoxDefinitions()
Reads the box definitions.
|
Collection<CommandInfo> |
SaClassicConnectorImpl.getCommandInfos(String docUID)
Reads all possible transitions for this task.
|
Collection<CommandInfo> |
SaClassicConnectorImpl.getCommandInfos(String docUID,
boolean transitionsOnly)
Reads all possible transitions and optional other possible commands for this task.
|
List<CommentInfo> |
SaClassicConnectorImpl.getCommentInfos(String taskId)
Reads the comments for the given task.
|
List<List<HistoryInfo>> |
SaClassicConnectorImpl.getCompleteHistoryInfos(String docId)
Reads the history and comments for the given document.
|
Properties |
SaClassicConnectorImpl.getConfiguration(String section) |
Properties |
SaClassicConnector.getConfiguration(String section)
This method reads the application configuration properties from the backend system.
|
SaUserInfo |
SaClassicConnectorImpl.getCurrentUserInfo() |
SaUserInfo |
SaClassicConnector.getCurrentUserInfo()
This method returns detailed info about the current user.
|
SaFieldDescription[] |
SaClassicConnectorImpl.getDBDefinition(String name) |
SaFieldDescription[] |
SaClassicConnector.getDBDefinition(String name)
Deprecated.
use
SaClassicConnector.getDDC(String) instead. Will be removed in version 8.1 |
DDC |
SaClassicConnectorImpl.getDDC(String ddcName) |
DDC |
SaClassicConnector.getDDC(String ddcName)
This method returns a document definition given by its name.
|
String[] |
SaClassicConnectorImpl.getDefinitions() |
String[] |
SaClassicConnector.getDefinitions()
This method returns the names of all DDCs registered in the Saperion system.
|
SaDocAccessData |
SaClassicConnectorImpl.getDocumentAccessData(String documentHDOC) |
SaDocAccessData |
SaClassicConnector.getDocumentAccessData(String documentHDOC)
This method reads the access rights the current user has on a given document.
|
long |
SaClassicConnectorImpl.getDocumentFolderCount(String folderTableDDC,
String documentDDC,
String sysRowId) |
long |
SaClassicConnector.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> |
SaClassicConnectorImpl.getDocumentFolders(String folderTableDDC,
String documentDDC,
String sysRowId) |
List<SaDocumentInfo> |
SaClassicConnector.getDocumentFolders(String folderTableDDC,
String documentDDC,
String sysRowId)
Returns a list of folder properties which contains all folders the document is contained in.
|
SaDocInfo |
SaClassicConnectorImpl.getDocumentInfo(String hDoc,
boolean currentRevision,
boolean resolveLinks) |
SaDocInfo |
SaClassicConnector.getDocumentInfo(String hDoc,
boolean currentRevision,
boolean resolveLinks)
Reads information like the document-structure and variables for the given document.
|
SaDocInfo |
SaClassicConnectorImpl.getDocumentInfo(String hDoc,
boolean currentRevision,
boolean resolveLinks,
boolean forceSizeDetermination) |
SaDocInfo |
SaClassicConnector.getDocumentInfo(String hDoc,
boolean currentRevision,
boolean resolveLinks,
boolean forceSizeDetermination)
Reads information like the document-structure and variables for the given document.
|
boolean |
SaClassicConnectorImpl.getEventsEnabled() |
boolean |
SaClassicConnector.getEventsEnabled()
This method returns whether events (e.g.
|
SaFeature |
SaClassicConnectorImpl.getFeatures() |
SaFeature |
SaClassicConnector.getFeatures()
This method returns the features enabled in the Saperion system.
|
SaDocumentInfo |
SaClassicConnectorImpl.getFolderByPath(String folderTableDDC,
String startFolderId,
String folderPath) |
SaDocumentInfo |
SaClassicConnector.getFolderByPath(String folderTableDDC,
String startFolderId,
String folderPath)
Returns the folder which matches to the given path.
|
List<SaDocumentInfo> |
SaClassicConnectorImpl.getFolderChildren(String folderTableDDC,
String folderId,
int depth,
SaQueryInfo filter,
int allowedMaxNrOfChildFolders) |
List<SaDocumentInfo> |
SaClassicConnector.getFolderChildren(String folderTableDDC,
String folderId,
int depth,
SaQueryInfo filter,
int allowedMaxNrOfChildFolders)
Returns a list with the children of the given node.
|
SaFolderClass |
SaClassicConnectorImpl.getFolderClass(String className) |
SaFolderClass |
SaClassicConnector.getFolderClass(String className)
Reads the folder class with the given name.
|
String[] |
SaClassicConnectorImpl.getFolderDefinitions() |
String[] |
SaClassicConnector.getFolderDefinitions()
Reads the registered folder DDC names from the repository.
|
List<SaDocumentInfo> |
SaClassicConnectorImpl.getFolderFromPath(String folderTableDDC,
String startNodeId,
String folderPath) |
List<SaDocumentInfo> |
SaClassicConnector.getFolderFromPath(String folderTableDDC,
String startFolderId,
String folderPath)
Returns the folders which match to the given path.
|
SaDocumentInfo |
SaClassicConnectorImpl.getFolderInfo(String folderTableDDC,
String folderId)
Deprecated.
|
SaDocumentInfo |
SaClassicConnector.getFolderInfo(String folderTableDDC,
String folderId)
Deprecated.
use
SaClassicConnector.getFolderInfo(String, String, boolean) instead. Will be removed in version 8.1. |
SaDocumentInfo |
SaClassicConnectorImpl.getFolderInfo(String folderTableDDC,
String folderId,
boolean forceLoadVariables) |
SaDocumentInfo |
SaClassicConnector.getFolderInfo(String folderTableDDC,
String folderId,
boolean forceLoadVariables)
Returns the folder information object for the given folder.
|
SaDocumentInfo |
SaClassicConnectorImpl.getFolderParent(String folderTableDDC,
String folderId) |
SaDocumentInfo |
SaClassicConnector.getFolderParent(String folderTableDDC,
String folderId)
Returns the parent of the given folder.
|
SaDocAccessData |
SaClassicConnectorImpl.getFolderRights(String folderTableDDC,
String folderId) |
SaDocAccessData |
SaClassicConnector.getFolderRights(String folderTableDDC,
String folderId)
Returns the rights mask for the given folder and user.
|
Set<FolderUpdateInfo> |
SaClassicConnectorImpl.getFolderUpdateInfo(Map<String,Long> folderIds)
Deprecated.
|
Set<FolderUpdateInfo> |
SaClassicConnector.getFolderUpdateInfo(Map<String,Long> folderIds)
Deprecated.
No longer supported. Will be removed in 8.1.
|
String |
SaClassicConnectorImpl.getFulltext(String ddcName,
String sysRowId)
Deprecated.
|
String |
SaClassicConnector.getFulltext(String ddcName,
String sysRowId)
Deprecated.
Will be removed in 8.1. Use
SaClassicConnector.getFulltext(String, String, String, long) instead. |
String |
SaClassicConnectorImpl.getFulltext(String ddcName,
String hdoc,
String fieldName,
long length) |
String |
SaClassicConnector.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.
|
Set<Map.Entry<String,String>> |
SaClassicConnectorImpl.getFullTextFields(String ddcName,
List<String> fullTextFields,
String hdoc)
|
default Set<Map.Entry<String,String>> |
SaClassicConnector.getFullTextFields(String ddcName,
List<String> fullTextFields,
String hdoc)
Fetches values of Full text columns
|
List<HistoryInfo> |
SaClassicConnectorImpl.getHistoryInfos(String taskId)
Reads the history for the given task.
|
List<String> |
SaClassicConnectorImpl.getInvolvedUsers(String documentHDOC) |
List<String> |
SaClassicConnector.getInvolvedUsers(String documentHDOC)
Deprecated.
use
SaClassicConnector.getAuthorizedUsers(String, String, MatchKind) instead. Will be removed in version 8.1. |
int |
SaClassicConnectorImpl.getLicenseCount(int type) |
int |
SaClassicConnector.getLicenseCount(int type)
This method returns the overall count of Licenses of the given type in the system.
|
SaLockInfo |
SaClassicConnectorImpl.getLockInfo(String sysRowId) |
SaLockInfo |
SaClassicConnector.getLockInfo(String sysRowId)
This method returns the locking information for a given document.
|
WorkflowMember |
SaClassicConnectorImpl.getMember(WorkflowMember member,
int depth,
String filter)
Returns the workflow members by the given parameters.
This method is considered as a search-method. |
WorkflowMember |
SaClassicConnectorImpl.getMembers()
Reads the workflow members in a full structured tree.
|
boolean |
SaClassicConnectorImpl.getOutOfOffice()
Get the substitute for the logged on user.
|
TaskInfo |
SaClassicConnectorImpl.getParentTask(String taskID)
Reads the parent task info for the given ID.
|
String |
SaClassicConnectorImpl.getReleaseAclName()
Gets the release ACL name, configured in the program.ini in section [Release].
|
String |
SaClassicConnectorImpl.getReleasedHdoc(String oldHdoc) |
String |
SaClassicConnector.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<com.saperion.connector.renditions.Rendition> |
SaClassicConnectorImpl.getRendition(Element element,
com.saperion.connector.options.Options options) |
List<com.saperion.connector.renditions.Rendition> |
SaClassicConnector.getRendition(Element element,
com.saperion.connector.options.Options options)
Returns the rendition object from a rendered document.
|
List<SaRMIServerInfo> |
SaClassicConnectorImpl.getServerInfos() |
Setting |
SaClassicConnectorImpl.getSetting(String name,
String section,
boolean isLong) |
Setting |
SaClassicConnector.getSetting(String name,
String section,
boolean isLong)
This method retrieves a
Setting identified by it's key and section from the database. |
String |
SaClassicConnectorImpl.getSubstitute()
Get the substitute for the logged on user.
|
List<String> |
SaClassicConnectorImpl.getSystemFiles(SystemFileKind kind,
String filter) |
List<String> |
SaClassicConnector.getSystemFiles(SystemFileKind kind,
String filter)
This method returns the names of all system files of a specific kind.
|
SaSystemInfo |
SaClassicConnectorImpl.getSystemInfo() |
SaSystemInfo |
SaClassicConnector.getSystemInfo()
This method returns general information about the connected system.
|
SaSystemSetting |
SaClassicConnectorImpl.getSystemSetting(String accessKey) |
SaSystemSetting |
SaClassicConnector.getSystemSetting(String accessKey)
Retrieves a system setting object.
|
TaskInfo |
SaClassicConnectorImpl.getTask(String taskID)
Reads the task info for the given ID.
|
List<TaskAuditInfo> |
SaClassicConnectorImpl.getTaskAuditList(int[] ids,
String filter,
Map<String,Object> parameter)
Reads the task audits for this user.
|
List<TaskInfo> |
SaClassicConnectorImpl.getTaskList(int[] ids,
String filter,
Map<String,Object> parameter)
Reads the tasks for this user.
|
byte[] |
SaClassicConnectorImpl.getThumbnail(String hDoc,
int widthX,
int widthY,
boolean color) |
byte[] |
SaClassicConnector.getThumbnail(String hDoc,
int widthX,
int widthY,
boolean color)
Reads the thumbnail of the given document.
|
List<String> |
SaClassicConnectorImpl.getUsers(String filter)
Reads a list of filtered users.
|
SaUserSetting |
SaClassicConnectorImpl.getUserSetting(String accessKey) |
SaUserSetting |
SaClassicConnector.getUserSetting(String accessKey)
Retrieves a user-specific setting object.
|
List<String> |
SaClassicConnectorImpl.getVersionIDs(String ddcName,
String sysrowID) |
List<String> |
SaClassicConnector.getVersionIDs(String ddcName,
String sysrowID)
Reads the version IDs of the given document.
|
SaWFConnector |
SaClassicConnectorImpl.getWorkflowConnector() |
SaWFConnector |
SaClassicConnector.getWorkflowConnector()
Returns a workflow connector based on this classic connector.
|
String |
SaClassicConnectorImpl.getWorkflowDdcName()
Gets the workflow ddc name.
|
List<String> |
SaClassicConnectorImpl.getWorkflowDefinitions()
Reads all available workflow definitions.
|
List<ProcessDefinitionDescriptor> |
SaClassicConnectorImpl.getWorkflowDefinitions(String ddcName)
Returns the workflow definitions that are allowed to be used for documents contained
in the specified DDC.
|
<T extends Serializable> |
SaClassicConnectorImpl.invoke(LegacyOperation<T> operation) |
<T extends Serializable> |
LegacyConnection.invoke(LegacyOperation<T> operation)
Invokes the given
Operation on the server side. |
boolean |
SaClassicConnectorImpl.isAlive() |
boolean |
SaClassicConnector.isAlive()
Tests the lifetime of this connector.
|
boolean |
SaClassicConnectorImpl.isReleaseActive() |
boolean |
SaClassicConnector.isReleaseActive()
Checks if is release feature in the program.ini in section [Release] is active.
|
List<com.saperion.connector.authentication.Session> |
SaClassicConnectorImpl.listActiveSessions()
List active sessions of the logged in user
|
List<com.saperion.connector.authentication.Session> |
SaClassicConnector.listActiveSessions()
List active sessions of the logged in user
|
InputStream |
SaClassicConnectorImpl.loadSystemFile(SystemFileKind kind,
String name) |
InputStream |
SaClassicConnector.loadSystemFile(SystemFileKind kind,
String name)
This method loads a system file of a specific kind.
|
boolean |
SaClassicConnectorImpl.lockDocument(String sysRowId,
String ddcName) |
boolean |
SaClassicConnector.lockDocument(String sysRowId,
String ddcName)
Locks a document.
|
void |
SaClassicConnectorImpl.logClientEvent(String hdoc,
SaConstants.ProtoEvents event,
String remark) |
void |
SaClassicConnector.logClientEvent(String hdoc,
SaConstants.ProtoEvents event,
String remark)
Adds an audit log event.
|
boolean |
SaClassicConnectorImpl.logoff() |
boolean |
SaClassicConnector.logoff()
This method logs the current user off from the system.
|
int |
SaClassicConnectorImpl.logon(byte[] token,
int type,
String client)
Deprecated.
|
int |
SaClassicConnector.logon(byte[] token,
int type,
String client)
Deprecated.
will be removed with version 8.1
|
com.saperion.connector.authentication.Session |
SaClassicConnectorImpl.logon(com.lexmark.saperion.remote.common.authentication.Credentials credentials)
This method authenticates the given
Credentials and returns the information about the open
session. |
com.saperion.connector.authentication.Session |
SaClassicConnector.logon(com.lexmark.saperion.remote.common.authentication.Credentials credentials)
This method authenticates the given
Credentials and returns the information about the open
session. |
com.saperion.connector.authentication.Session |
SaClassicConnectorImpl.logon(com.lexmark.saperion.remote.common.authentication.Credentials credentials,
com.saperion.connector.authentication.SessionInfo sessionInfo)
This method authenticates the given
Credentials, associate the given SessionInfo
and returns the information about the open session. |
com.saperion.connector.authentication.Session |
SaClassicConnector.logon(com.lexmark.saperion.remote.common.authentication.Credentials credentials,
com.saperion.connector.authentication.SessionInfo sessionInfo)
This method authenticates the given
Credentials, associate the given SessionInfo
and returns the information about the open session. |
default com.saperion.connector.authentication.Session |
SaClassicConnector.logon(int rmiToken)
Deprecated.
|
int |
SaClassicConnectorImpl.logon(jcifs.smb.NtlmPasswordAuthentication auth,
int type,
String client)
Deprecated.
|
int |
SaClassicConnector.logon(jcifs.smb.NtlmPasswordAuthentication auth,
int type,
String client)
Deprecated.
will be removed with version 8.1
|
int |
SaClassicConnectorImpl.logon(String username,
String password,
int type,
String client) |
int |
SaClassicConnector.logon(String username,
String password,
int type,
String client)
Deprecated.
use
SaClassicConnector.logon(Credentials) with
UsernamePasswordKey instead. Will be removed in version 8.1. |
void |
SaClassicConnectorImpl.moveFolder(String folderTableDDC,
String folderId,
String destinationId,
String beforeChild) |
void |
SaClassicConnector.moveFolder(String folderTableDDC,
String folderId,
String destinationId,
String beforeChild)
Moves the given folder to a new destination.
|
void |
SaClassicConnectorImpl.moveToFolder(String folderTableDDC,
String documentId,
String documentDDC,
String folderId,
String destinationId) |
void |
SaClassicConnector.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 |
SaClassicConnectorImpl.readDocument(String docHdoc,
boolean currentRevision,
int elementNumber) |
InputStream |
SaClassicConnector.readDocument(String documentHDOC,
boolean currentRevision,
int elementNumber)
Loads a document's content from the backend system.
|
InputStream |
SaClassicConnectorImpl.readDocument(String docHdoc,
boolean currentRevision,
int elementNumber,
boolean withAnnotations) |
InputStream |
SaClassicConnector.readDocument(String docHdoc,
boolean currentRevision,
int elementNumber,
boolean withAnnotations)
Loads a document's content from the backend system.
|
String |
SaClassicConnectorImpl.readDocumentFilename(String docHdoc,
boolean currentRevision,
int elementNumber) |
String |
SaClassicConnector.readDocumentFilename(String documentHDOC,
boolean currentRevision,
int elementNumber)
Deprecated.
will be removed with version 8.1
|
SaPropertyValue[] |
SaClassicConnectorImpl.readDocumentMetadata(String documentSysRowID,
String ddcName,
String[] fields) |
SaPropertyValue[] |
SaClassicConnector.readDocumentMetadata(String documentSysRowID,
String ddcName,
String[] fields)
Reads the metadata of the document with the given ID.
|
InputStream |
SaClassicConnectorImpl.readReleasedDocument(String docHdoc,
boolean currentRevision,
int elementNumber) |
InputStream |
SaClassicConnector.readReleasedDocument(String docHdoc,
boolean currentRevision,
int elementNumber)
Read released document if the release feature is
active.
|
InputStream |
SaClassicConnectorImpl.readVersionDocument(String docHdoc,
int elementNumber) |
InputStream |
SaClassicConnector.readVersionDocument(String versionID,
int elementNumber)
Loads a document version from the backend system.
|
String |
SaClassicConnectorImpl.readVersionDocumentFilename(String docHdoc,
int elementNumber) |
String |
SaClassicConnector.readVersionDocumentFilename(String documentHDOC,
int elementNumber)
Deprecated.
use getDocumentInfo.getFullName() instead. Will be removed with version 8.1
|
SaVersionData |
SaClassicConnectorImpl.readVersionMetadata(String versionID) |
SaVersionData |
SaClassicConnector.readVersionMetadata(String versionID)
Reads the version metadata of the document with the given ID.
|
SaVersionData |
SaClassicConnectorImpl.readVersionMetadata(String versionID,
boolean resolveLinks) |
SaVersionData |
SaClassicConnector.readVersionMetadata(String versionID,
boolean resolveLinks)
Reads the version metadata of the document with the given ID.
|
void |
SaClassicConnectorImpl.releaseDocument(String ddcName,
String hDoc,
String versionComment) |
void |
SaClassicConnector.releaseDocument(String ddcName,
String hDoc,
String versionComment)
Release the given document.
|
boolean |
SaClassicConnectorImpl.removeEvent(SaEvent event)
Deprecated.
|
boolean |
SaClassicConnector.removeEvent(SaEvent event)
Deprecated.
no longer supported. Will be removed with version 8.1
|
void |
SaClassicConnectorImpl.removeFromFolder(String folderTableDDC,
String documentSysRowId,
String documentDDC,
String folderId) |
void |
SaClassicConnector.removeFromFolder(String folderTableDDC,
String documentSysRowId,
String documentDDC,
String folderId)
Removes the document from the given folder.
|
void |
SaClassicConnectorImpl.removeListener(SaEventListener listener)
Deprecated.
|
void |
SaClassicConnector.removeListener(SaEventListener listener)
Deprecated.
will be removed with version 8.1
|
void |
SaClassicConnectorImpl.removeListener(SaStatusEventListener listener)
Deprecated.
|
void |
SaClassicConnector.removeListener(SaStatusEventListener listener)
Deprecated.
will be removed with version 8.1
|
String |
SaClassicConnectorImpl.resolveLatestHDoc(String oldHdoc) |
String |
SaClassicConnector.resolveLatestHDoc(String oldHdoc)
Resolves and returns the XHDOC of the latest version of the document identified by the given
HDOC.
|
SaSaveInfo |
SaClassicConnectorImpl.restoreVersion(String versionID) |
SaSaveInfo |
SaClassicConnector.restoreVersion(String versionID)
Restores the version with the given HDOC.
|
List<SaPropertyValue[]> |
SaClassicConnectorImpl.search(String hqlQuery)
Deprecated.
|
List<SaPropertyValue[]> |
SaClassicConnector.search(String hqlQuery)
Deprecated.
Use searchHQL() instead. Will be removed with version 8.1
|
Set<SaFolderClass> |
SaClassicConnectorImpl.searchFolderClass(SaFolderClassSearchInfo searchInfo) |
Set<SaFolderClass> |
SaClassicConnector.searchFolderClass(SaFolderClassSearchInfo searchInfo)
Searches for folder classes that match the specified propertied.
|
List<SaDocumentInfo> |
SaClassicConnectorImpl.searchFolderDocuments(String folderTableDDC,
String folderId,
SaQueryInfo hqlFilter) |
List<SaDocumentInfo> |
SaClassicConnector.searchFolderDocuments(String folderTableDDC,
String folderId,
SaQueryInfo hqlFilter)
HQL search extended with additional folder informations and depth.
|
List<SaDocumentInfo> |
SaClassicConnectorImpl.searchHQL(SaQueryInfo hqlQuery) |
List<SaDocumentInfo> |
SaClassicConnector.searchHQL(SaQueryInfo hqlQuery)
Performs a search with the given hql query (hibernate query language).
|
SettingSearchResult |
SaClassicConnectorImpl.searchSettings(SettingSearchInfo searchInfo) |
SettingSearchResult |
SaClassicConnector.searchSettings(SettingSearchInfo searchInfo)
This method searches settings in the database.
|
SaSaveInfo |
SaClassicConnectorImpl.setACLName(String ddcname,
String documentHDOC,
String acl,
String versionComment) |
SaSaveInfo |
SaClassicConnector.setACLName(String ddcname,
String documentHDOC,
String acl,
String versionComment)
This method specifies the Access Control Lists that secure the document given by its id.
|
void |
SaClassicConnectorImpl.setAnnotations(String hDoc,
int indexOfContentElement,
String annotations) |
void |
SaClassicConnector.setAnnotations(String hDoc,
int indexOfContentElement,
String annotations)
Sets the given annotations to the document.
|
void |
SaClassicConnectorImpl.setCurrentUserPresent(boolean present) |
void |
SaClassicConnector.setCurrentUserPresent(boolean present)
Deprecated.
Use
SaClassicConnector.updateCurrentUserInformation(MutableUserInformation) instead.
Will be removed with version 8.1. |
void |
SaClassicConnectorImpl.setEventsEnabled(boolean enabled) |
void |
SaClassicConnector.setEventsEnabled(boolean enabled)
This method sets whether events (e.g.
|
void |
SaClassicConnectorImpl.setFolderAcl(String folderTableDDC,
String folderId,
String aclName) |
void |
SaClassicConnector.setFolderAcl(String folderTableDDC,
String folderId,
String aclName)
Sets an ACL for the given folder.
|
void |
SaClassicConnectorImpl.setLocale(Locale locale) |
void |
SaClassicConnector.setLocale(Locale locale)
This methods sets the localization information for the current user.
|
void |
SaClassicConnectorImpl.setOutOfOffice(boolean isOutOfOffice)
set the out of office status for the logged on user.
|
void |
SaClassicConnectorImpl.setSetting(Setting setting) |
void |
SaClassicConnector.setSetting(Setting setting)
This method stores a
Setting in the database. |
void |
SaClassicConnectorImpl.setSubstitute(String name)
Set the substitute for the logged on user.
|
boolean |
SaClassicConnectorImpl.setUsedLicense(int type,
int count) |
boolean |
SaClassicConnector.setUsedLicense(int type,
int count)
Set the count of used licenses.
|
void |
SaClassicConnectorImpl.setUserSetting(SaUserSetting setting) |
void |
SaClassicConnector.setUserSetting(SaUserSetting setting)
Persists a user-specific setting object.
|
void |
SaClassicConnectorImpl.stopServer()
Deprecated.
|
void |
SaClassicConnector.stopServer()
Deprecated.
Functionality removed because of security-concerns. Method contained for
compatibility only. Use windows service management tool or SAPERION MMC to stop
the server. Will be removed with version 8.1.
|
void |
SaClassicConnectorImpl.storeSystemFile(SystemFileKind kind,
String name,
InputStream data) |
void |
SaClassicConnector.storeSystemFile(SystemFileKind kind,
String name,
InputStream data)
This method stores a system file of a specific kind.
|
boolean |
SaClassicConnectorImpl.unlockDocument(String sysRowId,
String ddcName) |
boolean |
SaClassicConnector.unlockDocument(String sysRowId,
String ddcName)
Unlocks a document.
|
void |
SaClassicConnectorImpl.updateCurrentUserInformation(MutableUserInformation user) |
void |
SaClassicConnector.updateCurrentUserInformation(MutableUserInformation user)
Changes information about the current user.
|
SaSaveInfo |
SaClassicConnectorImpl.updateDocument(String ddcName,
String documentHDOC,
Properties namevaluePairs,
InputStream[] content,
String versionComment)
Deprecated.
|
SaSaveInfo |
SaClassicConnector.updateDocument(String ddcName,
String documentHDOC,
Properties namevaluePairs,
InputStream[] content,
String versionComment)
Deprecated.
will be removed with version 8.1, use
SaClassicConnector.updateDocument(UpdateDocumentInfo) instead. |
SaSaveInfo |
SaClassicConnectorImpl.updateDocument(String ddcName,
String documentHDOC,
Properties namevaluePairs,
InputStream[] content,
String versionComment,
String acls)
Deprecated.
|
SaSaveInfo |
SaClassicConnector.updateDocument(String ddcName,
String documentHDOC,
Properties namevaluePairs,
InputStream[] content,
String versionComment,
String acls)
Deprecated.
will be removed with version 8.1
|
SaSaveInfo |
SaClassicConnectorImpl.updateDocument(String ddcName,
String documentHDOC,
Properties namevaluePairs,
InputStream[] content,
String versionComment,
String acls,
boolean resolveLinks)
Deprecated.
|
SaSaveInfo |
SaClassicConnector.updateDocument(String ddcName,
String documentHDOC,
Properties namevaluePairs,
InputStream[] content,
String versionComment,
String acls,
boolean resolveLinks)
Deprecated.
will be removed with version 8.1
|
SaSaveInfo |
SaClassicConnectorImpl.updateDocument(String ddcName,
String documentHDOC,
Properties namevaluePairs,
InputStream[] content,
String versionComment,
String acls,
boolean resolveLinks,
boolean checkin)
Deprecated.
|
SaSaveInfo |
SaClassicConnector.updateDocument(String ddcName,
String documentHDOC,
Properties namevaluePairs,
InputStream[] content,
String versionComment,
String acls,
boolean resolveLinks,
boolean checkin)
Deprecated.
will be removed with version 8.1
|
SaSaveInfo |
SaClassicConnectorImpl.updateDocument(UpdateDocumentInfo updateInfo) |
SaSaveInfo |
SaClassicConnector.updateDocument(UpdateDocumentInfo updateInfo)
Updates a document in the backend system with the given metadata, acls and content.
|
void |
SaClassicConnectorImpl.updateFolder(String folderTableDDC,
String folderId,
Properties namevaluePairs) |
void |
SaClassicConnector.updateFolder(String folderTableDDC,
String folderId,
Properties namevaluePairs)
Updates an existing folder with the given properties.
|
| Modifier and Type | Method and Description |
|---|---|
void |
CustomEventBuilder.fire()
Fires the custom event defined by this builder.
|
| Modifier and Type | Method and Description |
|---|---|
SaSystemException |
WrappedSystemException.getCause() |
| Modifier and Type | Method and Description |
|---|---|
static void |
ConnectorExceptions.throwMissingConnection() |
static void |
ConnectorExceptions.throwSystemException(String message) |
static void |
ConnectorExceptions.throwSystemException(String message,
Throwable cause) |
static void |
ConnectorExceptions.throwSystemException(Throwable cause) |
static void |
ConnectorExceptions.throwWrongRMIVersion() |
| Constructor and Description |
|---|
WrappedSystemException(SaSystemException cause) |
| Modifier and Type | Method and Description |
|---|---|
DirContext |
SaLDAPAuthenticator.authenticate(String name,
char[] password)
Authenicates the given user against the LDAP server.
|
| Modifier and Type | Method and Description |
|---|---|
void |
SaRMIClientCommand.addComment(String comment,
String taskUID,
int level) |
void |
AbstractWfRMIClientCommand.addComment(String comment,
String taskUID,
int level) |
void |
SaRMIClientCommand.addHistory(String description,
String taskUID) |
void |
AbstractWfRMIClientCommand.addHistory(String description,
String taskUID) |
void |
SaRMIClientCommand.addToFolder(String folderTableDDC,
String documentId,
String documentDDC,
String folderId)
Adds the document to a given folder.
|
void |
AbstractFolderRMIClientCommand.addToFolder(String folderTableDDC,
String documentId,
String documentDDC,
String folderId)
Adds the document to a given folder.
|
SaSaveInfo |
SaRMIClientCommand.cacheDocument(boolean isNew,
int commitMode,
String versionComment,
String xhDoc,
String ddcName,
String acls)
Stores the actual document to the backend.
|
SaSaveInfo |
AbstractDocRMIClientCommand.cacheDocument(boolean isNew,
int commitMode,
String versionComment,
String xhDoc,
String dbName,
String acls)
Stores the actual document to the backend.
|
void |
SaRMIClientCommandImpl.changePassword(String user,
String oldPassword,
String client,
String newPassword)
Changes the password of an existing user.
|
void |
SaRMIClientCommand.changePassword(String user,
String oldPassword,
String client,
String newPassword)
Changes the password of an existing user.
|
void |
SaRMIClientCommand.checkoutDocument(String hDoc)
Checkout the given document.
|
void |
AbstractDocRMIClientCommand.checkoutDocument(String hDoc)
Checkout the given document.
|
SapDocInfo |
SaRMIClientCommand.checkSapUrl(String url)
Checks the given SAP URL on the R/Link server and returns, if successfull, the HDOC and the
DDC.
|
SapDocInfo |
AbstractDocRMIClientCommand.checkSapUrl(String url)
Checks the given SAP URL on the R/Link server and returns, if successfull, the HDOC and the
DDC.
|
void |
SaRMIClientCommand.clearContent()
Clears all content of the opened document.
|
void |
AbstractDocRMIClientCommand.clearContent()
Clears all content of the opened document.
|
void |
SaRMIClientCommand.closeDocument(com.saperion.jni.SaJNIDocHandle handle)
Manually closing of a open document.
|
void |
AbstractDocRMIClientCommand.closeDocument(com.saperion.jni.SaJNIDocHandle handle)
Manually closing of a open document.
|
boolean |
SaRMIClientCommandImpl.closeSession(com.saperion.connector.authentication.Session session)
Close the given
Session |
boolean |
SaRMIClientCommand.closeSession(com.saperion.connector.authentication.Session session)
Close the given
Session |
String |
SaRMIClientCommand.copyFolder(String folderTableDDC,
String folderId,
String destinationId,
String beforeChild,
boolean withDocuments)
Copies the given node and all it’s children to the destination.
|
String |
AbstractFolderRMIClientCommand.copyFolder(String folderTableDDC,
String folderId,
String destinationId,
String beforeChild,
boolean withDocuments)
Copies the given node and all it’s children to the destination.
|
SaSaveInfo |
SaRMIClientCommand.createDocument(String ddcName,
List<SaPropertyValue> values)
Creates a new document with the given parameters.
|
SaSaveInfo |
AbstractDocRMIClientCommand.createDocument(String dbName,
List<SaPropertyValue> values)
Creates a new document with the given parameters.
|
String |
SaRMIClientCommand.createFolder(SaFolderSaveInfo info)
Creates a new node below a given node.
|
String |
AbstractFolderRMIClientCommand.createFolder(SaFolderSaveInfo info)
Creates a new node below a given node.
|
SaSaveInfo |
SaRMIClientCommand.createLink(LinkInfo link)
Creates a SAPERION Link into one Archive for an existing Document.
|
SaSaveInfo |
AbstractDocRMIClientCommand.createLink(LinkInfo link) |
SaSaveInfo |
SaRMIClientCommand.deleteDocument(int mode,
String hdoc)
Delete a document.
|
SaSaveInfo |
AbstractDocRMIClientCommand.deleteDocument(int mode,
String hDoc)
Delete a document.
|
void |
SaRMIClientCommand.deleteFolder(String folderTableDDC,
String folderId)
Deletes a given node.
|
void |
AbstractFolderRMIClientCommand.deleteFolder(String folderTableDDC,
String folderId)
Deletes a given node.
|
boolean |
SaRMIClientCommandImpl.deleteSetting(String name,
String section,
boolean isLong)
Deletes a setting in the database.
|
boolean |
SaRMIClientCommand.deleteSetting(String name,
String section,
boolean isLong)
Deletes a setting in the database.
|
void |
SaRMIClientCommand.discardDocument()
Discards the document identified by the tokens handle.
|
void |
AbstractDocRMIClientCommand.discardDocument() |
void |
SaRMIClientCommand.dsicardCheckout(String hDoc)
Discards the checkout of the given document.
|
void |
AbstractDocRMIClientCommand.dsicardCheckout(String hDoc)
Discards the checkout of the given document.
|
String |
SaRMIClientCommand.executeCommand(ContextInfo contextInfo)
Performs the given command.
|
String |
AbstractWfRMIClientCommand.executeCommand(ContextInfo contextInfo)
Performs the given command.
|
void |
SaRMIClientCommand.finishSQLTransaction(boolean commit,
String ddcName)
Finish SQL transaction.
|
void |
AbstractQueryRMIClientCommand.finishSQLTransaction(boolean commit,
String ddcName)
Finish SQL transaction.
|
void |
SaRMIClientCommand.finishTransaction(boolean commit)
Finish the transaction in the backend system.
|
void |
AbstractDocRMIClientCommand.finishTransaction(boolean commit)
Finish the transaction in the backend system.
|
String |
SaRMIClientCommand.getACLNames(String hDoc)
Reads the ACL's for the given document.
|
String |
AbstractDocRMIClientCommand.getACLNames(String hDoc)
Reads the ACL's for the given document.
|
SaACLRights |
SaRMIClientCommand.getACLRights(String[] acls)
Reads the rights for the given acl's.
|
SaACLRights |
AbstractDocRMIClientCommand.getACLRights(String[] acls)
Reads the rights for the given acl's.
|
List<SaAcl> |
SaRMIClientCommand.getAcls()
Reads all existing ACLs.
|
List<SaAcl> |
AbstractDocRMIClientCommand.getAcls()
Reads all existing ACLs.
|
List<String> |
SaRMIClientCommand.getAllACLs()
Deprecated.
|
List<String> |
AbstractDocRMIClientCommand.getAllACLs()
Deprecated.
|
String |
SaRMIClientCommand.getAnnotations(String hDoc,
int indexOfContentElement,
boolean currentRevision)
Reads the annotations from the given document.
|
String |
AbstractDocRMIClientCommand.getAnnotations(String hDoc,
int indexOfContentElement,
boolean currentRevision)
Reads the annotations from the given document.
|
int |
SaRMIClientCommandImpl.getArchivedSize(String hDoc)
Returns the total document size in archive.
|
int |
SaRMIClientCommand.getArchivedSize(String hDoc)
Returns the total document size in archive.
|
List<UsersRights> |
SaRMIClientCommandImpl.getAuthorizedUsers(String hDoc,
String rights,
MatchKind match)
Returns the users, that have specific rights on a document.
|
List<UsersRights> |
SaRMIClientCommand.getAuthorizedUsers(String hDoc,
String rights,
MatchKind match)
Returns the users, that have specific rights on a document.
|
BoxCount |
SaRMIClientCommand.getBoxCount(int boxId,
BoxCountType type,
Map<String,Object> parameters)
Returns the number of all elements and of all unread elements of the inbox identified by the given id.
|
BoxCount |
AbstractWfRMIClientCommand.getBoxCount(int boxId,
BoxCountType type,
Map<String,Object> parameters)
Returns the number of all elements and of all unread elements of the inbox identified by the given id.
|
List<BoxDefinition> |
SaRMIClientCommand.getBoxDefinitions()
Reads the box definitions.
|
List<BoxDefinition> |
AbstractWfRMIClientCommand.getBoxDefinitions()
Reads the box definitions.
|
Collection<CommandInfo> |
SaRMIClientCommand.getCommandInfos(String taskUID)
Reads all possible transitions for this task.
|
Collection<CommandInfo> |
AbstractWfRMIClientCommand.getCommandInfos(String taskUID)
Reads all possible transitions for this task.
|
Collection<CommandInfo> |
SaRMIClientCommand.getCommandInfos(String taskUID,
boolean transitionsOnly)
Reads all possible transitions and optional other possible commands for this task.
|
Collection<CommandInfo> |
AbstractWfRMIClientCommand.getCommandInfos(String taskUID,
boolean transitionsOnly)
Reads all possible transitions and optional other possible commands for this task.
|
List<CommentInfo> |
SaRMIClientCommand.getCommentInfos(String taskUID)
Reads the comments for the given task.
|
List<CommentInfo> |
AbstractWfRMIClientCommand.getCommentInfos(String taskUID)
Reads the comments for the given task.
|
List<List<HistoryInfo>> |
SaRMIClientCommand.getCompleteHistoryInfos(String docUID)
Reads the history for the given task.
|
List<List<HistoryInfo>> |
AbstractWfRMIClientCommand.getCompleteHistoryInfos(String docUID)
Reads the history for the given task.
|
DDC |
SaRMIClientCommandImpl.getDDC(String ddcName) |
DDC |
SaRMIClientCommand.getDDC(String ddcName)
Returns information about the specified DDC.
|
long |
SaRMIClientCommand.getDocumentFolderCount(String folderTableDDC,
String documentDDC,
String sysRowId)
Returns the total count over all folders from all users in which the specified document is
countained in.
|
long |
AbstractFolderRMIClientCommand.getDocumentFolderCount(String folderTableDDC,
String documentDDC,
String sysRowId)
Returns the total count over all folders from all users in which the specified document is
countained in.
|
List<SaDocumentInfo> |
SaRMIClientCommand.getDocumentFolders(String folderTableDDC,
String documentDDC,
String sysRowId)
Returns a list of folder properties which contains all nodes the document is contained in.
|
List<SaDocumentInfo> |
AbstractFolderRMIClientCommand.getDocumentFolders(String folderTableDDC,
String documentDDC,
String sysRowId)
Returns a list of folder properties which contains all nodes the document is contained in.
|
boolean |
SaRMIClientCommandImpl.getEventsEnabled() |
boolean |
SaRMIClientCommand.getEventsEnabled()
Returns whether events (e.g.
|
SaFeature |
SaRMIClientCommandImpl.getFeatures()
Read the features.
|
SaFeature |
SaRMIClientCommand.getFeatures()
Read the features.
|
SaFieldDescription[] |
SaRMIClientCommandImpl.getFieldDescriptions(String ddcName)
Reads the field descriptions for a given DDC.
|
SaFieldDescription[] |
SaRMIClientCommand.getFieldDescriptions(String ddcName)
Reads the field descriptions for a given DDC.
|
SaFieldDescription[] |
SaRMIClientCommandImpl.getFieldDescriptions(String ddcName,
String mandant)
Reads the field descriptions for a given DDC.
|
SaFieldDescription[] |
SaRMIClientCommand.getFieldDescriptions(String ddcName,
String mandant)
Reads the field descriptions for a given DDC.
|
List<SaDocumentInfo> |
SaRMIClientCommand.getFolderChildren(String folderTableDDC,
String folderId,
int depth,
SaQueryInfo filter,
int allowedMaxNrOfChildFolders)
Returns a cursor with the children of the given node.
|
List<SaDocumentInfo> |
AbstractFolderRMIClientCommand.getFolderChildren(String folderTableDDC,
String folderId,
int depth,
SaQueryInfo filter,
int allowedMaxNrOfChildFoldersPerLevel)
Returns a cursor with the children of the given node.
|
SaFolderClass |
SaRMIClientCommand.getFolderClass(String className)
Reads the folder class with the given name.
|
SaFolderClass |
AbstractFolderRMIClientCommand.getFolderClass(String className)
Reads the folder class with the given name.
|
List<SaDocumentInfo> |
SaRMIClientCommand.getFolderFromPath(String folderTableDDC,
String startNodeId,
String folderPath,
boolean exact)
Returns the node(s) which match to the given path.
|
List<SaDocumentInfo> |
AbstractFolderRMIClientCommand.getFolderFromPath(String folderTableDDC,
String startNodeId,
String folderPath,
boolean exact)
Returns the node(s) which match to the given path.
|
SaDocumentInfo |
SaRMIClientCommand.getFolderInfo(String folderTableDDC,
String folderId,
boolean forceLoadVariables)
Reads the folder info object for the given folder.
|
SaDocumentInfo |
AbstractFolderRMIClientCommand.getFolderInfo(String folderTableDDC,
String folderId,
boolean forceLoadVariables)
Reads the folder info object for the given folder.
|
SaDocumentInfo |
SaRMIClientCommand.getFolderParent(String folderTableDDC,
String folderId)
Returns the parent of the given node.
|
SaDocumentInfo |
AbstractFolderRMIClientCommand.getFolderParent(String folderTableDDC,
String folderId)
Returns the parent of the given node.
|
SaDocAccessData |
SaRMIClientCommand.getFolderRights(String folderTableDDC,
String folderId)
Returns the rights mask for the given folder and user.
|
SaDocAccessData |
AbstractFolderRMIClientCommand.getFolderRights(String folderTableDDC,
String folderId)
Returns the rights mask for the given folder and user.
|
Set<FolderUpdateInfo> |
SaRMIClientCommand.getFolderUpdateInfo(Map<String,Long> folderIds)
Get the Set of folders that shall be refreshed.
|
Set<FolderUpdateInfo> |
AbstractFolderRMIClientCommand.getFolderUpdateInfo(Map<String,Long> folderIds)
Get the Set of folders that shall be refreshed.
|
String |
SaRMIClientCommand.getFulltext(String ddcName,
String sysRowId,
String hdoc,
String fieldName,
long length)
Reads the fulltext information for the given document with the given SYSROWID in the given
DDC.
|
String |
AbstractQueryRMIClientCommand.getFulltext(String ddcName,
String sysRowId,
String hdoc,
String fieldName,
long length)
Reads the fulltext information for the given document with the given SYSROWID in the given
DDC.
|
Set<Map.Entry<String,String>> |
SaRMIClientCommandImpl.getFullTextFields(String ddcName,
List<String> fullTextFields,
String hdoc)
|
Set<Map.Entry<String,String>> |
SaRMIClientCommand.getFullTextFields(String ddcName,
List<String> fullTextFields,
String hdoc)
Fetches values of Full text columns
|
String |
SaRMIClientCommand.getHDocForSysRowId(String sysRowId,
String ddcName)
Searchs the HDOC for the given SysRowId.
|
String |
AbstractQueryRMIClientCommand.getHDocForSysRowId(String sysRowId,
String ddcName)
Searchs the HDOC for the given SysRowId.
|
List<HistoryInfo> |
SaRMIClientCommand.getHistoryInfos(String taskUID)
Reads the history for the given task.
|
List<HistoryInfo> |
AbstractWfRMIClientCommand.getHistoryInfos(String taskUID)
Reads the history for the given task.
|
List<String> |
SaRMIClientCommand.getIdsFromQuery(String query)
Executes a HQL query and returns the results as a string list.
|
List<String> |
AbstractQueryRMIClientCommand.getIdsFromQuery(String query)
Executes a HQL query and returns the results as a string list.
|
List<String> |
SaRMIClientCommand.getInvolvedUsers(String hDoc)
Reads all users involved in the set of ACL's.
|
List<String> |
AbstractDocRMIClientCommand.getInvolvedUsers(String hDoc)
Reads all users involved in the set of ACL's.
|
int |
SaRMIClientCommandImpl.getLicenseCount(int type)
Read the licence count for the given user.
|
int |
SaRMIClientCommand.getLicenseCount(int type)
Read the licence count for the given user.
|
SaLockInfo |
SaRMIClientCommand.getLockInfo(String sysRowId)
Gets the lock info for a given node.
|
SaLockInfo |
AbstractDocRMIClientCommand.getLockInfo(String sysRowId)
Gets the lock info for a given node.
|
List<String> |
SaRMIClientCommand.getLocks(String ddcName)
Reads all locks from the given DDC.
|
List<String> |
AbstractDocRMIClientCommand.getLocks(String ddcName)
Reads all locks from the given DDC.
|
List<String> |
SaRMIClientCommand.getLocks(String ddcName,
String mandant)
Reads all locks from the given DDC.
|
List<String> |
AbstractDocRMIClientCommand.getLocks(String ddcName,
String mandant)
Reads all locks from the given DDC.
|
WorkflowMember |
SaRMIClientCommandImpl.getMember(WorkflowMember member,
int depth,
String filter)
Reads the member.
|
WorkflowMember |
SaRMIClientCommand.getMember(WorkflowMember member,
int depth,
String filter)
Reads the member.
|
WorkflowMember |
SaRMIClientCommandImpl.getMembers()
Reads the member.
|
WorkflowMember |
SaRMIClientCommand.getMembers()
Reads the member.
|
com.saperion.jni.SaJNIDocAccessData |
SaRMIClientCommand.getNodeAccessData(String hdoc)
Opens the document identified by hdoc and returns an object containing all access right data
information for the session user.
|
com.saperion.jni.SaJNIDocAccessData |
AbstractDocRMIClientCommand.getNodeAccessData(String hDoc)
Opens the document identified by hdoc and returns an object containing all access right data
information for the session user.
|
boolean |
SaRMIClientCommand.getOutOfOffice()
Get the out of office status for the logged on user.
|
boolean |
AbstractWfRMIClientCommand.getOutOfOffice()
Get the out of office status for the logged on user.
|
TaskInfo |
SaRMIClientCommand.getParentTask(String taskID)
Reads the parent task info for the given ID.
|
TaskInfo |
AbstractWfRMIClientCommand.getParentTask(String taskID)
Reads the parent task info for the given ID.
|
String |
SaRMIClientCommandImpl.getRealDBName(String ddcName,
String field,
String mandant)
returns the real database table name for a given DDC.
|
String |
SaRMIClientCommand.getRealDBName(String ddcName,
String field,
String mandant)
returns the real database table name for a given DDC.
|
String |
SaRMIClientCommandImpl.getRMIVersion()
Get the RMI interface version from java core server.
|
String |
SaRMIClientCommand.getRMIVersion()
Get the RMI interface version from java core server.
|
Setting |
SaRMIClientCommandImpl.getSetting(String name,
String section,
boolean isLong)
Retrieves a setting from the database.
|
Setting |
SaRMIClientCommand.getSetting(String name,
String section,
boolean isLong)
Retrieves a setting from the database.
|
List<SaDocumentInfo> |
SaRMIClientCommand.getStringQueryResult(SaQueryInfo queryInfo)
Executes a given HQL string and returns the results as list.
|
List<SaDocumentInfo> |
AbstractQueryRMIClientCommand.getStringQueryResult(SaQueryInfo hqlQuery)
Executes a given HQL string and returns the results as list.
|
String |
SaRMIClientCommand.getSubstitute()
Get the substitute for the logged on user.
|
String |
AbstractWfRMIClientCommand.getSubstitute()
Get the substitute for the logged on user.
|
List<String> |
SaRMIClientCommandImpl.getSystemFiles(SystemFileKind kind,
String filter)
Gets the system files of a specific kind.
|
List<String> |
SaRMIClientCommand.getSystemFiles(SystemFileKind kind,
String filter)
Gets the system files of a specific kind.
|
SaSystemInfo |
SaRMIClientCommandImpl.getSystemInfo()
Reads system info.
|
SaSystemInfo |
SaRMIClientCommand.getSystemInfo()
Reads system info.
|
SaSystemSetting |
SaRMIClientCommandImpl.getSystemSetting(String accessKey)
Retrieves a system setting object.
|
SaSystemSetting |
SaRMIClientCommand.getSystemSetting(String accessKey)
Retrieves a system setting object.
|
TaskInfo |
SaRMIClientCommand.getTask(String taskID)
Reads the task info for the given ID.
|
TaskInfo |
AbstractWfRMIClientCommand.getTask(String taskID)
Reads the task info for the given ID.
|
List<TaskAuditInfo> |
SaRMIClientCommand.getTaskAuditList(int[] ids,
String filter,
Map<String,Object> parameter)
Reads the task audit for this user.
|
List<TaskAuditInfo> |
AbstractWfRMIClientCommand.getTaskAuditList(int[] ids,
String filter,
Map<String,Object> parameter)
Reads the task audit for this user.
|
List<TaskInfo> |
SaRMIClientCommand.getTaskList(int[] ids,
String filter,
Map<String,Object> parameter)
Reads the task for this user.
|
List<TaskInfo> |
AbstractWfRMIClientCommand.getTaskList(int[] ids,
String filter,
Map<String,Object> parameter)
Reads the task for this user.
|
byte[] |
SaRMIClientCommand.getThumbnail(String hDoc,
int widthX,
int widthY,
boolean color)
Reads the thumbnail of the given document.
|
byte[] |
AbstractDocRMIClientCommand.getThumbnail(String hDoc,
int widthX,
int widthY,
boolean color)
Reads the thumbnail of the given document.
|
int[] |
SaRMIClientCommandImpl.getUserIdsForQuery()
Read the userids.
|
int[] |
SaRMIClientCommand.getUserIdsForQuery()
Read the userids.
|
List<String> |
SaRMIClientCommand.getUsers(String filter)
Reads a list of filtered users.
|
List<String> |
AbstractWfRMIClientCommand.getUsers(String filter)
Reads a list of filtered users.
|
SaUserSetting |
SaRMIClientCommandImpl.getUserSetting(String accessKey)
Retrieves a user setting object.
|
SaUserSetting |
SaRMIClientCommand.getUserSetting(String accessKey)
Retrieves a user setting object.
|
List<String> |
SaRMIClientCommand.getVersionList(String ddcName,
String sysrowID)
Reads the versionlist for the given document.
|
List<String> |
AbstractQueryRMIClientCommand.getVersionList(String ddcName,
String sysrowID)
Reads the versionlist for the given document.
|
List<String> |
SaRMIClientCommand.getWorkflowDefinitions()
Reads all available workflow definitions.
|
List<String> |
AbstractWfRMIClientCommand.getWorkflowDefinitions()
Reads all available workflow definitions.
|
<T extends Serializable> |
SaRMIClientCommandImpl.invoke(com.lexmark.saperion.remote.common.operations.Operation<T,SaBasicException,LegacyConnection> operation)
This method invokes a
Operation on the backend. |
<T extends Serializable> |
SaRMIClientCommand.invoke(com.lexmark.saperion.remote.common.operations.Operation<T,SaBasicException,LegacyConnection> operation)
This method invokes a
Operation on the backend. |
boolean |
SaRMIClientCommandImpl.isAlive()
Test the lifetime of this token.
|
boolean |
SaRMIClientCommand.isAlive()
Test the lifetime of this token.
|
boolean |
SaRMIClientCommandImpl.isRevisionEnabled(int mandant,
String ddcName)
Gets the information whether the provided ddc table contains the fields required for
revisions.
|
boolean |
SaRMIClientCommand.isRevisionEnabled(int mandant,
String ddcName)
Gets the information whether the provided ddc table contains the fields required for
revisions.
|
List<com.saperion.connector.authentication.Session> |
SaRMIClientCommandImpl.listActiveSessions()
List the active sessions of the logged in user.
|
List<com.saperion.connector.authentication.Session> |
SaRMIClientCommand.listActiveSessions()
List the active sessions of the logged in user.
|
String[] |
SaRMIClientCommandImpl.loadDDCNames()
Retrieves the available DDC names.
|
String[] |
SaRMIClientCommand.loadDDCNames()
Retrieves the available DDC names.
|
String[] |
SaRMIClientCommandImpl.loadFolderDDCNames()
Retrieves the available folder DDC names.
|
String[] |
SaRMIClientCommand.loadFolderDDCNames()
Retrieves the available folder DDC names.
|
Properties |
SaRMIClientCommandImpl.loadSettings(String section)
Load settings from backend.
|
Properties |
SaRMIClientCommand.loadSettings(String section)
Load settings from backend.
|
InputStream |
SaRMIClientCommandImpl.loadSystemFile(SystemFileKind kind,
String name)
Loads a system file of a specific kind.
|
InputStream |
SaRMIClientCommand.loadSystemFile(SystemFileKind kind,
String name)
Loads a system file of a specific kind.
|
String |
SaRMIClientCommandImpl.loadWorkflowDDCName()
Retrieves the workflow DDC name.
|
String |
SaRMIClientCommand.loadWorkflowDDCName()
Retrieves the workflow DDC name.
|
boolean |
SaRMIClientCommand.lockNode(String sysRowId,
String ddcName,
int lockType,
boolean sessionScoped)
Locks a node.
|
boolean |
AbstractDocRMIClientCommand.lockNode(String sysRowId,
String ddcName,
int lockType,
boolean sessionScoped)
Locks a node.
|
void |
SaRMIClientCommand.logClientEvent(String hdoc,
SaConstants.ProtoEvents event,
String remark)
Adds an audit log event.
|
void |
AbstractDocRMIClientCommand.logClientEvent(String hdoc,
SaConstants.ProtoEvents event,
String remark)
Adds an audit log event.
|
boolean |
SaRMIClientCommandImpl.logoff()
Log off the user from the server instance.
|
boolean |
SaRMIClientCommand.logoff()
Log off the user from the server instance.
|
com.saperion.connector.authentication.Session |
SaRMIClientCommandImpl.logon(com.lexmark.saperion.remote.common.authentication.Credentials credentials)
Logon with the passed credentials.
|
com.saperion.connector.authentication.Session |
SaRMIClientCommand.logon(com.lexmark.saperion.remote.common.authentication.Credentials credentials)
Logon with the passed credentials.
|
com.saperion.connector.authentication.Session |
SaRMIClientCommandImpl.logon(com.lexmark.saperion.remote.common.authentication.Credentials credentials,
com.saperion.connector.authentication.SessionInfo sessionInfo)
Logon with the passed credentials and associate the given session information.
|
com.saperion.connector.authentication.Session |
SaRMIClientCommand.logon(com.lexmark.saperion.remote.common.authentication.Credentials credentials,
com.saperion.connector.authentication.SessionInfo sessionInfo)
Logon with the passed credentials and associate the given session information.
|
default com.saperion.connector.authentication.Session |
SaRMIClientCommand.logon(int rmiToken)
Deprecated.
|
void |
SaRMIClientCommand.moveFolder(String folderTableDDC,
String folderId,
String destinationId,
String beforeChild)
Moves the given node to a new destination.
|
void |
AbstractFolderRMIClientCommand.moveFolder(String folderTableDDC,
String folderId,
String destinationId,
String beforeChild)
Moves the given node to a new destination.
|
void |
SaRMIClientCommand.moveToFolder(String folderTableDDC,
String documentId,
String documentDDC,
String folderId,
String destinationId)
Moves the document’s filing to the given node.
|
void |
AbstractFolderRMIClientCommand.moveToFolder(String folderTableDDC,
String documentId,
String documentDDC,
String folderId,
String destinationId)
Moves the document’s filing to the given node.
|
<ResultType extends Serializable,ExceptionType extends com.lexmark.saperion.exceptions.EcmException> |
SaRMIClientCommandImpl.newInvoke(com.lexmark.saperion.remote.common.operations.EcmOperation<ResultType,ExceptionType> operation) |
<ResultType extends Serializable,ExceptionType extends com.lexmark.saperion.exceptions.EcmException> |
SaRMIClientCommand.newInvoke(com.lexmark.saperion.remote.common.operations.EcmOperation<ResultType,ExceptionType> operation)
This method invokes a
EcmOperation in the backend. |
protected void |
SaRMIClientCommandImpl.performLogonAfterFailure(Exception e)
Performs relogon in the backend.
|
com.saperion.jni.SaJNIReadBuffer |
SaRMIClientCommand.readDocumentFirst(String hdoc,
boolean currentRevision,
int element)
Opens an existing document with the given hdoc and returns a document handle for the
specified element (= sub-document) as well as the buffer containing the content data of the
element.
|
com.saperion.jni.SaJNIReadBuffer |
AbstractDocRMIClientCommand.readDocumentFirst(String hdoc,
boolean currentRevision,
int element)
Opens an existing document with the given hdoc and returns a document handle for the
specified element (= sub-document) as well as the buffer containing the content data of the
element.
|
com.saperion.jni.SaJNIReadBuffer |
SaRMIClientCommand.readDocumentFirst(String hdoc,
boolean currentRevision,
int element,
boolean withAnnotations)
Opens an existing document with the given hdoc and returns a document handle for the
specified element (= sub-document) as well as the buffer containing the content data of the
element.
|
com.saperion.jni.SaJNIReadBuffer |
AbstractDocRMIClientCommand.readDocumentFirst(String hdoc,
boolean currentRevision,
int element,
boolean withAnnotations)
Opens an existing document with the given hdoc and returns a document handle for the
specified element (= sub-document) as well as the buffer containing the content data of the
element.
|
SaPropertyValue[] |
SaRMIClientCommand.readDocumentMetadata(String sysRowId,
String ddcName,
String[] fields)
Reads the meta data of the document with the given ID.
|
SaPropertyValue[] |
AbstractQueryRMIClientCommand.readDocumentMetadata(String sysRowId,
String ddcName,
String[] fields)
Reads the meta data of the document with the given ID.
|
com.saperion.jni.SaJNIReadBuffer |
SaRMIClientCommand.readDocumentNext(com.saperion.jni.SaJNIDocHandle handle)
Reads the next bytes from the open document, described in the handle.
|
com.saperion.jni.SaJNIReadBuffer |
AbstractDocRMIClientCommand.readDocumentNext(com.saperion.jni.SaJNIDocHandle handle)
Reads the next bytes from the open document, described in the handle.
|
SaVersionData |
SaRMIClientCommand.readVersionMetadata(String versionID)
Reads the version meta data of the document with the given ID.
|
SaVersionData |
AbstractDocRMIClientCommand.readVersionMetadata(String versionID)
Reads the version meta data of the document with the given ID.
|
SaVersionData |
SaRMIClientCommand.readVersionMetadata(String versionID,
boolean resolveLinks)
Reads the version meta data of the document with the given ID.
|
SaVersionData |
AbstractDocRMIClientCommand.readVersionMetadata(String versionID,
boolean resolveLinks) |
void |
SaRMIClientCommand.releaseDocument(String hDoc,
String comment)
Release the given document.
|
void |
AbstractDocRMIClientCommand.releaseDocument(String hDoc,
String comment)
Release the given document.
|
protected void |
AbstractRMIClientCommand.reLogon() |
protected boolean |
AbstractRMIClientCommand.reLogonAfterConnectionFailure(Exception e)
If the cause of the exception is a connection failure, this methods performs a relogon.
|
void |
SaRMIClientCommand.removeElement(int element)
Removes a existing content element.
|
void |
AbstractDocRMIClientCommand.removeElement(int element)
Removes a existing content element.
|
void |
SaRMIClientCommand.removeElement(Integer[] elements)
Removes a series of existing content elements.
|
void |
AbstractDocRMIClientCommand.removeElement(Integer[] elements)
Removes a series of existing content elements.
|
void |
SaRMIClientCommand.removeFromFolder(String folderTableDDC,
String documentSysRowId,
String documentDDC,
String folderId)
Remove the document filing from the given node.
|
void |
AbstractFolderRMIClientCommand.removeFromFolder(String folderTableDDC,
String documentSysRowId,
String documentDDC,
String folderId)
Remove the document filing from the given node.
|
String |
SaRMIClientCommandImpl.resolveLatestHdoc(String oldHdoc)
Resolves the hdoc of the latest version of the document identified by the given hdoc.
|
String |
SaRMIClientCommand.resolveLatestHdoc(String oldHdoc)
Resolves the hdoc of the latest version of the document identified by the given hdoc.
|
SaSaveInfo |
SaRMIClientCommand.restoreVersion(String versionID)
Restores the given version to the actual version.
|
SaSaveInfo |
AbstractDocRMIClientCommand.restoreVersion(String versionID)
Restores the given version to the actual version.
|
SaSaveInfo |
SaRMIClientCommand.saveDocument(String nodeHdoc,
String ddcName,
List<SaPropertyValue> values)
Saves the document paramaters to the document.
|
SaSaveInfo |
AbstractDocRMIClientCommand.saveDocument(String hexUID,
String dbName,
List<SaPropertyValue> metadata)
Saves the document paramaters to the document.
|
SaSaveInfo |
SaRMIClientCommand.saveDocument(String nodeHdoc,
String ddcName,
List<SaPropertyValue> values,
boolean resolveLinks)
Saves the document paramaters to the document.
|
SaSaveInfo |
AbstractDocRMIClientCommand.saveDocument(String hexUID,
String dbName,
List<SaPropertyValue> metadata,
boolean resolveLinks)
Saves the document paramaters to the document.
|
Set<SaFolderClass> |
SaRMIClientCommand.searchFolderClass(SaFolderClassSearchInfo searchInfo)
Searches for folder classes with the specified properties.
|
Set<SaFolderClass> |
AbstractFolderRMIClientCommand.searchFolderClass(SaFolderClassSearchInfo searchInfo)
Searches for folder classes with the specified properties.
|
List<SaDocumentInfo> |
SaRMIClientCommand.searchFolderDocuments(String folderTableDDC,
String folderId,
SaQueryInfo hqlFilter)
HQL search extended with additional folder informations and depth.
|
List<SaDocumentInfo> |
AbstractFolderRMIClientCommand.searchFolderDocuments(String folderTableDDC,
String folderId,
SaQueryInfo hqlFilter)
HQL search extended with additional folder informations and depth.
|
SettingSearchResult |
SaRMIClientCommandImpl.searchSettings(SettingSearchInfo searchInfo)
Searches for settings.
|
SettingSearchResult |
SaRMIClientCommand.searchSettings(SettingSearchInfo searchInfo)
Searches for settings.
|
void |
SaRMIClientCommandImpl.sendBarcode(String indexMask,
String docUid,
String contentRep,
String sid,
String docType,
String value,
int mandant)
Send barcode to SAP.
|
void |
SaRMIClientCommand.sendBarcode(String indexMask,
String docUid,
String contentRep,
String sid,
String docType,
String value,
int mandant)
Send barcode to SAP.
|
SaSaveInfo |
SaRMIClientCommand.setACLName(String ddcname,
String hDoc,
String acl,
int commitMode,
String versionComment)
Sets the given ACL to the node.
|
SaSaveInfo |
AbstractDocRMIClientCommand.setACLName(String ddcname,
String hDoc,
String acl,
int commitMode,
String versionComment)
Sets the given ACL to the node.
|
void |
SaRMIClientCommand.setAnnotations(String hDoc,
int indexOfContentElement,
String annotations)
Sets the given annotations to the document.
|
void |
AbstractDocRMIClientCommand.setAnnotations(String hDoc,
int indexOfContentElement,
String annotations)
Sets the given annotations to the document.
|
void |
SaRMIClientCommand.setElementMark(int element)
Mark the content element.
|
void |
AbstractDocRMIClientCommand.setElementMark(int element)
Mark the content element.
|
void |
SaRMIClientCommandImpl.setEventsEnabled(boolean enabled) |
void |
SaRMIClientCommand.setEventsEnabled(boolean enabled)
Sets whether events (e.g.
|
void |
SaRMIClientCommand.setFolderAcl(String folderTableDDC,
String folderId,
String aclName)
Sets an ACL for the given folder.
|
void |
AbstractFolderRMIClientCommand.setFolderAcl(String folderTableDDC,
String folderId,
String aclName)
Sets an ACL for the given folder.
|
void |
SaRMIClientCommandImpl.setLocale(Locale local)
Set the locale for localization.
|
void |
SaRMIClientCommand.setLocale(Locale local)
Set the locale for localization.
|
void |
SaRMIClientCommand.setOutOfOffice(boolean isOutOfOffice)
Set the out of office status for the logged on user.
|
void |
AbstractWfRMIClientCommand.setOutOfOffice(boolean isOutOfOffice)
Set the out of office status for the logged on user.
|
void |
SaRMIClientCommandImpl.setSetting(Setting setting)
Persists a setting in the database.
|
void |
SaRMIClientCommand.setSetting(Setting setting)
Persists a setting in the database.
|
void |
SaRMIClientCommand.setSubstitute(String name)
Set the substitute for the logged on user.
|
void |
AbstractWfRMIClientCommand.setSubstitute(String substituteName)
Set the substitute for the logged on user.
|
boolean |
SaRMIClientCommandImpl.setUsedLicense(int type,
int count)
Set the count of used licenses.
|
boolean |
SaRMIClientCommand.setUsedLicense(int type,
int count)
Set the count of used licenses.
|
void |
SaRMIClientCommandImpl.setUserSetting(SaUserSetting setting)
Persists a user setting object.
|
void |
SaRMIClientCommand.setUserSetting(SaUserSetting setting)
Persists a user setting object.
|
void |
SaRMIClientCommand.setVariables(int element,
Map<String,String> variables)
Method to set the Variables for an Content-Object or the Structure itself.
|
void |
AbstractDocRMIClientCommand.setVariables(int element,
Map<String,String> variables) |
void |
SaRMIClientCommand.startSQLTransaction(String ddcName)
Start SQL transaction.
|
void |
AbstractQueryRMIClientCommand.startSQLTransaction(String ddcName)
Start SQL transaction.
|
void |
SaRMIClientCommand.startTransaction()
Starts a transaction in the backend system.
|
void |
AbstractDocRMIClientCommand.startTransaction()
Starts a transaction in the backend system.
|
SaSaveInfo |
SaRMIClientCommand.storeDocument(boolean isNew,
int commitMode,
String versionComment,
String ddcName,
String acls)
Stores the actual document to the backend.
|
SaSaveInfo |
AbstractDocRMIClientCommand.storeDocument(boolean isNew,
int commitMode,
String versionComment,
String dbName,
String acls)
Stores the actual document to the backend.
|
SaSaveInfo |
SaRMIClientCommand.storeDocument(boolean isNew,
int commitMode,
String versionComment,
String ddcName,
String acls,
boolean checkin)
Stores the actual document to the backend.
|
SaSaveInfo |
AbstractDocRMIClientCommand.storeDocument(boolean isNew,
int commitMode,
String versionComment,
String dbName,
String acls,
boolean checkout)
Stores the actual document to the backend.
|
void |
SaRMIClientCommandImpl.storeSystemFile(SystemFileKind kind,
String name,
InputStream data)
Stores a system file of a specific kind.
|
void |
SaRMIClientCommand.storeSystemFile(SystemFileKind kind,
String name,
InputStream data)
Stores a system file of a specific kind.
|
boolean |
SaRMIClientCommand.unlockNode(String sysRowId,
String ddcName)
Unlocks a node.
|
boolean |
AbstractDocRMIClientCommand.unlockNode(String sysRowId,
String ddcName)
Unlocks a node.
|
void |
SaRMIClientCommand.updateFolder(String folderTableDDC,
String folderId,
List<SaPropertyValue> values)
Updates a given node with the given properties.
|
void |
AbstractFolderRMIClientCommand.updateFolder(String folderTableDDC,
String folderId,
List<SaPropertyValue> values)
Updates a given node with the given properties.
|
long |
SaRMIClientCommand.writeContent(ContentStream contentStream)
Writes the content of the document.
|
long |
AbstractDocRMIClientCommand.writeContent(ContentStream content)
Writes the content of the document.
|
long |
SaRMIClientCommand.writeContent(InputStream stream)
Writes the content of the document.
|
long |
AbstractDocRMIClientCommand.writeContent(InputStream stream) |
long |
SaRMIClientCommand.writeContent(InputStream stream,
String fileName,
int element) |
long |
AbstractDocRMIClientCommand.writeContent(InputStream stream,
String fileName,
int element) |
long |
SaRMIClientCommand.writeContent(InputStream stream,
String fileName,
int element,
boolean doStreaming)
Writes the content of the document.
If the document size is less than SaConstants.JNI_BUFFER_SIZE than the default buffer size will be reduced and only one JNI call is initiated. |
long |
AbstractDocRMIClientCommand.writeContent(InputStream stream,
String fileName,
int element,
boolean doStreaming)
Writes the content of the document.
If the document size is less than SaConstants.JNI_BUFFER_SIZE than the default buffer size will be reduced and only one JNI call is initiated. |
| Constructor and Description |
|---|
SaRMISystemConnector(SaRMIServerInfo serverInfo)
Constructor.
|
| Modifier and Type | Method and Description |
|---|---|
protected SaBasicException |
LegacyAwareRmiClientService.mapSystemException(SaSystemException systemException)
Deprecated.
|
protected com.lexmark.saperion.exceptions.system.SystemException |
LegacyAwareRmiClientService.unwrapSystemException(SaSystemException systemException)
Deprecated.
|
| Modifier and Type | Method and Description |
|---|---|
void |
SaWFTaskImpl.addComment(String commentString,
int level)
Adds a comment to the workflow.
|
void |
SaWFTask.addComment(String comment,
int level)
Adds a comment to the workflow.
|
void |
SaWFTaskImpl.addHistory(String descriptionString)
Adds a history entry.
|
void |
SaWFTask.addHistory(String description)
Adds a history entry.
|
InputStream |
SaWFTaskImpl.getAttachmentContent(int element)
Reads the content of the attachment.
|
InputStream |
SaWFTask.getAttachmentContent(int element)
Reads the content of the attachment.
|
Long |
SaWFConnectorImpl.getBoxCount(int boxId)
Reads the count (number of workflow item) of the inbox identified by the given id.
|
Long |
SaWFConnector.getBoxCount(int boxId)
Reads the count (number of workflow item) of the inbox identified by the given id.
|
List<BoxDefinition> |
SaWFConnectorImpl.getBoxDefinitions()
Reads the box definitions.
|
List<BoxDefinition> |
SaWFConnector.getBoxDefinitions()
Reads the box definitions.
|
CommandInfo[] |
SaWFTaskImpl.getCommandInfos()
Reads all possible transitions for this task.
|
CommandInfo[] |
SaWFTask.getCommandInfos()
Reads all possible transitions for this task.
|
CommandInfo[] |
SaWFTaskImpl.getCommandInfos(boolean transitionsOnly)
Reads all possible transitions and optional other possible commands for
this task.
|
CommandInfo[] |
SaWFTask.getCommandInfos(boolean transitionsOnly)
Reads all possible transitions and optional other possible commands for
this task.
|
List<TaskInfo> |
SaWFConnectorImpl.getGroupbox(int[] ids,
String filter)
Read the content of the group box.
|
List<TaskInfo> |
SaWFConnector.getGroupbox(int[] ids,
String filter)
Read the content of the group box.
|
List<TaskInfo> |
SaWFConnectorImpl.getInbox(String filter)
Read the content of the inbox.
|
List<TaskInfo> |
SaWFConnector.getInbox(String filter)
Read the content of the inbox.
|
WorkflowMember |
SaWFConnectorImpl.getMember(WorkflowMember member,
int depth,
String filter)
Reads direct workflow member tree.
|
WorkflowMember |
SaWFConnector.getMember(WorkflowMember member,
int depth,
String filter)
Reads direct workflow member tree.
|
WorkflowMember |
SaWFConnectorImpl.getMembers()
Reads the workflow member tree.
|
WorkflowMember |
SaWFConnector.getMembers()
Reads the workflow member tree.
|
List<TaskInfo> |
SaWFConnectorImpl.getOrgUnitbox(int[] ids,
String filter)
Read the content of the organisation unit box.
|
List<TaskInfo> |
SaWFConnector.getOrgUnitbox(int[] ids,
String filter)
Read the content of the organisation unit box.
|
boolean |
SaWFConnectorImpl.getOutOfOffice()
Get the out of office status for the logged on user.
|
boolean |
SaWFConnector.getOutOfOffice()
Get the out of office status for the logged on user.
|
SaWFTask |
SaWFConnectorImpl.getParentTask(String taskId)
Get parent task direct by ID.
|
SaWFTask |
SaWFConnector.getParentTask(String taskId)
Get parent task direct by ID.
|
List<String> |
SaWFConnectorImpl.getProcessDefinitions()
Reads all available process definitions.
|
List<String> |
SaWFConnector.getProcessDefinitions()
Reads all available process definitions.
|
List<ProcessDefinitionDescriptor> |
SaWFConnectorImpl.getProcessDefinitions(String ddcName)
Returns the process definitions that are allowed to be used for documents contained
in the specified DDC.
|
List<ProcessDefinitionDescriptor> |
SaWFConnector.getProcessDefinitions(String ddcName)
Returns the process definitions that are allowed to be used for documents contained
in the specified DDC.
|
String |
SaWFConnectorImpl.getSubstitute()
Get the substitute for the logged on user.
|
String |
SaWFConnector.getSubstitute()
Get the substitute for the logged on user.
|
List<TaskInfo> |
SaWFConnectorImpl.getSubstitutebox(int[] ids,
String filter)
Read the content of the substitute box.
|
List<TaskInfo> |
SaWFConnector.getSubstitutebox(int[] ids,
String filter)
Read the content of the substitute box.
|
SaWFTask |
SaWFConnectorImpl.getTask(String taskId)
Get task direct by ID.
|
SaWFTask |
SaWFConnector.getTask(String taskId)
Get task direct by ID.
|
SaWFTask |
SaWFConnectorImpl.getTask(TaskInfo taskInfo)
Creates a task object from the given task information.
|
SaWFTask |
SaWFConnector.getTask(TaskInfo taskInfo)
Creates a task object from the given task information.
|
List<TaskAuditInfo> |
SaWFConnectorImpl.getTaskAuditList(int[] boxIds,
String filter)
Reads the task audit for this user.
|
List<TaskAuditInfo> |
SaWFConnector.getTaskAuditList(int[] boxIds,
String filter)
Reads the task audit for this user.
|
List<TaskAuditInfo> |
SaWFConnectorImpl.getTaskAuditList(int[] boxIds,
String filter,
Map<String,Object> parameter)
Reads the task audit for this user.
|
List<TaskAuditInfo> |
SaWFConnector.getTaskAuditList(int[] boxIds,
String filter,
Map<String,Object> parameter)
Reads the task audit for this user.
|
List<TaskInfo> |
SaWFConnectorImpl.getTaskList(int[] boxIds,
String filter)
Reads the task for this user.
|
List<TaskInfo> |
SaWFConnector.getTaskList(int[] boxIds,
String filter)
Reads the task for this user.
|
List<TaskInfo> |
SaWFConnectorImpl.getTaskList(int[] boxIds,
String filter,
Map<String,Object> parameter)
Reads the task for this user.
|
List<TaskInfo> |
SaWFConnector.getTaskList(int[] boxIds,
String filter,
Map<String,Object> parameter)
Reads the task for this user.
|
String |
SaWFConnectorImpl.getWorkflowDdcName()
Gets the workflow ddc name
|
String |
SaWFConnector.getWorkflowDdcName()
Gets the workflow ddc name
|
boolean |
SaWFConnectorImpl.logoff()
Logoff from the backend system.
|
boolean |
SaWFConnector.logoff()
Logoff from the backend system.
|
int |
SaWFConnectorImpl.logon(String username,
String password,
int type,
String client)
performs logon to the backend system.
|
int |
SaWFConnector.logon(String username,
String password,
int type,
String client)
performs logon to the backend system.
|
SaPropertyValue[] |
SaWFTaskImpl.readAttachmentMetadata()
Reads the metadata of the attachment.
|
SaPropertyValue[] |
SaWFTask.readAttachmentMetadata()
Reads the metadata of the attachment.
|
TaskUserSelection |
SaWFTaskImpl.readSelectableUsersForTransition(int transition)
Obtains the next tasks
TaskUserSelection for the given transition. |
TaskUserSelection |
SaWFTask.readSelectableUsersForTransition(int transition)
Obtains the next tasks
TaskUserSelection for the given transition. |
void |
SaWFConnectorImpl.setOutOfOffice(boolean isOutOfOffice)
set the out of office status for the logged on user.
|
void |
SaWFConnector.setOutOfOffice(boolean isOutOfOffice)
set the out of office status for the logged on user.
|
void |
SaWFConnectorImpl.setSubstitute(String name)
Set the substitute for the logged on user.
|
void |
SaWFConnector.setSubstitute(String name)
Set the substitute for the logged on user.
|
SaSaveInfo |
SaWFTaskImpl.updateAttachment(Properties namevaluePairs,
InputStream[] content,
String versionComment,
String acls)
Updates the attachment in the backend system with the given metadata,
acls and content.
|
SaSaveInfo |
SaWFTask.updateAttachment(Properties namevaluePairs,
InputStream[] content,
String versionComment,
String acls)
Updates the attachment in the backend system with the given metadata,
acls and content.
|
| Constructor and Description |
|---|
SaWFConnectorImpl()
Constructs the
SaWFConnectorImpl instance which provides
workflow functionalities. |
SaWFConnectorImpl(SaClassicConnector conn)
Constructor with given connector.
|
SaWFConnectorImpl(String configPath)
Constructs the
SaWFConnectorImpl instance which provides
workflow functionalities. |
SaWFTaskImpl(SaClassicConnectorImpl connector,
TaskInfo taskInfo,
String user)
Constructor.
|
| Modifier and Type | Class and Description |
|---|---|
class |
SaFolderAlreadyExistsException
Exception thrown when a folder is created and a sibling with the same name already exists.
|
class |
SaFolderNameException
Exception thrown in folder-related methods when a folder name contained an
invalid character.
|
class |
SaFolderOperationNotAllowedException
Thrown when an operation with folders is not allowed.
|
class |
SaSapUrlException
Exception thrown when checking a SAP-URL failed.
|
class |
SaTooManyResultsException
This exception is thrown when a query returned more results than allowed.
|
class |
SaUniqueConstraintViolationException
Exception thrown when a document is created or updated and the value of a unique field already exists in
another document.
|
class |
WrappedBasicException
This exception is intended to wrap instances of
SaBasicException in order to
transport them by rmi without breaking compatibility of existent calls and
operations. |
class |
WrappedEcmException
This exception works as wrapper in cases where server components already throw new exceptions while the client
interface still expects the old ones.
|
| Modifier and Type | Method and Description |
|---|---|
com.saperion.jna.applsrv.m2j.natives.HFIELDDATAArray |
DataBaseFieldMapper.createDdcSpecificArray(com.saperion.jna.applsrv.m2.Handle definition,
Map<String,Object> indexData) |
com.saperion.jna.applsrv.m2j.natives.HFIELDDATAArray |
DataBaseFieldMapper.createMappedArray(List<?> members) |
<T> T |
DataBaseFieldMapper.fromString(Class<T> clazz,
String input) |
| Modifier and Type | Class and Description |
|---|---|
static class |
LegacyOperationAdapter.EcmExceptionWrapper |
| Modifier and Type | Method and Description |
|---|---|
static SaSystemException |
LegacyOperation.mapEcmException(com.lexmark.saperion.exceptions.EcmException e) |
| Modifier and Type | Method and Description |
|---|---|
ArrayList<String> |
GetIxosDDCNames.invoke() |
| Modifier and Type | Method and Description |
|---|---|
String |
CreateLookupEntry.invoke()
Deprecated.
|
| Modifier and Type | Method and Description |
|---|---|
protected com.saperion.jni.SaJNIReadBuffer |
SaRMIInputStream.readDocumentFirst(String docHdoc,
boolean curRevision,
int docElement,
boolean withAnnotations) |
| Constructor and Description |
|---|
SaStatusInfo(SaPropertyValue value)
Constructor.
|
| Modifier and Type | Method and Description |
|---|---|
long |
SaRMIServerCommand.countTasks(int token,
int[] ids,
String filter,
Map<String,Object> filterParams)
Counts the tasks that are contained in the specified inbox(es).
|
List<SaDocumentInfo> |
SaRMIServerCommand.getStringQueryResult(int token,
SaQueryInfo queryInfo)
Executes a given HQL string and returns the results as list.
|
SaPropertyValue[] |
SaRMIServerCommand.readDocumentMetadata(int token,
String documentHDOC,
String ddcName,
String[] fields)
Reads the metadata of the document with the given ID.
|
| Modifier and Type | Class and Description |
|---|---|
class |
NativeException
An exception indicating that a native call resulted in a return code other than retOk.
|
| Modifier and Type | Method and Description |
|---|---|
void |
ClassicConnectorUtil.checkProperties(Description description,
SaFieldDescription[] fields)
Check properties.
|
void |
ClassicConnectorUtil.checkProperties(Map<String,Object> nameValuePairs,
String ddcName,
SaFieldDescription[] fields)
Check properties.
|
void |
ClassicConnectorUtil.checkProperties(SaFieldDescription[] fields,
Map<String,Object> nameValuePairs,
boolean skipMandatoryCheck,
String ddcName) |
void |
ClassicConnectorUtil.checkProperties(SaFieldDescription[] fields,
Properties props,
boolean skipMandatoryCheck,
String ddcName)
Check properties.
|
boolean |
ClassicConnectorUtil.validatedQueryString(String hqlQuery)
Validated query string.
|
Copyright © 2020 Hyland Software Germany GmbH. All rights reserved.