OSID Logo
OSID Specifications
topology rules package
Version 3.0.0
Release Candidate Preview
Interfaceosid.topology.rules.EdgeEnablerLookupSession
Implementsosid.OsidSession
Description

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.

MethodgetGraphId
Description

Gets the Graph Id associated with this session.

Returnosid.id.Idthe Graph Id associated with this session
CompliancemandatoryThis method must be implemented.
MethodgetGraph
Description

Gets the Graph associated with this session.

Returnosid.topology.Graphthe graph
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanLookupEdgeEnablers
Description

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.

Returnboolean false if lookup methods are not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethoduseComparativeEdgeEnablerView
Description

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.

CompliancemandatoryThis method is must be implemented.
MethodusePlenaryEdgeEnablerView
Description

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.

CompliancemandatoryThis method is must be implemented.
MethoduseFederatedGraphView
Description

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.

CompliancemandatoryThis method is must be implemented.
MethoduseIsolatedGraphView
Description

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

CompliancemandatoryThis method is must be implemented.
MethoduseActiveEdgeEnablerView
Description

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

CompliancemandatoryThis method is must be implemented.
MethoduseAnyStatusEdgeEnablerView
Description

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

CompliancemandatoryThis method is must be implemented.
MethodgetEdgeEnabler
Description

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.

Parametersosid.id.IdedgeEnablerId Id of the EdgeEnabler
Returnosid.topology.rules.EdgeEnablerthe edge enabler
ErrorsNOT_FOUND edgeEnablerId not found
NULL_ARGUMENT edgeEnablerId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method is must be implemented.
MethodgetEdgeEnablersByIds
Description

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.

Parametersosid.id.IdListedgeEnablerIdsthe list of Ids to retrieve
Returnosid.topology.rules.EdgeEnablerListthe returned EdgeEnabler list
ErrorsNOT_FOUNDan Id was not found
NULL_ARGUMENT edgeEnablerIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetEdgeEnablersByGenusType
Description

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.

Parametersosid.type.TypeedgeEnablerGenusTypean edge enabler genus type
Returnosid.topology.rules.EdgeEnablerListthe returned EdgeEnabler list
ErrorsNULL_ARGUMENT edgeEnablerGenusType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetEdgeEnablersByParentGenusType
Description

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.

Parametersosid.type.TypeedgeEnablerGenusTypean edge enabler genus type
Returnosid.topology.rules.EdgeEnablerListthe returned EdgeEnabler list
ErrorsNULL_ARGUMENT edgeEnablerGenusType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetEdgeEnablersByRecordType
Description

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.

Parametersosid.type.TypeedgeEnablerRecordTypean edge enabler record type
Returnosid.topology.rules.EdgeEnablerListthe returned EdgeEnabler list
ErrorsNULL_ARGUMENT edgeEnablerRecordType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetEdgeEnablersOnDate
Description

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.

Parametersosid.calendaring.DateTimefroma start date
osid.calendaring.DateTimetoan end date
Returnosid.topology.rules.EdgeEnablerListthe returned EdgeEnabler list
ErrorsINVALID_ARGUMENT from is greater than to
NULL_ARGUMENT from or to is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetEdgeEnablersOnDateWithAgent
Description

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.

Parametersosid.id.IdagentIdan agent Id
osid.calendaring.DateTimefroma start date
osid.calendaring.DateTimetoan end date
Returnosid.topology.rules.EdgeEnablerListthe returned EdgeEnabler list
ErrorsINVALID_ARGUMENT from is greater than to
NULL_ARGUMENT agentId, from, or to is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetEdgeEnablers
Description

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.

Returnosid.topology.rules.EdgeEnablerListthe returned EdgeEnabler list
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.