Interface | osid.type.TypeAdminSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session is used to create, update and delete | ||
Method | canCreateTypes | ||
Description |
Tests if this user can create | ||
Return | boolean | false if Type creation is not authorized,
true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getTypeFormForCreate | ||
Description |
Gets the type form for creating new types. A new form should be requested for each create transaction. | ||
Parameters | osid.type.Type | type | the Type to be created |
Return | osid.type.TypeForm | the type form | |
Errors | NULL_ARGUMENT | type is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | createType | ||
Description |
Creates a new | ||
Parameters | osid.type.TypeForm | typeForm | the type form |
Return | osid.type.Type | the created Type | |
Errors | ILLEGAL_STATE | typeForm already used in a create transaction | |
INVALID_ARGUMENT | one or more of the arguments is invalid | ||
NULL_ARGUMENT | typeForm is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | typeForm did not originate from
getTypeFormForCreate() | ||
Compliance | mandatory | This method must be implemented. | |
Method | canUpdateTypes | ||
Description |
Tests if this user can update types. A return of true
does not guarantee successful authorization. A return of
false indicates that it is known updating a | ||
Return | boolean | false if type modification is not authorized, true
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getTypeFormForUpdate | ||
Description |
Gets the type form for creating new types. A new form should be requested for each create transaction. | ||
Parameters | osid.type.Type | type | the Type to be updated |
Return | osid.type.TypeForm | the type form | |
Errors | NOT_FOUND | type not found | |
NULL_ARGUMENT | type is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | updateType | ||
Description |
Updates a type. | ||
Parameters | osid.type.TypeForm | typeForm | the type form |
Errors | ILLEGAL_STATE | typeForm already used in an update transaction | |
INVALID_ARGUMENT | the form contains an invalid value | ||
NULL_ARGUMENT | typeForm is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | typeForm did not originate from
getTypeFormForUpdate() | ||
Compliance | mandatory | This method must be implemented. | |
Method | canDeleteTypes | ||
Description |
Tests if this user can delete | ||
Return | boolean | false if Item deletion is not authorized,
true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | canDeleteType | ||
Description |
Tests if this user can delete the specified type. A
return of true does not guarantee successful
authorization. A return of false indicates that it is
known deleteing the | ||
Parameters | osid.type.Type | type | the Type to be deleted |
Return | boolean | false if type deletion is not authorized, true
otherwise | |
Errors | NULL_ARGUMENT | type is null | |
Compliance | mandatory | This method must be implemented. | |
Method | deleteType | ||
Description |
Removes a | ||
Parameters | osid.type.Type | type | the Type to remove |
Errors | NOT_FOUND | type is not found | |
NULL_ARGUMENT | type is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | makeEquivalent | ||
Description |
Makes two | ||
Parameters | osid.type.Type | primaryType | the primary Type |
osid.type.Type | equivalentType | a Type to be made equivalent | |
Errors | NOT_FOUND | primaryType or equivalentType is not found | |
NULL_ARGUMENT | primaryType or equivalentType is null
| ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | addBaseType | ||
Description |
Adds a base type to a type. A base type is a parent of the type where the type implies support of the base type. | ||
Parameters | osid.type.Type | type | a Type |
osid.type.Type | baseType | a base type | |
Errors | NOT_FOUND | type or baseType is not found | |
NULL_ARGUMENT | type or baseType is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | removeBaseType | ||
Description |
Removes a base type from a type. | ||
Parameters | osid.type.Type | type | a Type |
osid.type.Type | baseType | a base type | |
Errors | NOT_FOUND | type or baseType is not found or
baseType is not a base of type | |
NULL_ARGUMENT | type or baseType is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | addTypeRelation | ||
Description |
Adds a relation between two types. The relationship is
a | ||
Parameters | osid.type.Type | sourceType | the source type |
osid.type.Type | destinationType | the destination type | |
osid.type.Type | relationType | the relation type | |
Errors | NOT_FOUND | sourceType, destinationType, or relationType
is not found | |
NULL_ARGUMENT | sourceType, destinationType, or relationType
is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | removeTypeRelation | ||
Description |
Renoves a relation between two types. | ||
Parameters | osid.type.Type | sourceType | the source type |
osid.type.Type | destinationType | the destination type | |
osid.type.Type | relationType | the relation type | |
Errors | NOT_FOUND | sourceType, destinationType, or relationType
is not found, or the relationship does not exist | |
NULL_ARGUMENT | sourceType, destinationType, or relationType
is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |