Interface IssueOublietteSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, 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

Modifier and Type	Method	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 an 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 an 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 Closeable

close

Methods inherited from interface OsidSession

close

Modifier and Type	Method	Description
void	close()	Close this session.

Methods inherited from interface OsidSession

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

Modifier and Type	Method	Description
Agent	getAuthenticatedAgent()	Gets the agent authenticated to this session.
Id	getAuthenticatedAgentId()	Gets the Id of the agent authenticated to this session.
BigDecimal	getClockRate()	Gets the rate of the service clock.
Date	getDate()	Gets the service date which may be the current date or the effective date in which this session exists.
Agent	getEffectiveAgent()	Gets the effective agent in use by this session.
Id	getEffectiveAgentId()	Gets the Id of the effective agent in use by this session.
Type	getFormatType()	Gets the DisplayText format Type preference in effect for this session.
Locale	getLocale()	Gets the locale indicating the localization preferences in effect for this session.
boolean	isAuthenticated()	Tests if an agent is authenticated to this session.
Transaction	startTransaction()	Starts a new transaction for this sesson.
boolean	supportsTransactions()	Tests for the availability of transactions.

Method Details

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 an 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 an 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.