Interface | osid.relationship.FamilyLookupSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session provides methods for retrieving This session defines views that offer differing behaviors when retrieving multiple objects.
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 | ||
Method | canLookupFamilies | ||
Description |
Tests if this user can perform | ||
Return | boolean | false if lookup methods are not authorized, true
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | useComparativeFamilyView | ||
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 | usePlenaryFamilyView | ||
Description |
A complete view of the | ||
Compliance | mandatory | This method is must be implemented. | |
Method | getFamily | ||
Description |
Gets the | ||
Parameters | osid.id.Id | familyId | Id of the Family |
Return | osid.relationship.Family | the family | |
Errors | NOT_FOUND | familyId not found | |
NULL_ARGUMENT | familyId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method is must be implemented. | |
Method | getFamiliesByIds | ||
Description |
Gets a | ||
Parameters | osid.id.IdList | familyIds | the list of Ids to retrieve |
Return | osid.relationship.FamilyList | the returned Family list | |
Errors | NOT_FOUND | an Id was not found | |
NULL_ARGUMENT | familyIds is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getFamiliesByGenusType | ||
Description |
Gets a | ||
Parameters | osid.type.Type | familyGenusType | a family genus type |
Return | osid.relationship.FamilyList | the returned Family list | |
Errors | NULL_ARGUMENT | familyGenusType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getFamiliesByParentGenusType | ||
Description |
Gets a | ||
Parameters | osid.type.Type | familyGenusType | a family genus type |
Return | osid.relationship.FamilyList | the returned Family list | |
Errors | NULL_ARGUMENT | familyGenusType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getFamiliesByRecordType | ||
Description |
Gets a | ||
Parameters | osid.type.Type | familyRecordType | a family record type |
Return | osid.relationship.FamilyList | the returned Family list | |
Errors | NULL_ARGUMENT | familyRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getFamiliesByProvider | ||
Description |
Gets a | ||
Parameters | osid.id.Id | resourceId | a resource Id |
Return | osid.relationship.FamilyList | the returned Family list | |
Errors | NULL_ARGUMENT | resourceId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getFamilies | ||
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. | ||
Return | osid.relationship.FamilyList | a list of families | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |