| Package | Description |
|---|---|
| com.saperion.connector |
This package contains the main classic connector classes.
|
| com.saperion.connector.events | |
| com.saperion.connector.exceptions | |
| 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.jcs.modules.acl.connector | |
| com.saperion.jcs.modules.users.connector | |
| 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.
event handling is deprecated
|
void |
SaClassicConnector.addListener(SaEventListener listener)
Deprecated.
will be removed with version 8.0
|
void |
SaClassicConnectorImpl.addListener(SaStatusEventListener listener)
Deprecated.
event handling is deprecated
|
void |
SaClassicConnector.addListener(SaStatusEventListener listener)
Deprecated.
will be removed with version 8.0
|
void |
SaClassicConnectorImpl.addToFolder(String folderTableDDC,
String documentId,
String documentDDC,
String folderId)
Adds the document with given documentId to a given folder with given 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)
Caches the given document on the backend system.
|
SaSaveInfo |
SaClassicConnector.cacheDocument(String xhDoc,
DocumentInfo document)
Caches the given document on the backend system.
|
SaSaveInfo |
SaClassicConnectorImpl.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.
|
SaSaveInfo |
SaClassicConnector.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 |
SaClassicConnectorImpl.changePassword(String user,
String oldPassword,
String client,
String newPassword)
Changes the password of an existing user.
|
void |
SaClassicConnector.changePassword(String user,
String oldPassword,
String client,
String newPassword)
Changes the password of an existing user.
|
void |
SaClassicConnectorImpl.checkoutDocument(String hDoc)
Checkouts a document for the given document id (hdoc).
|
void |
SaClassicConnector.checkoutDocument(String hDoc)
Checkouts a document for the given document id (hdoc).
|
SapDocInfo |
SaClassicConnectorImpl.checkSapUrl(String url)
Checks the given SAP URL on the R/Link server and returns, if successfull, the HDOC and the
DDC.
|
SapDocInfo |
SaClassicConnector.checkSapUrl(String url)
Checks the given SAP URL on the R/Link server and returns, if successfull, the HDOC and the
DDC.
|
String |
SaClassicConnectorImpl.copyFolder(String folderTableDDC,
String folderId,
String destinationId,
String beforeChild,
boolean withDocuments)
Copies the given folder and all it's children to the destination.
|
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)
Creates a new document on the backend system with the given
DocumentInfo. |
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.
will be removed with version 8.0, use
SaClassicConnectorImpl.createDocument(DocumentInfo) instead. |
SaSaveInfo |
SaClassicConnector.createDocument(String ddcName,
Properties namevaluePairs,
InputStream[] content,
String versionComment)
Deprecated.
will be removed with version 8.0, 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.0, use
SaClassicConnector.createDocument(DocumentInfo) instead. |
String |
SaClassicConnectorImpl.createFolder(SaFolderSaveInfo info,
Properties namevaluePairs)
Creates a new folder below a given folder.
|
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.0 |
SaSaveInfo |
SaClassicConnectorImpl.createLink(LinkInfo link)
Creates a link to a document for given
LinkInfo. |
SaSaveInfo |
SaClassicConnector.createLink(LinkInfo link)
Creates a link to a document for given
LinkInfo. |
String |
SaClassicConnectorImpl.createLookupEntry(String ddc,
Properties props)
Deprecated.
This method does not handle system fields and might be removed in a future version.
Use
SaClassicConnectorImpl.invoke(Operation) with a CreateLookupEntry
operation instead. |
String |
SaClassicConnector.createLookupEntry(String ddc,
Properties props)
Deprecated.
This method does not handle system fields and might be removed in a future version.
Use
SaClassicConnector.invoke(Operation) with a CreateLookupEntry operation instead. |
void |
SaClassicConnectorImpl.deleteDocument(String documentHDOC,
int deleteType)
Deletes a document from the backend system with the given strategy.
|
void |
SaClassicConnector.deleteDocument(String documentHDOC,
int deleteType)
Deletes a document from the backend system with the given strategy.
|
void |
SaClassicConnectorImpl.deleteFolder(String folderTableDDC,
String folderId)
Deletes an existing folder.
|
void |
SaClassicConnector.deleteFolder(String folderTableDDC,
String folderId)
Deletes an existing folder.
|
void |
SaClassicConnectorImpl.deleteLookupEntry(String ddc,
String id)
Deprecated.
This method does not handle system fields and might be removed in a future version.
Use
SaClassicConnectorImpl.invoke(Operation) with a DeleteLookupEntry
operation instead. |
void |
SaClassicConnector.deleteLookupEntry(String ddc,
String id)
Deprecated.
This method does not handle system fields and might be removed in a future version.
Use
SaClassicConnector.invoke(Operation) with a DeleteLookupEntry operation instead. |
boolean |
SaClassicConnectorImpl.deleteSetting(String name,
String section,
boolean isLong)
Deletes a setting in the database.
|
boolean |
SaClassicConnector.deleteSetting(String name,
String section,
boolean isLong)
Deletes a setting in the database.
|
void |
SaClassicConnectorImpl.discardCheckout(String hDoc)
Discards the checkout of the given document.
|
void |
SaClassicConnector.discardCheckout(String hDoc)
Discards the checkout of the given document.
|
String |
SaClassicConnectorImpl.executeCommand(ContextInfo contextInfo)
Performs the given command.
|
String |
SaClassicConnectorImpl.getACLNames(String documentHDOC)
Reads the ACL's for the given document.
|
String |
SaClassicConnector.getACLNames(String documentHDOC)
Reads the ACL's for the given document.
|
SaACLRights |
SaClassicConnectorImpl.getACLRights(String[] acls)
Read the rights for the given ACL's.
|
SaACLRights |
SaClassicConnector.getACLRights(String[] acls)
Read the rights for the given ACL's.
|
List<SaAcl> |
SaClassicConnectorImpl.getAcls()
Reads all existing ACLs.
|
List<SaAcl> |
SaClassicConnector.getAcls()
Reads all existing ACLs.
|
List<String> |
SaClassicConnectorImpl.getAllACLs()
Deprecated.
use
SaClassicConnectorImpl.getAcls() instead |
List<String> |
SaClassicConnector.getAllACLs()
Deprecated.
use
SaClassicConnector.getAcls() instead. Will be removed with version 8.0 |
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.0 |
String |
SaClassicConnectorImpl.getAnnotations(String hDoc,
int indexOfContentElement,
boolean currentRevision)
Reads the annotations from the given document.
|
String |
SaClassicConnector.getAnnotations(String hDoc,
int indexOfContentElement,
boolean currentRevision)
Reads the annotations from the given document.
|
int |
SaClassicConnectorImpl.getArchivedSize(String hDoc)
Returns the total document size in the archive.
|
int |
SaClassicConnector.getArchivedSize(String hDoc)
Returns the total document size in the archive.
|
List<UsersRights> |
SaClassicConnectorImpl.getAuthorizedUsers(String hDoc,
String rights,
MatchKind match)
Returns the users, that have specific rights on a document.
|
List<UsersRights> |
SaClassicConnector.getAuthorizedUsers(String hDoc,
String rights,
MatchKind match)
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)
Reads the application configuration properties from the backend system.
|
Properties |
SaClassicConnector.getConfiguration(String section)
Reads the application configuration properties from the backend system.
|
SaUserInfo |
SaClassicConnectorImpl.getCurrentUserInfo()
Gets detailed info about the current user.
|
SaUserInfo |
SaClassicConnector.getCurrentUserInfo()
Gets detailed info about the current user.
|
SaFieldDescription[] |
SaClassicConnectorImpl.getDBDefinition(String name)
Reads the definitions of a database definition (DDC) for the given name.
|
SaFieldDescription[] |
SaClassicConnector.getDBDefinition(String name)
Reads the definitions of a database definition (DDC) for the given name.
|
DDC |
SaClassicConnectorImpl.getDDC(String ddcName) |
DDC |
SaClassicConnector.getDDC(String ddcName)
Returns information about the requested DDC.
|
String[] |
SaClassicConnectorImpl.getDefinitions()
Reads the registered DDC names from the repository.
|
String[] |
SaClassicConnector.getDefinitions()
Reads the registered DDC names from the repository.
|
SaDocAccessData |
SaClassicConnectorImpl.getDocumentAccessData(String documentHDOC)
Reads the access rights of the given document.
|
SaDocAccessData |
SaClassicConnector.getDocumentAccessData(String documentHDOC)
Reads the access rights of the given document.
|
long |
SaClassicConnectorImpl.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.
|
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)
Returns a list of folder properties which contains all folders the document is contained in.
|
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)
Reads the document information for the given document.
|
SaDocInfo |
SaClassicConnector.getDocumentInfo(String hDoc,
boolean currentRevision,
boolean resolveLinks)
Reads the document information for the given document.
|
SaDocInfo |
SaClassicConnectorImpl.getDocumentInfo(String hDoc,
boolean currentRevision,
boolean resolveLinks,
boolean forceSizeDetermination)
Reads the document information for the given document.
|
SaDocInfo |
SaClassicConnector.getDocumentInfo(String hDoc,
boolean currentRevision,
boolean resolveLinks,
boolean forceSizeDetermination)
Reads the document information for the given document.
|
boolean |
SaClassicConnectorImpl.getEventsEnabled() |
boolean |
SaClassicConnector.getEventsEnabled()
Returns whether events (e.g.
|
SaDocumentInfo |
SaClassicConnectorImpl.getFolderByPath(String folderTableDDC,
String startFolderId,
String folderPath)
Returns the folder which matches to the given path.
|
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)
Returns a list with the children of the given node.
|
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)
Reads the folder class with the given name.
|
SaFolderClass |
SaClassicConnector.getFolderClass(String className)
Reads the folder class with the given name.
|
String[] |
SaClassicConnectorImpl.getFolderDefinitions()
Reads the registered folder DDC names from the repository.
|
String[] |
SaClassicConnector.getFolderDefinitions()
Reads the registered folder DDC names from the repository.
|
List<SaDocumentInfo> |
SaClassicConnectorImpl.getFolderFromPath(String folderTableDDC,
String startNodeId,
String folderPath)
Returns the folders which match to the given path.
|
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.
|
SaDocumentInfo |
SaClassicConnectorImpl.getFolderInfo(String folderTableDDC,
String folderId,
boolean forceLoadVariables)
Returns the folder information object for the given folder.
|
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)
Returns the parent of the given folder.
|
SaDocumentInfo |
SaClassicConnector.getFolderParent(String folderTableDDC,
String folderId)
Returns the parent of the given folder.
|
SaDocAccessData |
SaClassicConnectorImpl.getFolderRights(String folderTableDDC,
String folderId)
Returns the rights mask for the given folder and user.
|
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)
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.
|
Set<FolderUpdateInfo> |
SaClassicConnector.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 |
SaClassicConnectorImpl.getFulltext(String ddcName,
String sysRowId)
Deprecated.
Will be removed in 8.0. Use
SaClassicConnectorImpl.getFulltext(String, String, String, long) instead. |
String |
SaClassicConnector.getFulltext(String ddcName,
String sysRowId)
Deprecated.
Will be removed in 8.0. Use
SaClassicConnector.getFulltext(String, String, String, long) instead. |
String |
SaClassicConnectorImpl.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.
|
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.
|
List<HistoryInfo> |
SaClassicConnectorImpl.getHistoryInfos(String taskId)
Reads the history for the given task.
|
List<String> |
SaClassicConnectorImpl.getInvolvedUsers(String documentHDOC)
Reads all users involved in the set of ACL's.
|
List<String> |
SaClassicConnector.getInvolvedUsers(String documentHDOC)
Reads all users involved in the set of ACL's.
|
SaLockInfo |
SaClassicConnectorImpl.getLockInfo(String sysRowId)
Returns the locking informations for a given document.
|
SaLockInfo |
SaClassicConnector.getLockInfo(String sysRowId)
Returns the locking informations 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)
Gets the released hdoc for given hdoc if release feature is on and release tag is set,
otherwise returns the given hDoc.
|
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<Rendition> |
SaClassicConnectorImpl.getRendition(Element element,
Options options) |
List<Rendition> |
SaClassicConnector.getRendition(Element element,
Options options) |
List<SaRMIServerInfo> |
SaClassicConnectorImpl.getServerInfos() |
com.saperion.connector.authentication.Session |
SaClassicConnectorImpl.getSession()
Returns the session of the logged in user.
|
Setting |
SaClassicConnectorImpl.getSetting(String name,
String section,
boolean isLong)
Retrieves a
Setting identified by it's key and section from the database. |
Setting |
SaClassicConnector.getSetting(String name,
String section,
boolean isLong)
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)
Gets the system files of a specific kind.
|
List<String> |
SaClassicConnector.getSystemFiles(SystemFileKind kind,
String filter)
Gets the system files of a specific kind.
|
SaSystemSetting |
SaClassicConnectorImpl.getSystemSetting(String accessKey)
Retrieves a system setting object.
|
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)
Reads the thumbnail of the given document.
|
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)
Retrieves a user-specific setting object.
|
SaUserSetting |
SaClassicConnector.getUserSetting(String accessKey)
Retrieves a user-specific setting object.
|
List<String> |
SaClassicConnectorImpl.getVersionIDs(String ddcName,
String sysrowID)
Reads the version IDs of the given document.
|
List<String> |
SaClassicConnector.getVersionIDs(String ddcName,
String sysrowID)
Reads the version IDs of the given document.
|
SaWFConnector |
SaClassicConnectorImpl.getWorkflowConnector()
Returns a workflow connector based on this classic connector.
|
SaWFConnector |
SaClassicConnector.getWorkflowConnector()
Returns a workflow connector based on this classic connector.
|
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(Operation<T> operation) |
<T extends Serializable> |
SaClassicConnector.invoke(Operation<T> operation)
Invokes the given
Operation on the server side. |
boolean |
SaClassicConnectorImpl.isReleaseActive()
Checks if is release feature in the program.ini in section [Release] is active.
|
boolean |
SaClassicConnector.isReleaseActive()
Checks if is release feature in the program.ini in section [Release] is active.
|
InputStream |
SaClassicConnectorImpl.loadSystemFile(SystemFileKind kind,
String name)
Loads a system file of a specific kind.
|
InputStream |
SaClassicConnector.loadSystemFile(SystemFileKind kind,
String name)
Loads a system file of a specific kind.
|
boolean |
SaClassicConnectorImpl.lockDocument(String sysRowId,
String ddcName)
Locks a document.
|
boolean |
SaClassicConnector.lockDocument(String sysRowId,
String ddcName)
Locks a document.
|
void |
SaClassicConnectorImpl.logClientEvent(String hdoc,
SaConstants.ProtoEvents event,
String remark)
Adds an audit log event.
|
void |
SaClassicConnector.logClientEvent(String hdoc,
SaConstants.ProtoEvents event,
String remark)
Adds an audit log event.
|
boolean |
SaClassicConnectorImpl.logoff()
Log off from the system.
|
boolean |
SaClassicConnector.logoff()
Log off from the system.
|
int |
SaClassicConnectorImpl.logon(byte[] token,
int type,
String client)
Deprecated.
will be removed with version 8.0
|
int |
SaClassicConnector.logon(byte[] token,
int type,
String client)
Deprecated.
will be removed with version 8.0
|
com.saperion.connector.authentication.Session |
SaClassicConnectorImpl.logon(com.saperion.connector.authentication.Credentials credentials) |
com.saperion.connector.authentication.Session |
SaClassicConnector.logon(com.saperion.connector.authentication.Credentials credentials)
Performs a logon with the given Credentials and returns the information about the open
session.
|
int |
SaClassicConnectorImpl.logon(jcifs.smb.NtlmPasswordAuthentication auth,
int type,
String client)
Deprecated.
will be removed with version 8.x
|
int |
SaClassicConnector.logon(jcifs.smb.NtlmPasswordAuthentication auth,
int type,
String client)
Deprecated.
will be removed with version 8.0
|
int |
SaClassicConnectorImpl.logon(String username,
String password,
int type,
String client)
performs logon to the backend system.
|
int |
SaClassicConnector.logon(String username,
String password,
int type,
String client)
performs logon to the backend system.
|
void |
SaClassicConnectorImpl.moveFolder(String folderTableDDC,
String folderId,
String destinationId,
String beforeChild)
Moves the given folder to a new destination.
|
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)
Removes the document from the source folder and adds it to the source folder.
|
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)
Loads a document's content from the backend system.
|
InputStream |
SaClassicConnector.readDocument(String documentHDOC,
boolean currentRevision,
int elementNumber)
Loads a document's content from the backend system.
|
String |
SaClassicConnectorImpl.readDocumentFilename(String docHdoc,
boolean currentRevision,
int elementNumber)
Reads the filenames of the application data of the document with the given ID.
|
String |
SaClassicConnector.readDocumentFilename(String documentHDOC,
boolean currentRevision,
int elementNumber)
Deprecated.
will be removed with version 8.0
|
SaPropertyValue[] |
SaClassicConnectorImpl.readDocumentMetadata(String documentSysRowID,
String ddcName,
String[] fields)
Reads the metadata of the document with the given ID.
|
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)
Read released document if the release feature is
active.
|
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)
Loads a document version from the backend system.
|
InputStream |
SaClassicConnector.readVersionDocument(String versionID,
int elementNumber)
Loads a document version from the backend system.
|
String |
SaClassicConnectorImpl.readVersionDocumentFilename(String docHdoc,
int elementNumber)
Reads the filenames of the application data of the document with the given ID.
|
String |
SaClassicConnector.readVersionDocumentFilename(String documentHDOC,
int elementNumber)
Deprecated.
use getDocumentInfo.getFullName() instead. Will be removed with version 8.0
|
SaVersionData |
SaClassicConnectorImpl.readVersionMetadata(String versionID)
Reads the version metadata of the document with the given ID.
|
SaVersionData |
SaClassicConnector.readVersionMetadata(String versionID)
Reads the version metadata of the document with the given ID.
|
void |
SaClassicConnectorImpl.releaseDocument(String ddcName,
String hDoc,
String versionComment)
Release the given document.
|
void |
SaClassicConnector.releaseDocument(String ddcName,
String hDoc,
String versionComment)
Release the given document.
|
void |
SaClassicConnectorImpl.removeFromFolder(String folderTableDDC,
String documentSysRowId,
String documentDDC,
String folderId)
Removes the document from the given folder.
|
void |
SaClassicConnector.removeFromFolder(String folderTableDDC,
String documentSysRowId,
String documentDDC,
String folderId)
Removes the document from the given folder.
|
String |
SaClassicConnectorImpl.resolveLatestHDoc(String oldHdoc)
Resolves and returns the XHDOC of the latest version of the document identified by the given
HDOC.
|
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)
Restores the version with the given HDOC.
|
SaSaveInfo |
SaClassicConnector.restoreVersion(String versionID)
Restores the version with the given HDOC.
|
List<SaPropertyValue[]> |
SaClassicConnectorImpl.search(String hqlQuery)
Deprecated.
use
SaClassicConnectorImpl.searchHQL(SaQueryInfo) instead |
List<SaPropertyValue[]> |
SaClassicConnector.search(String hqlQuery)
Deprecated.
Use searchHQL() instead. Will be removed with version 8.0
|
Set<SaFolderClass> |
SaClassicConnectorImpl.searchFolderClass(SaFolderClassSearchInfo searchInfo)
Searches for folder classes that match the specified propertied.
|
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)
HQL search extended with additional folder informations and depth.
|
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)
Performs a search with the given hql query (hibernate query language).
|
List<SaDocumentInfo> |
SaClassicConnector.searchHQL(SaQueryInfo hqlQuery)
Performs a search with the given hql query (hibernate query language).
|
SettingSearchResult |
SaClassicConnectorImpl.searchSettings(SettingSearchInfo searchInfo)
Searches for settings.
|
SettingSearchResult |
SaClassicConnector.searchSettings(SettingSearchInfo searchInfo)
Searches for settings.
|
SaSaveInfo |
SaClassicConnectorImpl.setACLName(String ddcname,
String documentHDOC,
String acl,
String versionComment)
Adds the given ACL to the node.
|
SaSaveInfo |
SaClassicConnector.setACLName(String ddcname,
String documentHDOC,
String acl,
String versionComment)
Adds the given ACL to the node.
|
void |
SaClassicConnectorImpl.setAnnotations(String hDoc,
int indexOfContentElement,
String annotations)
Sets the given annotations to the document.
|
void |
SaClassicConnector.setAnnotations(String hDoc,
int indexOfContentElement,
String annotations)
Sets the given annotations to the document.
|
void |
SaClassicConnectorImpl.setCurrentUserPresent(boolean present)
Sets whether the current user is present.
|
void |
SaClassicConnector.setCurrentUserPresent(boolean present)
Deprecated.
Use
SaClassicConnector.updateCurrentUserInformation(MutableUserInformation) instead.
Will be removed with version 8.0. |
void |
SaClassicConnectorImpl.setEventsEnabled(boolean enabled) |
void |
SaClassicConnector.setEventsEnabled(boolean enabled)
Sets whether events (e.g.
|
void |
SaClassicConnectorImpl.setFolderAcl(String folderTableDDC,
String folderId,
String aclName)
Sets an ACL for the given folder.
|
void |
SaClassicConnector.setFolderAcl(String folderTableDDC,
String folderId,
String aclName)
Sets an ACL for the given folder.
|
void |
SaClassicConnectorImpl.setLocale(Locale locale)
Set the localization information for this user.
|
void |
SaClassicConnector.setLocale(Locale locale)
Set the localization information for this user.
|
void |
SaClassicConnectorImpl.setOutOfOffice(boolean isOutOfOffice)
set the out of office status for the logged on user.
|
void |
SaClassicConnectorImpl.setSetting(Setting setting)
Stores a
Setting in the database. |
void |
SaClassicConnector.setSetting(Setting setting)
Stores a
Setting in the database. |
void |
SaClassicConnectorImpl.setSubstitute(String name)
Set the substitute for the logged on user.
|
void |
SaClassicConnectorImpl.setUserSetting(SaUserSetting setting)
Persists a user-specific setting object.
|
void |
SaClassicConnector.setUserSetting(SaUserSetting setting)
Persists a user-specific setting object.
|
void |
SaClassicConnectorImpl.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 |
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.0.
|
void |
SaClassicConnectorImpl.storeBpmn(BpmnImportDescription bpmnDescription,
BpmnImportCallback callback)
Transforms the bpmn model to a saperion process and stores it to the system.
|
void |
SaClassicConnectorImpl.storeSystemFile(SystemFileKind kind,
String name,
InputStream data)
Stores a system file of a specific kind.
|
void |
SaClassicConnector.storeSystemFile(SystemFileKind kind,
String name,
InputStream data)
Stores a system file of a specific kind.
|
boolean |
SaClassicConnectorImpl.unlockDocument(String sysRowId,
String ddcName)
Unlocks a document.
|
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.
will be removed with version 8.0, use
SaClassicConnectorImpl.updateDocument(UpdateDocumentInfo) instead. |
SaSaveInfo |
SaClassicConnector.updateDocument(String ddcName,
String documentHDOC,
Properties namevaluePairs,
InputStream[] content,
String versionComment)
Deprecated.
will be removed with version 8.0, use
#updateDocument(DocumentInfo) instead. |
SaSaveInfo |
SaClassicConnectorImpl.updateDocument(String ddcName,
String documentHDOC,
Properties namevaluePairs,
InputStream[] content,
String versionComment,
String acls)
Deprecated.
will be removed with version 8.0
|
SaSaveInfo |
SaClassicConnector.updateDocument(String ddcName,
String documentHDOC,
Properties namevaluePairs,
InputStream[] content,
String versionComment,
String acls)
Deprecated.
will be removed with version 8.0
|
SaSaveInfo |
SaClassicConnectorImpl.updateDocument(String ddcName,
String documentHDOC,
Properties namevaluePairs,
InputStream[] content,
String versionComment,
String acls,
boolean resolveLinks)
Deprecated.
will be removed with version 8.0
|
SaSaveInfo |
SaClassicConnector.updateDocument(String ddcName,
String documentHDOC,
Properties namevaluePairs,
InputStream[] content,
String versionComment,
String acls,
boolean resolveLinks)
Deprecated.
will be removed with version 8.0
|
SaSaveInfo |
SaClassicConnectorImpl.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 |
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.0
|
SaSaveInfo |
SaClassicConnectorImpl.updateDocument(UpdateDocumentInfo updateInfo)
Updates a document in the backend system with the given metadata, acls and content.
|
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)
Updates an existing folder with the given properties.
|
void |
SaClassicConnector.updateFolder(String folderTableDDC,
String folderId,
Properties namevaluePairs)
Updates an existing folder with the given properties.
|
void |
SaClassicConnectorImpl.updateLookupEntry(String ddc,
String id,
Properties props)
Deprecated.
This method does not handle system fields and might be removed in a future version.
Use
SaClassicConnectorImpl.invoke(Operation) with a UpdateLookupEntry
operation instead. |
void |
SaClassicConnector.updateLookupEntry(String ddc,
String id,
Properties props)
Deprecated.
This method does not handle system fields and might be removed in a future version.
Use
SaClassicConnector.invoke(Operation) with a UpdateLookupEntry operation instead. |
| Modifier and Type | Method and Description |
|---|---|
void |
CustomEventBuilder.fire()
Fires the custom event defined by this builder.
|
| Modifier and Type | Method and Description |
|---|---|
static void |
ConnectorExceptions.throwNotLoggedOn() |
static void |
ConnectorExceptions.throwNotLoggedOn(Throwable cause) |
| 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.
|
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.
|
void |
SaWFConnectorImpl.storeBpmn(BpmnImportDescription bpmnDescription,
BpmnImportCallback callback) |
void |
SaWFConnector.storeBpmn(BpmnImportDescription bpmnDescription,
BpmnImportCallback callback)
Transforms the bpmn model to a saperion process and stores it to the system.
|
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 |
SaPasswordExpiredException
Indicates that the users password is expired.
|
| Modifier and Type | Method and Description |
|---|---|
AccessManagement |
AccessManagement.Config.build()
Creates an AccessManagament instance.
|
| Modifier and Type | Method and Description |
|---|---|
UserManagement |
UserManagement.Config.build()
Creates a UserManagement instance.
|
| 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.
|
Copyright © 2016 SAPERION AG. All rights reserved.