com.saperion.connector.rmi

Class AbstractQueryRMIClientCommand

java.lang.Object

com.saperion.connector.rmi.AbstractRMIClientCommand

com.saperion.connector.rmi.AbstractFolderRMIClientCommand

com.saperion.connector.rmi.AbstractDocRMIClientCommand

com.saperion.connector.rmi.AbstractQueryRMIClientCommand

All Implemented Interfaces:

SaRMIClientCommand

Direct Known Subclasses:

AbstractWfRMIClientCommand

public abstract class AbstractQueryRMIClientCommand
extends AbstractDocRMIClientCommand

Class representing the query operations of the backend.

Field Summary

Fields inherited from class com.saperion.connector.rmi.AbstractRMIClientCommand

APPEND_CONTENT, appl, credentials, LOGGER, props, session, sysConnector, writeBufferSize

Constructor Summary

Constructors

Constructor and Description
AbstractQueryRMIClientCommand()

Method Summary

Modifier and Type	Method and Description
String	createLookupEntry(String ddc, Properties props) Deprecated.
void	deleteLookupEntry(String ddc, String id) Deprecated.
void	finishSQLTransaction(boolean commit, String ddcName) Finish SQL transaction.
String	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	getHDocForSysRowId(String sysRowId, String ddcName) Searchs the HDOC for the given SysRowId.
List<String>	getIdsFromQuery(String query) Executes a HQL query and returns the results as a string list.
List<SaDocumentInfo>	getStringQueryResult(SaQueryInfo hqlQuery) Executes a given HQL string and returns the results as list.
List<String>	getVersionList(String ddcName, String sysrowID) Reads the versionlist for the given document.
SaPropertyValue[]	readDocumentMetadata(String sysRowId, String ddcName, String[] fields) Reads the meta data of the document with the given ID.
void	startSQLTransaction(String ddcName) Start SQL transaction.
void	updateLookupEntry(String ddc, String id, Properties props) Deprecated.

Methods inherited from class com.saperion.connector.rmi.AbstractDocRMIClientCommand

cacheDocument, checkoutDocument, checkSapUrl, clearContent, closeDocument, createDocument, createLink, deleteDocument, discardDocument, dsicardCheckout, finishTransaction, getACLNames, getACLRights, getAcls, getAllACLs, getAnnotations, getInvolvedUsers, getLockInfo, getLocks, getLocks, getNodeAccessData, getThumbnail, lockNode, logClientEvent, readDocumentFirst, readDocumentNext, readVersionMetadata, readVersionMetadata, releaseDocument, removeElement, removeElement, restoreVersion, saveDocument, saveDocument, setACLName, setAnnotations, setElementMark, setVariables, startTransaction, storeDocument, storeDocument, unlockNode, writeContent, writeContent, writeContent, writeContent

Methods inherited from class com.saperion.connector.rmi.AbstractFolderRMIClientCommand

addToFolder, copyFolder, createFolder, deleteFolder, getDocumentFolderCount, getDocumentFolders, getFolderChildren, getFolderClass, getFolderFromPath, getFolderInfo, getFolderParent, getFolderRights, getFolderUpdateInfo, moveFolder, moveToFolder, removeFromFolder, searchFolderClass, searchFolderDocuments, setFolderAcl, updateFolder

Methods inherited from class com.saperion.connector.rmi.AbstractRMIClientCommand

getRemoteCommand, init, reLogon, reLogonAfterConnectionFailure

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.saperion.connector.rmi.SaRMIClientCommand

addComment, addHistory, changePassword, deleteSetting, executeCommand, getArchivedSize, getAuthorizedUsers, getBoxCount, getBoxDefinitions, getCommandInfos, getCommandInfos, getCommentInfos, getCommitMode, getCompleteHistoryInfos, getDDC, getDeleteMode, getEventsEnabled, getFeatures, getFieldDescriptions, getFieldDescriptions, getFullTextFields, getHistoryInfos, getLicenseCount, getMandant, getMember, getMembers, getOutOfOffice, getParentTask, getRealDBName, getRMIVersion, getServerInfos, getSession, getSetting, getSubstitute, getSystemConnector, getSystemFiles, getSystemInfo, getSystemSetting, getTask, getTaskAuditList, getTaskList, getToken, getUserIdsForQuery, getUsers, getUserSetting, getWorkflowDefinitions, invoke, isAlive, isRevisionEnabled, loadDDCNames, loadFolderDDCNames, loadSettings, loadSystemFile, loadWorkflowDDCName, logoff, logon, resolveLatestHdoc, searchSettings, sendBarcode, setEventsEnabled, setLocale, setOutOfOffice, setSetting, setSubstitute, setUsedLicense, setUserSetting, storeBpmn, storeSystemFile

Constructor Detail

AbstractQueryRMIClientCommand

public AbstractQueryRMIClientCommand()

Method Detail

getIdsFromQuery

public List<String> getIdsFromQuery(String query)
                             throws SaSystemException,
                                    SaAuthenticationException

Executes a HQL query and returns the results as a string list. Currently are only two queries in focus:

• search for hDocs
• search for sysRowIds

Parameters:

query - HQL query

Returns:

String result list

Throws:

SaSystemException - Error on the saperion system

SaAuthenticationException - SaAuthenticationException

See Also:

SaRMIClientCommand.getIdsFromQuery(java.lang.String)

getStringQueryResult

public List<SaDocumentInfo> getStringQueryResult(SaQueryInfo hqlQuery)
                                          throws SaSystemException,
                                                 SaAuthenticationException,
                                                 SaDBException

Executes a given HQL string and returns the results as list.

Parameters:

hqlQuery - HQL query info

Returns:

Result list

Throws:

SaSystemException - Error on the saperion system

SaAuthenticationException - SaAuthenticationException

SaDBException - query execution exception

See Also:

SaRMIClientCommand.getStringQueryResult(com.saperion.rmi.SaQueryInfo)

readDocumentMetadata

public SaPropertyValue[] readDocumentMetadata(String sysRowId,
                                              String ddcName,
                                              String[] fields)
                                       throws SaSystemException,
                                              SaAuthenticationException,
                                              SaGetNodeException

Reads the meta data of the document with the given ID.

Parameters:

sysRowId - The ID of the document (SYSROWID)

ddcName - The name of the database definition

fields - Field names to be read. If empty or null, all fields will be read.

Returns:

The Meta data of the document represented as an array of SaPropertyValue instances.

Throws:

SaSystemException - SaRMICommandException

SaAuthenticationException - SaAuthenticationException

SaGetNodeException - SaGetNodeException

See Also:

SaRMIClientCommand.readDocumentMetadata( java.lang.String, java.lang.String, java.lang.String[])

getFulltext

public String getFulltext(String ddcName,
                          String sysRowId,
                          String hdoc,
                          String fieldName,
                          long length)
                   throws SaSystemException,
                          SaAuthenticationException

Reads the fulltext information for the given document with the given SYSROWID in the given DDC.

Parameters:

ddcName - DDC name of the document

sysRowId - SYSROWID of the document. Can be null if hdoc is set. If both hdoc and sysRowId are set, hdoc will be used.

hdoc - HDOC of the document. Can be null if sysRowId is set. If both hdoc and sysRowId are set, hdoc will be used.

fieldName - name of the fulltext field to retrieve content from. If not set, the first fulltext field of the DDC will be used

length - maximum length of content to retrieve. If -1, the complete content will be returned.

Returns:

Content of the fulltext for this document

Throws:

SaSystemException - SaSystemException

SaAuthenticationException - SaAuthenticationException

See Also:

SaRMIClientCommand.getFulltext(String, String, String, String, long)

getVersionList

public List<String> getVersionList(String ddcName,
                                   String sysrowID)
                            throws SaSystemException,
                                   SaAuthenticationException

Reads the versionlist for the given document.

Parameters:

ddcName - DDC name

sysrowID - SYSROWID

Returns:

List of HDOC's

Throws:

SaSystemException - SaRMICommandException

SaAuthenticationException - SaAuthenticationException

See Also:

SaRMIClientCommand.getVersionList(java.lang.String, java.lang.String)

getHDocForSysRowId

public String getHDocForSysRowId(String sysRowId,
                                 String ddcName)
                          throws SaSystemException,
                                 SaAuthenticationException,
                                 SaDDCException

Searchs the HDOC for the given SysRowId.

Parameters:

sysRowId - SysRowId

ddcName - DDC name

Returns:

Resultset for HDOC's

Throws:

SaSystemException - SaRMICommandException

SaAuthenticationException - SaAuthenticationException

SaDDCException - SaDDCException

See Also:

SaRMIClientCommand.getHDocForSysRowId(java.lang.String, java.lang.String)

startSQLTransaction

public void startSQLTransaction(String ddcName)
                         throws SaSystemException

Start SQL transaction.

Parameters:

ddcName - the name of the ddc

Throws:

SaSystemException - Error on the saperion system

See Also:

SaRMIClientCommand.startSQLTransaction(java.lang.String)

finishSQLTransaction

public void finishSQLTransaction(boolean commit,
                                 String ddcName)
                          throws SaSystemException

Finish SQL transaction.

Parameters:

commit - True, if commit, else rollback

ddcName - the name of the ddc

Throws:

SaSystemException - Error on the saperion system

See Also:

SaRMIClientCommand.finishSQLTransaction(boolean, java.lang.String)

createLookupEntry

@Deprecated
public String createLookupEntry(String ddc,
                                             Properties props)
                                      throws SaSystemException,
                                             SaAuthenticationException,
                                             SaDDCException

Deprecated.

Creates a new entry in the given lookup table and returns the SYSROWID of the new entry.

Parameters:

ddc - Lookup DDC name

props - Properties for the new entry

Returns:

SYSROWID of the new entry

Throws:

SaSystemException - Remote exception

SaAuthenticationException - Authentication error

SaDDCException - Database exception

See Also:

SaRMIClientCommand.createLookupEntry(java.lang.String, java.util.Properties)

deleteLookupEntry

@Deprecated
public void deleteLookupEntry(String ddc,
                                           String id)
                                    throws SaSystemException,
                                           SaAuthenticationException,
                                           SaDDCException

Deprecated.

Deletes an existing lookup entry.

Parameters:

ddc - Lookup DDC name

id - SYSROWID of the existing entry

Throws:

SaSystemException - Remote exception

SaAuthenticationException - Authentication error

SaDDCException - Database exception

See Also:

SaRMIClientCommand.deleteLookupEntry(java.lang.String, java.lang.String)

updateLookupEntry

@Deprecated
public void updateLookupEntry(String ddc,
                                           String id,
                                           Properties props)
                                    throws SaSystemException,
                                           SaAuthenticationException,
                                           SaDDCException

Deprecated.

Updates an existing lookup entry with the given properties.

Parameters:

ddc - Lookup DDC name

id - SYSROWID of the existing entry

props - Properties for the entry

Throws:

SaSystemException - Remote exception

SaAuthenticationException - Authentication error

SaDDCException - Database exception

See Also:

SaRMIClientCommand.updateLookupEntry(java.lang.String, java.lang.String, java.util.Properties)