Collaboration API Documentation

com.filenet.bso.api.util
Interface BsoPropertyMap


public interface BsoPropertyMap

The BsoPropertyMap interface provides a simple map object in which both property keys and values are limited to string values.


Method Summary
 void clear()
          Removes all property keys and their values.
 void copy(BsoPropertyMap source)
          Copies all of the property keys and values from the source BsoPropertyMap object to this object.
 java.lang.String getProperty(java.lang.String key)
          Returns the value associated with the given property key.
 java.util.Iterator getPropertyKeys()
          Returns an iterator over a collection of property key names.
 boolean isEmpty()
          Returns a boolean that indicates whether or not the map has properties.
 void removeProperty(java.lang.String key)
          Removes the given property key and value from this map.
 void setProperty(java.lang.String key, java.lang.String value)
          Sets a property value and key into this map.
 int size()
          Returns the number of property key/value pairs in this map.
 

Method Detail

clear

public void clear()
Removes all property keys and their values.

copy

public void copy(BsoPropertyMap source)
Copies all of the property keys and values from the source BsoPropertyMap object to this object.

Parameters:
source - The source BsoPropertyMap object.

getProperty

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

Parameters:
key - The property key name associated with the value.

Returns:
The property value.

getPropertyKeys

public java.util.Iterator getPropertyKeys()
Returns an iterator over a collection of property key names.

Returns:
A collection of property key names.

isEmpty

public boolean isEmpty()
Returns a boolean that indicates whether or not the map has properties. true if map has no properties.

Returns:
true if the map has no properties; returns false if properties are present.

removeProperty

public void removeProperty(java.lang.String key)
Removes the given property key and value from this map.

Parameters:
key - A String that contains the property key name to remove.

setProperty

public void setProperty(java.lang.String key,
                        java.lang.String value)
Sets a property value and key into this map.

Parameters:
key - A String that contains the property key.

value - A String that contains the property value.

size

public int size()
Returns the number of property key/value pairs in this map.

Returns:
An integer representing the number of property key/value pairs.

Collaboration API Documentation

Copyright © 2002 - 2004 FileNet Corporation. All rights reserved.