|
Copyright © 2006 BEA Systems, Inc. All Rights Reserved | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.compoze.collab.SessionPropertyElement
com.compoze.collab.SessionProperty
public class SessionProperty
This class represents a session property.
Method Summary | |
---|---|
SessionOption |
getDefaultOption()
Gets the default option (if the property is an option property). |
String |
getDefaultValue()
Gets the default value for the property (for optional properties only). |
SessionOption |
getOption(String sName)
Gets an option by its internal name. |
SessionOption[] |
getOptions()
Gets the possible options for the value. |
String |
getSampleValue(Locale locale)
Gets a sample value to present to the user. |
boolean |
hasDefaultOption()
Determines if the property has a default option (if the property is an option property). |
boolean |
isOptional()
Determines if the property is optional. |
boolean |
isOptionProperty()
Determines if the property is an option property. |
boolean |
isSensitive()
Determines if the property contains sensitive contents (such as a password). |
String |
toString()
Creates a string representation of the object. |
Methods inherited from class com.compoze.collab.SessionPropertyElement |
---|
getAdminDescription, getInternalName, getResource, getShortUserDescription, getUserDescription, getUserName |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Method Detail |
---|
public String getSampleValue(Locale locale)
locale
- the locale
null
if no sample value
is providedpublic boolean isOptional()
true
if the property is optionalpublic boolean isOptionProperty()
true
if the property is an option property (
has options)public boolean hasDefaultOption()
true
if the property has a default option,
false
if not or if the property is not an option propertypublic SessionOption getDefaultOption()
null
if it is not an option property or there is no default optionpublic SessionOption getOption(String sName)
sName
- the name
null
if this is not an option
property or has no option with the specified namepublic boolean isSensitive()
true
if the property is sensitivepublic String getDefaultValue()
null
if this is a required
property or does not have a default valuepublic SessionOption[] getOptions()
null
)public String toString()
toString
in class Object
|
Copyright © 2006 BEA Systems, Inc. All Rights Reserved | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |