org.osid.topology

Interface Graph

All Superinterfaces:

Browsable, Extensible, Federateable, Identifiable, OsidCatalog, OsidObject, Sourceable

public interface Graph
extends OsidCatalog

A Graph represents a collection of nodes and edges.

Method Summary

Methods

Modifier and Type	Method and Description
GraphRecord	getGraphRecord(Type graphRecordType) Gets the graph record corresponding to the given Graph 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

Methods inherited from interface org.osid.Sourceable

getBranding, getBrandingIds, getLicense, getProvider, getProviderId

Method Detail

getGraphRecord

GraphRecord getGraphRecord(Type graphRecordType)
                           throws OperationFailedException

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

Parameters:

graphRecordType - the type of graph record to retrieve

Returns:

the graph record

Throws:

NullArgumentException - graphRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(graphRecordType) is false

Compliance:

mandatory - This method must be implemented.