org.osid.calendaring.rules

Interface RecurringEventEnablerLookupSession

All Superinterfaces:

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

public interface RecurringEventEnablerLookupSession
extends OsidSession

This session provides methods for retrieving RecurringEventEnablers.

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 recurring event enabler methods in this session operate, retrieve and pertain to recurring event enablers defined explicitly in the current calendar. Using an isolated view is useful for managing RecurringEventEnablers with the RecurringEventEnablerAdminSession.
• federated calendar view: All recurring event enabler methods in this session operate, retrieve and pertain to all recurring event enablers defined in this calendar and any other recurring event enablers implicitly available in this calendar through calendar inheritence.
• active recurring event enabler view: All recurring event enabler lookup methods return active offset event enablers.
• any status recurring event enabler view: Recurring event enablers of any active and inactive status are returned from methods.

Generally, the comparative view should be used for most applications as it permits operation even if there is data that cannot be accessed. The methods useFederatedDistributorView() and useIsolatedDistributorView() behave as a radio group and one should be selected before invoking the methods in this session.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canLookupRecurringEventEnablers() Tests if this user can perform RecurringEventEnabler lookups.
Calendar	getCalendar() Gets the Calendar associated with this session.
Id	getCalendarId() Gets the Calendar Id associated with this session.
RecurringEventEnabler	getRecurringEventEnabler(Id recurringEventEnablerId) Gets the RecurringEventEnabler specified by its Id.
RecurringEventEnablerList	getRecurringEventEnablers() Gets all RecurringEventEnablers.
RecurringEventEnablerList	getRecurringEventEnablersByGenusType(Type recurringEventEnablerGenusType) Gets a RecurringEventEnablerListList corresponding to the given recurring event enabler genus Type which does not include recurring event enablers of genus types derived from the specified Type.
RecurringEventEnablerList	getRecurringEventEnablersByIds(IdList recurringEventEnablerIds) Gets a RecurringEventEnablerList corresponding to the given IdList.
RecurringEventEnablerList	getRecurringEventEnablersByParentGenusType(Type recurringEventEnablerGenusType) Gets a RecurringEventEnablerListList corresponding to the given recurring event enabler genus Type and include any additional recurring event enablers with genus types derived from the specified Type.
RecurringEventEnablerList	getRecurringEventEnablersByRecordType(Type recurringEventEnablerRecordType) Gets a RecurringEventEnablerList containing the given recurring event enabler record Type.
RecurringEventEnablerList	getRecurringEventEnablersOnDate(DateTime from, DateTime to) Gets a RecurringEventEnablerListList effective for the entire the given date range inclusive but not confisned to the date range for any agent.
RecurringEventEnablerList	getRecurringEventEnablersOnDateWithAgent(Id agentId, DateTime from, DateTime to) Gets a RecurringEventEnablerListList effective for the entire the given date range.
void	useActiveRecurringEventEnablerView() Only active recurring event enablers are returned by methods in this session.
void	useAnyStatusRecurringEventEnablerView() All active and inactive recurring event enablers are returned by methods in this session.
void	useComparativeRecurringEventEnablerView() 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	usePlenaryRecurringEventEnablerView() A complete view of the RecurringEventEnabler 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

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canLookupRecurringEventEnablers

boolean canLookupRecurringEventEnablers()

Tests if this user can perform RecurringEventEnabler 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.

useComparativeRecurringEventEnablerView

void useComparativeRecurringEventEnablerView()

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.

usePlenaryRecurringEventEnablerView

void usePlenaryRecurringEventEnablerView()

A complete view of the RecurringEventEnabler 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 recurring event enablers 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.

useActiveRecurringEventEnablerView

void useActiveRecurringEventEnablerView()

Only active recurring event enablers are returned by methods in this session.

Compliance:

mandatory - This method is must be implemented.

useAnyStatusRecurringEventEnablerView

void useAnyStatusRecurringEventEnablerView()

All active and inactive recurring event enablers are returned by methods in this session.

Compliance:

mandatory - This method is must be implemented.

getRecurringEventEnabler

RecurringEventEnabler getRecurringEventEnabler(Id recurringEventEnablerId)
                                               throws NotFoundException,
                                                      OperationFailedException,
                                                      PermissionDeniedException

Gets the RecurringEventEnabler specified by its Id. In plenary mode, the exact Id is found or a NOT_FOUND results. Otherwise, the returned RecurringEventEnabler may have a different Id than requested, such as the case where a duplicate Id was assigned to a RecurringEventEnabler and retained for compatibility. In active mode, recurring event enablers are returned that are currently active. In any status mode, active and inactive recurring event enablers are returned.

Parameters:

recurringEventEnablerId - Id of the RecurringEventEnabler

Returns:

the recurring event enabler

Throws:

NotFoundException - recurringEventEnablerId not found

NullArgumentException - recurringEventEnablerId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method is must be implemented.

getRecurringEventEnablersByIds

RecurringEventEnablerList getRecurringEventEnablersByIds(IdList recurringEventEnablerIds)
                                                         throws NotFoundException,
                                                                OperationFailedException,
                                                                PermissionDeniedException

Gets a RecurringEventEnablerList corresponding to the given IdList. In plenary mode, the returned list contains all of the recurring event enablers 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 RecurringEventEnablers may be omitted from the list and may present the elements in any order including returning a unique set. In active mode, recurring event enablers are returned that are currently active. In any status mode, active and inactive recurring event enablers are returned.

Parameters:

recurringEventEnablerIds - the list of Ids to retrieve

Returns:

the returned RecurringEventEnablerList list

Throws:

NotFoundException - an Id was not found

NullArgumentException - recurringEventEnablerIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getRecurringEventEnablersByGenusType

RecurringEventEnablerList getRecurringEventEnablersByGenusType(Type recurringEventEnablerGenusType)
                                                               throws OperationFailedException,
                                                                      PermissionDeniedException

Gets a RecurringEventEnablerListList corresponding to the given recurring event enabler genus Type which does not include recurring event enablers of genus types derived from the specified Type. In plenary mode, the returned list contains all known recurring event enablers or an error results. Otherwise, the returned list may contain only those recurring event enablers that are accessible through this session. In active mode, recurring event enablers are returned that are currently active. In any status mode, active and inactive recurring event enablers are returned.

Parameters:

recurringEventEnablerGenusType - a recurring event enabler genus type

Returns:

the returned RecurringEventEnablerList list

Throws:

NullArgumentException - recurringEventEnablerGenusType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getRecurringEventEnablersByParentGenusType

RecurringEventEnablerList getRecurringEventEnablersByParentGenusType(Type recurringEventEnablerGenusType)
                                                                     throws OperationFailedException,
                                                                            PermissionDeniedException

Gets a RecurringEventEnablerListList corresponding to the given recurring event enabler genus Type and include any additional recurring event enablers with genus types derived from the specified Type. In plenary mode, the returned list contains all known recurring event enablers or an error results. Otherwise, the returned list may contain only those recurring event enablers that are accessible through this session. In active mode, recurring event enablers are returned that are currently active. In any status mode, active and inactive recurring event enablers are returned.

Parameters:

recurringEventEnablerGenusType - an offset event enabler genus type

Returns:

the returned RecurringEventEnablerList list

Throws:

NullArgumentException - recurringEventEnablerGenusType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getRecurringEventEnablersByRecordType

RecurringEventEnablerList getRecurringEventEnablersByRecordType(Type recurringEventEnablerRecordType)
                                                                throws OperationFailedException,
                                                                       PermissionDeniedException

Gets a RecurringEventEnablerList containing the given recurring event enabler record Type. In plenary mode, the returned list contains all known recurring event enablers or an error results. Otherwise, the returned list may contain only those recurring event enablers that are accessible through this session. In active mode, recurring event enablers are returned that are currently active. In any status mode, active and inactive recurring event enablers are returned.

Parameters:

recurringEventEnablerRecordType - an offset event enabler record type

Returns:

the returned RecurringEventEnablerList list

Throws:

NullArgumentException - ofsetEventEnablerRecordType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getRecurringEventEnablersOnDate

RecurringEventEnablerList getRecurringEventEnablersOnDate(DateTime from,
                                                        DateTime to)
                                                          throws OperationFailedException,
                                                                 PermissionDeniedException

Gets a RecurringEventEnablerListList effective for the entire the given date range inclusive but not confisned to the date range for any agent. In plenary mode, the returned list contains all known recurring event enablers or an error results. Otherwise, the returned list may contain only those recurring event enablers that are accessible through this session. In active mode, recurring event enablers are returned that are currently active. In any status mode, active and inactive recurring event enablers are returned.

Parameters:

from - a start date

to - an end date

Returns:

the returned RecurringEventEnablerList list

Throws:

InvalidArgumentException - from is greater than to

NullArgumentException - from or to is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getRecurringEventEnablersOnDateWithAgent

RecurringEventEnablerList getRecurringEventEnablersOnDateWithAgent(Id agentId,
                                                                 DateTime from,
                                                                 DateTime to)
                                                                   throws OperationFailedException,
                                                                          PermissionDeniedException

Gets a RecurringEventEnablerListList effective for the entire the given date range. inclusive but not confisned to the date range and evaluated against the given agent. In plenary mode, the returned list contains all known recurring event enablers or an error results. Otherwise, the returned list may contain only those recurring event enablers that are accessible through this session. In active mode, recurring event enablers are returned that are currently active. In any status mode, active and inactive recurring event enablers are returned.

Parameters:

agentId - an agent Id

from - a start date

to - an end date

Returns:

the returned RecurringEventEnabler list

Throws:

InvalidArgumentException - from is greater than to

NullArgumentException - agent, from, or to is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getRecurringEventEnablers

RecurringEventEnablerList getRecurringEventEnablers()
                                                    throws OperationFailedException,
                                                           PermissionDeniedException

Gets all RecurringEventEnablers. In plenary mode, the returned list contains all known recurring event enablers or an error results. Otherwise, the returned list may contain only those recurring event enablers that are accessible through this session. In active mode, recurring event enablers are returned that are currently active. In any status mode, active and inactive recurring event enablers are returned.

Returns:

the returned RecurringEventEnablerList list

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.