Interface | osid.relationship.rules.RelationshipEnablerFamilyAssignmentSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session provides methods to re-assign Adding a reference of a | ||
Method | canAssignRelationshipEnablers | ||
Description |
Tests if this user can alter relationship
enabler/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 | canAssignRelationshipEnablersToFamily | ||
Description |
Tests if this user can alter relationship
enabler/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 family enabler can be assigned. | ||
Parameters | osid.id.Id | familyId | the Id of the Family |
Return | osid.id.IdList | list of assignable relationship Ids | |
Errors | NULL_ARGUMENT | familyId is null | |
OPERATION_FAILED | unable to complete request | ||
Compliance | mandatory | This method must be implemented. | |
Method | getAssignableFamilyIdsForRelationshipEnabler | ||
Description |
Gets a list of families including and under the given family node in which a specific family enabler can be assigned. | ||
Parameters | osid.id.Id | familyId | the Id of the Family |
osid.id.Id | relationshipEnablerId | the Id of the RelationshipEnabler | |
Return | osid.id.IdList | list of assignable family Ids | |
Errors | NULL_ARGUMENT | familyId or relationshipEnablerId is
null | |
OPERATION_FAILED | unable to complete request | ||
Compliance | mandatory | This method must be implemented. | |
Method | assignRelationshipEnablerToFamily | ||
Description |
Adds an existing | ||
Parameters | osid.id.Id | relationshipEnablerId | the Id of the RelationshipEnabler |
osid.id.Id | familyId | the Id of the Family | |
Errors | ALREADY_EXISTS | relationshipEnablerId is already assigned to familyId
| |
NOT_FOUND | relationshipEnablerId or familyId not found | ||
NULL_ARGUMENT | relationshipEnablerId or familyId is
null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | unassignRelationshipEnablerFromFamily | ||
Description |
Removes a | ||
Parameters | osid.id.Id | relationshipEnablerId | the Id of the RelationshipEnabler |
osid.id.Id | familyId | the Id of the Family | |
Errors | NOT_FOUND | relationshipEnablerId or familyId not found
or relationshipEnablerId is not assigned to familyId
| |
NULL_ARGUMENT | relationshipEnablerId or familyId is
null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | reassignRelationshipEnablerToFamily | ||
Description |
Moves a | ||
Parameters | osid.id.Id | relationshipEnablerId | the Id of the RelationshipEnabler |
osid.id.Id | fromFamilyId | the Id of the current Family | |
osid.id.Id | toFamilyId | the Id of the destination Family | |
Errors | NOT_FOUND | relationshipEnablerId, fromFamilyId, or toFamilyId
not found or relationshipEnablerId not mapped to
fromFamilyId | |
NULL_ARGUMENT | relationshipEnabelrId, fromFamilyId, or toFamilyId
is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |