Package org.osid.inquiry

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

See: Description

Interface Summary

Interface	Description
AcknowledgementNotificationSession	This session defines methods to receive notifications on adds/changes to Inquiry objects in this Inquest for resources related to the authenticated agent.
AcknowledgementSession	This session defines methods for evaluating and responding to inquiries for users.
Audit	An Audit is an OsidGovernator for a group of Inquiries.
AuditAdminSession	This session creates, updates, and deletes Audits.
AuditForm	This is the form for creating and updating Audits.
AuditInquestAssignmentSession	This session provides methods to re-assign Audit to Inquest mappings.
AuditInquestSession	This session provides methods to retrieve Audit to Inquest mappings.
AuditList	Like all OsidLists, AuditList provides a means for accessing Audit elements sequentially either one at a time or many at a time.
AuditLookupSession	This session provides methods for retrieving Audits.
AuditNotificationSession	This session defines methods to receive notifications on adds/changes to Audit objects in this Inquest.
AuditQuery	This is the query for searching audits.
AuditQueryInspector	This is the query inspector for examning audit queries.
AuditQuerySession	This session provides methods for searching among Audit objects.
AuditReceiver	The audit receiver is the consumer supplied interface for receiving notifications pertaining to new, updated or deleted audits.
AuditSearch	The search interface for governing audit searches.
AuditSearchOrder	An interface for specifying the ordering of search results.
AuditSearchResults	This interface provides a means to capture results of a search.
AuditSearchSession	This session provides methods for searching among Audit objects.
AuditSmartInquestSession	This session manages queries and sequencing to create "smart" dynamic catalogs.
Inquest	An Inquest represents a collection of reservoirs.
InquestAdminSession	This session creates, updates, and deletes Inquests.
InquestForm	This is the form for creating and updating inquests.
InquestHierarchyDesignSession	This session defines methods for managing a hierarchy of Inquest objects.
InquestHierarchySession	This session defines methods for traversing a hierarchy of Inquest objects.
InquestList	Like all OsidLists, InquestList provides a means for accessing Inquest elements sequentially either one at a time or many at a time.
InquestLookupSession	This session provides methods for retrieving Inquest objects.
InquestNode	This interface is a container for a partial hierarchy retrieval.
InquestNodeList	Like all OsidLists, InquestNodeList provides a means for accessing InquestNode elements sequentially either one at a time or many at a time.
InquestNotificationSession	This session defines methods to receive notifications on adds/changes to Inquest objects.
InquestQuery	This is the query for searching inquests.
InquestQueryInspector	This is the query inspector for examining inquest queries.
InquestQuerySession	This session provides methods for searching among Inquest objects.
InquestReceiver	The inquest receiver is the consumer supplied interface for receiving notifications pertaining to new, updated or deleted Inquest objects.
InquestSearch	The search interface for governing inquest searches.
InquestSearchOrder	An interface for specifying the ordering of search results.
InquestSearchResults	This interface provides a means to capture results of a search.
InquestSearchSession	This session provides methods for searching among Inquest objects.
Inquiry	An Inquiry is an OsidRule that determines the nature of a Response.
InquiryAdminSession	This session creates, updates, and deletes Inquiries.
InquiryForm	This is the form for creating and updating Inquiries.
InquiryInquestAssignmentSession	This session provides methods to re-assign Inquiries to Inquest mappings.
InquiryInquestSession	This session provides methods to retrieve Inquiry to Inquest mappings.
InquiryList	Like all OsidLists, InquiryList provides a means for accessing Inquiry elements sequentially either one at a time or many at a time.
InquiryLookupSession	This session provides methods for retrieving Inquiry objects.
InquiryManager	The inquiry manager provides access to inquiry sessions and provides interoperability tests for various aspects of this service.
InquiryNotificationSession	This session defines methods to receive notifications on adds/changes to Inquiry objects in this Inquest.
InquiryProfile	The inquiry profile describes the interoperability among inquiry services.
InquiryProxyManager	The inquiry proxy manager provides access to inquiry sessions and provides interoperability tests for various aspects of this service.
InquiryQuery	This is the query for searching inquiries.
InquiryQueryInspector	This is the query inspector for examining inquiry queries.
InquiryQuerySession	This session provides methods for searching among Inquiry objects.
InquiryReceiver	The inquiry receiver is the consumer supplied interface for receiving notifications pertaining to new, updated or deleted Inquiry objects.
InquirySearch	The search interface for governing inquiry searches.
InquirySearchOrder	An interface for specifying the ordering of search results.
InquirySearchResults	This interface provides a means to capture results of a search.
InquirySearchSession	This session provides methods for searching among Inquiry objects.
InquirySmartInquestSession	This session manages queries and sequencing to create "smart" dynamic catalogs.
Response	A Response to an Inquiry .
ResponseAdminSession	This session creates, updates, and deletes Responses.
ResponseForm	This is the form for creating and updating responses.
ResponseInquestAssignmentSession	This session provides methods to re-assign Responses to Inquest mappings.
ResponseInquestSession	This session provides methods to retrieve Response to Inquest responses.
ResponseList	Like all OsidLists, ResponseList provides a means for accessing Response elements sequentially either one at a time or many at a time.
ResponseLookupSession	This session defines methods for retrieving responses.
ResponseNotificationSession	This session defines methods to receive notifications on adds/changes to Response objects in this dDstributor.
ResponseQuery	This is the query for searching responses.
ResponseQueryInspector	This is the query inspector for examining response queries.
ResponseQuerySession	This session provides methods for searching among Response objects.
ResponseReceiver	The response receiver is the consumer supplied interface for receiving notifications pertaining to new, updated or deleted responses.
ResponseSearch	The search interface for governing response searches.
ResponseSearchOrder	An interface for specifying the ordering of search results.
ResponseSearchResults	This interface provides a means to capture results of a search.
ResponseSearchSession	This session provides methods for searching among Response objects.
ResponseSmartInquestSession	This session manages queries and sequencing to create "smart" dynamic catalogs.

Package org.osid.inquiry Description

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

The Inquiry OSID provides a means for managing a series of inquiries and acknowledgements. An example use of the Inquiry OSID is to capture an acknowledgement from a user before proceeding with some action.

Inquiries

An Inquiry is a question or statement posed to a user. A simple inquiry requires a yes/no response that can be recorded. An Inquiry may require the user perform some external action where the results of the action are recorded and evaluated in this service. Inquiries may be informational or may require Responses.

Audits

An Audit is a set of Inquiries that can be ordered.

Responses

A Response captures the user result of an Inquiry. Typically, a Response may simply represent a yes/no confirmation but may also be extended to capture other input data that can be evaluated.

Inquiry Workflow

The Inquiry OSID can be used as part of a workflow in which a complex series of actions and checks must be performed. The Rules Check OSID provides a means for checking Audits in which its Inquiries require positive acknowledgements in the form of Responses in order to proceed.

Inquest Cataloging

All Inquiries, Responses , and Audits may be organized into federateable OsidCatalogs called Inquests.

Sub Packages

The Inquiry OSID includes an Inquiry Rules OSID for managing the applicability of Inquiries and an Inquiry Batch OSID for managing Inquiries, Audits, and Responses 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 INPUT 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.