public interface CommissionFoundrySession extends OsidSession
This session provides methods to retrieve Commission
to
Foundry
mappings. A Commission
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 |
canLookupCommissionFoundryMappings()
Tests if this user can perform lookups of commission/foundry mappings.
|
IdList |
getCommissionIdsByFoundries(IdList foundryIds)
Gets the list of
Commission Ids corresponding to a list
of Foundries. |
IdList |
getCommissionIdsByFoundry(Id foundryId)
Gets the list of
Commission Ids associated with a
Foundry. |
CommissionList |
getCommissionsByFoundries(IdList foundryIds)
Gets the list of
Commission corresponding to a list of
Foundries. |
CommissionList |
getCommissionsByFoundry(Id foundryId)
Gets the list of
Commissions associated with a
Foundry. |
FoundryList |
getFoundriesByCommission(Id commissionId)
Gets the
Foundries mapped to a Commission. |
IdList |
getFoundryIdsByCommission(Id commissionId)
Gets the
Foundry Ids mapped to a
Commission. |
void |
useComparativeCommissionFoundryView()
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 |
usePlenaryCommissionFoundryView()
A complete view of the
Commission and Foundry
returns is desired. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
boolean canLookupCommissionFoundryMappings()
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 useComparativeCommissionFoundryView()
mandatory
- This method is must be implemented. void usePlenaryCommissionFoundryView()
Commission
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 getCommissionIdsByFoundry(Id foundryId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Commission 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. CommissionList getCommissionsByFoundry(Id foundryId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Commissions
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 getCommissionIdsByFoundries(IdList foundryIds) throws OperationFailedException, PermissionDeniedException
Commission 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. CommissionList getCommissionsByFoundries(IdList foundryIds) throws OperationFailedException, PermissionDeniedException
Commission
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 getFoundryIdsByCommission(Id commissionId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Foundry
Ids
mapped to a
Commission.
commissionId
- Id
of a Commission
NotFoundException
- commissionId
is not
foundNullArgumentException
- commissionId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. FoundryList getFoundriesByCommission(Id commissionId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Foundries
mapped to a Commission.
commissionId
- Id
of a Commission
NotFoundException
- commissionId
is not
foundNullArgumentException
- commissionId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.