org.osid.calendaring

Interface TimePeriodLookupSession

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, OsidSession

public interface TimePeriodLookupSession
extends OsidSession

This session provides methods for retrieving TimePeriod objects. The TimePeriod represents a period of time in which to manage recurring events.

This session defines views that offer differing behaviors when retrieving multiple objects.

• comparative view: elements may be silently omitted or re-ordered
• plenary view: provides a complete set or is an error condition
• isolated calendar view: All time period methods in this session operate, retrieve and pertain to time periods defined explicitly in the current calendar. Using an isolated view is useful for managing time periods with the TimePeriodAdminSession.
• federated calendar view: All time period methods in this session operate, retrieve and pertain to all time periods defined in this calendar and any other calendars implicitly available in this calendar through calendar inheritence.

Time periods may have an additional records indicated by their respective record types. The record may not be accessed through a cast of the TimePeriod.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canLookupTimePeriods() Tests if this user can perform TimePeriod lookups.
Calendar	getCalendar() Gets the Calendar associated with this session.
Id	getCalendarId() Gets the Calendar Id associated with this session.
TimePeriod	getTimePeriod(Id timePeriodId) Gets the TimePeriod specified by its Id.
TimePeriodList	getTimePeriods() Gets all TimePeriods.
TimePeriodList	getTimePeriodsByDate(DateTime datetime) Gets a TimePeriodList containing the given DateTime.
TimePeriodList	getTimePeriodsByGenusType(Type timePeriodGenusType) Gets a TimePeriodList corresponding to the given time period genus Type which does not include time periods of genus types derived from the specified Type.
TimePeriodList	getTimePeriodsByIds(IdList timePeriodIds) Gets a TimePeriodList corresponding to the given IdList.
TimePeriodList	getTimePeriodsByParentGenusType(Type timePeriodGenusType) Gets a TimePeriodList corresponding to the given time period genus Type and include any additional time periods with genus types derived from the specified Type.
TimePeriodList	getTimePeriodsByRecordType(Type timePeriodRecordType) Gets a TimePeriodList containing the given time period record Type.
TimePeriodList	getTimePeriodsInDateRange(DateTime start, DateTime end) Gets a TimePeriodList corresponding to the given DateTime.
void	useComparativeTimePeriodView() The returns from the lookup methods may omit or translate elements based on this session, such as authorization, and not result in an error.
void	useFederatedCalendarView() Federates the view for methods in this session.
void	useIsolatedCalendarView() Isolates the view for methods in this session.
void	usePlenaryTimePeriodView() A complete view of the TimePeriod returns is desired.

Methods inherited from interface org.osid.OsidSession

getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions

Methods inherited from interface org.osid.binding.java.OsidSession

close

Methods inherited from interface java.io.Closeable

close

Method Detail

getCalendarId

Id getCalendarId()

Gets the Calendar Id associated with this session.

Returns:

the Calendar Id associated with this session

Compliance:

mandatory - This method must be implemented.

getCalendar

Calendar getCalendar()
                     throws OperationFailedException,
                            PermissionDeniedException

Gets the Calendar associated with this session.

Returns:

the Calendar associated with this session

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canLookupTimePeriods

boolean canLookupTimePeriods()

Tests if this user can perform TimePeriod lookups. A return of true does not guarantee successful authorization. A return of false indicates that it is known all methods in this session will result in a PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer lookup operations to unauthorized users.

Returns:

false if lookup methods are not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

useComparativeTimePeriodView

void useComparativeTimePeriodView()

The returns from the lookup methods may omit or translate elements based on this session, such as authorization, and not result in an error. This view is used when greater interoperability is desired at the expense of precision.

Compliance:

mandatory - This method is must be implemented.

usePlenaryTimePeriodView

void usePlenaryTimePeriodView()

A complete view of the TimePeriod returns is desired. Methods will return what is requested or result in an error. This view is used when greater precision is desired at the expense of interoperability.

Compliance:

mandatory - This method is must be implemented.

useFederatedCalendarView

void useFederatedCalendarView()

Federates the view for methods in this session. A federated view will include time periods in calendars which are children of this calendar in the calendar hierarchy.

Compliance:

mandatory - This method is must be implemented.

useIsolatedCalendarView

void useIsolatedCalendarView()

Isolates the view for methods in this session. An isolated view restricts lookups to this calendar only.

Compliance:

mandatory - This method is must be implemented.

getTimePeriod

TimePeriod getTimePeriod(Id timePeriodId)
                         throws NotFoundException,
                                OperationFailedException,
                                PermissionDeniedException

Gets the TimePeriod specified by its Id. In plenary mode, the exact Id is found or a NOT_FOUND results. Otherwise, the returned TimePeriod may have a different Id than requested, such as the case where a duplicate Id was assigned to a TimePeriod and retained for compatibility.

Parameters:

timePeriodId - Id of the TimePeriod

Returns:

the time period

Throws:

NotFoundException - timePeriodId not found

NullArgumentException - timePeriodId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method is must be implemented.

getTimePeriodsByIds

TimePeriodList getTimePeriodsByIds(IdList timePeriodIds)
                                   throws NotFoundException,
                                          OperationFailedException,
                                          PermissionDeniedException

Gets a TimePeriodList corresponding to the given IdList. In plenary mode, the returned list contains all of the time periods specified in the Id list, in the order of the list, including duplicates, or an error results if an Id in the supplied list is not found or inaccessible. Otherwise, inaccessible TimePeriods may be omitted from the list and may present the elements in any order including returning a unique set.

Parameters:

timePeriodIds - the list of Ids to retrieve

Returns:

the returned TimePeriod list

Throws:

NotFoundException - an Id was not found

NullArgumentException - rimePeriodIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getTimePeriodsByGenusType

TimePeriodList getTimePeriodsByGenusType(Type timePeriodGenusType)
                                         throws OperationFailedException,
                                                PermissionDeniedException

Gets a TimePeriodList corresponding to the given time period genus Type which does not include time periods of genus types derived from the specified Type. In plenary mode, the returned list contains all known time periods or an error results. Otherwise, the returned list may contain only those time periods that are accessible through this session.

Parameters:

timePeriodGenusType - a time period genus type

Returns:

the returned TimePeriod list

Throws:

NullArgumentException - timePeriodGenusType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getTimePeriodsByParentGenusType

TimePeriodList getTimePeriodsByParentGenusType(Type timePeriodGenusType)
                                               throws OperationFailedException,
                                                      PermissionDeniedException

Gets a TimePeriodList corresponding to the given time period genus Type and include any additional time periods with genus types derived from the specified Type. In plenary mode, the returned list contains all known time periods or an error results. Otherwise, the returned list may contain only those time periods that are accessible through this session.

Parameters:

timePeriodGenusType - a time period genus type

Returns:

the returned TimePeriod list

Throws:

NullArgumentException - timePeriodGenusType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getTimePeriodsByRecordType

TimePeriodList getTimePeriodsByRecordType(Type timePeriodRecordType)
                                          throws OperationFailedException,
                                                 PermissionDeniedException

Gets a TimePeriodList containing the given time period record Type. In plenary mode, the returned list contains all known time periods or an error results. Otherwise, the returned list may contain only those time periods that are accessible through this session.

Parameters:

timePeriodRecordType - a time period record type

Returns:

the returned TimePeriod list

Throws:

NullArgumentException - timePeriodRecordType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getTimePeriodsByDate

TimePeriodList getTimePeriodsByDate(DateTime datetime)
                                    throws OperationFailedException,
                                           PermissionDeniedException

Gets a TimePeriodList containing the given DateTime. Time periods containing the given date are matched. In plenary mode, the returned list contains all of the time periods specified in the Id list, in the order of the list, including duplicates, or an error results if an Id in the supplied list is not found or inaccessible. Otherwise, inaccessible TimePeriods may be omitted from the list and may present the elements in any order including returning a unique set.

Parameters:

datetime - a date

Returns:

the returned TimePeriod list

Throws:

NullArgumentException - datetime is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getTimePeriodsInDateRange

TimePeriodList getTimePeriodsInDateRange(DateTime start,
                                       DateTime end)
                                         throws OperationFailedException,
                                                PermissionDeniedException

Gets a TimePeriodList corresponding to the given DateTime. Time periods whose start end end times are included in the given date range are matched.In plenary mode, the returned list contains all of the time periods specified in the Id list, in the order of the list, including duplicates, or an error results if an Id in the supplied list is not found or inaccessible. Otherwise, inaccessible TimePeriods may be omitted from the list and may present the elements in any order including returning a unique set.

Parameters:

start - start of daterange

end - end of date range

Returns:

the returned TimePeriod list

Throws:

InvalidArgumentException - end is less than start

NullArgumentException - start or end is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getTimePeriods

TimePeriodList getTimePeriods()
                              throws OperationFailedException,
                                     PermissionDeniedException

Gets all TimePeriods. In plenary mode, the returned list contains all known time periods or an error results. Otherwise, the returned list may contain only those time periods that are accessible through this session.

Returns:

a TimePeriodList

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.