public interface IssueOublietteSession extends OsidSession
This session provides methods to retrieve Issue
to
Oubliette
issues. An Issue
may appear in
multiple Oubliette
objects. Each oubliette 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 |
canLookupIssueOublietteIssues()
Tests if this user can perform lookups of issue/oubliette mappings.
|
IdList |
getIssueIdsByOubliette(Id oublietteId)
Gets the list of
Issue Ids associated with a
Oubliette. |
IdList |
getIssueIdsByOubliettes(IdList oublietteIds)
Gets the list of
Issue Ids corresponding to a list of
Oubliettes. |
IssueList |
getIssuesByOubliette(Id oublietteId)
Gets the list of
Issues associated with a
Oubliette. |
IssueList |
getIssuesByOubliettes(IdList oublietteIds)
Gets the list of
Issues corresponding to a list of
Oubliettes. |
IdList |
getOublietteIdsByIssue(Id issueId)
Gets the
Oubliette Ids mapped to an
Issue. |
OublietteList |
getOubliettesByIssue(Id issueId)
Gets the
Oubliettes mapped to an Issue. |
void |
useComparativeIssueOublietteView()
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 |
usePlenaryIssueOublietteView()
A complete view of the
Issue and Oubliette
returns is desired. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
boolean canLookupIssueOublietteIssues()
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 issues is not authorized,
true
otherwisemandatory
- This method must be implemented. void useComparativeIssueOublietteView()
mandatory
- This method is must be implemented. void usePlenaryIssueOublietteView()
Issue
and Oubliette
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 getIssueIdsByOubliette(Id oublietteId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Issue Ids
associated with a
Oubliette.
oublietteId
- Id
of the Oubliette
Ids
NotFoundException
- oublietteId
is not
foundNullArgumentException
- oublietteId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. IssueList getIssuesByOubliette(Id oublietteId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Issues
associated with a
Oubliette.
oublietteId
- Id
of the Oubliette
NotFoundException
- oublietteId
is not
foundNullArgumentException
- oublietteId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. IdList getIssueIdsByOubliettes(IdList oublietteIds) throws OperationFailedException, PermissionDeniedException
Issue Ids
corresponding to a list of
Oubliettes.
oublietteIds
- list of oubliette Ids
Ids
NullArgumentException
- oublietteIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. IssueList getIssuesByOubliettes(IdList oublietteIds) throws OperationFailedException, PermissionDeniedException
Issues
corresponding to a list of
Oubliettes.
oublietteIds
- list of oubliette Ids
NullArgumentException
- oublietteIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. IdList getOublietteIdsByIssue(Id issueId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Oubliette
Ids
mapped to an
Issue.
issueId
- Id
of an Issue
NotFoundException
- issueId
is not foundNullArgumentException
- issueId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. OublietteList getOubliettesByIssue(Id issueId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Oubliettes
mapped to an Issue.
issueId
- Id
of an Issue
NotFoundException
- issueId
is not foundNullArgumentException
- issueId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.