Memory Adapter Reference
This page explains the Memory Adapter in Bridge context. If you were looking for the same information regarding the PAS Designer, refer to Memory Adapter in the Designer guide.
Tagged Values (<<MemoryAdapter>>)
| Attribute | Description | Allowed Values | |
|---|---|---|---|
| action | Supply the action you want to perform. | store | Store a value to memory. |
| retrieve | Retrieve a value from memory. | ||
| remove | Remove a value from memory. | ||
| clear | Clear the memory. | ||
| scope | Supply the scope of the operation. | global | The stored data is accessible globally to the service, and available across service calls (default). |
| session | The stored data is accessible within a service call. | ||
Parameters
store
Store a value to memory.
Name | Type | Direction | Description |
|---|---|---|---|
| key | String | in | Set a key that can be used to access the stored value with the Memory Adapter Reference#retrieve operation. |
| value | Any | in | Provide the data that should be stored to the memory. |
| hashMapKey | String | in | In case the stored value is a hash map, you can use hashMapKey to provide the key of a hash map entry you want to override. Refer to Using the Memory Adapter with Maps for more information on this. |
| oldValue | Any | out | If the provided key is already present in the memory, it gets overwritten. In this case, oldValue returns the previous value. If no old value is present, oldValue is NULL. In case value contains a hash map, oldValue returns the complete previously stored hash map. |
retrieve
Retrieve a value from memory.
Name | Type | Direction | Description |
|---|---|---|---|
| key | String | in | Provide the key of the value that has been stored to memory with Memory Adapter Reference#store. If no value with this key can be found, the Memory adapter throws error MEMADSM/9. |
| hashMapKey | String | in | In case the stored value is a hash map, you can use hashMapKey to retrieve a dedicated value from the map. Refer to Using the Memory Adapter with Maps for more information on this. |
| value | Any | out | Returns the either the stored value, or the map entry. |
remove
Remove a value from memory.
Name | Type | Direction | Description |
|---|---|---|---|
| key | String | in | Provide the key of the value that has been stored to memory with Memory Adapter Reference#store. If no value with this key can be found, the Memory adapter throws error MEMADSM/12. |
| hashMapKey | String | in | In case the stored value is a hash map, you can use hashMapKey to provide the key of a hash map entry you want to remove. Refer to Using the Memory Adapter with Maps for more information on this. |
| oldValue | Any | out | Returns the value of the memory item that has been removed. In case value contains a hash map, oldValue returns the complete previously stored hash map. |
clear
Clear all stored data. No parameters.
Related Pages: