Interface OffsetEventEnablerLookupSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface OffsetEventEnablerLookupSession
extends OsidSession

This session provides methods for retrieving OffsetEventEnablers .

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

Modifier and Type	Method	Description
boolean	canLookupOffsetEventEnablers()	Tests if this user can perform OffsetEventEnablers lookups.
Calendar	getCalendar()	Gets the Calendar associated with this session.
Id	getCalendarId()	Gets the Calendar Id associated with this session.
OffsetEventEnabler	getOffsetEventEnabler(Id offsetEventEnablerId)	Gets the OffsetEventEnabler specified by its Id .
OffsetEventEnablerList	getOffsetEventEnablers()	Gets all OffsetEventEnablers .
OffsetEventEnablerList	getOffsetEventEnablersByGenusType(Type offsetEventEnablerGenusType)	Gets an OffsetEventEnablerList corresponding to the given offset event enabler genus Type which does not include offset event enablers of genus types derived from the specified Type .
OffsetEventEnablerList	getOffsetEventEnablersByIds(IdList offsetEventEnablerIds)	Gets an OffsetEventEnablerList corresponding to the given IdList .
OffsetEventEnablerList	getOffsetEventEnablersByParentGenusType(Type offsetEventEnablerGenusType)	Gets an OffsetEventEnablerList corresponding to the given offset event enabler genus Type and include any additional offset event enablers with genus types derived from the specified Type .
OffsetEventEnablerList	getOffsetEventEnablersByRecordType(Type offsetEventEnablerRecordType)	Gets an OffsetEventEnablerList containing the given offset event enabler record Type .
OffsetEventEnablerList	getOffsetEventEnablersOnDate(DateTime from, DateTime to)	Gets an OffsetEventEnablerList effective for the entire the given date range inclusive but not confisned to the date range for any agent.
OffsetEventEnablerList	getOffsetEventEnablersOnDateWithAgent(Id agentId, DateTime from, DateTime to)	Gets an OffsetEventEnablerList effective for the entire the given date range.
void	useActiveOffsetEventEnablerView()	Only active offset event enablers are returned by methods in this session.
void	useAnyStatusOffsetEventEnablerView()	All active and inactive offset event enablers are returned by methods in this session.
void	useComparativeOffsetEventEnablerView()	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	usePlenaryOffsetEventEnablerView()	A complete view of the OffsetEventEnabler returns is desired.

Methods inherited from interface Closeable

close

Methods inherited from interface OsidSession

close

Modifier and Type	Method	Description
void	close()	Close this session.

Methods inherited from interface OsidSession

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

Modifier and Type	Method	Description
Agent	getAuthenticatedAgent()	Gets the agent authenticated to this session.
Id	getAuthenticatedAgentId()	Gets the Id of the agent authenticated to this session.
BigDecimal	getClockRate()	Gets the rate of the service clock.
Date	getDate()	Gets the service date which may be the current date or the effective date in which this session exists.
Agent	getEffectiveAgent()	Gets the effective agent in use by this session.
Id	getEffectiveAgentId()	Gets the Id of the effective agent in use by this session.
Type	getFormatType()	Gets the DisplayText format Type preference in effect for this session.
Locale	getLocale()	Gets the locale indicating the localization preferences in effect for this session.
boolean	isAuthenticated()	Tests if an agent is authenticated to this session.
Transaction	startTransaction()	Starts a new transaction for this sesson.
boolean	supportsTransactions()	Tests for the availability of transactions.

Method Details

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.

canLookupOffsetEventEnablers

boolean canLookupOffsetEventEnablers()

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

useComparativeOffsetEventEnablerView

void useComparativeOffsetEventEnablerView()

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.

usePlenaryOffsetEventEnablerView

void usePlenaryOffsetEventEnablerView()

A complete view of the OffsetEventEnabler 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 offset 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.

useActiveOffsetEventEnablerView

void useActiveOffsetEventEnablerView()

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

Compliance:

mandatory - This method is must be implemented.

useAnyStatusOffsetEventEnablerView

void useAnyStatusOffsetEventEnablerView()

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

Compliance:

mandatory - This method is must be implemented.

getOffsetEventEnabler

OffsetEventEnabler getOffsetEventEnabler(Id offsetEventEnablerId)
                                  throws NotFoundException,
OperationFailedException,
PermissionDeniedException

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

Parameters:

offsetEventEnablerId - Id of the OffsetEventEnabler

Returns:

the offset event enabler

Throws:

NotFoundException - offsetEventEnablerId not found

NullArgumentException - offsetEventEnablerId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method is must be implemented.

getOffsetEventEnablersByIds

OffsetEventEnablerList getOffsetEventEnablersByIds(IdList offsetEventEnablerIds)
                                            throws NotFoundException,
OperationFailedException,
PermissionDeniedException

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

Parameters:

offsetEventEnablerIds - the list of Ids to retrieve

Returns:

the returned OffsetEventEnabler list

Throws:

NotFoundException - an Id was not found

NullArgumentException - offsetEventEnablerIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getOffsetEventEnablersByGenusType

OffsetEventEnablerList getOffsetEventEnablersByGenusType(Type offsetEventEnablerGenusType)
                                                  throws OperationFailedException,
PermissionDeniedException

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

Parameters:

offsetEventEnablerGenusType - an offset event enabler genus type

Returns:

the returned OffsetEventEnabler list

Throws:

NullArgumentException - offsetEventEnablerGenusType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getOffsetEventEnablersByParentGenusType

OffsetEventEnablerList getOffsetEventEnablersByParentGenusType(Type offsetEventEnablerGenusType)
                                                        throws OperationFailedException,
PermissionDeniedException

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

Parameters:

offsetEventEnablerGenusType - an offset event enabler genus type

Returns:

the returned OffsetEventEnabler list

Throws:

NullArgumentException - offsetEventEnablerGenusType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getOffsetEventEnablersByRecordType

OffsetEventEnablerList getOffsetEventEnablersByRecordType(Type offsetEventEnablerRecordType)
                                                   throws OperationFailedException,
PermissionDeniedException

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

Parameters:

offsetEventEnablerRecordType - an offset event enabler record type

Returns:

the returned OffsetEventEnabler list

Throws:

NullArgumentException - ofsetEventEnablerRecordType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getOffsetEventEnablersOnDate

OffsetEventEnablerList getOffsetEventEnablersOnDate(DateTime from,
 DateTime to)
                                             throws OperationFailedException,
PermissionDeniedException

Gets an OffsetEventEnablerList 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 offset event enablers or an error results. Otherwise, the returned list may contain only those offset event enablers that are accessible through this session. In active mode, offset event enablers are returned that are currently active in addition to being effective during the given date range. In any status mode, active and inactive offset event enablers are returned.

Parameters:

from - a start date

to - an end date

Returns:

the returned OffsetEventEnabler 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.

getOffsetEventEnablersOnDateWithAgent

OffsetEventEnablerList getOffsetEventEnablersOnDateWithAgent(Id agentId,
 DateTime from,
 DateTime to)
                                                      throws OperationFailedException,
PermissionDeniedException

Gets an OffsetEventEnablerList 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 offset event enablers or an error results. Otherwise, the returned list may contain only those offset event enablers that are accessible through this session. In active mode, offset event enablers are returned that are currently active. In any status mode, active and inactive offset event enablers are returned.

Parameters:

agentId - an agent Id

from - a start date

to - an end date

Returns:

the returned OffsetEventEnabler 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.

getOffsetEventEnablers

OffsetEventEnablerList getOffsetEventEnablers()
                                       throws OperationFailedException,
PermissionDeniedException

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

Returns:

the returned OffsetEventEnabler list

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.