|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface ModifiablePortletPreferences<E extends java.lang.Object & java.util.Map.Entry<java.lang.String,java.lang.String>>
An interface representing modifiable portlet preferences. It can be obtained
through the
ModifiablePortletPreferencesProvider
.
Method Summary | |
---|---|
boolean |
confirmRemoveName(java.lang.String aName)
Indicates if the preference identified with the specified name may be removed. |
boolean |
confirmRemoveNames()
Indicates if all preferences data may be removed. |
boolean |
confirmRemoveNames(java.util.Collection<java.lang.String> aCollection)
Indicates if the preferences identified by the names specified in the collection may be removed. |
boolean |
confirmRetainNames(java.util.Collection<java.lang.String> aCollection)
Indicates if the preferences identified by the names specified in the collection may be retained. |
boolean |
confirmSetStringValue(java.lang.String aName,
java.lang.String aValue)
Indicates if the value for the preference identified by the specified name may be set. |
boolean |
confirmSetStringValues(java.lang.String aName,
java.lang.String[] aValue)
Indicates if the value for the preference identified by the specified name may be set. |
boolean |
confirmSetValue(java.lang.String aName,
java.lang.String aValue)
Indicates if the value for the preference identified by the specified name may be set. |
boolean |
confirmSetValues(PortletPreferences<? extends E> aPortletPreferences)
Indicates the specified preferences may be set. |
java.lang.String |
removeName(java.lang.String aName)
Removes the preference identified with the specified name. |
boolean |
removeNames()
Removes all preferences. |
boolean |
removeNames(java.util.Collection<java.lang.String> aCollection)
Removes the preferences identified by the names specified in the collection. |
boolean |
retainNames(java.util.Collection<java.lang.String> aCollection)
Retains only the preferences identified by the names specified in the collection. |
java.lang.String |
setStringValue(java.lang.String aName,
java.lang.String aValue)
Sets the value for the preference identified by the specified name. |
java.lang.String[] |
setStringValues(java.lang.String aName,
java.lang.String[] aValue)
Sets the value for the preference identified by the specified name. |
java.lang.String |
setValue(java.lang.String aName,
java.lang.String aValue)
Sets the value for the preference identified by the specified name. |
boolean |
setValues(PortletPreferences<? extends E> aPortletPreferences)
Sets the specified portlet preferences. |
Methods inherited from interface com.ibm.portal.portletmodel.PortletPreferences |
---|
getStringValue, getStringValues, getValue, isPreferenceDefined, isReadOnly, iterator |
Methods inherited from interface com.ibm.portal.ModifiableMetaData |
---|
confirmSetValues, setValues |
Methods inherited from interface com.ibm.portal.MetaData |
---|
getNames |
Method Detail |
---|
java.lang.String setValue(java.lang.String aName, java.lang.String aValue) throws CannotModifyPropertyException
String
. If the name does not
exist a new preference is created with the given name, value and
read-only set to false.
setValue
in interface ModifiableMetaData<java.lang.String,E extends java.lang.Object & java.util.Map.Entry<java.lang.String,java.lang.String>>
aName
- name of preference to set the value foraValue
- preference value to set
null
is returned
CannotModifyPropertyException
- in case the value of the preference cannot be set, or the
value is not of type stringjava.lang.String setStringValue(java.lang.String aName, java.lang.String aValue) throws CannotModifyPropertyException
aName
- name of preference to set the value foraValue
- preference value to set
null
is returned
CannotModifyPropertyException
- in case the value of the preference cannot be setjava.lang.String[] setStringValues(java.lang.String aName, java.lang.String[] aValue) throws CannotModifyPropertyException
aName
- name of preference to set the value foraValue
- preference value to set
String
or null
, if the preference is not set
CannotModifyPropertyException
- in case the value of the preference cannot be setboolean setValues(PortletPreferences<? extends E> aPortletPreferences) throws CannotModifyPropertyException
aPortletPreferences
- portlet preferences to set
true
if this
ModifiablePortletPreferences
was changed as a
result of this call
CannotModifyPropertyException
- in case a specified portlet preferences cannot be set; in
this case, the portlet preferences are set only partiallyjava.lang.String removeName(java.lang.String aName) throws CannotModifyPropertyException
removeName
in interface ModifiableMetaData<java.lang.String,E extends java.lang.Object & java.util.Map.Entry<java.lang.String,java.lang.String>>
aName
- name of preference to remove
String[]
; if
none existed, null
is returned
CannotModifyPropertyException
- in case the preference cannot be removedboolean removeNames(java.util.Collection<java.lang.String> aCollection) throws CannotModifyPropertyException
removeNames
in interface ModifiableMetaData<java.lang.String,E extends java.lang.Object & java.util.Map.Entry<java.lang.String,java.lang.String>>
aCollection
- names of preferences to remove
true
if this
ModifiablePortletPreferences
was changed as a
result of this call
CannotModifyPropertyException
- in case a specified preference cannot be removed; in this
case, the preferences are removed only partiallyboolean removeNames() throws CannotModifyPropertyException
removeNames
in interface ModifiableMetaData<java.lang.String,E extends java.lang.Object & java.util.Map.Entry<java.lang.String,java.lang.String>>
true
if this
ModifiablePortletPreferences
was changed as a
result of this call
CannotModifyPropertyException
- in case a preference cannot be removed; in this case, the
preferences are removed only partiallyboolean retainNames(java.util.Collection<java.lang.String> aCollection) throws CannotModifyPropertyException
retainNames
in interface ModifiableMetaData<java.lang.String,E extends java.lang.Object & java.util.Map.Entry<java.lang.String,java.lang.String>>
aCollection
- names of preferences to retain
true
if this
ModifiablePortletPreferences
was changed as a
result of this call
CannotModifyPropertyException
- in case a preference, which is not to be retained, cannot be
removed; in this case, the preferences are removed only
partially.boolean confirmSetValue(java.lang.String aName, java.lang.String aValue)
confirmSetValue
in interface ModifiableMetaData<java.lang.String,E extends java.lang.Object & java.util.Map.Entry<java.lang.String,java.lang.String>>
aName
- name of preferenceaValue
- preference value
true
in case the preference may be set,
false
otherwiseboolean confirmSetStringValue(java.lang.String aName, java.lang.String aValue)
aName
- name of preferenceaValue
- preference value
true
in case the preference may be set,
false
otherwiseboolean confirmSetStringValues(java.lang.String aName, java.lang.String[] aValue)
aName
- name of preferenceaValue
- preference value
true
in case the preference may be set,
false
otherwiseboolean confirmSetValues(PortletPreferences<? extends E> aPortletPreferences)
aPortletPreferences
- preferences
true
in case the preferences may be set,
false
otherwiseboolean confirmRemoveName(java.lang.String aName)
confirmRemoveName
in interface ModifiableMetaData<java.lang.String,E extends java.lang.Object & java.util.Map.Entry<java.lang.String,java.lang.String>>
aName
- name of preference
true
in case the preference may be removed,
false
otherwiseboolean confirmRemoveNames(java.util.Collection<java.lang.String> aCollection)
confirmRemoveNames
in interface ModifiableMetaData<java.lang.String,E extends java.lang.Object & java.util.Map.Entry<java.lang.String,java.lang.String>>
aCollection
- names identifying preferences
true
in case the preferences may be removed,
false
otherwiseboolean confirmRemoveNames()
confirmRemoveNames
in interface ModifiableMetaData<java.lang.String,E extends java.lang.Object & java.util.Map.Entry<java.lang.String,java.lang.String>>
true
in case all preferences may be removed,
false
otherwiseboolean confirmRetainNames(java.util.Collection<java.lang.String> aCollection)
confirmRetainNames
in interface ModifiableMetaData<java.lang.String,E extends java.lang.Object & java.util.Map.Entry<java.lang.String,java.lang.String>>
aCollection
- names of preferences
true
in case the preferences may be retained,
false
otherwise
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |