Raritan / Server Technology Xerus™ PDU JSON-RPC API
|
Outlet group manager interface. More...
import"OutletGroupManager.idl";
Public Member Functions | |
int | createGroup (in string name, in vector< Outlet > members, out OutletGroup group) |
Create a new outlet group. More... | |
map< int, OutletGroup > | getAllGroups () |
Retrieve the list of outlet groups. More... | |
int | getGroup (in int id, out OutletGroup group) |
Retrieve a specific outlet group. More... | |
int | deleteGroup (in int id) |
Delete an outlet group. More... | |
Public Attributes | |
constant int | ERR_INVALID_ARGUMENT = 1 |
constant int | ERR_NO_SUCH_ID = 2 |
constant int | ERR_MAX_GROUP_COUNT_REACHED = 3 |
valueobject | GroupCreatedEvent: event::UserEvent { int id |
Event: A new outlet group has been created. More... | |
int | uniqueId |
Random ID uniquely identifying the new group. More... | |
OutletGroup | group |
The new group. | |
OutletGroup::Settings | settings |
The new group's settings. More... | |
valueobject | GroupDeletedEvent: event::UserEvent { int id |
Event: An outlet group has been deleted. More... | |
Outlet group manager interface.
int pdumodel::OutletGroupManager::createGroup | ( | in string | name, |
in vector< Outlet > | members, | ||
out OutletGroup | group | ||
) |
Create a new outlet group.
name | New group name |
members | List of member outlets |
group | Result: Reference to newly created group; null in case of error |
int pdumodel::OutletGroupManager::deleteGroup | ( | in int | id | ) |
Delete an outlet group.
id | The ID of the group to delete |
map<int, OutletGroup> pdumodel::OutletGroupManager::getAllGroups | ( | ) |
Retrieve the list of outlet groups.
int pdumodel::OutletGroupManager::getGroup | ( | in int | id, |
out OutletGroup | group | ||
) |
Retrieve a specific outlet group.
id | The ID of the requested group |
group | Result: requested outlet group; null if not found |
valueobject pdumodel::OutletGroupManager::GroupCreatedEvent |
Event: A new outlet group has been created.
The ID under which the outlet group manager references this group; may be reused after a group is deleted.
valueobject pdumodel::OutletGroupManager::GroupDeletedEvent |
Event: An outlet group has been deleted.
The ID under which the outlet group manager referenced the group
OutletGroup::Settings pdumodel::OutletGroupManager::settings |
The new group's settings.
Last group settings before deletion.
int pdumodel::OutletGroupManager::uniqueId |
Random ID uniquely identifying the new group.
Random unique ID of the deleted group.