Interface | osid.relationship.RelationshipAdminSession | ||
---|---|---|---|
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 | 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 | canCreateRelationships | ||
Description |
Tests if this user can create | ||
Return | boolean | false if Relationship creation is not
authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | canCreateRelationshipWithRecordTypes | ||
Description |
Tests if this user can create a single | ||
Parameters | osid.type.Type[] | relationshipRecordTypes | array of relationship record types |
Return | boolean | true if Relationship creation using the
specified record Types is supported, false
otherwise | |
Errors | NULL_ARGUMENT | relationshipRecordTypes is null | |
Compliance | mandatory | This method must be implemented. | |
Method | getRelationshipFormForCreate | ||
Description |
Gets the relationship form for creating new relationships. A new form should be requested for each create transaction. | ||
Parameters | osid.id.Id | sourceId | Id of a peer |
osid.id.Id | destinationId | Id of the related peer | |
osid.type.Type[] | relationshipRecordTypes | array of relationship record types | |
Return | osid.relationship.RelationshipForm | the relationship form | |
Errors | NOT_FOUND | sourceId or destinationId is not found | |
NULL_ARGUMENT | sourceId or destinationId is null
| ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | unable to get form for requested recod types | ||
Compliance | mandatory | This method must be implemented. | |
Method | createRelationship | ||
Description |
Creates a new | ||
Parameters | osid.relationship.RelationshipForm | relationshipForm | the form for this Relationship |
Return | osid.relationship.Relationship | the new Relationship | |
Errors | ILLEGAL_STATE | relationshipForm already used in a create transaction | |
INVALID_ARGUMENT | one or more of the form elements is invalid | ||
NULL_ARGUMENT | relationshipForm is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | relationshipForm did not originate from
getRelationshipFormForCreate() | ||
Compliance | mandatory | This method must be implemented. | |
Method | canUpdateRelationships | ||
Description |
Tests if this user can update | ||
Return | boolean | false if Relationship modification is not
authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getRelationshipFormForUpdate | ||
Description |
Gets the relationship form for updating an existing relationship. A new relationship form should be requested for each update transaction. | ||
Parameters | osid.id.Id | relationshipId | the Id of the Relationship |
Return | osid.relationship.RelationshipForm | the relationship form | |
Errors | NOT_FOUND | relationshipId is not found | |
NULL_ARGUMENT | relationshipId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | updateRelationship | ||
Description |
Updates an existing relationship. | ||
Parameters | osid.relationship.RelationshipForm | relationshipForm | the form containing the elements to be updated |
Errors | ILLEGAL_STATE | relationshipForm already used in an update transaction | |
INVALID_ARGUMENT | the form contains an invalid value | ||
NULL_ARGUMENT | relationshipForm is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | relationshipForm did not originate from
getRelationshipFormForUpdate() | ||
Compliance | mandatory | This method must be implemented. | |
Method | canDeleteRelationships | ||
Description |
Tests if this user can delete | ||
Return | boolean | false if Relationship deletion is not
authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | deleteRelationship | ||
Description |
Deletes a | ||
Parameters | osid.id.Id | relationshipId | the Id of the Relationship to remove |
Errors | NOT_FOUND | relationshipId not found | |
NULL_ARGUMENT | relationshipId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canManageRelationshipAliases | ||
Description |
Tests if this user can manage | ||
Return | boolean | false if Relationship aliasing is not
authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | aliasRelationship | ||
Description |
Adds an | ||
Parameters | osid.id.Id | relationshipId | the Id of a Relationship |
osid.id.Id | aliasId | the alias Id | |
Errors | ALREADY_EXISTS | aliasId is already assigned | |
NOT_FOUND | relationship not found | ||
NULL_ARGUMENT | relationshipId or aliasId is null
| ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |