public interface CatalogLookupSession extends OsidSession
This session provides methods for retrieving Catalog
objects. The Catalog
represents a collection of OSID
Ids.
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
Catalogs
it can access, without breaking execution. However, an
assessment may only be useful if all Catalogs
referenced by
it are available, and a test-taking applicationmay sacrifice some
interoperability for the sake of precision.
Modifier and Type | Method and Description |
---|---|
boolean |
canLookupCatalogs()
Tests if this user can perform
Catalog lookups. |
Catalog |
getCatalog(Id catalogId)
Gets the
Catalog specified by its Id. |
CatalogList |
getCatalogs()
Gets all
Catalogs. |
CatalogList |
getCatalogsByGenusType(Type catalogGenusType)
Gets a
CatalogList corresponding to the given catalog
genus Type which does not include catalogs of genus
types derived from the specified Type. |
CatalogList |
getCatalogsByIds(IdList catalogIds)
Gets a
CatalogList corresponding to the given catalog
IdList. |
CatalogList |
getCatalogsByParentGenusType(Type catalogGenusType)
Gets a
CatalogList corresponding to the given catalog
genus Type and include any additional catalogs with
genus types derived from the specified Type. |
CatalogList |
getCatalogsByProvider(Id resourceId)
Gets a
CatalogList from the given provider. |
CatalogList |
getCatalogsByRecordType(Type catalogRecordType)
Gets a
CatalogList containing the given subject record
Type. |
void |
useComparativeCatalogView()
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 |
usePlenaryCatalogView()
A complete view of the
Catalog returns is desired. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
boolean canLookupCatalogs()
Catalog
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 useComparativeCatalogView()
mandatory
- This method is must be implemented. void usePlenaryCatalogView()
Catalog
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. Catalog getCatalog(Id catalogId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Catalog
specified by its Id.
In
plenary mode, the exact Id
is found or a
NOT_FOUND
results. Otherwise, the returned Catalog
may have a different Id
than requested, such as
the case where a duplicate Id
was assigned to a
Catalog
and retained for compatibility.catalogId
- Id
of the Catalog
NotFoundException
- catalogId
not foundNullArgumentException
- catalogId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method is must be implemented. CatalogList getCatalogsByIds(IdList catalogIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
CatalogList
corresponding to the given catalog
IdList.
In plenary mode, the returned list contains all
of the catalogs 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 Catalogs
may be omitted from the list and
may present the elements in any order including returning a unique
set.catalogIds
- the list of Ids
to retrieve Catalog list
NotFoundException
- an Id was
not foundNullArgumentException
- catalogIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. CatalogList getCatalogsByGenusType(Type catalogGenusType) throws OperationFailedException, PermissionDeniedException
CatalogList
corresponding to the given catalog
genus Type
which does not include catalogs of genus
types derived from the specified Type.
In plenary mode,
the returned list contains all known catalogs or an error results.
Otherwise, the returned list may contain only those catalogs that are
accessible through this session.catalogGenusType
- a catalog genus type Catalog list
NullArgumentException
- catalogGenusType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. CatalogList getCatalogsByParentGenusType(Type catalogGenusType) throws OperationFailedException, PermissionDeniedException
CatalogList
corresponding to the given catalog
genus Type
and include any additional catalogs with
genus types derived from the specified Type.
In plenary
mode, the returned list contains all known catalogs or an error
results. Otherwise, the returned list may contain only those catalogs
that are accessible through this session.catalogGenusType
- a catalog genus type Catalog list
NullArgumentException
- catalogGenusType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. CatalogList getCatalogsByRecordType(Type catalogRecordType) throws OperationFailedException, PermissionDeniedException
CatalogList
containing the given subject record
Type.
In plenary mode, the returned list contains all
known subjects or an error results. Otherwise, the returned list may
contain only those catalogs that are accessible through this session.catalogRecordType
- a catalog record type Catalog list
NullArgumentException
- catalogRecordType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. CatalogList getCatalogsByProvider(Id resourceId) throws OperationFailedException, PermissionDeniedException
CatalogList
from the given provider.
In plenary mode, the returned list contains all known subjects
or an error results. Otherwise, the returned list may contain only
those catalogs that are accessible through this session.resourceId
- a resource Id
Catalog list
NullArgumentException
- resourceId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. CatalogList getCatalogs() throws OperationFailedException, PermissionDeniedException
Catalogs.
In plenary mode, the returned list
contains all known catalogs or an error results. Otherwise, the
returned list may contain only those catalogs that are accessible
through this session. Catalogs
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.