NativeQueryHandler (Cyclos 4.8.3 Scripting API Documentation)

All Superinterfaces:

org.cyclos.impl.CustomBean
```
public interface NativeQueryHandler
extends org.cyclos.impl.CustomBean
```
Single place which contains the native queries

Author:

luis

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`long`	`copyLargeObject(long sourceOid)` Makes a copy of the large object with the specified oid and returns the oid of the copy.
`org.cyclos.impl.locks.Lock`	`createLock(org.cyclos.impl.locks.LockType type, java.lang.Long id, long timeoutMillis)` Creates a database lock for the given type and entity identifier, waiting the maximum time as the given timeout in millis
`void`	`deleteLargeObject(long oid)` Deletes the large object with the specified oid.
`java.lang.String`	`dictionaryFor(BuiltinLanguage language)` Returns the name of the dictionary used for the given language
`org.cyclos.impl.banking.NativeAccountStatus`	`getAccountStatus(Account account, java.util.Date date)` Returns the native account status at a given date
`com.querydsl.jpa.JPQLTemplates`	`getJpaQueryTemplates()` Returns the templates used for jpa queries
`java.lang.Long`	`getObjectId(long id)` Returns the oid associated to the specified stored file id.
`UsersWithBalancesOverview`	`getUsersWithBalancesOverview(UserWithBalanceQuery params)` Returns the overview summaries of users with balances search according to the given parameters
`long`	`insertAccountsPendingToCharge(AccountFeeLog log)` Inserts the references for the accounts pending to charge the given account fee log
`long`	`insertMailings(MailingList mailingList)` Inserts mailings for all users for a given mailing list message
`void`	`insertTransferInitialStatus(TransferType transferType, TransferStatus status)` Inserts the relation for current status and a log for each transfer of the given type
`void`	`insertUserIncomingMessages(SendMessageDTO sendMessage, MessageOwner messageOwner, User sendingUser, OutgoingMessage outgoing)` Inserts incoming messages for users for a given outgoing message
`long`	`insertUsersForBulkAction(java.lang.Long bulkActionId, UserQuery query)` Inserts a record of `BulkActionUser` for each returned user of the given query
`boolean`	`isFullTextQuerySupported()` Returns whether full-text queries are supported
`boolean`	`isPhraseSearchSupported()` Returns whether phrase searches are supported within full-text queries
`com.mysema.commons.lang.CloseableIterator<Record>`	`iterateRecords(RecordQuery params)` Iterates record entities according to the given query parameters
`com.mysema.commons.lang.CloseableIterator<java.lang.Long>`	`iterateUserIds(UserQuery query)` Iterates user ids according to the given query parameters
`com.mysema.commons.lang.CloseableIterator<UserWithFieldsVO>`	`iterateUsers(UserQuery query)` Iterates user entities according to the given query parameters
`java.util.List<DictionaryVO>`	`listDictionaries()` Returns a list of existing full text dictionaries
`java.util.List<java.lang.Long>`	`nextAccountIdsToClose(int maxCount, java.util.Date limit, int paymentsThreshold)` Returns up to the maximum count of account ids to close balance, limiting to accounts which have been closed at most at the given date, and having at minimum the given number of payments pending closing
`java.io.InputStream`	`openLargeObject(long oid)` Opens the large object associated to the specified oid. NOTE: After read, the input stream must be closed (the large object will be closed in turn).
`Pair<java.util.Set<java.lang.String>,java.util.Set<java.lang.Long>>`	`purgeRemovedBuiltinLanguages()` Removes all languages that were pointing to `BuiltinLanguage`s that no longer exist, returning both the language templates that no longer exist and the ids of languages that were removed
`void`	`reindexNetwork(java.lang.Long networkId)` Reindex all data within the given network (probably because the dictionaries definitions have changed)
`void`	`reindexTranslations()` Reindex translation files, allowing searching for keys which are not customized
`void`	`removeFromContacts(User user)` Removes all rows in the contacts relation where the given user is on either side
`Page<BasicAdVO>`	`searchAds(BasicAdQuery params)` Searches for advertisement according to the given query
`Page<Record>`	`searchRecords(RecordQuery params)` Searches for user records according to the given query parameters
`Page<TranslationKeyVO>`	`searchTranslationKeys(TranslationQuery params)` Searches for translation keys according o the given query parameters
`Page<UserWithFieldsVO>`	`searchUsers(UserQuery query)` Searches for users according to the given query parameters
`Page<UserWithBalanceVO>`	`searchUsersWithBalance(UserWithBalanceQuery params)` Searches for users including the account balance, according to the given query parameters
`void`	`setObjectId(long storedFileId, long oid)` Sets the oid to the specified stored file id.
`boolean`	`supportsBlobsInReadOnlyTransactions()` Returns whether the underlying database supports accessing BLOBs from pure read-only transactions
`long`	`writeLargeObject(java.io.InputStream in)` Creates a new large object reading the content from the stream and returns its oid. NOTE: The input stream parameter won't be closed it is responsibility of the client code.

- Method Detail
  - copyLargeObject
```
long copyLargeObject(long sourceOid)
              throws java.io.IOException
```
    Makes a copy of the large object with the specified oid and returns the oid of the copy.
    
    Throws:
    
    java.io.IOException
  - createLock
```
org.cyclos.impl.locks.Lock createLock(org.cyclos.impl.locks.LockType type,
                                      java.lang.Long id,
                                      long timeoutMillis)
                               throws LockAcquisitionException
```
    Creates a database lock for the given type and entity identifier, waiting the maximum time as the given timeout in millis
    
    Throws:
    
    LockAcquisitionException
  - deleteLargeObject
```
void deleteLargeObject(long oid)
```
    Deletes the large object with the specified oid.
  - dictionaryFor
```
java.lang.String dictionaryFor(BuiltinLanguage language)
```
    Returns the name of the dictionary used for the given language
  - getAccountStatus
```
org.cyclos.impl.banking.NativeAccountStatus getAccountStatus(Account account,
                                                             java.util.Date date)
```
    Returns the native account status at a given date
  - getJpaQueryTemplates
```
com.querydsl.jpa.JPQLTemplates getJpaQueryTemplates()
```
    Returns the templates used for jpa queries
  - getObjectId
```
java.lang.Long getObjectId(long id)
```
    Returns the oid associated to the specified stored file id. Returns null if the stored file doesn't have any associated content.
  - getUsersWithBalancesOverview
```
UsersWithBalancesOverview getUsersWithBalancesOverview(UserWithBalanceQuery params)
```
    Returns the overview summaries of users with balances search according to the given parameters
  - insertAccountsPendingToCharge
```
long insertAccountsPendingToCharge(AccountFeeLog log)
```
    Inserts the references for the accounts pending to charge the given account fee log
  - insertMailings
```
long insertMailings(MailingList mailingList)
```
    Inserts mailings for all users for a given mailing list message
    
    Returns:
    
    the quantity of users that the mailing list is sending
  - insertTransferInitialStatus
```
void insertTransferInitialStatus(TransferType transferType,
                                 TransferStatus status)
```
    Inserts the relation for current status and a log for each transfer of the given type
  - insertUserIncomingMessages
```
void insertUserIncomingMessages(SendMessageDTO sendMessage,
                                MessageOwner messageOwner,
                                User sendingUser,
                                OutgoingMessage outgoing)
```
    Inserts incoming messages for users for a given outgoing message
  - insertUsersForBulkAction
```
long insertUsersForBulkAction(java.lang.Long bulkActionId,
                              UserQuery query)
```
    Inserts a record of BulkActionUser for each returned user of the given query
  - isFullTextQuerySupported
```
boolean isFullTextQuerySupported()
```
    Returns whether full-text queries are supported
  - isPhraseSearchSupported
```
boolean isPhraseSearchSupported()
```
    Returns whether phrase searches are supported within full-text queries
  - iterateRecords
```
com.mysema.commons.lang.CloseableIterator<Record> iterateRecords(RecordQuery params)
```
    Iterates record entities according to the given query parameters
  - iterateUserIds
```
com.mysema.commons.lang.CloseableIterator<java.lang.Long> iterateUserIds(UserQuery query)
```
    Iterates user ids according to the given query parameters
  - iterateUsers
```
com.mysema.commons.lang.CloseableIterator<UserWithFieldsVO> iterateUsers(UserQuery query)
```
    Iterates user entities according to the given query parameters
  - listDictionaries
```
java.util.List<DictionaryVO> listDictionaries()
```
    Returns a list of existing full text dictionaries
  - nextAccountIdsToClose
```
java.util.List<java.lang.Long> nextAccountIdsToClose(int maxCount,
                                                     java.util.Date limit,
                                                     int paymentsThreshold)
```
    Returns up to the maximum count of account ids to close balance, limiting to accounts which have been closed at most at the given date, and having at minimum the given number of payments pending closing
  - openLargeObject
```
java.io.InputStream openLargeObject(long oid)
```
    Opens the large object associated to the specified oid.
    NOTE: After read, the input stream must be closed (the large object will be closed in turn).
  - purgeRemovedBuiltinLanguages
```
Pair<java.util.Set<java.lang.String>,java.util.Set<java.lang.Long>> purgeRemovedBuiltinLanguages()
```
    Removes all languages that were pointing to BuiltinLanguages that no longer exist, returning both the language templates that no longer exist and the ids of languages that were removed
  - reindexNetwork
```
void reindexNetwork(java.lang.Long networkId)
```
    Reindex all data within the given network (probably because the dictionaries definitions have changed)
  - reindexTranslations
```
void reindexTranslations()
```
    Reindex translation files, allowing searching for keys which are not customized
  - removeFromContacts
```
void removeFromContacts(User user)
```
    Removes all rows in the contacts relation where the given user is on either side
  - searchAds
```
Page<BasicAdVO> searchAds(BasicAdQuery params)
```
    Searches for advertisement according to the given query
  - searchRecords
```
Page<Record> searchRecords(RecordQuery params)
```
    Searches for user records according to the given query parameters
  - searchTranslationKeys
```
Page<TranslationKeyVO> searchTranslationKeys(TranslationQuery params)
```
    Searches for translation keys according o the given query parameters
  - searchUsers
```
Page<UserWithFieldsVO> searchUsers(UserQuery query)
```
    Searches for users according to the given query parameters
  - searchUsersWithBalance
```
Page<UserWithBalanceVO> searchUsersWithBalance(UserWithBalanceQuery params)
```
    Searches for users including the account balance, according to the given query parameters
  - setObjectId
```
void setObjectId(long storedFileId,
                 long oid)
```
    Sets the oid to the specified stored file id.
  - supportsBlobsInReadOnlyTransactions
```
boolean supportsBlobsInReadOnlyTransactions()
```
    Returns whether the underlying database supports accessing BLOBs from pure read-only transactions
  - writeLargeObject
```
long writeLargeObject(java.io.InputStream in)
               throws java.io.IOException
```
    Creates a new large object reading the content from the stream and returns its oid.
    NOTE: The input stream parameter won't be closed it is responsibility of the client code.
    
    Throws:
    
    java.io.IOException

Interface NativeQueryHandler

Method Summary

Method Detail

copyLargeObject

createLock

deleteLargeObject

dictionaryFor

getAccountStatus

getJpaQueryTemplates

getObjectId

getUsersWithBalancesOverview

insertAccountsPendingToCharge

insertMailings

insertTransferInitialStatus

insertUserIncomingMessages

insertUsersForBulkAction

isFullTextQuerySupported

isPhraseSearchSupported

iterateRecords

iterateUserIds

iterateUsers

listDictionaries

nextAccountIdsToClose

openLargeObject

purgeRemovedBuiltinLanguages

reindexNetwork

reindexTranslations

removeFromContacts

searchAds

searchRecords

searchTranslationKeys

searchUsers

searchUsersWithBalance

setObjectId

supportsBlobsInReadOnlyTransactions

writeLargeObject