public interface CatalogEnablerLookupSession extends OsidSession
This session provides methods for retrieving CatalogEnablers.
A CatalogEnabler
enables a catalog node in a
federated hierarchy.
This session defines views that offer differing behaviors when retrieving multiple objects.
CatalogEnablers
with the
CatalogEnablerAdminSession.
Generally, the comparative view should be used for most applications
as it permits operation even if there is data that cannot be accessed. The
methods useFederatedDistributorView()
and
useIsolatedDistributorView()
behave as a radio group and one
should be selected before invoking the methods in this session.
Modifier and Type | Method and Description |
---|---|
boolean |
canLookupCatalogEnablers()
Tests if this user can perform
CatalogEnablers lookups. |
Catalog |
getCatalog()
Gets the
Catalog associated with this session. |
CatalogEnabler |
getCatalogEnabler(Id catalogEnablerId)
Gets the
CatalogEnabler specified by its Id. |
CatalogEnablerList |
getCatalogEnablers()
Gets all
CatalogEnablers. |
CatalogEnablerList |
getCatalogEnablersByGenusType(Type catalogEnablerGenusType)
Gets a
CatalogEnablerList corresponding to the given
catalog enabler genus Type which does not include
catalog enablers of genus types derived from the specified
Type. |
CatalogEnablerList |
getCatalogEnablersByIds(IdList catalogEnablerIds)
Gets a
CatalogEnablerList corresponding to the given
IdList. |
CatalogEnablerList |
getCatalogEnablersByParentGenusType(Type catalogEnablerGenusType)
Gets a
CatalogEnablerList corresponding to the given
catalog enabler genus Type and include any additional
catalog enablers with genus types derived from the specified
Type. |
CatalogEnablerList |
getCatalogEnablersByRecordType(Type catalogEnablerRecordType)
Gets a
CatalogEnablerList containing the given catalog
enabler record Type. |
CatalogEnablerList |
getCatalogEnablersOnDate(DateTime from,
DateTime to)
Gets a
CatalogEnablerList effective for the entire
given date range inclusive but not confined to the date range. |
CatalogEnablerList |
getCatalogEnablersOnDateWithAgent(Id agentId,
DateTime from,
DateTime to)
Gets a
CatalogEnablerList effective for the entire
given date range inclusive but not confined to the date range and
evaluated against the given agent. |
Id |
getCatalogId()
Gets the
Catalog Id associated with this
session. |
void |
useActiveCatalogEnablerView()
Only active catalog enablers are returned by methods in this session.
|
void |
useAnyStatusCatalogEnablerView()
All active and inactive catalog enablers are returned by methods in
this session.
|
void |
useComparativeCatalogEnablerView()
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 |
useFederatedCatalogView()
Federates the view for methods in this session.
|
void |
useIsolatedCatalogView()
Isolates the view for methods in this session.
|
void |
usePlenaryCatalogEnablerView()
A complete view of the
CatalogEnabler returns is
desired. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getCatalogId()
Catalog
Id
associated with this
session. Catalog Id
associated with this sessionmandatory
- This method must be implemented. Catalog getCatalog() throws OperationFailedException, PermissionDeniedException
Catalog
associated with this session.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canLookupCatalogEnablers()
CatalogEnablers
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 useComparativeCatalogEnablerView()
mandatory
- This method is must be implemented. void usePlenaryCatalogEnablerView()
CatalogEnabler
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. void useFederatedCatalogView()
mandatory
- This method is must be implemented. void useIsolatedCatalogView()
mandatory
- This method is must be implemented. void useActiveCatalogEnablerView()
mandatory
- This method is must be implemented. void useAnyStatusCatalogEnablerView()
mandatory
- This method is must be implemented. CatalogEnabler getCatalogEnabler(Id catalogEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
CatalogEnabler
specified by its Id.
In plenary mode, the exact Id
is found
or a NOT_FOUND
results. Otherwise, the returned
CatalogEnabler
may have a different Id
than
requested, such as the case where a duplicate Id
was
assigned to a CatalogEnabler
and retained for
compatibility.
In active mode, catalog enablers are returned that are currently
active. In any status mode, active and inactive catalog enablers are
returned.catalogEnablerId
- Id
of the
CatalogEnabler
NotFoundException
- catalogEnablerId
not
foundNullArgumentException
- catalogEnablerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method is must be implemented. CatalogEnablerList getCatalogEnablersByIds(IdList catalogEnablerIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
CatalogEnablerList
corresponding to the given
IdList.
In plenary mode, the returned list contains all of the
catalog enablers 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 CatalogEnablers
may be omitted from the
list and may present the elements in any order including returning a
unique set.
In active mode, catalog enablers are returned that are currently
active. In any status mode, active and inactive catalog enablers are
returned.catalogEnablerIds
- the list of Ids
to retrieve CatalogEnabler
listNotFoundException
- an Id was
not foundNullArgumentException
- catalogEnablerIds
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. CatalogEnablerList getCatalogEnablersByGenusType(Type catalogEnablerGenusType) throws OperationFailedException, PermissionDeniedException
CatalogEnablerList
corresponding to the given
catalog enabler genus Type
which does not include
catalog enablers of genus types derived from the specified
Type.
In plenary mode, the returned list contains all known
catalog enablers or an error results. Otherwise, the returned list may
contain only those catalog enablers that are accessible through this
session.
In active mode, catalog enablers are returned that are currently
active. In any status mode, active and inactive catalog enablers are
returned.catalogEnablerGenusType
- a catalog enabler genus type CatalogEnabler
listNullArgumentException
- catalogEnablerGenusType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. CatalogEnablerList getCatalogEnablersByParentGenusType(Type catalogEnablerGenusType) throws OperationFailedException, PermissionDeniedException
CatalogEnablerList
corresponding to the given
catalog enabler genus Type
and include any additional
catalog enablers with genus types derived from the specified
Type.
In plenary mode, the returned list contains all known
catalog enablers or an error results. Otherwise, the returned list may
contain only those catalog enablers that are accessible through this
session.
In active mode, catalog enablers are returned that are currently
active. In any status mode, active and inactive catalog enablers are
returned.catalogEnablerGenusType
- a catalog enabler genus type CatalogEnabler
listNullArgumentException
- catalogEnablerGenusType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. CatalogEnablerList getCatalogEnablersByRecordType(Type catalogEnablerRecordType) throws OperationFailedException, PermissionDeniedException
CatalogEnablerList
containing the given catalog
enabler record Type.
In plenary mode, the returned list contains all known
catalog enablers or an error results. Otherwise, the returned list may
contain only those catalog enablers that are accessible through this
session.
In active mode, catalog enablers are returned that are currently
active. In any status mode, active and inactive catalog enablers are
returned.catalogEnablerRecordType
- a catalog enabler record type CatalogEnabler
listNullArgumentException
- catalogEnablerRecordType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. CatalogEnablerList getCatalogEnablersOnDate(DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
CatalogEnablerList
effective for the entire
given date range inclusive but not confined to the date range.
In plenary mode, the returned list contains all known
catalog enablers or an error results. Otherwise, the returned list may
contain only those catalog enablers that are accessible through this
session.
In active mode, catalog enablers are returned that are currently
active. In any status mode, active and inactive catalog enablers are
returned.from
- a start dateto
- an end date CatalogEnabler
listInvalidArgumentException
- from
is
greater than to
NullArgumentException
- from
or
to
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. CatalogEnablerList getCatalogEnablersOnDateWithAgent(Id agentId, DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
CatalogEnablerList
effective for the entire
given date range inclusive but not confined to the date range and
evaluated against the given agent.
In plenary mode, the returned list contains all known
catalog enablers or an error results. Otherwise, the returned list may
contain only those catalog enablers that are accessible through this
session.
In active mode, catalog enablers are returned that are currently
active. In any status mode, active and inactive catalog enablers are
returned.agentId
- an agent Idfrom
- a start dateto
- an end date CatalogEnabler
listInvalidArgumentException
- from
is
greater than to
NullArgumentException
- agentId, from
or
to
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. CatalogEnablerList getCatalogEnablers() throws OperationFailedException, PermissionDeniedException
CatalogEnablers.
In plenary mode, the returned list contains all known
catalog enablers or an error results. Otherwise, the returned list may
contain only those catalog enablers that are accessible through this
session. In both cases, the order of the set is not specified.
In active mode, catalog enablers are returned that are currently
active. In any status mode, active and inactive catalog enablers are
returned. CatalogEnabler
listOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.