public interface SystemLookupSession extends OsidSession
This session provides methods for retrieving System
objects.
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
Systems
it can access, without breaking execution. However, an
assessment may only be useful if all Systems
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 |
canLookupSystems()
Tests if this user can perform
System lookups. |
System |
getSystem(Id systemId)
Gets the
System specified by its Id. |
SystemList |
getSystems()
Gets all
Systems. |
SystemList |
getSystemsByGenusType(Type systemGenusType)
Gets a
SystemList corresponding to the given system
genus Type which does not include systems of types
derived from the specified Type. |
SystemList |
getSystemsByIds(IdList systemIds)
Gets a
SystemList corresponding to the given
IdList. |
SystemList |
getSystemsByParentGenusType(Type systemGenusType)
Gets a
SystemList corresponding to the given system
genus Type and include any additional systems with
genus types derived from the specified Type. |
SystemList |
getSystemsByProvider(Id resourceId)
Gets a
SystemList for the given provider. |
SystemList |
getSystemsByRecordType(Type systemRecordType)
Gets a
SystemList containing the given system record
Type. |
void |
useComparativeSystemView()
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 |
usePlenarySystemView()
A complete view of the
System returns is desired. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
boolean canLookupSystems()
System
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 useComparativeSystemView()
mandatory
- This method is must be implemented. void usePlenarySystemView()
System
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. System getSystem(Id systemId) throws NotFoundException, OperationFailedException, PermissionDeniedException
System
specified by its Id.
In
plenary mode, the exact Id
is found or a
NOT_FOUND
results. Otherwise, the returned System
may have a different Id
than requested, such as
the case where a duplicate Id
was assigned to a
System
and retained for compatibility.systemId
- Id
of the System
NotFoundException
- systemId
not foundNullArgumentException
- systemId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method is must be implemented. SystemList getSystemsByIds(IdList systemIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
SystemList
corresponding to the given
IdList.
In plenary mode, the returned list contains all of the
systems 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 Systems
may be omitted from the list and
may present the elements in any order including returning a unique
set.systemIds
- the list of Ids
to retrieve System
listNotFoundException
- an Id
was not foundNullArgumentException
- systemIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. SystemList getSystemsByGenusType(Type systemGenusType) throws OperationFailedException, PermissionDeniedException
SystemList
corresponding to the given system
genus Type
which does not include systems of types
derived from the specified Type.
In plenary mode, the
returned list contains all known systems or an error results.
Otherwise, the returned list may contain only those systems that are
accessible through this session.systemGenusType
- a system genus type System
listNullArgumentException
- systemGenusType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. SystemList getSystemsByParentGenusType(Type systemGenusType) throws OperationFailedException, PermissionDeniedException
SystemList
corresponding to the given system
genus Type
and include any additional systems with
genus types derived from the specified Type.
In plenary
mode, the returned list contains all known systems or an error
results. Otherwise, the returned list may contain only those systems
that are accessible through this session.systemGenusType
- a system genus type System
listNullArgumentException
- systemGenusType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. SystemList getSystemsByRecordType(Type systemRecordType) throws OperationFailedException, PermissionDeniedException
SystemList
containing the given system record
Type.
In plenary mode, the returned list contains all
known systems or an error results. Otherwise, the returned list may
contain only those systems that are accessible through this session.systemRecordType
- a system record type System
listNullArgumentException
- systemRecordType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. SystemList getSystemsByProvider(Id resourceId) throws OperationFailedException, PermissionDeniedException
SystemList
for the given provider. In plenary
mode, the returned list contains all known systems or an error
results. Otherwise, the returned list may contain only those systems
that are accessible through this session.resourceId
- a resource Id System
listNullArgumentException
- resourceId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. SystemList getSystems() throws OperationFailedException, PermissionDeniedException
Systems.
In plenary mode, the returned list
contains all known systems or an error results. Otherwise, the
returned list may contain only those systems that are accessible
through this session. Systems
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.