- TIBCO BusinessEvents®
- ActiveSpaces(Deprecated)
- AS

# AS

## Description

AS Client Functions

## Functions

Name | Signature and Synopsis
--- | ---
`beginTransaction` | `void beginTransaction(String channelUri)` Start a transaction
`commitTransaction` | `void commitTransaction(String channelUri)` Commit a transaction
`getConceptBlobFromPayload` | `Object getConceptBlobFromPayload(SimpleEvent event, String blobFieldName, Concept conceptTemplate)` Get Concept's Blob from the payload of SimpleEvent
`getConsumptionMode` | `String getConsumptionMode(SimpleEvent event)` Gets the Event consumption mode.
`getEvent` | `Object getEvent(String destinationUri, SimpleEvent key)` Get the event with specific key from Space
`getEventType` | `String getEventType(SimpleEvent event)` Gets the event type.
`getEvents` | `Object[] getEvents(String destinationUri, SimpleEvent[] keys)` Get the event result set
`getSimpleEventBlobFromPayload` | `Object getSimpleEventBlobFromPayload(SimpleEvent event, String blobFieldName, SimpleEvent eventTemplate)` Get SimpleEvent's Blob from the payload of SimpleEvent
`lockEvent` | `Object lockEvent(String destinationUri, SimpleEvent event, Object... options)` Locks the event associated with a key event value. If lock operation is a success, matching tuple is returned (or null if no match is found), and lock must be released subsequently. If lock operation fails (e.g. due to specified timeout) then an exception is thrown with 'LOCKED (entry_lock_timeout)' message, which must be handled by the caller.
`lockEvents` | `Object[] lockEvents(String destinationUri, SimpleEvent[] keys, Object... options)` Batch lock operation
`putEvent` | `Object putEvent(String destinationUri, SimpleEvent event)` Stores a event into the Space and returns the corresponding entry
`putEvents` | `Object[] putEvents(String destinationUri, SimpleEvent[] keys)` Batch put operation
`query` | `Object[] query(String destinationUri, SimpleEvent eventTemplate, String browserTypeStr, String timeScope, String distributionScope, int timeout, long prefetch, String filter)` Retrieves the entries that match the conditions you specified in the associated Space
`queryIterator` | `Object queryIterator(String destinationUri, SimpleEvent eventTemplate, String browserTypeStr, String timeScope, String distributionScope, int timeout, long prefetch, String filter)` Retrieves the iterator of entries that match the conditions you specified in the associated Space
`releaseTransaction` | `Object releaseTransaction(String channelUri)` Return TransationId if the thread is in a transaction. TransactionId can then be given to another thread to continue transaction
`rollbackTransaction` | `void rollbackTransaction(String channelUri)` Rollback a transaction
`takeEvent` | `Object takeEvent(String destinationUri, SimpleEvent key)` Returns and atomically removes from the space the event (if one exists) whose event key fields match the key fields of the event provided
`takeEvents` | `Object[] takeEvents(String destinationUri, SimpleEvent[] keys)` Batch take operation
`takeSnapshot` | `Object[] takeSnapshot(String destinationUri, SimpleEvent eventTemplate, String browserTypeStr, String distributionScope, int timeout, long prefetch, String filter)` Take snapshot of the entries that match the conditions you specified in the associated Space
`takeTransaction` | `void takeTransaction(String channelUri, Object transactionId)` Take TransactionId to continue transaction
`unlockEvent` | `void unlockEvent(String destinationUri, SimpleEvent event, Object... options)` Unlocks the event associated with a key event value. If unlock operation fails (e.g. due to specified timeout) then an exception is thrown with 'LOCKED (entry_lock_timeout)' message, which must be handled by the caller.
`unlockEvents` | `Object[] unlockEvents(String destinationUri, SimpleEvent[] keys, Object... options)` Batch unlock operation