public interface WorkFoundrySession extends OsidSession
This session provides methods to retrieve Work
to
Foundry
resourcings. A Work
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 |
canLookupWorkFoundryAvailabilities()
Tests if this user can perform lookups of work/foundry resourcings.
|
FoundryList |
getFoundriesByWork(Id workId)
Gets the
Foundries mapped to a Work. |
IdList |
getFoundryIdsByWork(Id workId)
Gets the
Foundry Ids mapped to a
Work. |
IdList |
getWorkIdsByFoundries(IdList foundryIds)
Gets the list of
Work Ids corresponding to a list of
Foundries. |
IdList |
getWorkIdsByFoundry(Id foundryId)
Gets the list of
Work Ids associated with a
Foundry. |
WorkList |
getWorksByFoundries(IdList foundryIds)
Gets the list of
Work corresponding to a list of
Foundries. |
WorkList |
getWorksByFoundry(Id foundryId)
Gets the list of
Works associated with a
Foundry. |
void |
useComparativeWorkFoundryView()
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 |
usePlenaryWorkFoundryView()
A complete view of the
Work and Foundry
returns is desired. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
boolean canLookupWorkFoundryAvailabilities()
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 useComparativeWorkFoundryView()
mandatory
- This method is must be implemented. void usePlenaryWorkFoundryView()
Work
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 getWorkIdsByFoundry(Id foundryId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Work 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. WorkList getWorksByFoundry(Id foundryId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Works
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 getWorkIdsByFoundries(IdList foundryIds) throws OperationFailedException, PermissionDeniedException
Work 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. WorkList getWorksByFoundries(IdList foundryIds) throws OperationFailedException, PermissionDeniedException
Work
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 getFoundryIdsByWork(Id workId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Foundry
Ids
mapped to a
Work.
workId
- Id
of a Work
NotFoundException
- workId
is not foundNullArgumentException
- workId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. FoundryList getFoundriesByWork(Id workId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Foundries
mapped to a Work.
workId
- Id
of a Work
NotFoundException
- workId
is not foundNullArgumentException
- workId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.