oracle.webcenter.peopleconnections.common.settings

Interface UpdateableSettings

public interface UpdateableSettings

An updateable-settings object allows making updates to a settings document.

An instance of this class can be obtained by calling the getXXXForUpdate methods of a SettingsManager.

Since:

release specific (what release of product did this appear in)

Method Summary

Modifier and Type	Method and Description
javax.xml.bind.Element	getUpdateableBean() Returns a JAXB bean representing a view of the settings document, on which updates can be made.
void	save() Persists all the updates made so far on the JAXB bean for this updateable-settings instance.

Method Detail

getUpdateableBean

javax.xml.bind.Element getUpdateableBean()
                                  throws SettingsException

Returns a JAXB bean representing a view of the settings document, on which updates can be made.

Any subsequent call to this method on the same updateable-settings instance will continue to return the same bean instance, preserving any updates that have been made on it so far.

Updates made on the bean returned by this method will not persisted to the backend until save() is called.

Typically one would typecast the bean returned by this method to the appropriate JAXB class associated with the XSD on which the settings document is based, and call getters and setters on it to read and update the settings info.

Returns:

JAXB bean representing a view of the settings document, on which updates can be made

Throws:

SettingsException - If any error occurs while reading the document or preparing an updateable JAXB bean for it

save

void save()
   throws SettingsException

Persists all the updates made so far on the JAXB bean for this updateable-settings instance.

Throws:

SettingsException - If any error occurs while saving the document