Interface SpeedZoneEnablerLookupSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface SpeedZoneEnablerLookupSession
extends OsidSession

This session provides methods for retrieving SpeedZoneEnablers .

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 map view: All speed zone enabler methods in this session operate, retrieve and pertain to speed zone enablers defined explicitly in the current map. Using an isolated view is useful for managing SpeedZoneEnablers with the SpeedZoneEnablerAdminSession .
• federated map view: All speed zone enabler methods in this session operate, retrieve and pertain to all speed zone enablers defined in this map and any other speed zone enablers implicitly available in this map through map inheritence.
• active speed zone enabler view: All speed zone enabler lookup methods return active speed zone enablers.
• any active speed zone enabler view: Speed zone enablers of any active or 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 useFederatedMapView() and useIsolatedMapView() 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	canLookupSpeedZoneEnablers()	Tests if this user can perform SpeedZoneEnablers lookups.
Map	getMap()	Gets the Map associated with this session.
Id	getMapId()	Gets the Map Id associated with this session.
SpeedZoneEnabler	getSpeedZoneEnabler(Id speedZoneEnablerId)	Gets the SpeedZoneEnabler specified by its Id .
SpeedZoneEnablerList	getSpeedZoneEnablers()	Gets all SpeedZoneEnablers .
SpeedZoneEnablerList	getSpeedZoneEnablersByGenusType(Type speedZoneEnablerGenusType)	Gets a SpeedZoneEnablerList corresponding to the given speed zone enabler genus Type which does not include speed zone enablers of genus types derived from the specified Type .
SpeedZoneEnablerList	getSpeedZoneEnablersByIds(IdList speedZoneEnablerIds)	Gets a SpeedZoneEnablerList corresponding to the given IdList .
SpeedZoneEnablerList	getSpeedZoneEnablersByParentGenusType(Type speedZoneEnablerGenusType)	Gets a SpeedZoneEnablerList corresponding to the given speed zone enabler genus Type and include any additional speed zone enablers with genus types derived from the specified Type .
SpeedZoneEnablerList	getSpeedZoneEnablersByRecordType(Type speedZoneEnablerRecordType)	Gets a SpeedZoneEnablerList containing the given speed zone enabler record Type .
SpeedZoneEnablerList	getSpeedZoneEnablersOnDate(DateTime from, DateTime to)	Gets a SpeedZoneEnablerList that are effective for the entire given date range inclusive but not confined to the date range for any agent.
SpeedZoneEnablerList	getSpeedZoneEnablersOnDateWithAgent(Id agentId, DateTime from, DateTime to)	Gets a SpeedZoneEnablerList that are effective for the entire given date range inclusive but not confined to the date range and evaluated against the given agent.
void	useActiveSpeedZoneEnablerView()	Only active speed zone enablers are returned by methods in this session.
void	useAnyStatusSpeedZoneEnablerView()	All active and inactive speed zone enablers are returned by methods in this session.
void	useComparativeSpeedZoneEnablerView()	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	useFederatedMapView()	Federates the view for methods in this session.
void	useIsolatedMapView()	Isolates the view for methods in this session.
void	usePlenarySpeedZoneEnablerView()	A complete view of the SpeedZoneEnabler 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

getMapId

Id getMapId()

Gets the Map Id associated with this session.

Returns:

the Map Id associated with this session

Compliance:

mandatory - This method must be implemented.

getMap

Map getMap()
    throws OperationFailedException,
PermissionDeniedException

Gets the Map associated with this session.

Returns:

the map

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canLookupSpeedZoneEnablers

boolean canLookupSpeedZoneEnablers()

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

useComparativeSpeedZoneEnablerView

void useComparativeSpeedZoneEnablerView()

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.

usePlenarySpeedZoneEnablerView

void usePlenarySpeedZoneEnablerView()

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

useFederatedMapView

void useFederatedMapView()

Federates the view for methods in this session. A federated view will include speed zone enablers in maps which are children of this map in the map hierarchy.

Compliance:

mandatory - This method is must be implemented.

useIsolatedMapView

void useIsolatedMapView()

Isolates the view for methods in this session. An isolated view restricts lookups to this map only.

Compliance:

mandatory - This method is must be implemented.

useActiveSpeedZoneEnablerView

void useActiveSpeedZoneEnablerView()

Only active speed zone enablers are returned by methods in this session.

Compliance:

mandatory - This method is must be implemented.

useAnyStatusSpeedZoneEnablerView

void useAnyStatusSpeedZoneEnablerView()

All active and inactive speed zone enablers are returned by methods in this session.

Compliance:

mandatory - This method is must be implemented.

getSpeedZoneEnabler

SpeedZoneEnabler getSpeedZoneEnabler(Id speedZoneEnablerId)
                              throws NotFoundException,
OperationFailedException,
PermissionDeniedException

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

Parameters:

speedZoneEnablerId - Id of the SpeedZoneEnabler

Returns:

the speed zone enabler

Throws:

NotFoundException - speedZoneEnablerId not found

NullArgumentException - speedZoneEnablerId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method is must be implemented.

getSpeedZoneEnablersByIds

SpeedZoneEnablerList getSpeedZoneEnablersByIds(IdList speedZoneEnablerIds)
                                        throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets a SpeedZoneEnablerList corresponding to the given IdList . In plenary mode, the returned list contains all of the speed zone enablers specified in the Id list, in the order of the list, including duplicates, or an error results if a Id in the supplied list is not found or inaccessible. Otherwise, inaccessible SpeedZoneEnablers may be omitted from the list and may present the elements in any order including returning a unique set. In active mode, speed zone enablers are returned that are currently active. In any status mode, active and inactive speed zone enablers are returned.

Parameters:

speedZoneEnablerIds - the list of Ids to retrieve

Returns:

the returned SpeedZoneEnabler list

Throws:

NotFoundException - a Id was not found

NullArgumentException - speedZoneEnablerIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getSpeedZoneEnablersByGenusType

SpeedZoneEnablerList getSpeedZoneEnablersByGenusType(Type speedZoneEnablerGenusType)
                                              throws OperationFailedException,
PermissionDeniedException

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

Parameters:

speedZoneEnablerGenusType - a speed zone enabler genus type

Returns:

the returned SpeedZoneEnabler list

Throws:

NullArgumentException - speedZoneEnablerGenusType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getSpeedZoneEnablersByParentGenusType

SpeedZoneEnablerList getSpeedZoneEnablersByParentGenusType(Type speedZoneEnablerGenusType)
                                                    throws OperationFailedException,
PermissionDeniedException

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

Parameters:

speedZoneEnablerGenusType - a speed zone enabler genus type

Returns:

the returned SpeedZoneEnabler list

Throws:

NullArgumentException - speedZoneEnablerGenusType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getSpeedZoneEnablersByRecordType

SpeedZoneEnablerList getSpeedZoneEnablersByRecordType(Type speedZoneEnablerRecordType)
                                               throws OperationFailedException,
PermissionDeniedException

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

Parameters:

speedZoneEnablerRecordType - a speed zone enabler record type

Returns:

the returned SpeedZoneEnabler list

Throws:

NullArgumentException - speedZoneEnablerRecordType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getSpeedZoneEnablersOnDate

SpeedZoneEnablerList getSpeedZoneEnablersOnDate(DateTime from,
 DateTime to)
                                         throws OperationFailedException,
PermissionDeniedException

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

Parameters:

from - a start date

to - an end date

Returns:

the returned SpeedZoneEnabler list

Throws:

InvalidArgumentException - from is greater tha to

NullArgumentException - from or to is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getSpeedZoneEnablersOnDateWithAgent

SpeedZoneEnablerList getSpeedZoneEnablersOnDateWithAgent(Id agentId,
 DateTime from,
 DateTime to)
                                                  throws OperationFailedException,
PermissionDeniedException

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

Parameters:

agentId - an agent Id

from - a start date

to - an end date

Returns:

the returned SpeedZoneEnabler list

Throws:

InvalidArgumentException - from is greater tha to

NullArgumentException - agentId, from , or to is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getSpeedZoneEnablers

SpeedZoneEnablerList getSpeedZoneEnablers()
                                   throws OperationFailedException,
PermissionDeniedException

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

Returns:

the returned SpeedZoneEnabler list

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.