public interface CommissionEnablerFoundrySession extends OsidSession
This session provides methods to retrieve CommissionEnabler
to Foundry
mappings. A CommissionEnabler
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 |
canLookupCommissionEnablerFoundryMappings()
Tests if this user can perform lookups of commission enabler/foundry
mappings.
|
IdList |
getCommissionEnablerIdsByFoundries(IdList foundryIds)
Gets the list of
CommissionEnabler Ids corresponding to
a list of Foundries. |
IdList |
getCommissionEnablerIdsByFoundry(Id foundryId)
Gets the list of
CommissionEnablerIds associated with a
Foundry. |
CommissionEnablerList |
getCommissionEnablersByFoundries(IdList foundryIds)
Gets the list of commission enabler corresponding to a list of
Foundries. |
CommissionEnablerList |
getCommissionEnablersByFoundry(Id foundryId)
Gets the list of commission enabler associated with a
Foundry. |
IdList |
getFoundryIdsByCommissionEnabler(Id commissionEnablerId)
Gets the
Foundry Ids mapped to a
CommissionEnabler. |
FoundryList |
getFoundrysByCommissionEnabler(Id commissionEnablerId)
Gets the
Foundries mapped to a
CommissionEnabler. |
void |
useComparativeCommissionEnablerFoundryView()
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 |
usePlenaryCommissionEnablerFoundryView()
A complete view of the
CommissionEnabler and
Foundry returns is desired. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
boolean canLookupCommissionEnablerFoundryMappings()
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 useComparativeCommissionEnablerFoundryView()
mandatory
- This method is must be implemented. void usePlenaryCommissionEnablerFoundryView()
CommissionEnabler
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 getCommissionEnablerIdsByFoundry(Id foundryId) throws NotFoundException, OperationFailedException, PermissionDeniedException
CommissionEnablerIds
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. CommissionEnablerList getCommissionEnablersByFoundry(Id foundryId) throws NotFoundException, OperationFailedException, PermissionDeniedException
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 getCommissionEnablerIdsByFoundries(IdList foundryIds) throws OperationFailedException, PermissionDeniedException
CommissionEnabler 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. CommissionEnablerList getCommissionEnablersByFoundries(IdList foundryIds) throws OperationFailedException, PermissionDeniedException
Foundries.
foundryIds
- list of foundry Ids
NullArgumentException
- foundryIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. IdList getFoundryIdsByCommissionEnabler(Id commissionEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Foundry
Ids
mapped to a
CommissionEnabler.
commissionEnablerId
- Id
of a
CommissionEnabler
NotFoundException
- commissionEnablerId
is not foundNullArgumentException
- commissionEnablerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. FoundryList getFoundrysByCommissionEnabler(Id commissionEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Foundries
mapped to a
CommissionEnabler.
commissionEnablerId
- Id
of a
CommissionEnabler
NotFoundException
- commissionEnablerId
is not foundNullArgumentException
- commissionEnablerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.