Interface | osid.relationship.RelationshipFamilyAssignmentSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session provides methods to re-assign Moving or adding a reference of a | ||
Method | canAssignRelationships | ||
Description |
Tests if this user can alter relationship/family
mappings. A return of true does not guarantee successful
authorization. A return of false indicates that it is
known mapping methods in this session will result in a
| ||
Return | boolean | false if mapping is not authorized, true
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | canAssignRelationshipsToFamily | ||
Description |
Tests if this user can alter relationship/family
mappings. A return of true does not guarantee successful
authorization. A return of false indicates that it is
known mapping methods in this session will result in a
| ||
Parameters | osid.id.Id | familyId | the Id of the Family |
Return | boolean | false if mapping is not authorized, true
otherwise | |
Errors | NULL_ARGUMENT | familyId is null | |
Compliance | mandatory | This method must be implemented. | |
Method | getAssignableFamilyIds | ||
Description |
Gets a list of families including and under the given family node in which any relationship can be assigned. | ||
Parameters | osid.id.Id | familyId | the Id of the Family |
Return | osid.id.IdList | list of assignable family Ids | |
Errors | NULL_ARGUMENT | familyId is null | |
OPERATION_FAILED | unable to complete request | ||
Compliance | mandatory | This method must be implemented. | |
Method | getAssignableFamilyIdsForRelationship | ||
Description |
Gets a list of families including and under the given family node in which a specific relationship can be assigned. | ||
Parameters | osid.id.Id | familyId | the Id of the Family |
osid.id.Id | relationshipId | the Id of the Relationship | |
Return | osid.id.IdList | list of assignable family Ids | |
Errors | NULL_ARGUMENT | familyId or relationshipId is null
| |
OPERATION_FAILED | unable to complete request | ||
Compliance | mandatory | This method must be implemented. | |
Method | assignRelationshipToFamily | ||
Description |
Adds an existing | ||
Parameters | osid.id.Id | relationshipId | the Id of the Relationship |
osid.id.Id | familyId | the Id of the Family | |
Errors | ALREADY_EXISTS | relationshipId is already assigned to familyId
| |
NOT_FOUND | relationshipId or familyId not found | ||
NULL_ARGUMENT | relationshipId or familyId is null
| ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | unassignRelationshipFromFamily | ||
Description |
Removes a | ||
Parameters | osid.id.Id | relationshipId | the Id of the Relationship |
osid.id.Id | familyId | the Id of the Family | |
Errors | NOT_FOUND | relationshipId or familyId not found or
relationshipId not assigned to familyId | |
NULL_ARGUMENT | relationshipId or familyId is null
| ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | reassignRelationshipToFamily | ||
Description |
Moves a | ||
Parameters | osid.id.Id | relationshipId | the Id of the Relationship |
osid.id.Id | fromFamilyId | the Id of the current Family | |
osid.id.Id | toFamilyId | the Id of the destination Family | |
Errors | NOT_FOUND | relationshipId, fromFamilyId, or toFamilyId
not found or relationshipId not mapped to fromFamilyId
| |
NULL_ARGUMENT | relationshipId, fromFamilyId, or toFamilyId
is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |