Collaboration API Documentation

com.filenet.bso.api.util
Interface BsoPersistentDataContainer


public interface BsoPersistentDataContainer

Classes that implement the BsoPersistentDataContainer interface provide functionality similar to the java.util.Properties Java class, but the property data is persisted to the FileNet Content Engine.

Implementations should create a snapshot of the Content Engine data when the object is constructed. Data in the container is refreshed from the Content Engine whenever the user modifies content via put or remove methods.

See Also:
BsoPersistentDataContainerFactory

Field Summary
static java.lang.String ASSOCIATED_SYMNAME
          Value of "PersistentDataContainer"; suggested Content Engine object property name for object associations with other persistent Content Engine objects.
static java.lang.String FILE_EXTENSION
          Value of ".txt"; suggested file extension for names of instances of BsoPersistentDataContainer objects persisted to the Content Engine.
static java.lang.String TITLE_PREFIX
          Value of "persistentData"; suggested prefix for names of instances of BsoPersistentDataContainer objects persisted to the Content Engine.
 
Method Summary
 java.lang.String find(java.lang.String key)
          Returns the property value associated with the given key.
 java.util.Iterator getDataKeys()
          Returns an iterator over a collection of keys to the container data.
 java.util.Iterator getSortedDataKeys()
          Returns a sorted iterator over a collection of keys to the container data.
 void put(java.lang.String[] keys, java.lang.String[] values)
          Stores multiple values in the container and associates them with their respective keys.
 void put(java.lang.String key, java.lang.String value)
          Stores a value in the container and associates it with the given key.
 void remove(java.lang.String keyName)
          Removes a value and key from the container.
 void remove(java.lang.String[] keyNames)
          Removes multiple values and keys from the container.
 

Field Detail

ASSOCIATED_SYMNAME

public static final java.lang.String ASSOCIATED_SYMNAME
Value of "PersistentDataContainer"; suggested Content Engine object property name for object associations with other persistent Content Engine objects.

TITLE_PREFIX

public static final java.lang.String TITLE_PREFIX
Value of "persistentData"; suggested prefix for names of instances of BsoPersistentDataContainer objects persisted to the Content Engine.

FILE_EXTENSION

public static final java.lang.String FILE_EXTENSION
Value of ".txt"; suggested file extension for names of instances of BsoPersistentDataContainer objects persisted to the Content Engine.
Method Detail

find

public java.lang.String find(java.lang.String key)
Returns the property value associated with the given key.

Returns:
A String value associated with the key.

put

public void put(java.lang.String key,
                java.lang.String value)
Stores a value in the container and associates it with the given key. Modifications to container data are immediately persisted to the Content Engine.

Parameters:
key - A String containing the key.

value - A String containing the value to store.

put

public void put(java.lang.String[] keys,
                java.lang.String[] values)
Stores multiple values in the container and associates them with their respective keys. Modifications to container data are immediately persisted to the Content Engine.

Parameters:
keys - A String array containing the keys.

values - A String array containing the values to store.

remove

public void remove(java.lang.String keyName)
Removes a value and key from the container. Modifications to container data are immediately persisted to the Content Engine.

Parameters:
keyName - A String containing the name of the key to remove.

remove

public void remove(java.lang.String[] keyNames)
Removes multiple values and keys from the container. Modifications to container data are immediately persisted to the Content Engine.

Parameters:
keyNames - A String array containing the names of the keys to remove.

getDataKeys

public java.util.Iterator getDataKeys()
Returns an iterator over a collection of keys to the container data.

Returns:
A collection of key names.

getSortedDataKeys

public java.util.Iterator getSortedDataKeys()
Returns a sorted iterator over a collection of keys to the container data.

Returns:
A collection of sorted key names.

Collaboration API Documentation

Copyright ?2002 - 2005 FileNet Corporation. All rights reserved.