Interface IssueEnablerOublietteSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface IssueEnablerOublietteSession
extends OsidSession

This session provides methods to retrieve IssueEnabler to Oubliette mappings. An IssueEnabler 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	canLookupIssueEnablerOublietteMappings()	Tests if this user can perform lookups of issue enabler/oubliette mappings.
IdList	getIssueEnablerIdsByOubliette(Id oublietteId)	Gets the list of IssueEnabler Ids associated with an Oubliette .
IdList	getIssueEnablerIdsByOubliettes(IdList oublietteIds)	Gets the list of IssueEnabler Ids corresponding to a list of Oubliettes .
IssueEnablerList	getIssueEnablersByOubliette(Id oublietteId)	Gets the list of IssueEnablers associated with an Oubliette .
IssueEnablerList	getIssueEnablersByOubliettes(IdList oublietteIds)	Gets the list of IssueEnabler corresponding to a list of Oubliettes .
IdList	getOublietteIdsByIssueEnabler(Id issueEnablerId)	Gets the Oubliette Ids mapped to an IssueEnabler .
OublietteList	getOubliettesByIssueEnabler(Id issueEnablerId)	Gets the Oubliettes mapped to an IssueEnabler .
void	useComparativeIssueEnablerOublietteView()	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	usePlenaryIssueEnablerOublietteView()	A complete view of the IssueEnabler 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

canLookupIssueEnablerOublietteMappings

boolean canLookupIssueEnablerOublietteMappings()

Tests if this user can perform lookups of issue enabler/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. T his is intended as a hint to an application that may opt not to offer lookup operations to unauthorized users.

Returns:

false if looking up mappings is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

useComparativeIssueEnablerOublietteView

void useComparativeIssueEnablerOublietteView()

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.

usePlenaryIssueEnablerOublietteView

void usePlenaryIssueEnablerOublietteView()

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

getIssueEnablerIdsByOubliette

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

Gets the list of IssueEnabler Ids associated with an Oubliette .

Parameters:

oublietteId - Id of the Oubliette

Returns:

list of related issue enabler 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.

getIssueEnablersByOubliette

IssueEnablerList getIssueEnablersByOubliette(Id oublietteId)
                                      throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the list of IssueEnablers associated with an Oubliette .

Parameters:

oublietteId - Id of the Oubliette

Returns:

list of related issue enablers

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.

getIssueEnablerIdsByOubliettes

IdList getIssueEnablerIdsByOubliettes(IdList oublietteIds)
                               throws OperationFailedException,
PermissionDeniedException

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

Parameters:

oublietteIds - list of oubliette Ids

Returns:

list of issue enabler Ids

Throws:

NullArgumentException - oublietteIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getIssueEnablersByOubliettes

IssueEnablerList getIssueEnablersByOubliettes(IdList oublietteIds)
                                       throws OperationFailedException,
PermissionDeniedException

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

Parameters:

oublietteIds - list of oubliette Ids

Returns:

list of issue enabler Ids

Throws:

NullArgumentException - oublietteIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getOublietteIdsByIssueEnabler

IdList getOublietteIdsByIssueEnabler(Id issueEnablerId)
                              throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the Oubliette Ids mapped to an IssueEnabler .

Parameters:

issueEnablerId - Id of an IssueEnabler

Returns:

list of oubliette Ids

Throws:

NotFoundException - issueEnablerId is not found

NullArgumentException - issueEnablerId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getOubliettesByIssueEnabler

OublietteList getOubliettesByIssueEnabler(Id issueEnablerId)
                                   throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the Oubliettes mapped to an IssueEnabler .

Parameters:

issueEnablerId - Id of an IssueEnabler

Returns:

list of oubliettes

Throws:

NotFoundException - issueEnablerId is not found

NullArgumentException - issueEnablerId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.