com.ibm.portal.admin
Interface ModifiableVirtualPortal

All Superinterfaces:

Identifiable, Localized, Modifiable, ModifiableIdentifiable, ModifiableLocalized, VirtualPortal

public interface ModifiableVirtualPortal
extends VirtualPortal, ModifiableIdentifiable, ModifiableLocalized

An interface representing a modifiable virtual portal instance.

Since:

6.1.0

Method Summary

boolean	confirmSetRealm(java.lang.String aRealm) Indicates if the given realm may be set.
java.lang.String	setRealm(java.lang.String aRealm) Sets the virtual portal's realm.

Methods inherited from interface com.ibm.portal.admin.VirtualPortal

getRealm, getShortID

Methods inherited from interface com.ibm.portal.ModifiableIdentifiable

getModifiableObjectID

Methods inherited from interface com.ibm.portal.Identifiable

getObjectID

Methods inherited from interface com.ibm.portal.ModifiableLocalized

confirmRemoveDescription, confirmRemoveDescriptions, confirmRemoveDescriptions, confirmRemoveTitle, confirmRemoveTitles, confirmRemoveTitles, confirmRetainDescriptions, confirmRetainTitles, confirmSetAll, confirmSetDescription, confirmSetDescriptions, confirmSetTitle, confirmSetTitles, removeDescription, removeDescriptions, removeDescriptions, removeTitle, removeTitles, removeTitles, retainDescriptions, retainTitles, setAll, setDescription, setDescriptions, setTitle, setTitles

Methods inherited from interface com.ibm.portal.Localized

getDescription, getLocales, getTitle

Method Detail

setRealm

java.lang.String setRealm(java.lang.String aRealm)
                          throws CannotModifyPropertyException,
                                 ModelException

Sets the virtual portal's realm.

Parameters:

aRealm - The new realm of the virtual portal

Returns:

the former realm or null if none has been set.

Throws:

CannotModifyPropertyException - in case the realm cannot be set

ModelException

confirmSetRealm

boolean confirmSetRealm(java.lang.String aRealm)

Indicates if the given realm may be set.

Parameters:

aRealm - The new realm of the virtual portal

Returns:

true if the specified realm may be set, false otherwise