TradingAgreementRegistry

java.lang.Object
- com.ibm.commerce.registry.AbstractManagedDynamicCacheRegistry
- - com.ibm.commerce.registry.TradingAgreementRegistry

All Implemented Interfaces:

ElementUpdate, ManagedDynamicCache, Registry
```
public class TradingAgreementRegistry
extends AbstractManagedDynamicCacheRegistry
```
This class defines the registry where the trading agreements are cached.

Constructor Summary

Constructors
Constructor and Description

TradingAgreementRegistry()
TradingAgreementRegistry constructor.

Constructors
Constructor and Description
`TradingAgreementRegistry()` TradingAgreementRegistry constructor.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addElement(TradingAgreementAccessBean tradingAgreement)` This method adds a `TradingAgreementAccessBean` object to the list.
`java.lang.Object`	`createKey(java.lang.String strKey)` This method creates a cache key.
`java.lang.String`	`createKeyString(TypedProperty prop)` This method creates a cache key
`TradingAgreementAccessBean`	`find(java.lang.String key)` This method returns the `TradingAgreementAccessBean` with a given id from the cache.
`TradingAgreementAccessBean[]`	`findAll(java.lang.String[] taIdStr)` This method returns all the `TradingAgreementAccessBean` objects with the given ids from the cache.
`TradingAgreementAccessBean[]`	`getAll()` This method returns all the `TradingAgreementAccessBean` objects in the cache
`void`	`initialize()` This method initializes the `TradingAgreementRegistry` object.
`void`	`populate(com.ibm.commerce.registry.LRUDynamicHashtable aCache)` This method populates the cache.
`void`	`putAll(TradingAgreementAccessBean[] ta)` This method will store the given `TradingAgreementAccessBean` object in the registry.
`void`	`refresh()` This method this method refreshes the trading agreement registry from the database.
`void`	`refreshDependentRegistry(java.lang.String astrRegistryName)` This method refreshes a dependent registry.
`java.lang.Object`	`retrieve(java.lang.Object key)` This method retrieves a `TradingAgreementAccessBean` object from the database.
`static TradingAgreementRegistry`	`singleton()` This method returns a singleton instance of the trading agreement registry.
`void`	`update(java.lang.String action, java.lang.Object key)` This method updates a given trading agreement element.
`void`	`updateDependentRegistry(java.lang.String astrRegistryName, java.lang.String astrAction, java.lang.Object aKey)` This method updates a dependent registry.

Methods inherited from class com.ibm.commerce.registry.AbstractManagedDynamicCacheRegistry
addElement, findObject, getCache, getCacheSize, getElement, getElementCount, getElements, getEvictions, getHits, getKeys, getMisses, getUsedCacheSize, removeAllElements, removeElement, setCache, setCacheSize, setInitialCapacity, setLoadFactor

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - TradingAgreementRegistry
```
public TradingAgreementRegistry()
```
    TradingAgreementRegistry constructor.
- Method Detail
  - addElement
```
public void addElement(TradingAgreementAccessBean tradingAgreement)
```
    This method adds a TradingAgreementAccessBean object to the list.
    
    Parameters:
    
    tradingAgreement - The TradingAgreementAccessBean to be added to the list.
  - find
```
public TradingAgreementAccessBean find(java.lang.String key)
                                throws java.lang.Exception
```
    This method returns the TradingAgreementAccessBean with a given id from the cache.
    
    Parameters:
    
    key - The trading agreement identifier.
    
    Returns:
    
    A TradingAgreementAccessBean object.
    
    Throws:
    
    java.lang.Exception
  - findAll
```
public TradingAgreementAccessBean[] findAll(java.lang.String[] taIdStr)
                                     throws java.lang.Exception
```
    This method returns all the TradingAgreementAccessBean objects with the given ids from the cache.
    
    Parameters:
    
    taIdStr - The list of trading agreement identifiers.
    
    Returns:
    
    An array of TradingAgreementAccessBean objects.
    
    Throws:
    
    java.lang.Exception
  - getAll
```
public TradingAgreementAccessBean[] getAll()
```
    This method returns all the TradingAgreementAccessBean objects in the cache
    
    Returns:
    
    An array of TradingAgreementAccessBean objects.
  - initialize
```
public void initialize()
                throws java.lang.Exception
```
    This method initializes the TradingAgreementRegistry object. This will include the initialization of the WcsApp object with this instance of the registry.
    
    Specified by:
    
    initialize in interface Registry
    
    Overrides:
    
    initialize in class AbstractManagedDynamicCacheRegistry
    
    Throws:
    
    java.lang.Exception
  - putAll
```
public void putAll(TradingAgreementAccessBean[] ta)
```
    This method will store the given TradingAgreementAccessBean object in the registry.
    
    Parameters:
    
    ta - An array of TradingAgreementAccessBean objects.
  - updateDependentRegistry
```
public void updateDependentRegistry(java.lang.String astrRegistryName,
                                    java.lang.String astrAction,
                                    java.lang.Object aKey)
```
    This method updates a dependent registry.
    
    Parameters:
    
    astrRegistryName - The registry name.
    
    astrAction - The action.
    
    aKey - The key.
    
    Throws:
    
    java.lang.Exception
  - refreshDependentRegistry
```
public void refreshDependentRegistry(java.lang.String astrRegistryName)
```
    This method refreshes a dependent registry.
    
    Parameters:
    
    astrRegistryName - The registry name.
    
    Throws:
    
    java.lang.Exception
  - refresh
```
public void refresh()
             throws java.lang.Exception
```
    This method this method refreshes the trading agreement registry from the database.
    
    Specified by:
    
    refresh in interface Registry
    
    Overrides:
    
    refresh in class AbstractManagedDynamicCacheRegistry
    
    Throws:
    
    java.lang.Exception
  - singleton
```
public static TradingAgreementRegistry singleton()
```
    This method returns a singleton instance of the trading agreement registry.
    
    Returns:
    
    A singleton TradingAgreementRegistry object
  - update
```
public void update(java.lang.String action,
                   java.lang.Object key)
            throws java.lang.Exception
```
    This method updates a given trading agreement element.
    
    Specified by:
    
    update in interface ElementUpdate
    
    Overrides:
    
    update in class AbstractManagedDynamicCacheRegistry
    
    Parameters:
    
    action - The action. Valid actions are 'add', 'delete' and 'update'.
    
    key - The key that identifies a particular element.
    
    Throws:
    
    java.lang.Exception
  - retrieve
```
public java.lang.Object retrieve(java.lang.Object key)
                          throws java.lang.Exception
```
    This method retrieves a TradingAgreementAccessBean object from the database.
    
    Specified by:
    
    retrieve in class AbstractManagedDynamicCacheRegistry
    
    Parameters:
    
    key - The key used to locate the object in the database.
    
    Returns:
    
    The TradingAgreementAccessBean object found from the given key.
    
    Throws:
    
    java.lang.Exception
  - populate
```
public void populate(com.ibm.commerce.registry.LRUDynamicHashtable aCache)
              throws java.lang.Exception
```
    This method populates the cache.
    
    Specified by:
    
    populate in class AbstractManagedDynamicCacheRegistry
    
    Parameters:
    
    aCache - The Hashtable to be populated
    
    Throws:
    
    java.lang.Exception
  - createKeyString
```
public java.lang.String createKeyString(TypedProperty prop)
                                 throws java.lang.Exception
```
    This method creates a cache key
    
    Specified by:
    
    createKeyString in interface ElementUpdate
    
    Specified by:
    
    createKeyString in class AbstractManagedDynamicCacheRegistry
    
    Parameters:
    
    prop - The input properties
    
    Returns:
    
    a cache key
    
    Throws:
    
    java.lang.Exception
  - createKey
```
public java.lang.Object createKey(java.lang.String strKey)
                           throws java.lang.Exception
```
    This method creates a cache key.
    
    Specified by:
    
    createKey in interface ElementUpdate
    
    Specified by:
    
    createKey in class AbstractManagedDynamicCacheRegistry
    
    Parameters:
    
    strkey - The cache key represented as a String object.
    
    Returns:
    
    A cache key.
    
    Throws:
    
    java.lang.Exception

Methods inherited from class com.ibm.commerce.registry.AbstractManagedDynamicCacheRegistry

Methods inherited from class java.lang.Object

TradingAgreementRegistry

addElement

find

findAll

getAll

initialize

putAll

updateDependentRegistry

refreshDependentRegistry

refresh

singleton

update

retrieve

populate

createKeyString

createKey