OSID Logo
OSID Specifications
relationship package
Version 3.0.0
Release Candidate Preview
Interfaceosid.relationship.FamilyLookupSession
Implementsosid.OsidSession
Description

This session provides methods for retrieving Family objects. The Family represents a collection of relationships.

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 Families it can access, without breaking execution. However, an assessment may only be useful if all Families referenced by it are available, and a test-taking applicationmay sacrifice some interoperability for the sake of precision.

MethodcanLookupFamilies
Description

Tests if this user can perform Family 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 not offer lookup operations to unauthorized users.

Returnboolean false if lookup methods are not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethoduseComparativeFamilyView
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.
MethodusePlenaryFamilyView
Description

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

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

Parametersosid.id.IdfamilyId Id of the Family
Returnosid.relationship.Familythe family
ErrorsNOT_FOUND familyId not found
NULL_ARGUMENT familyId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method is must be implemented.
MethodgetFamiliesByIds
Description

Gets a FamilyList corresponding to the given IdList. In plenary mode, the returned list contains all of the families 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 families may be omitted from the list and may present the elements in any order including returning a unique set.

Parametersosid.id.IdListfamilyIdsthe list of Ids to retrieve
Returnosid.relationship.FamilyListthe returned Family list
ErrorsNOT_FOUNDan Id was not found
NULL_ARGUMENT familyIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetFamiliesByGenusType
Description

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

Parametersosid.type.TypefamilyGenusTypea family genus type
Returnosid.relationship.FamilyListthe returned Family list
ErrorsNULL_ARGUMENT familyGenusType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetFamiliesByParentGenusType
Description

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

Parametersosid.type.TypefamilyGenusTypea family genus type
Returnosid.relationship.FamilyListthe returned Family list
ErrorsNULL_ARGUMENT familyGenusType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetFamiliesByRecordType
Description

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

Parametersosid.type.TypefamilyRecordTypea family record type
Returnosid.relationship.FamilyListthe returned Family list
ErrorsNULL_ARGUMENT familyRecordType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetFamiliesByProvider
Description

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

Parametersosid.id.IdresourceIda resource Id
Returnosid.relationship.FamilyListthe returned Family list
ErrorsNULL_ARGUMENT resourceId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetFamilies
Description

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

Returnosid.relationship.FamilyLista list of families
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.