Package | Description |
---|---|
com.saperion.ws |
Root package for SAPERION ws classes and packages.
|
com.saperion.ws.wrapper.exception |
Package for ws wrapper executions.
|
com.saperion.ws.wrapper.wf.exception |
Package for ws workflow wrapper exceptions.
|
Modifier and Type | Method and Description |
---|---|
SaWsSaveInfo |
SaWsArchiveService.create(int token,
String definition,
List<SaWsProperty> metadatas,
SaWsContentContainer container,
String versionComment,
String acls)
Creates a new document on the backend system with the given metadata and content.
|
String |
SaWsLookupService.createEntry(int token,
String definition,
List<SaWsProperty> metadatas)
Creates a new lookup entry on the backend system with the given metadata
and content.
|
void |
SaWsArchiveService.delete(int token,
String xhdoc,
SaWsDeleteType deleteType)
Deletes a document from the backend system with the given strategy.
|
void |
SaWsLookupService.deleteEntry(int token,
String definition,
String sysrowid)
Deletes a lookup entry from the backend system.
|
void |
SaWsWorkflowService.execute(int token,
String taskId,
SaWsCommand command,
String nextActor,
String comment,
Date escalationDate)
Executes the specified task.
|
SaWsAccessData |
SaWsArchiveService.getAccessData(int token,
String xhdoc)
Reads the access rights of the given document.
|
SaWsAccessData |
SaWsAccessService.getAccessData(int token,
String xhdoc)
Reads the access rights of the given document.
|
Annotations |
SaWsContentService.getAnnotations(int token,
String xhdoc,
int elementNumber)
Returns the annotations by the specified document in its current revision.
|
SaWsAuthorizedUsers |
SaWsAccessService.getAuthorizedUsers(int token,
String xhdoc,
List<SaWsRight> rights,
SaWsMatchKind match)
Retrieves and returns a SaWsAuthorizedUsers object with the matching users.
|
List<SaWsBoxDefinition> |
SaWsWorkflowService.getBoxDefinitions(int token)
Returns a list of box definitions of the current session user.
|
List<SaWsProperty> |
SaWsConfigurationService.getConfiguration(int token,
String section)
Reads the configuration properties from the backend system.
|
protected com.saperion.connector.SaClassicConnector |
AbstractService.getConnection(int token)
Retrieves the connection by the given token.
|
SaWsContent |
SaWsVersionService.getContent(int token,
String xhdoc,
int elementNumber)
Loads a document version from the backend system.
|
SaWsContent |
SaWsContentService.getContent(int token,
String xhdoc,
int elementNumber)
Loads a document in its current revision from the backend system.
|
SaWsContent |
SaWsArchiveService.getContent(int token,
String xhdoc,
int elementNumber)
Deprecated.
This method is deprecated. Use SaWsContentService.getContent instead.
|
String |
SaWsVersionService.getContentFilename(int token,
String xhdoc,
int elementNumber)
Loads the filename for a document from the backend system.
|
String |
SaWsArchiveService.getContentFilename(int token,
String xhdoc,
int elementNumber)
Deprecated.
This method is deprecated. Use SaWsContentService.getContentFilename instead.
|
List<SaWsFieldDescription> |
SaWsConfigurationService.getDefinition(int token,
String definition)
Reads the DDC definition of one database with the given name.
|
String[] |
SaWsConfigurationService.getDefinitions(int token)
Reads the registered DDC names from the repository.
|
String |
SaWsContentService.getFilename(int token,
String xhdoc,
int elementNumber)
Loads the filename for a document from the backend system.
|
SaWsLockInfo |
SaWsArchiveService.getLockInfo(int token,
String sysRowId)
Returns the locking informations for a given document.
|
List<SaWsUser> |
SaWsWorkflowService.getMembers(int token,
MemberOptions options)
Returns the members of the current workflow of the session's user.
|
SaWsVersionData |
SaWsVersionService.getMetadata(int token,
String xhdoc)
Reads the version metadata of the document with the given ID.
|
boolean |
SaWsWorkflowService.getOutOfOffice(int token)
Determines if current session's user is out of office.
|
List<String> |
SaWsWorkflowService.getProcessDefinitions(int token)
Returns a list of process definitions as strings of the current session user.
|
SaWsContent |
SaWsVersionService.getReleasedDocument(int token,
String xhdoc,
int elementNumber)
Gets the content stream of the last released document.
|
long |
SaWsContentService.getSize(int token,
String xhdoc,
int elementNumber)
Returns the total document size in archive.
|
SaWsContentStructure |
SaWsContentService.getStructure(int token,
String xhdoc)
With the help of getStructure you are able to receive all informations about the
documents
content structure of the actual document version.
|
String |
SaWsWorkflowService.getSubstitute(int token)
Returns the substitute (username) as string.
|
SaWsTask |
SaWsWorkflowService.getTask(int token,
String taskId)
Retrieves and returns the task by the given id.
|
List<SaWsTask> |
SaWsWorkflowService.getTasks(int token,
int[] boxIds,
String filter)
Returns the filtered tasks.
|
List<String> |
SaWsVersionService.getVersionIDs(int token,
String definition,
String sysrowid)
Reads the version IDs of the given document.
|
boolean |
SaWsArchiveService.lock(int token,
String sysRowId,
String definition)
Locks a document.
|
int |
SaWsAuthenticationService.login(String username,
String password,
int type,
String mandant,
String applicationToken)
Login to the backend system.
|
boolean |
SaWsAuthenticationService.logoff(int token)
Logoff from the backend system.
|
int |
SaWsAuthenticationService.logon(String username,
String password,
SaWsLicenseType type,
String mandant,
String applicationToken)
Logon to the backend system.
|
List<SaWsDocumentInfo> |
SaWsArchiveService.query(int token,
SaWsQueryInfo queryInfo) |
void |
SaWsVersionService.releaseDocument(int token,
String ddcName,
String xhdoc,
String comment)
Release the document by given xhdoc.
|
SaWsSaveInfo |
SaWsVersionService.restore(int token,
String xhdoc)
Restores the version with the given HDOC.
|
protected List<SaWsPropertyValue[]> |
SaWsArchiveService.search(int token,
com.saperion.rmi.SaQueryInfo query)
This method performs the search for the given SaQueryInfo.
|
List<SaWsPropertyValue[]> |
SaWsArchiveService.search(int token,
String hql)
Performs a search with the given hql query (hibernate query language).
|
List<SaWsPropertyValue[]> |
SaWsArchiveService.searchWithPaging(int token,
String hql,
int offset,
int maxNumber)
Performs a search with the given hql query (hibernate query language) with the support for
paging by the given offset and max number parameters.
|
void |
SaWsContentService.setAnnotations(int token,
Annotations annotations,
String xhdoc,
int elementNumber)
Sets the annotations of a document.
|
void |
SaWsWorkflowService.setOutOfOffice(int token,
boolean outOfOffice)
Set the "out of office" state of the current session's user.
|
void |
SaWsWorkflowService.setSubstitute(int token,
String username)
Sets the substitute (username) for the session's user.
|
void |
SaWsWorkflowService.start(int token,
String processName,
String nextActor,
String comment,
String attachmentId)
Starts a workflow with the specified parameters.
|
boolean |
SaWsArchiveService.unlock(int token,
String sysRowId,
String definition)
Unlocks a document.
|
SaWsSaveInfo |
SaWsArchiveService.update(int token,
String definition,
String xhdoc,
List<SaWsProperty> metadatas,
SaWsContentContainer container,
String versionComment,
String acls)
Updates a document in the backend system with the given metadata and content.
|
void |
SaWsLookupService.updateEntry(int token,
String definition,
String sysrowid,
List<SaWsProperty> metadatas)
Updates a lookup entry in the backend system with the given metadata.
|
Modifier and Type | Class and Description |
---|---|
class |
SaWsAuthenticationException
The Class SaWsAuthenticationException.
|
class |
SaWsDBException
The Class SaWsDBException.
|
class |
SaWsLockException
The Class SaWsLockException.
|
class |
SaWsRepositoryException
The Class SaWsRepositoryException.
|
Modifier and Type | Class and Description |
---|---|
class |
SaWsWorkflowException
The Class SaWsWorkflowException.
|
Copyright © 2020 Hyland Software Germany GmbH. All rights reserved.