public interface EffortFoundrySession extends OsidSession
This session provides methods to retrieve Effort
to
Foundry
mappings. An Effort
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 |
canLookupEffortFoundryMappings()
Tests if this user can perform lookups of effort/foundry mappings.
|
IdList |
getEffortIdsByFoundries(IdList foundryIds)
Gets the list of
Effort Ids corresponding to a list of
Foundries. |
IdList |
getEffortIdsByFoundry(Id foundryId)
Gets the list of
Effort Ids associated with a
Foundry. |
EffortList |
getEffortsByFoundries(IdList foundryIds)
Gets the list of
Effort corresponding to a list of
Foundries. |
EffortList |
getEffortsByFoundry(Id foundryId)
Gets the list of
Efforts associated with a
Foundry. |
FoundryList |
getFoundriesByEffort(Id effortId)
Gets the
Foundries mapped to an Effort. |
IdList |
getFoundryIdsByEffort(Id effortId)
Gets the
Foundry Ids mapped to an
Effort. |
void |
useComparativeEffortFoundryView()
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 |
usePlenaryEffortFoundryView()
A complete view of the
Effort and Foundry
returns is desired. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
boolean canLookupEffortFoundryMappings()
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 useComparativeEffortFoundryView()
mandatory
- This method is must be implemented. void usePlenaryEffortFoundryView()
Effort
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 getEffortIdsByFoundry(Id foundryId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Effort 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. EffortList getEffortsByFoundry(Id foundryId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Efforts
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 getEffortIdsByFoundries(IdList foundryIds) throws OperationFailedException, PermissionDeniedException
Effort 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. EffortList getEffortsByFoundries(IdList foundryIds) throws OperationFailedException, PermissionDeniedException
Effort
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 getFoundryIdsByEffort(Id effortId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Foundry
Ids
mapped to an
Effort.
effortId
- Id
of an Effort
NotFoundException
- effortId
is not
foundNullArgumentException
- effortId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. FoundryList getFoundriesByEffort(Id effortId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Foundries
mapped to an Effort.
effortId
- Id
of an Effort
NotFoundException
- effortId
is not
foundNullArgumentException
- effortId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.