public interface CyclicTimePeriodLookupSession extends OsidSession
This session provides methods for retrieving CyclicTimePeriod
objects.
This session defines views that offer differing behaviors when retrieving multiple objects.
CyclicTimePeriodAdminSession.
Cyclic time periods may have an additional records indicated by their
respective record types. The record may not be accessed through a cast of
the CyclicTimePeriod.
Modifier and Type | Method and Description |
---|---|
boolean |
canLookupCyclicTimePeriods()
Tests if this user can perform
CyclicTimePeriod
lookups. |
Calendar |
getCalendar()
Gets the
Calendar associated with this session. |
Id |
getCalendarId()
Gets the
Calendar Id associated with
this session. |
CyclicTimePeriod |
getCyclicTimePeriod(Id cyclicTimePeriodId)
Gets the
CyclicTimePeriod specified by its Id. |
CyclicTimePeriodList |
getCyclicTimePeriods()
Gets all
CyclicTimePeriods. |
CyclicTimePeriodList |
getCyclicTimePeriodsByGenusType(Type cyclicTimePeriodGenusType)
Gets a
CyclicTimePeriodList corresponding to the given
cyclic time period genus Type which does not include
cyclic time periods of genus types derived from the specified
Type. |
CyclicTimePeriodList |
getCyclicTimePeriodsByIds(IdList cyclicTimePeriodIds)
Gets a
CyclicTimePeriodList corresponding to the given
IdList. |
CyclicTimePeriodList |
getCyclicTimePeriodsByParentGenusType(Type cyclicTimePeriodGenusType)
Gets a
CyclicTimePeriodList corresponding to the given
cyclic time period genus Type and include any
additional cyclic time periods with genus types derived from the
specified Type. |
CyclicTimePeriodList |
getCyclicTimePeriodsByRecordType(Type cyclicTimePeriodRecordType)
Gets a
CyclicTimePeriodList containing the given cyclic
time period record Type. |
void |
useComparativeCyclicTimePeriodView()
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 |
usePlenaryCyclicTimePeriodView()
A complete view of the
CyclicTimePeriod returns is
desired. |
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 canLookupCyclicTimePeriods()
CyclicTimePeriod
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. false
if lookup methods are not authorized,
true
otherwisemandatory
- This method must be implemented. void useComparativeCyclicTimePeriodView()
mandatory
- This method is must be implemented. void usePlenaryCyclicTimePeriodView()
CyclicTimePeriod
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.mandatory
- This method is must be implemented. void useFederatedCalendarView()
mandatory
- This method is must be implemented. void useIsolatedCalendarView()
mandatory
- This method is must be implemented. CyclicTimePeriod getCyclicTimePeriod(Id cyclicTimePeriodId) throws NotFoundException, OperationFailedException, PermissionDeniedException
CyclicTimePeriod
specified by its Id.
In plenary mode, the exact Id
is found or a
NOT_FOUND
results. Otherwise, the returned
CyclicTimePeriod
may have a different Id
than
requested, such as the case where a duplicate Id
was
assigned to a CyclicTimePeriod
and retained for
compatibility.cyclicTimePeriodId
- Id
of the
CyclicTimePeriod
NotFoundException
- cyclicTimePeriodId
not foundNullArgumentException
- cyclicTimePeriodId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method is must be implemented. CyclicTimePeriodList getCyclicTimePeriodsByIds(IdList cyclicTimePeriodIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
CyclicTimePeriodList
corresponding to the given
IdList.
In plenary mode, the returned list contains all
of the cyclic 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 CyclicTimePeriods
may be
omitted from the list and may present the elements in any order
including returning a unique set.cyclicTimePeriodIds
- the list of Ids
to retrieve CyclicTimePeriod
listNotFoundException
- an Id was
not foundNullArgumentException
- rimePeriodIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. CyclicTimePeriodList getCyclicTimePeriodsByGenusType(Type cyclicTimePeriodGenusType) throws OperationFailedException, PermissionDeniedException
CyclicTimePeriodList
corresponding to the given
cyclic time period genus Type
which does not include
cyclic time periods of genus types derived from the specified
Type.
In plenary mode, the returned list contains all known
cyclic time periods or an error results. Otherwise, the returned list
may contain only those cyclic time periods that are accessible through
this session.cyclicTimePeriodGenusType
- a cyclic time period genus type CyclicTimePeriod
listNullArgumentException
-
cyclicTimePeriodGenusType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. CyclicTimePeriodList getCyclicTimePeriodsByParentGenusType(Type cyclicTimePeriodGenusType) throws OperationFailedException, PermissionDeniedException
CyclicTimePeriodList
corresponding to the given
cyclic time period genus Type
and include any
additional cyclic time periods with genus types derived from the
specified Type.
In plenary mode, the returned list
contains all known cyclic time periods or an error results. Otherwise,
the returned list may contain only those cyclic time periods that are
accessible through this session.cyclicTimePeriodGenusType
- a cyclic time period genus type CyclicTimePeriod
listNullArgumentException
-
cyclicTimePeriodGenusType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. CyclicTimePeriodList getCyclicTimePeriodsByRecordType(Type cyclicTimePeriodRecordType) throws OperationFailedException, PermissionDeniedException
CyclicTimePeriodList
containing the given cyclic
time period record Type.
In plenary mode, the returned
list contains all known cyclic time periods or an error results.
Otherwise, the returned list may contain only those cyclic time
periods that are accessible through this session.cyclicTimePeriodRecordType
- a cyclic time period record type CyclicTimePeriod
listNullArgumentException
-
cyclicTimePeriodRecordType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. CyclicTimePeriodList getCyclicTimePeriods() throws OperationFailedException, PermissionDeniedException
CyclicTimePeriods.
In plenary mode, the
returned list contains all known cyclic time periods or an error
results. Otherwise, the returned list may contain only those cyclic
time periods that are accessible through this session. In both cases,
the order of the set is not specified. CyclicTimePeriodList
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.