public interface AntimatroidLookupSession extends OsidSession
This session provides methods for retrieving Antimatroid
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
Antimatroids
it can access, without breaking execution. However,
an assessment may only be useful if all Antimatroids
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 |
canLookupAntimatroids()
Tests if this user can perform
Antimatroid lookups. |
Antimatroid |
getAntimatroid(Id antimatroidId)
Gets the
Antimatroid specified by its Id. |
AntimatroidList |
getAntimatroids()
Gets all
Antimatroids. |
AntimatroidList |
getAntimatroidsByGenusType(Type antimatroidGenusType)
Gets an
AntimatroidList corresponding to the given
antimatroid genus Type which does not include
antimatroids of types derived from the specified Type. |
AntimatroidList |
getAntimatroidsByIds(IdList antimatroidIds)
Gets an
AntimatroidList corresponding to the given
IdList. |
AntimatroidList |
getAntimatroidsByParentGenusType(Type antimatroidGenusType)
Gets an
AntimatroidList corresponding to the given
antimatroid genus Type and include any additional
antimatroids with genus types derived from the specified Type. |
AntimatroidList |
getAntimatroidsByProvider(Id resourceId)
Gets an
AntimatroidList for the given provider. |
AntimatroidList |
getAntimatroidsByRecordType(Type antimatroidRecordType)
Gets an
AntimatroidList containing the given
antimatroid record Type. |
void |
useComparativeAntimatroidView()
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 |
usePlenaryAntimatroidView()
A complete view of the
Antimatroid returns is desired. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
boolean canLookupAntimatroids()
Antimatroid
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 useComparativeAntimatroidView()
mandatory
- This method is must be implemented. void usePlenaryAntimatroidView()
Antimatroid
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. Antimatroid getAntimatroid(Id antimatroidId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Antimatroid
specified by its Id.
In plenary mode, the exact Id
is found or a
NOT_FOUND
results. Otherwise, the returned
Antimatroid
may have a different Id
than
requested, such as the case where a duplicate Id
was
assigned to an Antimatroid
and retained for
compatibility.antimatroidId
- Id
of the Antimatroid
NotFoundException
- antimatroidId
not
foundNullArgumentException
- antimatroidId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method is must be implemented. AntimatroidList getAntimatroidsByIds(IdList antimatroidIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
AntimatroidList
corresponding to the given
IdList.
In plenary mode, the returned list contains all
of the antimatroids 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 Antimatroids
may be omitted
from the list and may present the elements in any order including
returning a unique set.antimatroidIds
- the list of Ids
to retrieve Antimatroid
listNotFoundException
- an Id
was not foundNullArgumentException
- antimatroidIds
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. AntimatroidList getAntimatroidsByGenusType(Type antimatroidGenusType) throws OperationFailedException, PermissionDeniedException
AntimatroidList
corresponding to the given
antimatroid genus Type
which does not include
antimatroids of types derived from the specified Type.
In plenary mode, the returned list contains all known antimatroids or
an error results. Otherwise, the returned list may contain only those
antimatroids that are accessible through this session.antimatroidGenusType
- an antimatroid genus type Antimatroid
listNullArgumentException
- antimatroidGenusType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. AntimatroidList getAntimatroidsByParentGenusType(Type antimatroidGenusType) throws OperationFailedException, PermissionDeniedException
AntimatroidList
corresponding to the given
antimatroid genus Type
and include any additional
antimatroids with genus types derived from the specified Type.
In plenary mode, the returned list contains all known
antimatroids or an error results. Otherwise, the returned list may
contain only those antimatroids that are accessible through this
session.antimatroidGenusType
- an antimatroid genus type Antimatroid
listNullArgumentException
- antimatroidGenusType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. AntimatroidList getAntimatroidsByRecordType(Type antimatroidRecordType) throws OperationFailedException, PermissionDeniedException
AntimatroidList
containing the given
antimatroid record Type.
In plenary mode, the returned
list contains all known antimatroids or an error results. Otherwise,
the returned list may contain only those antimatroids that are
accessible through this session.antimatroidRecordType
- an antimatroid record type Antimatroid
listNullArgumentException
- antimatroidRecordType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. AntimatroidList getAntimatroidsByProvider(Id resourceId) throws OperationFailedException, PermissionDeniedException
AntimatroidList
for the given provider. In
plenary mode, the returned list contains all known antimatroids or an
error results. Otherwise, the returned list may contain only those
antimatroids that are accessible through this session.resourceId
- a resource Id Antimatroid
listNullArgumentException
- resourceId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. AntimatroidList getAntimatroids() throws OperationFailedException, PermissionDeniedException
Antimatroids.
In plenary mode, the returned
list contains all known antimatroids or an error results. Otherwise,
the returned list may contain only those antimatroids that are
accessible through this session. Antimatroids
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.