Interface | osid.ontology.OntologyAdminSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session creates, updates, and deletes Create and update operations differ in their usage. To
create an For updates, The delete operations delete This session includes an | ||
Method | canCreateOntologies | ||
Description |
Tests if this user can create | ||
Return | boolean | false if Ontology creation is not authorized,
true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | canCreateOntologyWithRecordTypes | ||
Description |
Tests if this user can create a single | ||
Parameters | osid.type.Type[] | ontologyRecordTypes | array of ontology record types |
Return | boolean | true if Ontology creation using the specified
Types is supported, false otherwise | |
Errors | NULL_ARGUMENT | ontologyRecordTypes is null | |
Compliance | mandatory | This method must be implemented. | |
Method | getOntologyFormForCreate | ||
Description |
Gets the ontology form for creating new ontologies. A new form should be requested for each create transaction. | ||
Parameters | osid.type.Type[] | ontologyRecordTypes | array of ontology record types |
Return | osid.ontology.OntologyForm | the ontology form | |
Errors | NULL_ARGUMENT | ontologyRecordTypes 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 | createOntology | ||
Description |
Creates a new | ||
Parameters | osid.ontology.OntologyForm | ontologyForm | the form for this Ontology |
Return | osid.ontology.Ontology | the new Ontology | |
Errors | ILLEGAL_STATE | ontologyForm already used in a create transaction | |
INVALID_ARGUMENT | one or more of the form elements is invalid | ||
NULL_ARGUMENT | ontologyForm is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | ontologyForm did not originate from
getOntologyFormForCreate() | ||
Compliance | mandatory | This method must be implemented. | |
Method | canUpdateOntologies | ||
Description |
Tests if this user can update | ||
Return | boolean | false if Ontology modification is not
authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getOntologyFormForUpdate | ||
Description |
Gets the ontology form for updating an existing ontology. A new ontology form should be requested for each update transaction. | ||
Parameters | osid.id.Id | ontologyId | the Id of the Ontology |
Return | osid.ontology.OntologyForm | the ontology form | |
Errors | NOT_FOUND | ontologyId is not found | |
NULL_ARGUMENT | ontologyId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | updateOntology | ||
Description |
Updates an existing ontology. | ||
Parameters | osid.ontology.OntologyForm | ontologyForm | the form containing the elements to be updated |
Errors | ILLEGAL_STATE | ontologyForm already used in an update transaction | |
INVALID_ARGUMENT | the form contains an invalid value | ||
NULL_ARGUMENT | ontologyForm is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | ontologyForm did not originate from
getOntologyFormForUpdate() | ||
Compliance | mandatory | This method must be implemented. | |
Method | canDeleteOntologies | ||
Description |
Tests if this user can delete ontologies. A return of
true does not guarantee successful authorization. A return
of false indicates that it is known deleting an | ||
Return | boolean | false if Ontology deletion is not authorized,
true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | deleteOntology | ||
Description |
Deletes an | ||
Parameters | osid.id.Id | ontologyId | the Id of the Ontology to remove |
Errors | NOT_FOUND | ontologyId not found | |
NULL_ARGUMENT | ontologyId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canManageOntologyAliases | ||
Description |
Tests if this user can manage | ||
Return | boolean | false if Ontology aliasing is not authorized,
true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | aliasOntology | ||
Description |
Adds an | ||
Parameters | osid.id.Id | ontologyId | the Id of an Ontology |
osid.id.Id | aliasId | the alias Id | |
Errors | ALREADY_EXISTS | aliasId is already assigned | |
NOT_FOUND | ontologyId not found | ||
NULL_ARGUMENT | ontologyId or aliasId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |