oracle.panama.model
Interface DeviceGroup

All Superinterfaces:

ModelObject, XMLObject

public interface DeviceGroup

extends ModelObject

DeviceGroup represents a collection of devices. It is used to publish services to a group of devices. A DeviceGroup is ortogonal to Group. Both objects can be used to define fine granularity access control to services.

See Also:

Group

Field Summary

Fields inherited from interface oracle.panama.model.ModelObject

TYPEID

Method Summary

void	addDevice(Device device) Assign a device to a device group, if the device is already inside the group, it's a no-op.
void	addDynamicAttribute(java.lang.String name, java.lang.String value) Adds an dynamic attribute to the device group.
java.util.HashMap	getAllDynamicAttributes() Return all the attributes for this device group.
java.lang.String	getDescription() Get the description for the device group.
Device[]	getDevices() Get the list of devices that's already been assigned to the group.
java.lang.String	getDynamicAttribute(java.lang.String name) Get the dynamic attribute's value given it's name.
void	removeDevice(Device device) Remove a device from the device group, if the device is not inside the group, it's a no-op.
void	removeDynamicAttribute(java.lang.String name) Remove the dynamic attribute.
void	setDescription(java.lang.String description) Set the description for the device group

Methods inherited from interface oracle.panama.model.ModelObject

delete, getCreatedDate, getId, getLastModifiedDate, getName, getTypeId, getTypeName, isSystem, setName, setSystem, undoAll

Methods inherited from interface oracle.panama.model.XMLObject

setXML, toXML

Method Detail

addDevice

public void addDevice(Device device)

Assign a device to a device group, if the device is already inside the group, it's a no-op.

Parameters:

device - The device to be added to the group.

Throws:

java.lang.IllegalArgumentException - if the device parameter is null.

addDynamicAttribute

public void addDynamicAttribute(java.lang.String name,
                                java.lang.String value)

Adds an dynamic attribute to the device group.

Parameters:

name - The name of the attribute. The name has to be unique per device group!

value - The value of the attribute.

getAllDynamicAttributes

public java.util.HashMap getAllDynamicAttributes()

Return all the attributes for this device group.

Returns:

The attributes for this device group in the form of hash map.

getDescription

public java.lang.String getDescription()

Get the description for the device group.

Returns:

The description for the device group.

getDevices

public Device[] getDevices()

Get the list of devices that's already been assigned to the group.

Returns:

The list of devices that's already been assigned to the group. An empty array is returned if there is not devices inside the group at all.

getDynamicAttribute

public java.lang.String getDynamicAttribute(java.lang.String name)

Get the dynamic attribute's value given it's name.

Parameters:

name - The name of the attribute interested.

Returns:

The value of the attribute that's interesting.

removeDevice

public void removeDevice(Device device)

Remove a device from the device group, if the device is not inside the group, it's a no-op.

Parameters:

device - The device to be removed from the group.

Throws:

java.lang.IllegalArgumentException - if the device parameter is null.

removeDynamicAttribute

public void removeDynamicAttribute(java.lang.String name)

Remove the dynamic attribute.

Parameters:

name - The name of the attribute to be removed

setDescription

public void setDescription(java.lang.String description)

Set the description for the device group

Parameters:

description - The description for the device group.