Interface | osid.topology.rules.EdgeEnablerAdminSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session creates and removes edge enablers. The data
for create and update is provided via the | ||
Method | getGraphId | ||
Description |
Gets the | ||
Return | osid.id.Id | the Graph Id associated with this session | |
Compliance | mandatory | This method must be implemented. | |
Method | getGraph | ||
Description |
Gets the | ||
Return | osid.topology.Graph | the graph | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canCreateEdgeEnabler | ||
Description |
Tests if this user can create edge enablers. A return
of true does not guarantee successful authorization. A
return of false indicates that it is known creating an
| ||
Return | boolean | false if EdgeEnabler creation is not
authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | canCreateEdgeEnablerWithRecordTypes | ||
Description |
Tests if this user can create a single | ||
Parameters | osid.type.Type[] | edgeEnablerRecordTypes | array of edge enabler types |
Return | boolean | true if EdgeEnabler creation using the
specified record Types is supported, false
otherwise | |
Errors | NULL_ARGUMENT | edgeEnablerRecordTypes is null | |
Compliance | mandatory | This method must be implemented. | |
Method | getEdgeEnablerFormForCreate | ||
Description |
Gets the edge enabler form for creating new edge enablers. A new form should be requested for each create transaction. | ||
Parameters | osid.type.Type[] | edgeEnablerRecordTypes | array of edge enabler types |
Return | osid.topology.rules.EdgeEnablerForm | the edge enabler form | |
Errors | NULL_ARGUMENT | edgeEnablerRecordTypes 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 | createEdgeEnabler | ||
Description |
Creates a new | ||
Parameters | osid.topology.rules.EdgeEnablerForm | edgeEnablerForm | the form for this EdgeEnabler |
Return | osid.topology.rules.EdgeEnabler | the new EdgeEnabler | |
Errors | ILLEGAL_STATE | edgeEnablerForm already used in a create transaction | |
INVALID_ARGUMENT | one or more of the form elements is invalid | ||
NULL_ARGUMENT | edgeEnablerForm is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | edgeEnablerForm did not originate from
getEdgeEnablerFormForCreate() | ||
Compliance | mandatory | This method must be implemented. | |
Method | canUpdateEdgeEnablers | ||
Description |
Tests if this user can update edge enablers. A return
of true does not guarantee successful authorization. A
return of false indicates that it is known updating an
| ||
Return | boolean | false if EdgeEnabler modification is not
authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getEdgeEnablerFormForUpdate | ||
Description |
Gets the edge enabler form for updating an existing edge enabler. A new edge enabler form should be requested for each update transaction. | ||
Parameters | osid.id.Id | edgeEnablerId | the Id of the EdgeEnabler |
Return | osid.topology.rules.EdgeEnablerForm | the edge enabler form | |
Errors | NOT_FOUND | edgeEnablerId is not found | |
NULL_ARGUMENT | edgeEnablerId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | updateEdgeEnabler | ||
Description |
Updates an existing edge enabler. | ||
Parameters | osid.topology.rules.EdgeEnablerForm | edgeEnablerForm | the form containing the elements to be updated |
Errors | ILLEGAL_STATE | edgeEnablerForm already used in an update transaction | |
INVALID_ARGUMENT | the form contains an invalid value | ||
NULL_ARGUMENT | edgeEnablerId or edgeEnablerForm is
null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | edgeEnablerForm did not originate from
getEdgeEnablerFormForUpdate() | ||
Compliance | mandatory | This method must be implemented. | |
Method | canDeleteEdgeEnablers | ||
Description |
Tests if this user can delete edge enablers. A return
of true does not guarantee successful authorization. A
return of false indicates that it is known deleting an
| ||
Return | boolean | false if EdgeEnabler deletion is not
authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | deleteEdgeEnabler | ||
Description |
Deletes an | ||
Parameters | osid.id.Id | edgeEnablerId | the Id of the EdgeEnabler to remove |
Errors | NOT_FOUND | edgeEnablerId not found | |
NULL_ARGUMENT | edgeEnablerId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canManageEdgeEnablerAliases | ||
Description |
Tests if this user can manage | ||
Return | boolean | false if EdgeEnabler aliasing is not
authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | aliasEdgeEnabler | ||
Description |
Adds an | ||
Parameters | osid.id.Id | edgeEnablerId | the Id of an EdgeEnabler |
osid.id.Id | aliasId | the alias Id | |
Errors | ALREADY_EXISTS | aliasId is already assigned | |
NOT_FOUND | edgeEnablerId not found | ||
NULL_ARGUMENT | edgeEnablerId or aliasId is null
| ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |