org.osid.topology.rules

Interface EdgeEnablerLookupSession

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, OsidSession

public interface EdgeEnablerLookupSession
extends OsidSession

This session provides methods for retrieving EdgeEnablers.

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 graph view: All edge enabler methods in this session operate, retrieve and pertain to edge enablers defined explicitly in the current graph. Using an isolated view is useful for managing EdgeEnablers with the EdgeEnablerAdminSession.
• federated graph view: All edge enabler methods in this session operate, retrieve and pertain to all edge enablers defined in this graph and any other edge enablers implicitly available in this graph through graph inheritence.
• active edge enabler view: All edge enabler lookup methods return active edge enablers.
• any status edge enabler view: Edge 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 useFederatedDistributorView() and useIsolatedDistributorView() behave as a radio group and one should be selected before invoking the methods in this session.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canLookupEdgeEnablers() Tests if this user can perform EdgeEnablers lookups.
EdgeEnabler	getEdgeEnabler(Id edgeEnablerId) Gets the EdgeEnabler specified by its Id.
EdgeEnablerList	getEdgeEnablers() Gets all EdgeEnablers.
EdgeEnablerList	getEdgeEnablersByGenusType(Type edgeEnablerGenusType) Gets an EdgeEnablerList corresponding to the given edge enabler genus Type which does not include edge enablers of genus types derived from the specified Type.
EdgeEnablerList	getEdgeEnablersByIds(IdList edgeEnablerIds) Gets an EdgeEnablerList corresponding to the given IdList.
EdgeEnablerList	getEdgeEnablersByParentGenusType(Type edgeEnablerGenusType) Gets an EdgeEnablerList corresponding to the given edge enabler genus Type and include any additional edge enablers with genus types derived from the specified Type.
EdgeEnablerList	getEdgeEnablersByRecordType(Type edgeEnablerRecordType) Gets an EdgeEnablerList containing the given edge enabler record Type.
EdgeEnablerList	getEdgeEnablersOnDate(DateTime from, DateTime to) Gets an EdgeEnablerList which are effective for the entire given date range inclusive but not confined to the date range for any agent.
EdgeEnablerList	getEdgeEnablersOnDateWithAgent(Id agentId, DateTime from, DateTime to) Gets an EdgeEnablerList which are effective for the entire given date range inclusive but not confined to the date range and evaluated against the given agent.
Graph	getGraph() Gets the Graph associated with this session.
Id	getGraphId() Gets the Graph Id associated with this session.
void	useActiveEdgeEnablerView() Only active edge enablers are current are returned by methods in this session.
void	useAnyStatusEdgeEnablerView() All active and inactive edge enablers are returned by methods in this session.
void	useComparativeEdgeEnablerView() 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	useFederatedGraphView() Federates the view for methods in this session.
void	useIsolatedGraphView() Isolates the view for methods in this session.
void	usePlenaryEdgeEnablerView() A complete view of the EdgeEnabler returns is desired.

Methods inherited from interface org.osid.OsidSession

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

Methods inherited from interface org.osid.binding.java.OsidSession

close

Methods inherited from interface java.io.Closeable

close

Method Detail

getGraphId

Id getGraphId()

Gets the Graph Id associated with this session.

Returns:

the Graph Id associated with this session

Compliance:

mandatory - This method must be implemented.

getGraph

Graph getGraph()
               throws OperationFailedException,
                      PermissionDeniedException

Gets the Graph associated with this session.

Returns:

the graph

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canLookupEdgeEnablers

boolean canLookupEdgeEnablers()

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

useComparativeEdgeEnablerView

void useComparativeEdgeEnablerView()

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.

usePlenaryEdgeEnablerView

void usePlenaryEdgeEnablerView()

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

useFederatedGraphView

void useFederatedGraphView()

Federates the view for methods in this session. A federated view will include edge enablers in ontologies which are children of this graph in the graph hierarchy.

Compliance:

mandatory - This method is must be implemented.

useIsolatedGraphView

void useIsolatedGraphView()

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

Compliance:

mandatory - This method is must be implemented.

useActiveEdgeEnablerView

void useActiveEdgeEnablerView()

Only active edge enablers are current are returned by methods in this session.

Compliance:

mandatory - This method is must be implemented.

useAnyStatusEdgeEnablerView

void useAnyStatusEdgeEnablerView()

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

Compliance:

mandatory - This method is must be implemented.

getEdgeEnabler

EdgeEnabler getEdgeEnabler(Id edgeEnablerId)
                           throws NotFoundException,
                                  OperationFailedException,
                                  PermissionDeniedException

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

Parameters:

edgeEnablerId - Id of the EdgeEnabler

Returns:

the edge enabler

Throws:

NotFoundException - edgeEnablerId not found

NullArgumentException - edgeEnablerId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method is must be implemented.

getEdgeEnablersByIds

EdgeEnablerList getEdgeEnablersByIds(IdList edgeEnablerIds)
                                     throws NotFoundException,
                                            OperationFailedException,
                                            PermissionDeniedException

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

Parameters:

edgeEnablerIds - the list of Ids to retrieve

Returns:

the returned EdgeEnabler list

Throws:

NotFoundException - an Id was not found

NullArgumentException - edgeEnablerIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getEdgeEnablersByGenusType

EdgeEnablerList getEdgeEnablersByGenusType(Type edgeEnablerGenusType)
                                           throws OperationFailedException,
                                                  PermissionDeniedException

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

Parameters:

edgeEnablerGenusType - an edge enabler genus type

Returns:

the returned EdgeEnabler list

Throws:

NullArgumentException - edgeEnablerGenusType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getEdgeEnablersByParentGenusType

EdgeEnablerList getEdgeEnablersByParentGenusType(Type edgeEnablerGenusType)
                                                 throws OperationFailedException,
                                                        PermissionDeniedException

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

Parameters:

edgeEnablerGenusType - an edge enabler genus type

Returns:

the returned EdgeEnabler list

Throws:

NullArgumentException - edgeEnablerGenusType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getEdgeEnablersByRecordType

EdgeEnablerList getEdgeEnablersByRecordType(Type edgeEnablerRecordType)
                                            throws OperationFailedException,
                                                   PermissionDeniedException

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

Parameters:

edgeEnablerRecordType - an edge enabler record type

Returns:

the returned EdgeEnabler list

Throws:

NullArgumentException - edgeEnablerRecordType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getEdgeEnablersOnDate

EdgeEnablerList getEdgeEnablersOnDate(DateTime from,
                                    DateTime to)
                                      throws OperationFailedException,
                                             PermissionDeniedException

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

Parameters:

from - a start date

to - an end date

Returns:

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

getEdgeEnablersOnDateWithAgent

EdgeEnablerList getEdgeEnablersOnDateWithAgent(Id agentId,
                                             DateTime from,
                                             DateTime to)
                                               throws OperationFailedException,
                                                      PermissionDeniedException

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

Parameters:

agentId - an agent Id

from - a start date

to - an end date

Returns:

the returned EdgeEnabler list

Throws:

InvalidArgumentException - from is greater than to

NullArgumentException - agentId, from, or to is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getEdgeEnablers

EdgeEnablerList getEdgeEnablers()
                                throws OperationFailedException,
                                       PermissionDeniedException

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

Returns:

the returned EdgeEnabler list

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.