com.prosyst.mprm.admin.m2m.groups

Interface Group

All Known Subinterfaces:

EditableGroup

public interface Group

Interface representing an M2M Group. Groups are organized hierarchically and can contain IDs of component and device control units. Each group belongs to exactly one group type and has unique ID, which can be used to identify the group in the system. Groups can be editable or read-only. If a group is editable it will implement also the EditableGroup interface.

Method Summary

Modifier and Type	Method and Description
void	addGroupListener(GroupChangeListener listener) Register listener for changes in this group.
java.lang.String[]	getCategories() List of categories to which a group belongs.
Group	getChildGroup(java.lang.String id) Get child group by ID.
java.lang.String	getDescription() Get group description (if available).
java.lang.String	getID() Get group ID.
java.lang.String	getName() Get group user friendly name.
java.util.Map<java.lang.String,java.lang.String>	getProperties() Get group properties.
java.lang.String	getProperty(java.lang.String name) Get the value of property with the given name.
GroupType	getType() Get group type.
boolean	isEmpty() Returns true if the group has no components or child groups.
<any>	listChildGroups(java.lang.String ldapFilter) List child groups IDs matching given LDAP filter.
<any>	listComponents(java.lang.String cuFilter, boolean includeChildGroups) List components (IDs to device or component control units) in this group and its children.
<any>	listComponents(java.lang.String cuType, java.lang.String cuFilter, boolean includeChildGroups) List components (IDs to device or component control units) in this group and its children.
<any>	listParentGroups() List IDs of this group parent groups.
void	removeGroupListener(GroupChangeListener listener) Remove listener previously registered through the addGroupListener(GroupChangeListener) methods.

Method Detail

getID

java.lang.String getID()

Get group ID.

Returns:

group unique ID.

getName

java.lang.String getName()

Get group user friendly name.

Returns:

group name

getType

GroupType getType()

Get group type.

Returns:

group type

getDescription

java.lang.String getDescription()

Get group description (if available).

Returns:

description or null if description is not available

getCategories

java.lang.String[] getCategories()

List of categories to which a group belongs.

Returns:

group categories or null if categories are not defined for this group

isEmpty

boolean isEmpty()
         throws ManagementException

Returns true if the group has no components or child groups.

Returns:

true - if the group has no components or child groups, false - otherwise.

Throws:

ManagementException - if system error occurs

listComponents

<any> listComponents(java.lang.String cuFilter,
                     boolean includeChildGroups)
              throws ManagementException

List components (IDs to device or component control units) in this group and its children. Control unit filter can be given to narrow the results returned.

Parameters:

cuFilter - control unit filter to be applied to components or null if all component IDs should be returned

includeChildGroups - true, if component IDs in child groups should also be returned, false otherwise

Returns:

list of component IDs matching the given criteria

Throws:

ManagementException - if system error occurs

listComponents

<any> listComponents(java.lang.String cuType,
                     java.lang.String cuFilter,
                     boolean includeChildGroups)
              throws ManagementException

List components (IDs to device or component control units) in this group and its children. Control unit filter can be given to narrow the results returned.

Parameters:

cuType - control unit type

cuFilter - control unit filter to be applied to components or null if all component IDs should be returned

includeChildGroups - true, if component IDs in child groups should also be returned, false otherwise

Returns:

list of component IDs matching the given criteria

Throws:

ManagementException - if system error occurs

listChildGroups

<any> listChildGroups(java.lang.String ldapFilter)
               throws ManagementException

List child groups IDs matching given LDAP filter. If no filter is given all child group IDs will be returned. All properties from (@link GroupFilterPropertyConstants} can be used in the filter in addition to custom group properties ( getProperties()).

Parameters:

ldapFilter - LDAP filter or null

Returns:

IDs of child groups matching the search criteria

Throws:

ManagementException

listParentGroups

<any> listParentGroups()
                throws ManagementException

List IDs of this group parent groups.

Returns:

IDs of parent groups

Throws:

ManagementException - if system error occurs

getChildGroup

Group getChildGroup(java.lang.String id)
             throws ManagementException

Get child group by ID.

Parameters:

id - child group ID

Returns:

child group

Throws:

ManagementException - if system error occurs

getProperties

java.util.Map<java.lang.String,java.lang.String> getProperties()

Get group properties.

Returns:

group properties or null if the group has no properties set

getProperty

java.lang.String getProperty(java.lang.String name)

Get the value of property with the given name.

Parameters:

name - property name

Returns:

property value or null if no property with the given name is found

addGroupListener

void addGroupListener(GroupChangeListener listener)

Register listener for changes in this group.

Parameters:

listener - listener

removeGroupListener

void removeGroupListener(GroupChangeListener listener)

Remove listener previously registered through the addGroupListener(GroupChangeListener) methods.

Parameters:

listener - listener