org.osid.tracking

Interface FrontOfficeLookupSession

All Superinterfaces:

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

public interface FrontOfficeLookupSession
extends OsidSession

This session provides methods for retrieving FrontOffice objects. The FrontOffice represents a collection of issues and efforts.

This session defines views that offer differing behaviors when retrieving multiple objects.

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

Generally, the comparative view should be used for most applications as it permits operation even if there is data that cannot be accessed. For example, a browsing application may only need to examine the FrontOffices it can access, without breaking execution. However, an assessment may only be useful if all FrontOffices referenced by it are available, and a test-taking application may sacrifice some interoperability for the sake of precision.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canLookupFrontOffices() Tests if this user can perform FrontOffice lookups.
FrontOffice	getFrontOffice(Id frontOfficeId) Gets the FrontOffice specified by its Id.
FrontOfficeList	getFrontOffices() Gets all FrontOffices.
FrontOfficeList	getFrontOfficesByGenusType(Type frontOfficeGenusType) Gets a FrontOfficeList corresponding to the given front office genus Type which does not include front offices of types derived from the specified Type.
FrontOfficeList	getFrontOfficesByIds(IdList frontOfficeIds) Gets a FrontOfficeList corresponding to the given IdList.
FrontOfficeList	getFrontOfficesByParentGenusType(Type frontOfficeGenusType) Gets a FrontOfficeList corresponding to the given front office genus Type and include any additional front offices with genus types derived from the specified Type.
FrontOfficeList	getFrontOfficesByProvider(Id resourceId) Gets a FrontOfficeList from the given provider.
FrontOfficeList	getFrontOfficesByRecordType(Type frontOfficeRecordType) Gets a FrontOfficeList containing the given front office record Type.
void	useComparativeFrontOfficeView() 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	usePlenaryFrontOfficeView() A complete view of the FrontOffice 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

canLookupFrontOffices

boolean canLookupFrontOffices()

Tests if this user can perform FrontOffice lookups. A return of true does not guarantee successful authorization. A return of false indicates that it is known all 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 lookup methods are not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

useComparativeFrontOfficeView

void useComparativeFrontOfficeView()

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.

usePlenaryFrontOfficeView

void usePlenaryFrontOfficeView()

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

getFrontOffice

FrontOffice getFrontOffice(Id frontOfficeId)
                           throws NotFoundException,
                                  OperationFailedException,
                                  PermissionDeniedException

Gets the FrontOffice specified by its Id. In plenary mode, the exact Id is found or a NOT_FOUND results. Otherwise, the returned FrontOffice may have a different Id than requested, such as the case where a duplicate Id was assigned to a FrontOffice and retained for compatibility.

Parameters:

frontOfficeId - Id of the FrontOffice

Returns:

the front office

Throws:

NotFoundException - frontOfficeId not found

NullArgumentException - frontOfficeId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method is must be implemented.

getFrontOfficesByIds

FrontOfficeList getFrontOfficesByIds(IdList frontOfficeIds)
                                     throws NotFoundException,
                                            OperationFailedException,
                                            PermissionDeniedException

Gets a FrontOfficeList corresponding to the given IdList. In plenary mode, the returned list contains all of the front offices specified in the Id list, in the order of the list, including duplicates, or an error results if an Id in the supplied list is not found or inaccessible. Otherwise, inaccessible FrontOffices may be omitted from the list and may present the elements in any order including returning a unique set.

Parameters:

frontOfficeIds - the list of Ids to retrieve

Returns:

the returned FrontOffice list

Throws:

NotFoundException - an Id was not found

NullArgumentException - frontOfficeIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getFrontOfficesByGenusType

FrontOfficeList getFrontOfficesByGenusType(Type frontOfficeGenusType)
                                           throws OperationFailedException,
                                                  PermissionDeniedException

Gets a FrontOfficeList corresponding to the given front office genus Type which does not include front offices of types derived from the specified Type. In plenary mode, the returned list contains all known front offices or an error results. Otherwise, the returned list may contain only those front offices that are accessible through this session.

Parameters:

frontOfficeGenusType - a front office genus type

Returns:

the returned FrontOffice list

Throws:

NullArgumentException - frontOfficeGenusType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getFrontOfficesByParentGenusType

FrontOfficeList getFrontOfficesByParentGenusType(Type frontOfficeGenusType)
                                                 throws OperationFailedException,
                                                        PermissionDeniedException

Gets a FrontOfficeList corresponding to the given front office genus Type and include any additional front offices with genus types derived from the specified Type. In plenary mode, the returned list contains all known front offices or an error results. Otherwise, the returned list may contain only those front offices that are accessible through this session.

Parameters:

frontOfficeGenusType - a front office genus type

Returns:

the returned FrontOffice list

Throws:

NullArgumentException - frontOfficeGenusType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getFrontOfficesByRecordType

FrontOfficeList getFrontOfficesByRecordType(Type frontOfficeRecordType)
                                            throws OperationFailedException,
                                                   PermissionDeniedException

Gets a FrontOfficeList containing the given front office record Type. In plenary mode, the returned list contains all known front offices or an error results. Otherwise, the returned list may contain only those front offices that are accessible through this session.

Parameters:

frontOfficeRecordType - a front office record type

Returns:

the returned FrontOffice list

Throws:

NullArgumentException - frontOfficeRecordType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getFrontOfficesByProvider

FrontOfficeList getFrontOfficesByProvider(Id resourceId)
                                          throws OperationFailedException,
                                                 PermissionDeniedException

Gets a FrontOfficeList from the given provider. In plenary mode, the returned list contains all known front offices or an error results. Otherwise, the returned list may contain only those front offices that are accessible through this session.

Parameters:

resourceId - a resource Id

Returns:

the returned FrontOffice list

Throws:

NullArgumentException - resourceId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getFrontOffices

FrontOfficeList getFrontOffices()
                                throws OperationFailedException,
                                       PermissionDeniedException

Gets all FrontOffices. In plenary mode, the returned list contains all known front offices or an error results. Otherwise, the returned list may contain only those front offices that are accessible through this session.

Returns:

a list of FrontOffices

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.