public interface RecurringEventEnablerLookupSession extends OsidSession
This session provides methods for retrieving
RecurringEventEnablers.
This session defines views that offer differing behaviors when retrieving multiple objects.
RecurringEventEnablers
with the
RecurringEventEnablerAdminSession.
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.
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. |
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.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canLookupRecurringEventEnablers()
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. false
if lookup methods are not authorized,
true
otherwisemandatory
- This method must be implemented. void useComparativeRecurringEventEnablerView()
mandatory
- This method is must be implemented. void usePlenaryRecurringEventEnablerView()
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.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. void useActiveRecurringEventEnablerView()
mandatory
- This method is must be implemented. void useAnyStatusRecurringEventEnablerView()
mandatory
- This method is must be implemented. RecurringEventEnabler getRecurringEventEnabler(Id recurringEventEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
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.recurringEventEnablerId
- Id
of the
RecurringEventEnabler
NotFoundException
- recurringEventEnablerId
not foundNullArgumentException
- recurringEventEnablerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method is must be implemented. RecurringEventEnablerList getRecurringEventEnablersByIds(IdList recurringEventEnablerIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
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.recurringEventEnablerIds
- the list of Ids
to
retrieve RecurringEventEnablerList
listNotFoundException
- an Id was
not foundNullArgumentException
- recurringEventEnablerIds
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. RecurringEventEnablerList getRecurringEventEnablersByGenusType(Type recurringEventEnablerGenusType) throws OperationFailedException, PermissionDeniedException
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.recurringEventEnablerGenusType
- a recurring event enabler genus
type RecurringEventEnablerList
listNullArgumentException
-
recurringEventEnablerGenusType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. RecurringEventEnablerList getRecurringEventEnablersByParentGenusType(Type recurringEventEnablerGenusType) throws OperationFailedException, PermissionDeniedException
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.recurringEventEnablerGenusType
- an offset event enabler genus
type RecurringEventEnablerList
listNullArgumentException
-
recurringEventEnablerGenusType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. RecurringEventEnablerList getRecurringEventEnablersByRecordType(Type recurringEventEnablerRecordType) throws OperationFailedException, PermissionDeniedException
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.recurringEventEnablerRecordType
- an offset event enabler record
type RecurringEventEnablerList
listNullArgumentException
-
ofsetEventEnablerRecordType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. RecurringEventEnablerList getRecurringEventEnablersOnDate(DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
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.from
- a start dateto
- an end date RecurringEventEnablerList
listInvalidArgumentException
- from
is
greater than to
NullArgumentException
- from
or
to
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. RecurringEventEnablerList getRecurringEventEnablersOnDateWithAgent(Id agentId, DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
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.agentId
- an agent Idfrom
- a start dateto
- an end date RecurringEventEnabler
listInvalidArgumentException
- from
is
greater than to
NullArgumentException
- agent, from,
or
to
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. RecurringEventEnablerList getRecurringEventEnablers() throws OperationFailedException, PermissionDeniedException
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. RecurringEventEnablerList
listOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.