Interface | osid.relationship.rules.RelationshipEnablerFamilySession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session provides methods to retrieve This lookup session defines several views:
| ||
Method | canLookupRelationshipEnablerFamilytMappings | ||
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 | ||
Return | boolean | false if looking up mappings is not authorized, true
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | useComparativeRelationshipEnablerFamilyView | ||
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. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | usePlenaryRelationshipEnablerFamilyView | ||
Description |
A complete view of the | ||
Compliance | mandatory | This method is must be implemented. | |
Method | getRelationshipEnablerIdsByFamily | ||
Description |
Gets the list of | ||
Parameters | osid.id.Id | familyId | Id of the Family |
Return | osid.id.IdList | list of related relationship enabler Ids | |
Errors | NOT_FOUND | familyId is not found | |
NULL_ARGUMENT | familyId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getRelationshipEnablersByFamily | ||
Description |
Gets the list of relationship enablers associated with
a | ||
Parameters | osid.id.Id | familyId | Id of the Family |
Return | osid.relationship.rules.RelationshipEnablerList | list of related relationship enablers | |
Errors | NOT_FOUND | familyId is not found | |
NULL_ARGUMENT | familyId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getRelationshipEnablerIdsByFamilies | ||
Description |
Gets the list of | ||
Parameters | osid.id.IdList | familyIds | list of family Ids |
Return | osid.id.IdList | list of relationship enabler Ids | |
Errors | NULL_ARGUMENT | familyIds is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getRelationshipEnablersByFamilies | ||
Description |
Gets the list of relationship enablers corresponding to
a list of | ||
Parameters | osid.id.IdList | familyIds | list of family Ids |
Return | osid.relationship.rules.RelationshipEnablerList | list of relationship enablers | |
Errors | NULL_ARGUMENT | familyIds is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getFamilyIdsByRelationshipEnabler | ||
Description |
Gets the | ||
Parameters | osid.id.Id | relationshipEnablerId | Id of a RelationshipEnabler |
Return | osid.id.IdList | list of family Ids | |
Errors | NOT_FOUND | relationshipEnablerId is not found | |
NULL_ARGUMENT | relationshipEnablerId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getRelationshipsByRelationshipEnabler | ||
Description |
Gets the families mapped to a | ||
Parameters | osid.id.Id | relationshipEnablerId | Id of a RelationshipEnabler |
Return | osid.relationship.FamilyList | list of families | |
Errors | NOT_FOUND | relationshipEnablerId is not found | |
NULL_ARGUMENT | relationshipEnablerId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |