public interface PackageDepotSession extends OsidSession
This session provides methods to retrieve Package
to
Depot
mappings. A Package
may appear in
multiple Depots.
Each Depot
may have its own
authorizations governing who is allowed to look at it.
This lookup session defines two views:
Modifier and Type | Method and Description |
---|---|
boolean |
canLookupPackageDepotMappings()
Tests if this user can perform lookups of package/depot mappings.
|
IdList |
getDepotIdsByPackage(Id packageId)
Gets the list of
Depot Ids mapped to a
Package. |
DepotList |
getDepotsByPackage(Id packageId)
Gets the list of
Depots mapped to a Package. |
IdList |
getPackageIdsByDepot(Id depotId)
Gets the list of
Package Ids associated
with a Depot. |
IdList |
getPackageIdsByDepots(IdList depotIds)
Gets the list of
Package Ids corresponding to a list of
Depots. |
PackageList |
getPackagesByDepot(Id depotId)
Gets the list of
Packages associated with a
Depot. |
PackageList |
getPackagesByDepots(IdList depotIds)
Gets the list of
Packages corresponding to a list of
Depots. |
void |
useComparativeDepotView()
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 |
useDenormalizedDependencyView()
A denormalized view returns all dependencies.
|
void |
useDenormalizedVersionView()
All versions of the same package are returned.
|
void |
useNormalizedDependencyView()
A normalized view uses a single
Package to represent a
set of package dependencies. |
void |
useNormalizedVersionView()
The returns from the lookup methods may omit multiple versions of the
same package.
|
void |
usePlenaryDepotView()
A complete view of the
Package and Depot
returns is desired. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
boolean canLookupPackageDepotMappings()
PERMISSION_DENIED.
This is intended as
a hint to an application that may opt not to offer lookup operations
to unauthorized users. false
if looking up mappings is not authorized,
true
otherwisemandatory
- This method must be implemented. void useComparativeDepotView()
mandatory
- This method is must be implemented. void usePlenaryDepotView()
Package
and Depot
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 useNormalizedVersionView()
mandatory
- This method is must be implemented. void useDenormalizedVersionView()
mandatory
- This method is must be implemented. void useNormalizedDependencyView()
Package
to represent a
set of package dependencies.mandatory
- This method is must be implemented. void useDenormalizedDependencyView()
mandatory
- This method is must be implemented. IdList getPackageIdsByDepot(Id depotId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Package
Ids
associated
with a Depot.
depotId
- Id
of the Depot
Ids
NotFoundException
- depotId
is not foundNullArgumentException
- depotId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. PackageList getPackagesByDepot(Id depotId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Packages
associated with a
Depot.
depotId
- Id
of the Depot
NotFoundException
- depotId
is not foundNullArgumentException
- depotId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. IdList getPackageIdsByDepots(IdList depotIds) throws OperationFailedException, PermissionDeniedException
Package Ids
corresponding to a list of
Depots.
depotIds
- list of depot Ids
Ids
NullArgumentException
- depotIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. PackageList getPackagesByDepots(IdList depotIds) throws OperationFailedException, PermissionDeniedException
Packages
corresponding to a list of
Depots.
depotIds
- list of depot Ids
NullArgumentException
- depotIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. IdList getDepotIdsByPackage(Id packageId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Depot
Ids
mapped to a
Package.
packageId
- Id
of a Package
Ids
NotFoundException
- packageId
is not
foundNullArgumentException
- packageId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DepotList getDepotsByPackage(Id packageId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Depots
mapped to a Package.
packageId
- Id
of a Package
NotFoundException
- packageId
is not
foundNullArgumentException
- packageId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.