Interface | osid.relationship.FamilyAdminSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session creates, updates, and deletes Create and update operations differ in their usage. To
create a For updates, The delete operations delete This session includes an | ||
Method | canCreateFamilies | ||
Description |
Tests if this user can create families. A return of
true does not guarantee successful authorization. A return
of false indicates that it is known creating a | ||
Return | boolean | false if Family creation is not authorized,
true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | canCreateFamilyWithRecordTypes | ||
Description |
Tests if this user can create a single | ||
Parameters | osid.type.Type[] | familyRecordTypes | array of family record types |
Return | boolean | true if Family creation using the specified
record Types is supported, false otherwise | |
Errors | NULL_ARGUMENT | familyRecordTypes is null | |
Compliance | mandatory | This method must be implemented. | |
Method | getFamilyFormForCreate | ||
Description |
Gets the family form for creating new families. A new form should be requested for each create transaction. | ||
Parameters | osid.type.Type[] | familyRecordTypes | array of family record types |
Return | osid.relationship.FamilyForm | the family form | |
Errors | NULL_ARGUMENT | familyRecordTypes is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | unable to get form for requested record types | ||
Compliance | mandatory | This method must be implemented. | |
Method | createFamily | ||
Description |
Creates a new | ||
Parameters | osid.relationship.FamilyForm | familyForm | the form for this Family. |
Return | osid.relationship.Family | the new Family | |
Errors | ILLEGAL_STATE | familyForm already used in a create transaction | |
INVALID_ARGUMENT | one or more of the form elements is invalid | ||
NULL_ARGUMENT | familyForm is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | familyForm did not originate from
getFamilyFormForCreate() | ||
Compliance | mandatory | This method must be implemented. | |
Method | canUpdateFamilies | ||
Description |
Tests if this user can update families. A return of
true does not guarantee successful authorization. A return
of false indicates that it is known updating a | ||
Return | boolean | false if Family modification is not
authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getFamilyFormForUpdate | ||
Description |
Gets the family form for updating an existing family. A new family form should be requested for each update transaction. | ||
Parameters | osid.id.Id | familyId | the Id of the Family |
Return | osid.relationship.FamilyForm | the family form | |
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 | updateFamily | ||
Description |
Updates an existing family. | ||
Parameters | osid.relationship.FamilyForm | familyForm | the form containing the elements to be updated |
Errors | ILLEGAL_STATE | familyForm already used in an update transaction | |
INVALID_ARGUMENT | the form contains an invalid value | ||
NULL_ARGUMENT | familyId or familyForm is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | familyForm did not originate from
getFamilyFormForUpdate() | ||
Compliance | mandatory | This method must be implemented. | |
Method | canDeleteFamilies | ||
Description |
Tests if this user can delete families. A return of
true does not guarantee successful authorization. A return
of false indicates that it is known deleting a | ||
Return | boolean | false if Family deletion is not authorized,
true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | deleteFamily | ||
Description |
Deletes a | ||
Parameters | osid.id.Id | familyId | the Id of the Family to remove |
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 must be implemented. | |
Method | canManageFamilyAliases | ||
Description |
Tests if this user can manage | ||
Return | boolean | false if Family aliasing is not authorized,
true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | aliasFamily | ||
Description |
Adds an | ||
Parameters | osid.id.Id | familyId | the Id of a Family |
osid.id.Id | aliasId | the alias Id | |
Errors | ALREADY_EXISTS | aliasId is already assigned | |
NOT_FOUND | familyId not found | ||
NULL_ARGUMENT | familyId or aliasId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |