Package org.osid.control

The Open Service Interface Definitions for the org.osid.control service.

See: Description

Interface Summary

Interface	Description
Action	An Action executes a Scene, Setting, another ActionGroup, or other Rule .
ActionForm	This is the form for creating and updating actions.
ActionGroup	An ActionGroup is a list of Actions to execute.
ActionGroupAdminSession	This session creates, updates, and deletes ActionGroups.
ActionGroupForm	This is the form for creating and updating action groups.
ActionGroupList	Like all OsidLists, ActionGroupList provides a means for accessing ActionGroup elements sequentially either one at a time or many at a time.
ActionGroupLookupSession	This session provides methods for retrieving ActionGroup objects.
ActionGroupNotificationSession	This session defines methods to receive notifications on adds/changes to ActionGroup objects in this System.
ActionGroupQuery	This is the query for searching action groups.
ActionGroupQueryInspector	This is the query inspector for examining action group queries.
ActionGroupQuerySession	This session provides methods for searching among ActionGroup objects.
ActionGroupReceiver	The action group receiver is the consumer supplied interface for receiving notifications pertaining to new, updated or deleted ActionGroup objects.
ActionGroupSearch	The search interface for governing action group searches.
ActionGroupSearchOrder	An interface for specifying the ordering of search results.
ActionGroupSearchResults	This interface provides a means to capture results of a search.
ActionGroupSearchSession	This session provides methods for searching among ActionGroup objects.
ActionGroupSmartSystemSession	This session manages queries and sequencing to create "smart" dynamic catalogs.
ActionGroupSystemAssignmentSession	This session provides methods to re-assign ActionGroups to System mappings.
ActionGroupSystemSession	This session provides methods to retrieve ActionGroup to System mappings.
ActionList	Like all OsidLists, ActionList provides a means for accessing Action elements sequentially either one at a time or many at a time.
ActionQuery	This is the query for searching actions.
ActionQueryInspector	This is the query inspector for examining action queries.
Controller	A Controller is an addressable Operable that executes an action.
ControllerAdminSession	This session creates, updates, and deletes Controllers.
ControllerForm	This is the form for creating and updating Controllers.
ControllerList	Like all OsidLists, ControllerList provides a means for accessing Controller elements sequentially either one at a time or many at a time.
ControllerLookupSession	This session provides methods for retrieving Controllers.
ControllerNotificationSession	This session defines methods to receive notifications on adds/changes to Controller objects in this System.
ControllerQuery	This is the query for searching controllers.
ControllerQueryInspector	This is the query inspector for examning controller queries.
ControllerQuerySession	This session provides methods for searching among Controller objects.
ControllerReceiver	The controller receiver is the consumer supplied interface for receiving notifications pertaining to new, updated or deleted controllers.
ControllerSearch	The search interface for governing controller searches.
ControllerSearchOrder	An interface for specifying the ordering of search results.
ControllerSearchResults	This interface provides a means to capture results of a search.
ControllerSearchSession	This session provides methods for searching among Controller objects.
ControllerSmartSystemSession	This session manages queries and sequencing to create "smart" dynamic catalogs.
ControllerSystemAssignmentSession	This session provides methods to re-assign Controller to System mappings.
ControllerSystemSession	This session provides methods to retrieve Controller to System mappings.
ControlManager	The control manager provides access to control sessions and provides interoperability tests for various aspects of this service.
ControlProfile	The control profile describes the interoperability among control services.
ControlProxyManager	The control proxy manager provides access to control sessions and provides interoperability tests for various aspects of this service.
Device	A Device manages a set of Inputs to Controllers.
DeviceAdminSession	This session creates, updates, and deletes Devices.
DeviceForm	This is the form for creating and updating Devices.
DeviceList	Like all OsidLists, DeviceList provides a means for accessing Device elements sequentially either one at a time or many at a time.
DeviceLookupSession	This session provides methods for retrieving Device objects.
DeviceNotificationSession	This session defines methods to receive notifications on adds/changes to Device objects in this System.
DeviceQuery	This is the query for searching devices.
DeviceQueryInspector	This is the query inspector for examining device queries.
DeviceQuerySession	This session provides methods for searching among Device objects.
DeviceReceiver	The device receiver is the consumer supplied interface for receiving notifications pertaining to new, updated or deleted Device objects.
DeviceSearch	The search interface for governing device searches.
DeviceSearchOrder	An interface for specifying the ordering of search results.
DeviceSearchResults	This interface provides a means to capture results of a search.
DeviceSearchSession	This session provides methods for searching among Device objects.
DeviceSmartSystemSession	This session manages queries and sequencing to create "smart" dynamic catalogs.
DeviceSystemAssignmentSession	This session provides methods to re-assign Devices to System mappings.
DeviceSystemSession	This session provides methods to retrieve Device to System mappings.
Input	An Input is an OsidRelationship between a Device and a Controller.
InputAdminSession	This session creates, updates, and deletes Inputs.
InputForm	This is the form for creating and updating Inputs.
InputList	Like all OsidLists, InputList provides a means for accessing Input elements sequentially either one at a time or many at a time.
InputLookupSession	This session provides methods for retrieving Input objects.
InputNotificationSession	This session defines methods to receive notifications on adds/changes to Input objects in this System.
InputQuery	This is the query for searching inputs.
InputQueryInspector	This is the query inspector for examining input queries.
InputQuerySession	This session provides methods for searching among Input objects.
InputReceiver	The input receiver is the consumer supplied interface for receiving notifications pertaining to new, updated or deleted Input objects.
InputSearch	The search interface for governing input searches.
InputSearchOrder	An interface for specifying the ordering of search results.
InputSearchResults	This interface provides a means to capture results of a search.
InputSearchSession	This session provides methods for searching among Input objects.
InputSmartSystemSession	This session manages queries and sequencing to create "smart" dynamic catalogs.
InputSystemAssignmentSession	This session provides methods to re-assign Inputs to System mappings.
InputSystemSession	This session provides methods to retrieve Input to System mappings.
Scene	A Scene is a collection of Settings.
SceneAdminSession	This session creates, updates, and deletes Scenes.
SceneForm	This is the form for creating and updating scenes.
SceneList	Like all OsidLists, SceneList provides a means for accessing Scene elements sequentially either one at a time or many at a time.
SceneLookupSession	This session defines methods for retrieving scenes.
SceneNotificationSession	This session defines methods to receive notifications on adds/changes to Scene objects in this dDstributor.
SceneQuery	This is the query for searching scenes.
SceneQueryInspector	This is the query inspector for examining scene queries.
SceneQuerySession	This session provides methods for searching among Scene objects.
SceneReceiver	The scene receiver is the consumer supplied interface for receiving notifications pertaining to new, updated or deleted scenes.
SceneSearch	The search interface for governing scene searches.
SceneSearchOrder	An interface for specifying the ordering of search results.
SceneSearchResults	This interface provides a means to capture results of a search.
SceneSearchSession	This session provides methods for searching among Scene objects.
SceneSmartSystemSession	This session manages queries and sequencing to create "smart" dynamic catalogs.
SceneSystemAssignmentSession	This session provides methods to re-assign Scenes to System mappings.
SceneSystemSession	This session provides methods to retrieve Scene to System scenes.
Setting	An Setting is a preset value for a Controller.
SettingAdminSession	This session creates, updates, and deletes Settings.
SettingForm	This is the form for creating and updating settings.
SettingList	Like all OsidLists, SettingList provides a means for accessing Setting elements sequentially either one at a time or many at a time.
SettingLookupSession	This session defines methods for retrieving settings.
SettingNotificationSession	This session defines methods to receive notifications on adds/changes to Setting objects in this dDstributor.
SettingQuery	This is the query for searching settings.
SettingQueryInspector	This is the query inspector for examining setting queries.
SettingQuerySession	This session provides methods for searching among Setting objects.
SettingReceiver	The setting receiver is the consumer supplied interface for receiving notifications pertaining to new, updated or deleted settings.
SettingSearch	The search interface for governing setting searches.
SettingSearchOrder	An interface for specifying the ordering of search results.
SettingSearchResults	This interface provides a means to capture results of a search.
SettingSearchSession	This session provides methods for searching among Setting objects.
SettingSmartSystemSession	This session manages queries and sequencing to create "smart" dynamic catalogs.
SettingSystemAssignmentSession	This session provides methods to re-assign Settings to System mappings.
SettingSystemSession	This session provides methods to retrieve Setting to System settings.
System	A System represents a collection of Devices, Inputs, Controllers, Settings, Triggers, ActionGroups, and Scenes.
SystemAdminSession	This session creates, updates, and deletes Systems.
SystemForm	This is the form for creating and updating systems.
SystemHierarchyDesignSession	This session defines methods for managing a hierarchy of System objects.
SystemHierarchySession	This session defines methods for traversing a hierarchy of System objects.
SystemList	Like all OsidLists, SystemList provides a means for accessing System elements sequentially either one at a time or many at a time.
SystemLookupSession	This session provides methods for retrieving System objects.
SystemNode	This interface is a container for a partial hierarchy retrieval.
SystemNodeList	Like all OsidLists, SystemNodeList provides a means for accessing SystemNode elements sequentially either one at a time or many at a time.
SystemNotificationSession	This session defines methods to receive notifications on adds/changes to System objects.
SystemQuery	This is the query for searching systems.
SystemQueryInspector	This is the query inspector for examining system queries.
SystemQuerySession	This session provides methods for searching among System objects.
SystemReceiver	The system receiver is the consumer supplied interface for receiving notifications pertaining to new, updated or deleted System objects.
SystemSearch	The search interface for governing system searches.
SystemSearchOrder	An interface for specifying the ordering of search results.
SystemSearchResults	This interface provides a means to capture results of a search.
SystemSearchSession	This session provides methods for searching among System objects.
Trigger	A Trigger is an OsidRule that listens to events from a Controller.
TriggerAdminSession	This session creates, updates, and deletes Triggers.
TriggerForm	This is the form for creating and updating triggers.
TriggerList	Like all OsidLists, TriggerList provides a means for accessing Trigger elements sequentially either one at a time or many at a time.
TriggerLookupSession	This session provides methods for retrieving Trigger objects.
TriggerNotificationSession	This session defines methods to receive notifications on adds/changes to Trigger objects in this System.
TriggerQuery	This is the query for searching triggers.
TriggerQueryInspector	This is the query inspector for examining trigger queries.
TriggerQuerySession	This session provides methods for searching among Trigger objects.
TriggerReceiver	The trigger receiver is the consumer supplied interface for receiving notifications pertaining to new, updated or deleted Trigger objects.
TriggerSearch	The search interface for governing trigger searches.
TriggerSearchOrder	An interface for specifying the ordering of search results.
TriggerSearchResults	This interface provides a means to capture results of a search.
TriggerSearchSession	This session provides methods for searching among Trigger objects.
TriggerSmartSystemSession	This session manages queries and sequencing to create "smart" dynamic catalogs.
TriggerSystemAssignmentSession	This session provides methods to re-assign Triggers to System mappings.
TriggerSystemSession	This session provides methods to retrieve Trigger to System mappings.

Package org.osid.control Description

The Open Service Interface Definitions for the org.osid.control service.

The Control OSID manages control systems. A system is comprised o f Devices whose Controllers are the control points. Devices have various Input mechanisms to command the Controllers.

Device

A Device represents some piece of visible equipment in a system. Example Devices are joysticks, yokes, and control panels.

Controller

A Controller is an Operable manages a specific responder in a system such as a model railroad gate, an airplane rudder, or the volume of a stereo. The management of a Controller includes on/off, variable amount values, or a set of States. A Controller is a black box. The Control OSID does not describe or manage system responders or how a Controller performs its tasks.

Inputs

An Input is an OsidRelationship between a Device and a Controller. A yoke may have several Inputs. One Input for push-pull that commands the Controller for the elevator, another Input for turning that commands the Controller for the ailerons, and another Input that commands the Controller for enabling and disabling auto-pilot.

Settings

A Setting captures fixed setting values for a Controller. A Controller for a sound system volume may have a variable amount Setting for LOUD and another variable amount Setting for SOFT. Settings are the basic building blocks for Scenes.

Scenes

A Scen e is a set of Settings. While a Setting is a value for a single Controller, Scenes apply values across a bunch of Controllers. Executing a movie theater Scene may set the light Controllers to dim values, close the curtains, and set the sound system vilume.

Triggers

Triggers are OsidRules used to perform actions in response to a value or state change in a Controller. Triggers have two parts. One part of the Trigger is the event listening criteria (fan turned on, light changed brightness). The second part of a Trigger is the execution that is to be performed when the event criteria is true. The OsidRule may encapsulate more complex event criteria.

An example Trigger is when the motion sensor Controller is turned "on," the Trigger executes a Setting or a Scene that turns on the porch light.

Triggers may execute Scenes or Settings directly. This is the simpler approach but does not allow for other rules or conditionals not expressable by a set of critera. Triggers may also execute ActionGroups.

Actions and ActionGroups

ActionGroups are a set of Actions. Actions are OsidRules to be executed. Built-in rules execute Settings or Scenes. These OsidRules may reference other actions or behaviors not directly described in the Action.

Settings, Scenes, and Actions

A Setting is a single state or value for a specific Controller used to build Scenes but may also be directly executed by a Trigger or Action.

Scenes are a set of Settings used to set the state or values of multiple Controllers simultaneously and provide reusability of clusters of Settings.

ActionGroups may be used with Triggers to achieve the same effect as a Setting. The difference between a set of Actions and a Setting are the presence of rules in the Actions. These rules may determine which Actions within an ActionGroup apply at tha time within a context. As such, each evaluation across an ActionGroup may result in different sets of executed Actions unlike Scenes whose complete set of Settings are known up front and may be thought of as a multicast group.

System Cataloging

All Devices, Inputs, Controllers, Settings, Scenes, Triggers , and ActionGroups may be organized into federateable OsidCatalogs called Systems.

Sub Packages

The Control OSID includes a Control Rules OSID for managing rules amd a Control Batch OSID for managing Devices, Inputs, Controllers, Scenes, Settings, Triggers, and ActionGroups in bulk.

Copyright © 2013 Ingenescus. All Rights Reserved.

This Work is being provided by the copyright holder(s) subject to the following license. By obtaining, using and/or copying this Work, you agree that you have read, understand, and will comply with the following terms and conditions.

Permission to use, copy and distribute unmodified versions of this Work, for any purpose, without fee or royalty is hereby granted, provided that you include the above copyright notices and the terms of this license on ALL copies of the Work or portions thereof.

You may nodify or create Derivatives of this Work only for your internal purposes. You shall not distribute or transfer any such Derivative of this Work to any location or to any third party. For the purposes of this license, "Derivative" shall mean any derivative of the Work as defined in the United States Copyright Act of 1976, such as a translation or modification.

This Work and the information contained herein is provided on an "AS IS" basis WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE WORK OR THE USE OR OTHER DEALINGS IN THE WORK.

The export of software employing encryption technology may require a specific license from the United States Government. It is the responsibility of any person or organization contemplating export to obtain such a license before exporting this Work.