- TIBCO BusinessEvents®
- ActiveSpaces(Deprecated)
- Metaspace
- Space
- Options

# Metaspace.Space.Options

## Description

Options functions

## Functions

Name | Signature and Synopsis
--- | ---
`createPutOptions` | `Object createPutOptions ()` Used to instantiate an instance of a PutOptions object.
`createTakeOptions` | `Object createTakeOptions()` Used to instantiate an instance of a TakeOptions object.
`getLockWait` | `long getLockWait (Object options)` Retrieve the current setting for the amount of time to wait for the lock on the key of an existing tuple.
`getTTL` | `long getTTL (Object options)` Retrieve the current setting for the number of milliseconds to use as an entry's time to live.
`isForget` | `boolean isForget (Object options)` For TakeOptions - Retrieve the current setting for whether or not to return the tuple taken from a space using this TakeOptions object. For PutOptions -Retrieve whether tuples, which already exist in a space, should be returned as the return values of put operations, or whether the existing tuples should be "forgotten" and not returned.
`isLock` | `boolean isLock (Object options)` For TakeOptions - Retrieve the current setting for whether or not to lock the key of a tuple after it is removed from a space. For PutOptions - Retrieve whether or not to lock the key of a tuple after it is stored into the space.
`isUnlock` | `boolean isUnlock (Object options)` For TakeOptions - Retrieve the current setting for whether or not to unlock the key of a tuple after it is removed from a space. For PutOptions - Retrieve whether or not to unlock the key of a tuple after it is stored into a space.
`setForget` | `Object setForget (Object options, boolean forget)` For TakeOptions - Specify whether or not to return the tuple taken from a space using this TakeOptions object. For PutOptions - Specifies whether a tuple, which already exists in the space, should be returned as the return value of a put operation.
`setLock` | `Object setLock (Object options, boolean lock)` For TakeOptions - Specify whether or not to lock the key of a tuple after it is removed from a space. For PutOptions - Specify whether or not to lock the key of a tuple after the tuple has been stored in a space.
`setLockWait` | `Object setLockWait (Object options, long lockWait)` For TakeOptions - Specify the amount of time to wait to acquire the lock on an existing locked tuple. For PutOptions - Specify the amount of time to wait to acquire the lock on the key of an existing tuple.
`setTTL` | `Object setTTL (Object options, long ttl)` Specify the time to live for entries stored into a space using this PutOptions object. WAIT_FOREVER means that an entry will never expire.
`setUnlock` | `Object setUnlock (Object options, boolean unlock)` For TakeOptions - Specify whether or not to unlock the key of a tuple after it is removed from a space. For PutOptions - Specify whether or not to unlock the key after storing a tuple into a space