com.saperion.operations.inject

Interface DatabaseSession

public interface DatabaseSession

Abstraction layer for database calls.

Author:

jschwarz

Method Summary

Modifier and Type	Method and Description
Map<String,Object>	getCompleteDocumentById(DDC definition, String id) Gets the database properties of the document given by its SysRowId.
Map<String,Object>	getDocumentById(DDC definition, String id) Gets the database properties of the document given by its SysRowId.
Map<String,Object>	getUniqueDocument(DDC definition, QueryExpression<Boolean> condition) Gets the database properties of the unique document that fulfill the given condition.
List<Map<String,Object>>	rawSearch(DDC definition, QueryExpression<Boolean> filter) Gets the list of database properties of the documents that match the given filter.
List<Map<String,Object>>	searchDocuments(DDC definition, QueryExpression<Boolean> filter) Gets the list of database properties of the documents that match the given filter.

Method Detail

getDocumentById

Map<String,Object> getDocumentById(DDC definition,
                                   String id)
                            throws SaRMIDBException

Gets the database properties of the document given by its SysRowId. Will return null if the id is not found.

Parameters:

definition - the definition to search in

id - the sysrowid to search for

Returns:

the Database properties of the document given by its SysRowId or null if the id is not found

Throws:

SaRMIDBException

getCompleteDocumentById

Map<String,Object> getCompleteDocumentById(DDC definition,
                                           String id)
                                    throws SaRMIDBException

Gets the database properties of the document given by its SysRowId. Will return null if the id is not found. Opposed to getDocumentById(com.saperion.intf.DDC, String) this call will also return system fields for internal use.

Parameters:

definition - the definition to search in

id - the sysrowid to search for

Returns:

the Database properties of the document given by its SysRowId or null if the id is not found

Throws:

SaRMIDBException

getUniqueDocument

Map<String,Object> getUniqueDocument(DDC definition,
                                     QueryExpression<Boolean> condition)
                              throws SaRMIDBException

Gets the database properties of the unique document that fulfill the given condition. If no such document exists null will be returned. If several such documents exist an exception will be thrown.

Parameters:

definition - the definition to search in

condition - the search filter

Returns:

the database properties of the unique document that fulfill the given condition or null if no such document exists

Throws:

SaRMIDBException

searchDocuments

List<Map<String,Object>> searchDocuments(DDC definition,
                                         QueryExpression<Boolean> filter)
                                  throws SaRMIDBException

Gets the list of database properties of the documents that match the given filter.

Parameters:

definition - the definition to search in

filter - the search filter

Returns:

the list of database properties of the documents that match the given filter.

Throws:

SaRMIDBException

rawSearch

List<Map<String,Object>> rawSearch(DDC definition,
                                   QueryExpression<Boolean> filter)
                            throws SaRMIDBException

Gets the list of database properties of the documents that match the given filter. IMPORTANT: This method skips checks like for sysclient or sysacluserlist. Use with caution.

Parameters:

definition - the definition to search in

filter - the search filter

Returns:

the list of database properties of the documents that match the given filter.

Throws:

SaRMIDBException