Interface IssueFrontOfficeSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface IssueFrontOfficeSession
extends OsidSession

This session provides methods to retrieve Issue to FrontOffice mappings. An Issue may appear in multiple FrontOffice objects. Each front office 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	canLookupIssueFrontOfficeMappings()	Tests if this user can perform lookups of issue/front office mappings.
IdList	getFrontOfficeIdsByIssue(Id issueId)	Gets the FrontOffice Ids frontOfficeped to an Issue .
FrontOfficeList	getFrontOfficesByIssue(Id issueId)	Gets the FrontOffices frontOfficeped to an Issue .
IdList	getIssueIdsByFrontOffice(Id frontOfficeId)	Gets the list of Issue Ids associated with a FrontOffice .
IdList	getIssueIdsByFrontOffices(IdList frontOfficeIds)	Gets the list of Issue Ids corresponding to a list of FrontOffices .
IssueList	getIssuesByFrontOffice(Id frontOfficeId)	Gets the list of Issues associated with a FrontOffice .
IssueList	getIssuesByFrontOffices(IdList frontOfficeIds)	Gets the list of Issues corresponding to a list of FrontOffices .
void	useComparativeIssueFrontOfficeView()	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	usePlenaryIssueFrontOfficeView()	A complete view of the Issue and FrontOffice 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

canLookupIssueFrontOfficeMappings

boolean canLookupIssueFrontOfficeMappings()

Tests if this user can perform lookups of issue/front office 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 mappings is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

useComparativeIssueFrontOfficeView

void useComparativeIssueFrontOfficeView()

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.

usePlenaryIssueFrontOfficeView

void usePlenaryIssueFrontOfficeView()

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

getIssueIdsByFrontOffice

IdList getIssueIdsByFrontOffice(Id frontOfficeId)
                         throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the list of Issue Ids associated with a FrontOffice .

Parameters:

frontOfficeId - Id of the FrontOffice

Returns:

list of related issue Ids

Throws:

NotFoundException - frontOfficeId is not found

NullArgumentException - frontOfficeId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getIssuesByFrontOffice

IssueList getIssuesByFrontOffice(Id frontOfficeId)
                          throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the list of Issues associated with a FrontOffice .

Parameters:

frontOfficeId - Id of the FrontOffice

Returns:

list of related issues

Throws:

NotFoundException - frontOfficeId is not found

NullArgumentException - frontOfficeId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getIssueIdsByFrontOffices

IdList getIssueIdsByFrontOffices(IdList frontOfficeIds)
                          throws OperationFailedException,
PermissionDeniedException

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

Parameters:

frontOfficeIds - list of front office Ids

Returns:

list of issue Ids

Throws:

NullArgumentException - frontOfficeIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getIssuesByFrontOffices

IssueList getIssuesByFrontOffices(IdList frontOfficeIds)
                           throws OperationFailedException,
PermissionDeniedException

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

Parameters:

frontOfficeIds - list of front office Ids

Returns:

list of issues

Throws:

NullArgumentException - frontOfficeIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getFrontOfficeIdsByIssue

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

Gets the FrontOffice Ids frontOfficeped to an Issue .

Parameters:

issueId - Id of an Issue

Returns:

list of frontOffices

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.

getFrontOfficesByIssue

FrontOfficeList getFrontOfficesByIssue(Id issueId)
                                throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the FrontOffices frontOfficeped to an Issue .

Parameters:

issueId - Id of an Issue

Returns:

list of frontOffices

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.