OSID Logo
OSID Specifications
tracking package
Version 3.0.0
Release Candidate Preview
Interfaceosid.tracking.FrontOfficeLookupSession
Implementsosid.OsidSession
Description

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.

MethodcanLookupFrontOffices
Description

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.

Returnboolean false if lookup methods are not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethoduseComparativeFrontOfficeView
Description

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.

CompliancemandatoryThis method is must be implemented.
MethodusePlenaryFrontOfficeView
Description

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.

CompliancemandatoryThis method is must be implemented.
MethodgetFrontOffice
Description

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.

Parametersosid.id.IdfrontOfficeId Id of the FrontOffice
Returnosid.tracking.FrontOfficethe front office
ErrorsNOT_FOUND frontOfficeId not found
NULL_ARGUMENT frontOfficeId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method is must be implemented.
MethodgetFrontOfficesByIds
Description

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.

Parametersosid.id.IdListfrontOfficeIdsthe list of Ids to retrieve
Returnosid.tracking.FrontOfficeListthe returned FrontOffice list
ErrorsNOT_FOUNDan Id was not found
NULL_ARGUMENT frontOfficeIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetFrontOfficesByGenusType
Description

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.

Parametersosid.type.TypefrontOfficeGenusTypea front office genus type
Returnosid.tracking.FrontOfficeListthe returned FrontOffice list
ErrorsNULL_ARGUMENT frontOfficeGenusType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetFrontOfficesByParentGenusType
Description

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.

Parametersosid.type.TypefrontOfficeGenusTypea front office genus type
Returnosid.tracking.FrontOfficeListthe returned FrontOffice list
ErrorsNULL_ARGUMENT frontOfficeGenusType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetFrontOfficesByRecordType
Description

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.

Parametersosid.type.TypefrontOfficeRecordTypea front office record type
Returnosid.tracking.FrontOfficeListthe returned FrontOffice list
ErrorsNULL_ARGUMENT frontOfficeRecordType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetFrontOfficesByProvider
Description

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.

Parametersosid.id.IdresourceIda resource Id
Returnosid.tracking.FrontOfficeListthe returned FrontOffice list
ErrorsNULL_ARGUMENT resourceId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetFrontOffices
Description

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.

Returnosid.tracking.FrontOfficeLista list of FrontOffices
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.