Package org.osid.metering

package org.osid.metering

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

The Metering OSID is an auxiliary service to read measurements and calculate statistics.

Meters

The Meter represents a measure. Examples might be the number of access times or the number of bytes consumed. The Meter itself is simply the identifier for the measure. The count for a specific reference Id at the current point in time is available in a Reading of a Meter using the MeterReadingSession .

Statistics

Statistics are Readings over a period of time. Statistics offer sums, averages, and other statistical data for a Meter in a given period of time.

Cataloging

Meters can be organized into Utility catalogs for organization and federation.

Sub Packages

The Metering OSID contains a Metering Batch OSID for managing Meters in bulk and a Metering Threshold OSID for managing and subscribing to thresholds.

Copyright © 2009-2011 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.

Related Packages

Package	Description
org.osid	The Open Service Interface Definitions for the org.osid service.
org.osid.metering.batch	The Open Service Interface Definitions for the org.osid.metering.batch service.
org.osid.metering.records
org.osid.metering.threshold

Interfaces

Class	Description
Meter	A Meter represents a measure.
MeterAdminSession	This session creates, updates, and deletes Meters .
MeterForm	This is the form for creating and updating Meters .
MeteringManager	The metering manager provides access to metering sessions and provides interoperability tests for various aspects of this service.
MeteringProfile	The metering profile describes the interoperability among metering services.
MeteringProxyManager	The metering manager provides access to metering sessions and provides interoperability tests for various aspects of this service.
MeterList	Like all OsidLists , MeterList provides a means for accessing Meter elements sequentially either one at a time or many at a time.
MeterLookupSession	This session defines methods for retrieving meters.
MeterNotificationSession	This session defines methods to receive notifications on new or deleted meters.
MeterQuery	This is the query for searching meters.
MeterQueryInspector	This is the query inspector for examining meter queries.
MeterQuerySession	This session provides methods for searching among meters.
MeterReadingSession	This session is used to read meters.
MeterReceiver	The meter receiver is the consumer supplied interface for receiving notifications pertaining to new, updated or deleted Meter objects.
MeterSearch	The search interface for governing meter searches.
MeterSearchOrder	An interface for specifying the ordering of search results.
MeterSearchResults	This interface provides a means to capture results of a search.
MeterSearchSession	This session provides methods for searching among meters.
MeterSmartUtilitySession	This session manages queries and sequencing to create "smart" dynamic catalogs.
MeterUtilityAssignmentSession	This session provides methods to re-assign Meters to Utility objects A Meter may appear in multiple Utility objects and removing the last reference to a Meter is the equivalent of deleting it.
MeterUtilitySession	This session provides methods to retrieve Meter to Utility mappings.
Reading	A Reading represents data from a Meter for a referenced metered object at the current point in time.
ReadingList	Like all OsidLists , ReadingList provides a means for accessing Reading elements sequentially either one at a time or many at a time.
Statistic	A Statistic represents a reading of a Meter for a reference metered object over a period of time.
StatisticList	Like all OsidLists , StatisticList provides a means for accessing Statistic elements sequentially either one at a time or many at a time.
StatisticLookupSession	This session is used to retrieve statistics from a meter.
StatisticNotificationSession	This session defines methods to receive notifications on statistics.
StatisticQuery	This is the query for searching statistics.
StatisticQueryInspector	This is the query inspector for examining meter queries.
StatisticQuerySession	This session provides methods for searching statistics.
StatisticReceiver	The meter receiver is the consumer supplied interface for receiving notifications pertaining to new, updated or deleted Statistic objects.
StatisticSearch	The search interface for governing statistic searches.
StatisticSearchOrder	An interface for specifying the ordering of search results.
StatisticSearchResults	This interface provides a means to capture results of a search.
StatisticSearchSession	This session provides methods for searching among statistics The search query is constructed using the StatisticQuery .
StatisticSmartUtilitySession	This session manages queries and sequencing to create "smart" dynamic catalogs.
Utility	A Utility represents a collection of Meters .
UtilityAdminSession	This session creates, updates, and deletes Utilities .
UtilityForm	This is the form for creating and updating utilities.
UtilityHierarchyDesignSession	This session manages a hierarchy of utilities.
UtilityHierarchySession	This session defines methods for traversing a hierarchy of Utility objects.
UtilityList	Like all OsidLists , UtilityList provides a means for accessing Utility elements sequentially either one at a time or many at a time.
UtilityLookupSession	This session provides methods for retrieving Utility objects.
UtilityNode	This interface is a container for a partial hierarchy retrieval.
UtilityNodeList	Like all OsidLists , UtilityNodeList provides a means for accessing UtilityNode elements sequentially either one at a time or many at a time.
UtilityNotificationSession	This session defines methods to receive notifications on adds/changes to Utility objects.
UtilityQuery	This is the query for searching for utilities.
UtilityQueryInspector	This is the query inspector for examining utility queries.
UtilityQuerySession	This session provides methods for searching Utility objects.
UtilityReceiver	The utility receiver is the consumer supplied interface for receiving notifications pertaining to new, updated or deleted Utility objects.
UtilitySearch	The search interface for governing utility searches.
UtilitySearchOrder	An interface for specifying the ordering of search results.
UtilitySearchResults	This interface provides a means to capture results of a search.
UtilitySearchSession	This session provides methods for searching Utility objects.