com.ibm.portal.admin
Interface ModifiableDeviceClassCapable

All Superinterfaces:

DeviceClassCapable, Modifiable

All Known Subinterfaces:

ModifiableContentLabel, ModifiableContentNode, ModifiableContentPage, ModifiableContentURL, ModifiableExternalContentURL, ModifiableInternalContentURL, ModifiableStaticContentPage

public interface ModifiableDeviceClassCapable
extends DeviceClassCapable, Modifiable

This interface describes resource that support the assignment of device classes.

Since:

8.0.0.0

Method Summary

boolean	addDeviceClass(DeviceClass aDeviceClass) Adds a device class.
boolean	addDeviceClasses(java.util.Set<? extends DeviceClass> aDeviceClassSet) Adds all device classes specified by the set.
boolean	confirmAddDeviceClass(DeviceClass aDeviceClass) Indicates if the specified device class may be set.
boolean	confirmAddDeviceClasses(java.util.Set<? extends DeviceClass> aDeviceClassSet) Indicates if the specified device classes may be set.
boolean	confirmRemoveDeviceClass(DeviceClass aDeviceClass) Indicates if the specified device class may be removed.
boolean	confirmRemoveDeviceClasses() Indicates if all device classes may be removed.
boolean	removeDeviceClass(DeviceClass aDeviceClass) Removes a device class.
boolean	removeDeviceClasses() Clears all device classes.

Methods inherited from interface com.ibm.portal.devicesupport.DeviceClassCapable

getDeviceClasses, supportsDeviceClass

Method Detail

addDeviceClass

boolean addDeviceClass(DeviceClass aDeviceClass)
                       throws CannotModifyPropertyException

Adds a device class.

Parameters:

aDeviceClass - device class to add; must not be null

Returns:

true if this DeviceClassCapable was changed as a result of this call

Throws:

CannotModifyPropertyException - in case the device class cannot be added

addDeviceClasses

boolean addDeviceClasses(java.util.Set<? extends DeviceClass> aDeviceClassSet)
                         throws CannotModifyPropertyException

Adds all device classes specified by the set.

Parameters:

aDeviceClassSet - set with the device classes to add; must contain com.ibm.portal.admin.DeviceClass instances. Must not contain null.

Returns:

true if this DeviceClassCapable was changed as a result of this call

Throws:

CannotModifyPropertyException - in case a device class cannot be added; in this case the device classes are added only partially

removeDeviceClass

boolean removeDeviceClass(DeviceClass aDeviceClass)
                          throws CannotModifyPropertyException

Removes a device class.

Parameters:

aDeviceClass - device class to remove; must not be null

Returns:

true if this DeviceClassCapable was changed as a result of this call

Throws:

CannotModifyPropertyException - in case the device class cannot be removed for the locale

removeDeviceClasses

boolean removeDeviceClasses()
                            throws CannotModifyPropertyException

Clears all device classes.

Returns:

true if this DeviceClassCapable was changed as a result of this call

Throws:

CannotModifyPropertyException - in case a device class cannot be removed; in this case the device classes are removed only partially

confirmAddDeviceClass

boolean confirmAddDeviceClass(DeviceClass aDeviceClass)

Indicates if the specified device class may be set.

Parameters:

aDeviceClass - device class for which to indicate if it may be set; must not be null

Returns:

true if the specified device class may be set, false otherwise

confirmAddDeviceClasses

boolean confirmAddDeviceClasses(java.util.Set<? extends DeviceClass> aDeviceClassSet)

Indicates if the specified device classes may be set.

Parameters:

aDeviceClassSet - set of com.ibm.portal.admin.DeviceClasss for which to indicate if they may be set; must not be null

Returns:

true if the specified device classes may be set, false otherwise

confirmRemoveDeviceClass

boolean confirmRemoveDeviceClass(DeviceClass aDeviceClass)

Indicates if the specified device class may be removed.

Parameters:

aDeviceClass - device class for which to indicate if it may be removed; must not be null

Returns:

true if the device class may be removed, false otherwise

confirmRemoveDeviceClasses

boolean confirmRemoveDeviceClasses()

Indicates if all device classes may be removed.

Returns:

true if all device classes may be removed, false otherwise