org.osid.topology

Interface Node

All Superinterfaces:

Browsable, Extensible, Identifiable, OsidObject

public interface Node
extends OsidObject

A Node represents a node in a Graph.

Method Summary

Methods

Modifier and Type	Method and Description
NodeRecord	getNodeRecord(Type nodeRecordType) Gets the node record corresponding to the given Node record Type.

Methods inherited from interface org.osid.OsidObject

getDescription, getDisplayName, getGenusType, isOfGenusType

Methods inherited from interface org.osid.Identifiable

getId, isCurrent

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Methods inherited from interface org.osid.Browsable

getProperties, getPropertiesByRecordType

Method Detail

getNodeRecord

NodeRecord getNodeRecord(Type nodeRecordType)
                         throws OperationFailedException

Gets the node record corresponding to the given Node record Type. This method is used to retrieve an object implementing the requested record. The nodeRecordType may be the Type returned in getRecordTypes() or any of its parents in a Type hierarchy where hasRecordType(nodeRecordType) is true .

Parameters:

nodeRecordType - the type of node record to retrieve

Returns:

the node record

Throws:

NullArgumentException - nodeRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(nodeRecordType) is false

Compliance:

mandatory - This method must be implemented.