com.netegrity.llsdk6.imsapi.collections
Interface PropertyDict

All Superinterfaces:

java.lang.Cloneable, java.util.Map, java.io.Serializable

public interface PropertyDict
extends java.io.Serializable, java.lang.Cloneable, java.util.Map

Contains a tab's configuration parameters as defined in the Identity Manager User Console. Identity Manager sets the configuration parameter values in this object.

Identity Manager passes the defined PropertyDict object into a tab's initialize() method.

Since:

IdentityMinder 6.0

Nested Class Summary

Nested classes/interfaces inherited from interface java.util.Map

java.util.Map.Entry<K,V>

Method Summary

void	clear() Clears all entries in the property dictionary.
java.lang.Object	clone() This is a public override of Object.clone() to make it accessible -- typically used by Identity Manager.
boolean	containsKey(java.lang.String name) Determines if this property dictionary contains a value for the specified property name.
boolean	getBool(java.lang.String name) Retrieves a boolean configuration parameter by name.
java.lang.Boolean	getBoolean(java.lang.String name) Retrieves a Boolean configuration parameter by name.
java.lang.String	getDictName() Retrieves the name of this property dictionary.
int	getInt(java.lang.String name) Retrieves an int configuration parameter by name.
java.lang.Integer	getInteger(java.lang.String name) Retrieves an Integer configuration parameter by name.
java.lang.String	getKeyIgnoreCase(java.lang.String key) Does a case insensitive search for the specified key name and returns the key name from the PropertyDict map.
long	getLong(java.lang.String name) Retrieves a long configuration parameter by name.
java.lang.String	getString(java.lang.String name) Retrieves a String configuration parameter by name (decoding CDATA-wrapped script if necessary).
java.lang.String	getString(java.lang.String name, boolean bDecode) Retrieves a String configuration parameter by name (decoding is optional).
boolean	isEmpty() Determines if there are any properties in the dictionary.
java.util.Enumeration	keys() Retrieves the keys of the property dictionary.
boolean	remove(java.lang.String name) Removes the specified property from the dictionary.
void	setBool(java.lang.String name, boolean value) Sets a boolean configuration parameter by name.
void	setBoolean(java.lang.String name, java.lang.Boolean value) Sets a Boolean configuration parameter by name.
void	setDictName(java.lang.String name) Sets the name of this property dictionary -- typically used by Identity Manager.
void	setInt(java.lang.String name, int value) Sets an int configuration parameter by name.
void	setInteger(java.lang.String name, java.lang.Integer value) Sets an Integer configuration parameter by name.
void	setLong(java.lang.String name, long value) Sets a long configuration parameter by name.
void	setString(java.lang.String name, java.lang.String value) Sets a String configuration parameter by name.
void	setString(java.lang.String name, java.lang.String value, boolean bCDataEncode) Sets a String configuration parameter by name.
int	size() Returns the number of properties in the dictionary.

Methods inherited from interface java.util.Map

containsKey, containsValue, entrySet, equals, get, hashCode, keySet, put, putAll, remove, values

Method Detail

containsKey

boolean containsKey(java.lang.String name)

Determines if this property dictionary contains a value for the specified property name.

Parameters:

name - The property name.

Returns:

true if the property dictionary contains a value for the specified property, or false otherwise.

getDictName

java.lang.String getDictName()

Retrieves the name of this property dictionary. Any given LinkedDataCollection can have multiple dictionaries, but each must have a unique name.

Returns:

The name of the current property dictionary.

setDictName

void setDictName(java.lang.String name)

Sets the name of this property dictionary -- typically used by Identity Manager. Any given LinkedDataCollection can have multiple dictionaries, but each must have a unique name.

Parameters:

name - A String containing the name to set.

getKeyIgnoreCase

java.lang.String getKeyIgnoreCase(java.lang.String key)

Does a case insensitive search for the specified key name and returns the key name from the PropertyDict map. If the key does not exist it simply returns the key passed. This is to insure we do not create a duplicate key because the key contained the PropertyDict map is the same name, but in different case.

Parameters:

key - A String containing the key name to search the PropertyDict map for.

Returns:

The key contained in the original PropertyDict map or the key passed if case insensitive key is not found.

getString

java.lang.String getString(java.lang.String name)

Retrieves a String configuration parameter by name (decoding CDATA-wrapped script if necessary).

Parameters:

name - The parameter to retrieve.

Returns:

The parameter value.

Throws:

com.netegrity.llsdk6.imsapi.exception.AttributeNotPresentException - if the config set has no parameter of this name

getString

java.lang.String getString(java.lang.String name,
                           boolean bDecode)

Retrieves a String configuration parameter by name (decoding is optional). The caller must be able to handle both wrapped and unwrapped data.

Parameters:

name - The parameter to retrieve.

bDecode - true if decoding CDATA-wrapped script is necessary, or false otherwise.

Returns:

The parameter value.

Throws:

com.netegrity.llsdk6.imsapi.exception.AttributeNotPresentException - if the config set has no parameter of this name

getInt

int getInt(java.lang.String name)

Retrieves an int configuration parameter by name.

Parameters:

name - The parameter to retrieve.

Returns:

The parameter value.

Throws:

com.netegrity.llsdk6.imsapi.exception.AttributeNotPresentException - if the config set has no parameter of this name

getLong

long getLong(java.lang.String name)

Retrieves a long configuration parameter by name.

Parameters:

name - The parameter to retrieve.

Returns:

The parameter value.

Throws:

com.netegrity.llsdk6.imsapi.exception.AttributeNotPresentException - if the config set has no parameter of this name

getInteger

java.lang.Integer getInteger(java.lang.String name)

Retrieves an Integer configuration parameter by name.

Parameters:

name - The parameter to retrieve.

Returns:

The parameter value.

Throws:

com.netegrity.llsdk6.imsapi.exception.AttributeNotPresentException - if the config set has no parameter of this name

getBool

boolean getBool(java.lang.String name)

Retrieves a boolean configuration parameter by name.

Parameters:

name - The parameter to retrieve.

Returns:

The parameter value.

Throws:

com.netegrity.llsdk6.imsapi.exception.AttributeNotPresentException - if the config set has no parameter of this name

getBoolean

java.lang.Boolean getBoolean(java.lang.String name)

Retrieves a Boolean configuration parameter by name.

Parameters:

name - The parameter to retrieve.

Returns:

The parameter value.

Throws:

com.netegrity.llsdk6.imsapi.exception.AttributeNotPresentException - if the config set has no parameter of this name

setString

void setString(java.lang.String name,
               java.lang.String value)

Sets a String configuration parameter by name.

Parameters:

name - The parameter to set.

value - The value to assign to the parameter.

setString

void setString(java.lang.String name,
               java.lang.String value,
               boolean bCDataEncode)

Sets a String configuration parameter by name.

Parameters:

name - The parameter to set.

value - The value to assign to the parameter.

bCDataEncode - true if the value should be CDATA-encoded when peristing, or false otherwise.

setInt

void setInt(java.lang.String name,
            int value)

Sets an int configuration parameter by name.

Parameters:

name - The parameter to set.

value - The value to assign to the parameter.

setLong

void setLong(java.lang.String name,
             long value)

Sets a long configuration parameter by name.

Parameters:

name - The parameter to set.

value - The value to assign to the parameter.

setInteger

void setInteger(java.lang.String name,
                java.lang.Integer value)

Sets an Integer configuration parameter by name.

Parameters:

name - The parameter to set.

value - The value to assign to the parameter.

setBool

void setBool(java.lang.String name,
             boolean value)

Sets a boolean configuration parameter by name.

Parameters:

name - The parameter to set.

value - The value to assign to the parameter.

setBoolean

void setBoolean(java.lang.String name,
                java.lang.Boolean value)

Sets a Boolean configuration parameter by name.

Parameters:

name - The parameter to set.

value - The value to assign to the parameter.

isEmpty

boolean isEmpty()

Determines if there are any properties in the dictionary.

Specified by:

isEmpty in interface java.util.Map

Returns:

true if empty, or false otherwise.

keys

java.util.Enumeration keys()

Retrieves the keys of the property dictionary.

Returns:

An Enumeration of keys.

size

int size()

Returns the number of properties in the dictionary.

Specified by:

size in interface java.util.Map

Returns:

The number of properties.

clear

void clear()

Clears all entries in the property dictionary.

Specified by:

clear in interface java.util.Map

remove

boolean remove(java.lang.String name)

Removes the specified property from the dictionary. If the property does not exist, the method succeeds with no impact.

Parameters:

name - The parameter to remove.

Returns:

true if the property existed.

clone

java.lang.Object clone()
                       throws java.lang.CloneNotSupportedException

This is a public override of Object.clone() to make it accessible -- typically used by Identity Manager.

Returns:

A deep copy of the dictionary.

Throws:

java.lang.CloneNotSupportedException