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

This session provides methods to retrieve RelationshipEnabler to Relationship mappings. A RelationshipEnabler may appear in multiple Relationship objects. Each relationship 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
MethodcanLookupRelationshipEnablerFamilytMappings
Description

Tests if this user can perform lookups of relationship enabler/family 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.

Returnboolean false if looking up mappings is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethoduseComparativeRelationshipEnablerFamilyView
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.
MethodusePlenaryRelationshipEnablerFamilyView
Description

A complete view of the RelationshipEnabler and 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.
MethodgetRelationshipEnablerIdsByFamily
Description

Gets the list of RelationshipEnablerIds associated with a Family.

Parametersosid.id.IdfamilyId Id of the Family
Returnosid.id.IdListlist of related relationship enabler Ids
ErrorsNOT_FOUND familyId is not found
NULL_ARGUMENT familyId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetRelationshipEnablersByFamily
Description

Gets the list of relationship enablers associated with a Family.

Parametersosid.id.IdfamilyId Id of the Family
Returnosid.relationship.rules.RelationshipEnablerListlist of related relationship enablers
ErrorsNOT_FOUND familyId is not found
NULL_ARGUMENT familyId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetRelationshipEnablerIdsByFamilies
Description

Gets the list of RelationshipEnabler Ids corresponding to a list of Families.

Parametersosid.id.IdListfamilyIdslist of family Ids
Returnosid.id.IdListlist of relationship enabler Ids
ErrorsNULL_ARGUMENT familyIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetRelationshipEnablersByFamilies
Description

Gets the list of relationship enablers corresponding to a list of Families.

Parametersosid.id.IdListfamilyIdslist of family Ids
Returnosid.relationship.rules.RelationshipEnablerListlist of relationship enablers
ErrorsNULL_ARGUMENT familyIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetFamilyIdsByRelationshipEnabler
Description

Gets the Family Ids mapped to a RelationshipEnabler.

Parametersosid.id.IdrelationshipEnablerId Id of a RelationshipEnabler
Returnosid.id.IdListlist of family Ids
ErrorsNOT_FOUND relationshipEnablerId is not found
NULL_ARGUMENT relationshipEnablerId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetRelationshipsByRelationshipEnabler
Description

Gets the families mapped to a RelationshipEnabler.

Parametersosid.id.IdrelationshipEnablerId Id of a RelationshipEnabler
Returnosid.relationship.FamilyListlist of families
ErrorsNOT_FOUND relationshipEnablerId is not found
NULL_ARGUMENT relationshipEnablerId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.