Package org.osid.calendaring.cycle

The Open Service Interface Definitions for the org.osid.calendaring.cycle service.

See: Description

Interface Summary

Interface	Description
CalendaringCycleManager	The calendaring cycle manager provides access to calendaring cycle sessions and provides interoperability tests for various aspects of this service.
CalendaringCycleProfile	The CalendaringCycleProfile describes the interoperability among calendaring cycle services.
CalendaringCycleProxyManager	The calendaring manager provides access to calendaring sessions and provides interoperability tests for various aspects of this service.
CyclicEvent	An CyclicEvent represents canonical event.
CyclicEventAdminSession	This session creates, updates, and deletes Cyclic Events.
CyclicEventCalendarAssignmentSession	This session provides methods to re-assign CyclicEvents to Calendars.
CyclicEventCalendarSession	This session provides methods to retrieve CyclicEvent to Calendar mappings.
CyclicEventForm	This is the form for creating and updating Events.
CyclicEventList	Like all OsidLists, CyclicEventList provides a means for accessing CyclicEvent elements sequentially either one at a time or many at a time.
CyclicEventLookupSession	This session provides methods for retrieving CyclicEvent s.
CyclicEventNotificationSession	This session defines methods to receive asynchronous notifications on adds/changes to CyclicEvent objects.
CyclicEventQuery	This is the query for searching cyclic events.
CyclicEventQueryInspector	This is the query inspector for examining event queries.
CyclicEventQuerySession	This session provides methods for searching CyclicEvent objects.
CyclicEventReceiver	The cyclic event receiver is the consumer supplied interface for receiving notifications pertaining to new, updated or deleted CyclicEvents.
CyclicEventSearch	EventSearch defines the interface for specifying event search options.
CyclicEventSearchOrder	An interface for specifying the ordering of search results.
CyclicEventSearchResults	This interface provides a means to capture results of a search.
CyclicEventSearchSession	This session provides methods for searching Event objects.
CyclicEventSmartCalendarSession	This session manages queries and sequencing to create "smart" dynamic catalogs.
CyclicTimePeriod	A CyclicTimePeriod represents a canonical span of time.
CyclicTimePeriodAdminSession	This session creates, updates, and deletes CyclicTimePeriods.
CyclicTimePeriodCalendarAssignmentSession	This session provides methods to re-assign CyclicTimePeriods to Calendars.
CyclicTimePeriodCalendarSession	This session provides methods to retrieve CyclicTimePeriod to Calendar mappings.
CyclicTimePeriodForm	This is the form for creating and updating CyclicTimePeriods.
CyclicTimePeriodList	Like all OsidLists, CyclicTimePeriodList provides a means for accessing CyclicTimePeriod elements sequentially either one at a time or many at a time.
CyclicTimePeriodLookupSession	This session provides methods for retrieving CyclicTimePeriod objects.
CyclicTimePeriodNotificationSession	This session defines methods to receive asynchronous notifications on adds/changes to CyclicTimePeriods.
CyclicTimePeriodQuery	This is the query for searching cyclic time periods.
CyclicTimePeriodQueryInspector	This is the query inspector for examining cyclic time period queries.
CyclicTimePeriodQuerySession	This session provides methods for searching CyclicTimePeriod objects.
CyclicTimePeriodReceiver	The cyclic time period receiver is the consumer supplied interface for receiving notifications pertaining to new, updated or deleted CyclicTimePeriods.
CyclicTimePeriodSearch	CyclicTimePeriodSearch defines the interface for specifying cyclic time period search options.
CyclicTimePeriodSearchOrder	An interface for specifying the ordering of search results.
CyclicTimePeriodSearchResults	This interface provides a means to capture results of a search.
CyclicTimePeriodSearchSession	This session provides methods for searching CyclicTimePeriod objects.
CyclicTimePeriodSmartCalendarSession	This session manages queries and sequencing to create "smart" dynamic catalogs.
EventCyclicEventAssignmentSession	This session provides methods to manually assign Events to CyclicEvents.
EventCyclicEventLookupSession	This session provides methods to retrieve CyclicEvent to Event mappings.
TimePeriodCyclicTimePeriodAssignmentSession	This session provides methods to manually assign TimePeriods to CyclicTimePeriods.
TimePeriodCyclicTimePeriodLookupSession	This session provides methods to retrieve CyclicTimePeriod to TimePeriod mappings.

Package org.osid.calendaring.cycle Description

The Open Service Interface Definitions for the org.osid.calendaring.cycle service.

The Calendaring Cycle OSID manages canonical versions of events and time periods. This package does not define the rules to automatically generate events and time periods. This package sits in between the Calendaring OSID and the Calendaring Mason OSID where rules for generation are defined.

This package defines CyclicEvents and CyclicTimePeriods. An example of a CyclicEvent is "Thanksgiving" or "Quarterly Report Deadline" that occurs at predicatble intervals. An example of a CyclicTimePeriod is "Fiscal Q4" or "Fall Term."

This package can be positioned either or both of two ways:

• Defining and mapping existing Events and TimePeriods to these canonical counterparts for the purposes of defining rules in other OSIDs that manage a recurring behavior, such as an OsidEnabler.
• Defining rules behind CyclicEvents and CyclicTimePeriods inthe Calendaring Mason OSID to centrally manage the automatic generation of Events and TimePeriods in the Calendaring OSID. Not for the faint of heart.

Calendaring Catalogging

CyclicEvents and CyclicTimePreiods are organized into federateable Calendars.

Sub Packages

The Calendaring Cycle OSID contains a Calendaring cycle Batch OSID for managing time cycles in bulk.

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