public interface GraphLookupSession extends OsidSession
This session provides methods for retrieving Graph
objects. The Graph
represents a collection of nodes and
edges.
This session defines views that offer differing behaviors when retrieving multiple objects.
Generally, the comparative view should be used for most applications
as it permits operation even if there is data that cannot be accessed. For
example, a browsing application may only need to examine the Graphs
it can access, without breaking execution. However, an assessment
may only be useful if all Graphs
referenced by it are
available, and a test-taking application may sacrifice some
interoperability for the sake of precision.
Modifier and Type | Method and Description |
---|---|
boolean |
canLookupGraphs()
Tests if this user can perform
Graph lookups. |
Graph |
getGraph(Id graphId)
Gets the
Graph specified by its Id. |
GraphList |
getGraphs()
Gets all
Graphs. |
GraphList |
getGraphsByGenusType(Type graphGenusType)
Gets a
GraphList corresponding to the given graph genus
Type which does not include graphs of types derived
from the specified Type. |
GraphList |
getGraphsByIds(IdList graphIds)
Gets a
GraphList corresponding to the given
IdList. |
GraphList |
getGraphsByParentGenusType(Type graphGenusType)
Gets a
GraphList corresponding to the given graph genus
Type and include any additional graphs with genus types
derived from the specified Type. |
GraphList |
getGraphsByProvider(Id resourceId)
Gets a
GraphList for the given provider. |
GraphList |
getGraphsByRecordType(Type graphRecordType)
Gets a
GraphList containing the given graph record
Type. |
void |
useComparativeGraphView()
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 |
usePlenaryGraphView()
A complete view of the
Graph returns is desired. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
boolean canLookupGraphs()
Graph
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. false
if lookup methods are not authorized,
true
otherwisemandatory
- This method must be implemented. void useComparativeGraphView()
mandatory
- This method is must be implemented. void usePlenaryGraphView()
Graph
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.mandatory
- This method is must be implemented. Graph getGraph(Id graphId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Graph
specified by its Id.
In
plenary mode, the exact Id
is found or a
NOT_FOUND
results. Otherwise, the returned Graph
may have a different Id
than requested, such as
the case where a duplicate Id
was assigned to a
Graph
and retained for compatibility.graphId
- Id
of the Graph
NotFoundException
- graphId
not foundNullArgumentException
- graphId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method is must be implemented. GraphList getGraphsByIds(IdList graphIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
GraphList
corresponding to the given
IdList.
In plenary mode, the returned list contains all of the
graphs 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 Graphs
may be omitted from the list and
may present the elements in any order including returning a unique
set.graphIds
- the list of Ids
to retrieve Graph
listNotFoundException
- an Id was
not foundNullArgumentException
- graphIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. GraphList getGraphsByGenusType(Type graphGenusType) throws OperationFailedException, PermissionDeniedException
GraphList
corresponding to the given graph genus
Type
which does not include graphs of types derived
from the specified Type.
In plenary mode, the returned
list contains all known graphs or an error results. Otherwise, the
returned list may contain only those graphs that are accessible
through this session.graphGenusType
- a graph genus type Graph
listNullArgumentException
- graphGenusType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. GraphList getGraphsByParentGenusType(Type graphGenusType) throws OperationFailedException, PermissionDeniedException
GraphList
corresponding to the given graph genus
Type
and include any additional graphs with genus types
derived from the specified Type.
In plenary mode, the
returned list contains all known graphs or an error results.
Otherwise, the returned list may contain only those graphs that are
accessible through this session.graphGenusType
- a graph genus type Graph
listNullArgumentException
- graphGenusType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. GraphList getGraphsByRecordType(Type graphRecordType) throws OperationFailedException, PermissionDeniedException
GraphList
containing the given graph record
Type.
In plenary mode, the returned list contains all
known graphs or an error results. Otherwise, the returned list may
contain only those graphs that are accessible through this session.graphRecordType
- a graph record type Graph
listNullArgumentException
- graphRecordType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. GraphList getGraphsByProvider(Id resourceId) throws OperationFailedException, PermissionDeniedException
GraphList
for the given provider.
In plenary mode, the returned list contains all known graphs or an
error results. Otherwise, the returned list may contain only those
graphs that are accessible through this session.resourceId
- a resource Id
Graph
listNullArgumentException
- resourceId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. GraphList getGraphs() throws OperationFailedException, PermissionDeniedException
Graphs.
In plenary mode, the returned list
contains all known graphs or an error results. Otherwise, the returned
list may contain only those graphs that are accessible through this
session. Graphs
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.