public interface CyclicTimePeriodQuerySession extends OsidSession
This session provides methods for searching CyclicTimePeriod
objects. The search query is constructed using the
CyclicTimePeriodQuery.
The cyclic time period record Type
also specifies the record for the cyclic time period query.
Cyclic time periods may have a query record indicated by their
respective record types. The query record is accessed via the
CyclicTimePeriodQuery.
Modifier and Type | Method and Description |
---|---|
boolean |
canSearchCyclicTimePeriods()
Tests if this user can perform
CyclicTimePeriod
searches. |
Calendar |
getCalendar()
Gets the
Calendar associated with this session. |
Id |
getCalendarId()
Gets the
Calendar Id associated with
this session. |
CyclicTimePeriodQuery |
getCyclicTimePeriodQuery()
Gets a cyclic time period query.
|
CyclicTimePeriodList |
getCyclicTimePeriodsByQuery(CyclicTimePeriodQuery cyclicTimePeriodQuery)
Gets a list of
CyclicTimePeriods matching the given
query. |
void |
useFederatedCalendarView()
Federates the view for methods in this session.
|
void |
useIsolatedCalendarView()
Isolates the view for methods in this session.
|
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getCalendarId()
Calendar
Id
associated with
this session. Calendar Id
associated with this sessionmandatory
- This method must be implemented. Calendar getCalendar() throws OperationFailedException, PermissionDeniedException
Calendar
associated with this session. Calendar
associated with this sessionOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canSearchCyclicTimePeriods()
CyclicTimePeriod
searches. 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 search operations to unauthorized users. false
if search methods are not authorized,
true
otherwisemandatory
- This method must be implemented. void useFederatedCalendarView()
mandatory
- This method is must be implemented. void useIsolatedCalendarView()
mandatory
- This method is must be implemented. CyclicTimePeriodQuery getCyclicTimePeriodQuery()
mandatory
- This method must be implemented. CyclicTimePeriodList getCyclicTimePeriodsByQuery(CyclicTimePeriodQuery cyclicTimePeriodQuery) throws OperationFailedException, PermissionDeniedException
CyclicTimePeriods
matching the given
query.cyclicTimePeriodQuery
- the cyclic time period query CyclicTimePeriodList
NullArgumentException
- cyclicTimePeriodQuery
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- cyclicTimePeriodQuery
is not of this servicemandatory
- This method must be implemented.