com.sun.idm.logging.audit
Class PublisherOption

java.lang.Object
  extended bycom.sun.idm.logging.audit.PublisherOption
All Implemented Interfaces:
java.util.Map

public class PublisherOption
extends java.lang.Object
implements java.util.Map

Configuration option of an "log publisher". Instance of this class are inmutable.


Nested Class Summary
 
Nested classes inherited from class java.util.Map
java.util.Map.Entry
 
Field Summary
static java.lang.String CLASS
           
static java.lang.String code_id
           
static java.lang.String DISPLAY_TYPE_CHECKBOX
           
static java.lang.String DISPLAY_TYPE_SECRET_TEXT
           
static java.lang.String DISPLAY_TYPE_TEXT
           
static java.lang.String DISPLAY_TYPE_TEXTAREA
           
 
Constructor Summary
PublisherOption(java.lang.String name, java.lang.String type)
           
PublisherOption(java.lang.String name, java.lang.String type, boolean isRequired)
           
PublisherOption(java.lang.String name, java.lang.String type, boolean isRequired, java.lang.String displayName)
           
PublisherOption(java.lang.String name, java.lang.String type, boolean isRequired, java.lang.String displayName, java.lang.String helpKey)
           
 
Method Summary
 void clear()
           
 boolean containsKey(java.lang.Object key)
           
 boolean containsValue(java.lang.Object value)
           
 java.util.Set entrySet()
           
 java.lang.Object get(java.lang.Object key)
           
 java.lang.String getDisplayName()
           
 java.lang.String getHelp()
           
 java.lang.String getName()
           
 java.lang.String getType()
           
 boolean isEmpty()
           
 boolean isRequired()
           
 java.util.Set keySet()
           
 java.lang.Object put(java.lang.Object key, java.lang.Object value)
           
 void putAll(java.util.Map t)
           
 java.lang.Object remove(java.lang.Object key)
           
 int size()
           
 java.lang.String toString()
           
 java.util.Collection values()
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface java.util.Map
equals, hashCode
 

Field Detail

code_id

public static final java.lang.String code_id
See Also:
Constant Field Values

CLASS

public static final java.lang.String CLASS
See Also:
Constant Field Values

DISPLAY_TYPE_TEXT

public static final java.lang.String DISPLAY_TYPE_TEXT
See Also:
Constant Field Values

DISPLAY_TYPE_CHECKBOX

public static final java.lang.String DISPLAY_TYPE_CHECKBOX
See Also:
Constant Field Values

DISPLAY_TYPE_TEXTAREA

public static final java.lang.String DISPLAY_TYPE_TEXTAREA
See Also:
Constant Field Values

DISPLAY_TYPE_SECRET_TEXT

public static final java.lang.String DISPLAY_TYPE_SECRET_TEXT
See Also:
Constant Field Values
Constructor Detail

PublisherOption

public PublisherOption(java.lang.String name,
                       java.lang.String type)
Parameters:
name - option name
type - option type

PublisherOption

public PublisherOption(java.lang.String name,
                       java.lang.String type,
                       boolean isRequired)
Parameters:
name - option name
type - option type
isRequired - true iff the option is mandatory, false otherwise

PublisherOption

public PublisherOption(java.lang.String name,
                       java.lang.String type,
                       boolean isRequired,
                       java.lang.String displayName)
Parameters:
name - option name
type - option type
isRequired - true iff the option is mandatory, false otherwise
displayName - the name displayed in the user interface for this option. This can be a message catalog key.

PublisherOption

public PublisherOption(java.lang.String name,
                       java.lang.String type,
                       boolean isRequired,
                       java.lang.String displayName,
                       java.lang.String helpKey)
Parameters:
name - option name
type - option type
isRequired - true iff the option is mandatory, false otherwise
displayName - the name displayed in the user interface for this option
helpKey - the help displayed in the user interface for this option This can be a message catalog key.
Method Detail

clear

public void clear()
Specified by:
clear in interface java.util.Map

containsKey

public boolean containsKey(java.lang.Object key)
Specified by:
containsKey in interface java.util.Map

containsValue

public boolean containsValue(java.lang.Object value)
Specified by:
containsValue in interface java.util.Map

entrySet

public java.util.Set entrySet()
Specified by:
entrySet in interface java.util.Map

get

public java.lang.Object get(java.lang.Object key)
Specified by:
get in interface java.util.Map

isEmpty

public boolean isEmpty()
Specified by:
isEmpty in interface java.util.Map

keySet

public java.util.Set keySet()
Specified by:
keySet in interface java.util.Map

put

public java.lang.Object put(java.lang.Object key,
                            java.lang.Object value)
Specified by:
put in interface java.util.Map

putAll

public void putAll(java.util.Map t)
Specified by:
putAll in interface java.util.Map

remove

public java.lang.Object remove(java.lang.Object key)
Specified by:
remove in interface java.util.Map

size

public int size()
Specified by:
size in interface java.util.Map

values

public java.util.Collection values()
Specified by:
values in interface java.util.Map

getName

public java.lang.String getName()
Returns:
the name of this configuration option

getDisplayName

public java.lang.String getDisplayName()
Returns:
the name of this configuration option used for display purposes. The name can be a message catalog key.

getHelp

public java.lang.String getHelp()
Returns:
the help for this configuration option. The help message is displayed in the configuration user interface. The returned value can be a message catalog key.

getType

public java.lang.String getType()
Returns:
the type of this configuration option (not used currently)

isRequired

public boolean isRequired()
Returns:
true if this configuration option is mandatory

toString

public java.lang.String toString()
Returns:
the string representation of the option object.