org.osid.topology

Interface NodeLookupSession

All Superinterfaces:

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

public interface NodeLookupSession
extends OsidSession

This session defines methods for retrieving nodes.

This lookup session defines several views:

• comparative view: elements may be silently omitted or re-ordered
• plenary view: provides a complete result set or is an error condition
• isolated graph view: All node methods in this session operate, retrieve and pertain to nodes defined explicitly in the current graph. Using an isolated view is useful for managing Nodes with the NodeAdminSession.
• federated graph view: All node lookup methods in this session operate, retrieve and pertain to all nodes defined in this graph and any other nodes implicitly available in this graph through repository inheritence.

The methods useFederatedGraphView() and useIsolatedGraphView() behave as a radio group and one should be selected before invoking any lookup methods.

Nodes may have an additional records indicated by their respective record types. The record may not be accessed through a cast of the Nodes.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canLookupNodes() Tests if this user can perform Node lookups.
Graph	getGraph() Gets the Graph associated with this session.
Id	getGraphId() Gets the Graph Id associated with this session.
Node	getNode(Id nodeId) Gets the Node specified by its Id.
NodeList	getNodes() Gets all Nodes.
NodeList	getNodesByGenusType(Type nodeGenusType) Gets a NodeList corresponding to the given node genus Type which does not include nodes of types derived from the specified Type.
NodeList	getNodesByIds(IdList nodeIds) Gets a NodeList corresponding to the given IdList.
NodeList	getNodesByParentGenusType(Type nodeGenusType) Gets a NodeList corresponding to the given node genus Type and include any additional nodes with genus types derived from the specified Type.
NodeList	getNodesByRecordType(Type nodeRecordType) Gets a NodeList containing the given node record Type.
void	useComparativeNodeView() 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	usePlenaryNodeView() A complete view of the Node 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.

canLookupNodes

boolean canLookupNodes()

Tests if this user can perform Node 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 not offer lookup operations to unauthorized users.

Returns:

false if lookup methods are not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

useComparativeNodeView

void useComparativeNodeView()

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.

usePlenaryNodeView

void usePlenaryNodeView()

A complete view of the Node 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 nodes in graphs 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 retrievals to this graph only.

Compliance:

mandatory - This method is must be implemented.

getNode

Node getNode(Id nodeId)
             throws NotFoundException,
                    OperationFailedException,
                    PermissionDeniedException

Gets the Node specified by its Id. In plenary mode, the exact Id is found or a NOT_FOUND results. Otherwise, the returned Node may have a different Id than requested, such as the case where a duplicate Id was assigned to a Node and retained for compatibility.

Parameters:

nodeId - the Id of the Node to retrieve

Returns:

the returned Node

Throws:

NotFoundException - no Node found with the given Id

NullArgumentException - nodeId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getNodesByIds

NodeList getNodesByIds(IdList nodeIds)
                       throws NotFoundException,
                              OperationFailedException,
                              PermissionDeniedException

Gets a NodeList corresponding to the given IdList. In plenary mode, the returned list contains all of the nodes 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 Nodes may be omitted from the list and may present the elements in any order including returning a unique set.

Parameters:

nodeIds - the list of Ids to retrieve

Returns:

the returned Node list

Throws:

NotFoundException - an Id was not found

NullArgumentException - nodeIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getNodesByGenusType

NodeList getNodesByGenusType(Type nodeGenusType)
                             throws OperationFailedException,
                                    PermissionDeniedException

Gets a NodeList corresponding to the given node genus Type which does not include nodes of types derived from the specified Type. In plenary mode, the returned list contains all known nodes or an error results. Otherwise, the returned list may contain only those nodes that are accessible through this session.

Parameters:

nodeGenusType - a node genus type

Returns:

the returned Node list

Throws:

NullArgumentException - nodeGenusType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getNodesByParentGenusType

NodeList getNodesByParentGenusType(Type nodeGenusType)
                                   throws OperationFailedException,
                                          PermissionDeniedException

Gets a NodeList corresponding to the given node genus Type and include any additional nodes with genus types derived from the specified Type. In plenary mode, the returned list contains all known nodes or an error results. Otherwise, the returned list may contain only those nodes that are accessible through this session.

Parameters:

nodeGenusType - a node genus type

Returns:

the returned Node list

Throws:

NullArgumentException - nodeGenusType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getNodesByRecordType

NodeList getNodesByRecordType(Type nodeRecordType)
                              throws OperationFailedException,
                                     PermissionDeniedException

Gets a NodeList containing the given node record Type. In plenary mode, the returned list contains all known nodes or an error results. Otherwise, the returned list may contain only those nodes that are accessible through this session.

Parameters:

nodeRecordType - a node record type

Returns:

the returned Node list

Throws:

NullArgumentException - nodeRecordType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getNodes

NodeList getNodes()
                  throws OperationFailedException,
                         PermissionDeniedException

Gets all Nodes. In plenary mode, the returned list contains all known nodes or an error results. Otherwise, the returned list may contain only those nodes that are accessible through this session.

Returns:

a list of Nodes

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.