public interface AvailabilityFoundrySession extends OsidSession
This session provides methods to retrieve Availability
to Foundry
availabilities. An Availability
may appear in multiple Foundry
objects. Each foundry may
have its own authorizations governing who is allowed to look at it.
This lookup session defines several views:
Modifier and Type | Method and Description |
---|---|
boolean |
canLookupAvailabilityFoundryAvailabilities()
Tests if this user can perform lookups of availability/foundry
mappings.
|
AvailabilityList |
getAvailabilitiesByFoundries(IdList foundryIds)
Gets the list of
Availabilities corresponding to a list
of Foundries. |
AvailabilityList |
getAvailabilitiesByFoundry(Id foundryId)
Gets the list of
Availabilities associated with a
Foundry. |
IdList |
getAvailabilityIdsByFoundries(IdList foundryIds)
Gets the list of
Availability Ids corresponding to a
list of Foundries. |
IdList |
getAvailabilityIdsByFoundry(Id foundryId)
Gets the list of
Availability Ids associated with a
Foundry. |
FoundryList |
getFoundriesByAvailability(Id availabilityId)
Gets the
Foundries mapped to an Availability. |
IdList |
getFoundryIdsByAvailability(Id availabilityId)
Gets the
Foundry Ids mapped to an
Availability. |
void |
useComparativeAvailabilityFoundryView()
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 |
usePlenaryAvailabilityFoundryView()
A complete view of the
Availability and Foundry
returns is desired. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
boolean canLookupAvailabilityFoundryAvailabilities()
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 availabilities is not
authorized, true
otherwisemandatory
- This method must be implemented. void useComparativeAvailabilityFoundryView()
mandatory
- This method is must be implemented. void usePlenaryAvailabilityFoundryView()
Availability
and Foundry
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. IdList getAvailabilityIdsByFoundry(Id foundryId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Availability Ids
associated with a
Foundry.
foundryId
- Id
of the Foundry
Ids
NotFoundException
- foundryId
is not
foundNullArgumentException
- foundryId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. AvailabilityList getAvailabilitiesByFoundry(Id foundryId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Availabilities
associated with a
Foundry.
foundryId
- Id
of the Foundry
NotFoundException
- foundryId
is not
foundNullArgumentException
- foundryId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. IdList getAvailabilityIdsByFoundries(IdList foundryIds) throws OperationFailedException, PermissionDeniedException
Availability Ids
corresponding to a
list of Foundries.
foundryIds
- list of foundry Ids
Ids
NullArgumentException
- foundryIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. AvailabilityList getAvailabilitiesByFoundries(IdList foundryIds) throws OperationFailedException, PermissionDeniedException
Availabilities
corresponding to a list
of Foundries.
foundryIds
- list of foundry Ids
NullArgumentException
- foundryIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. IdList getFoundryIdsByAvailability(Id availabilityId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Foundry
Ids
mapped to an
Availability.
availabilityId
- Id
of an Availability
NotFoundException
- availabilityId
is
not foundNullArgumentException
- availabilityId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. FoundryList getFoundriesByAvailability(Id availabilityId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Foundries
mapped to an Availability.
availabilityId
- Id
of an Availability
NotFoundException
- availabilityId
is
not foundNullArgumentException
- availabilityId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.