Interface | osid.relationship.rules.RelationshipEnablerAdminSession | ||
---|---|---|---|
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 | canCreateRelationshipEnabler | ||
Description |
Tests if this user can create relationship enablers. A
return of true does not guarantee successful
authorization. A return of false indicates that it is
known creating a | ||
Return | boolean | false if RelationshipEnabler creation is not
authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | canCreateRelationshipEnablerWithRecordTypes | ||
Description |
Tests if this user can create a single | ||
Parameters | osid.type.Type[] | relationshipEnablerRecordTypes | array of relationship enabler record types |
Return | boolean | true if RelationshipEnabler creation using
the specified record Types is supported, false
otherwise | |
Errors | NULL_ARGUMENT | relationshipEnablerRecordTypes is null | |
Compliance | mandatory | This method must be implemented. | |
Method | getRelationshipEnablerFormForCreate | ||
Description |
Gets the relationship enabler form for creating new relationship enablers. A new form should be requested for each create transaction. | ||
Parameters | osid.type.Type[] | relationshipEnablerRecordTypes | array of relationship enabler record types |
Return | osid.relationship.rules.RelationshipEnablerForm | the relationship enabler form | |
Errors | NULL_ARGUMENT | relationshipEnablerRecordTypes 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 | createRelationshipEnabler | ||
Description |
Creates a new | ||
Parameters | osid.relationship.rules.RelationshipEnablerForm | relationshipEnablerForm | the form for this RelationshipEnabler |
Return | osid.relationship.rules.RelationshipEnabler | the new RelationshipEnabler | |
Errors | ILLEGAL_STATE | relationshipEnablerForm already used in a create transaction | |
INVALID_ARGUMENT | one or more of the form elements is invalid | ||
NULL_ARGUMENT | relationshipEnablerForm is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | relationshipEnablerForm did not originate from
getRelationshipEnablerFormForCreate() | ||
Compliance | mandatory | This method must be implemented. | |
Method | canUpdateRelationshipEnablers | ||
Description |
Tests if this user can update relationship enablers. A
return of true does not guarantee successful
authorization. A return of false indicates that it is
known updating a | ||
Return | boolean | false if RelationshipEnabler modification is
not authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getRelationshipEnablerFormForUpdate | ||
Description |
Gets the relationship enabler form for updating an existing relationship enabler. A new relationship enabler form should be requested for each update transaction. | ||
Parameters | osid.id.Id | relationshipEnablerId | the Id of the RelationshipEnabler |
Return | osid.relationship.rules.RelationshipEnablerForm | the relationship enabler form | |
Errors | NOT_FOUND | relationshipEnablerId is not found | |
NULL_ARGUMENT | relationshipEnablerId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | updateRelationshipEnabler | ||
Description |
Updates an existing relationship enabler. | ||
Parameters | osid.relationship.rules.RelationshipEnablerForm | relationshipEnablerForm | the form containing the elements to be updated |
Errors | ILLEGAL_STATE | relationshipEnablerForm already used in an update
transaction | |
INVALID_ARGUMENT | the form contains an invalid value | ||
NULL_ARGUMENT | relationshipEnablerForm is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | relationshipEnablerForm did not originate from
getRelationshipEnablerFormForUpdate() | ||
Compliance | mandatory | This method must be implemented. | |
Method | canDeleteRelationshipEnablers | ||
Description |
Tests if this user can delete relationship enablers. A
return of true does not guarantee successful
authorization. A return of false indicates that it is
known deleting a | ||
Return | boolean | false if RelationshipEnabler deletion is not
authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | deleteRelationshipEnabler | ||
Description |
Deletes a | ||
Parameters | osid.id.Id | relationshipEnablerId | the Id of the RelationshipEnabler to remove |
Errors | NOT_FOUND | relationshipEnablerId not found | |
NULL_ARGUMENT | relationshipEnablerId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canManageRelationshipEnablerAliases | ||
Description |
Tests if this user can manage | ||
Return | boolean | false if RelationshipEnabler aliasing is not
authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | aliasRelationshipEnabler | ||
Description |
Adds an | ||
Parameters | osid.id.Id | relationshipEnablerId | the Id of a RelationshipEnabler |
osid.id.Id | aliasId | the alias Id | |
Errors | ALREADY_EXISTS | aliasId is already assigned | |
NOT_FOUND | relationshipEnablerId not found | ||
NULL_ARGUMENT | relationshipEnablerId or aliasId is
null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |