org.osid.hold

Interface IssueOublietteSession

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, OsidSession

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:

• comparative view: elements may be silently omitted or re-ordered
• plenary view: provides a complete result set or is an error condition

Method Summary

Methods

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.

Methods inherited from interface org.osid.OsidSession

getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions

Methods inherited from interface org.osid.binding.java.OsidSession

close

Methods inherited from interface java.io.Closeable

close

Method Detail

canLookupIssueOublietteIssues

boolean canLookupIssueOublietteIssues()

Tests if this user can perform lookups of issue/oubliette mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known lookup methods in this session will result in a PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer lookup operations to unauthorized users.

Returns:

false if looking up issues is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

useComparativeIssueOublietteView

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. This view is used when greater interoperability is desired at the expense of precision.

Compliance:

mandatory - This method is must be implemented.

usePlenaryIssueOublietteView

void usePlenaryIssueOublietteView()

A complete view of the 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.

Compliance:

mandatory - This method is must be implemented.

getIssueIdsByOubliette

IdList getIssueIdsByOubliette(Id oublietteId)
                              throws NotFoundException,
                                     OperationFailedException,
                                     PermissionDeniedException

Gets the list of Issue Ids associated with a Oubliette.

Parameters:

oublietteId - Id of the Oubliette

Returns:

list of related issue Ids

Throws:

NotFoundException - oublietteId is not found

NullArgumentException - oublietteId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getIssuesByOubliette

IssueList getIssuesByOubliette(Id oublietteId)
                               throws NotFoundException,
                                      OperationFailedException,
                                      PermissionDeniedException

Gets the list of Issues associated with a Oubliette.

Parameters:

oublietteId - Id of the Oubliette

Returns:

list of related issues

Throws:

NotFoundException - oublietteId is not found

NullArgumentException - oublietteId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getIssueIdsByOubliettes

IdList getIssueIdsByOubliettes(IdList oublietteIds)
                               throws OperationFailedException,
                                      PermissionDeniedException

Gets the list of Issue Ids corresponding to a list of Oubliettes.

Parameters:

oublietteIds - list of oubliette Ids

Returns:

list of issue Ids

Throws:

NullArgumentException - oublietteIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getIssuesByOubliettes

IssueList getIssuesByOubliettes(IdList oublietteIds)
                                throws OperationFailedException,
                                       PermissionDeniedException

Gets the list of Issues corresponding to a list of Oubliettes.

Parameters:

oublietteIds - list of oubliette Ids

Returns:

list of issues

Throws:

NullArgumentException - oublietteIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getOublietteIdsByIssue

IdList getOublietteIdsByIssue(Id issueId)
                              throws NotFoundException,
                                     OperationFailedException,
                                     PermissionDeniedException

Gets the Oubliette Ids mapped to an Issue.

Parameters:

issueId - Id of an Issue

Returns:

list of oubliettes

Throws:

NotFoundException - issueId is not found

NullArgumentException - issueId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getOubliettesByIssue

OublietteList getOubliettesByIssue(Id issueId)
                                   throws NotFoundException,
                                          OperationFailedException,
                                          PermissionDeniedException

Gets the Oubliettes mapped to an Issue.

Parameters:

issueId - Id of an Issue

Returns:

list of oubliettes

Throws:

NotFoundException - issueId is not found

NullArgumentException - issueId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.