Interface | osid.relationship.RelationshipSmartFamilySession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session manages queries and sequencing to create
"smart" dynamic catalogs. A This | ||
Method | getFamilyId | ||
Description |
Gets the | ||
Return | osid.id.Id | the Family Id associated with this session | |
Compliance | mandatory | This method must be implemented. | |
Method | getFamily | ||
Description |
Gets the | ||
Return | osid.relationship.Family | the family | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canManageSmartFamilies | ||
Description |
Tests if this user can manage smart families. 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 | ||
Return | boolean | false if smart family methods are not authorized,
true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getRelationshipQuery | ||
Description |
Gets a relationship query. | ||
Return | osid.relationship.RelationshipQuery | the relationship query | |
Compliance | mandatory | This method must be implemented. | |
Method | getRelationshipSearchOrder | ||
Description |
Gets a relationship search order. | ||
Return | osid.relationship.RelationshipSearchOrder | the relationship search order | |
Compliance | mandatory | This method must be implemented. | |
Method | applyRelationshipQuery | ||
Description |
Applies a relationship query to this family. | ||
Parameters | osid.relationship.RelationshipQuery | relationshipQuery | the relationship query |
Errors | NULL_ARGUMENT | relationshipQuery is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure occurred | ||
UNSUPPORTED | relationshipQuery not of this service | ||
Compliance | mandatory | This method must be implemented. | |
Method | inspectRelationshipQuery | ||
Description |
Gets a relationship query inspector for this family. | ||
Return | osid.relationship.RelationshipQueryInspector | the relationship query inspector | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure occurred | ||
Compliance | mandatory | This method must be implemented. | |
Method | applyRelationshipSequencing | ||
Description |
Applies a relationship search order to this family. | ||
Parameters | osid.relationship.RelationshipSearchOrder | relationshipSearchOrder | the relationship search order |
Errors | NULL_ARGUMENT | relationshipSearchOrder is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure occurred | ||
UNSUPPORTED | relationshipSearchOrder not of this service | ||
Compliance | mandatory | This method must be implemented. | |
Method | getRelationshipQueryFromInspector | ||
Description |
Gets a relationship query from an inspector. | ||
Parameters | osid.relationship.RelationshipQueryInspector | relationshipQueryInspector | a relationship query inspector |
Return | osid.relationship.RelationshipQuery | the relationship query | |
Errors | NULL_ARGUMENT | relatinshipQueryInspector is null | |
UNSUPPORTED | relationshipQueryInspector is not of this service | ||
Compliance | mandatory | This method must be implemented. |