OSID Logo
OSID Specifications
topology rules package
Version 3.0.0
Release Candidate Preview
Interfaceosid.topology.rules.EdgeEnablerAdminSession
Implementsosid.OsidSession
Description

This session creates and removes edge enablers. The data for create and update is provided via the EdgeEnablerForm.

MethodgetGraphId
Description

Gets the Graph Id associated with this session.

Returnosid.id.Idthe Graph Id associated with this session
CompliancemandatoryThis method must be implemented.
MethodgetGraph
Description

Gets the Graph associated with this session.

Returnosid.topology.Graphthe graph
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanCreateEdgeEnabler
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 EdgeEnabler will result in a PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer create operations to an unauthorized user.

Returnboolean false if EdgeEnabler creation is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodcanCreateEdgeEnablerWithRecordTypes
Description

Tests if this user can create a single EdgeEnabler using the desired record types. While TopologyRulesManager.getEdgeEnablerRecordTypes() can be used to examine which records are supported, this method tests which record(s) are required for creating a specific EdgeEnabler. Providing an empty array tests if an EdgeEnabler can be created with no records.

Parametersosid.type.Type[]edgeEnablerRecordTypesarray of edge enabler types
Returnboolean true if EdgeEnabler creation using the specified record Types is supported, false otherwise
ErrorsNULL_ARGUMENT edgeEnablerRecordTypes is null
CompliancemandatoryThis method must be implemented.
MethodgetEdgeEnablerFormForCreate
Description

Gets the edge enabler form for creating new edge enablers. A new form should be requested for each create transaction.

Parametersosid.type.Type[]edgeEnablerRecordTypesarray of edge enabler types
Returnosid.topology.rules.EdgeEnablerFormthe edge enabler form
ErrorsNULL_ARGUMENT edgeEnablerRecordTypes is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTEDunable to get form for requested record types
CompliancemandatoryThis method must be implemented.
MethodcreateEdgeEnabler
Description

Creates a new EdgeEnabler.

Parametersosid.topology.rules.EdgeEnablerFormedgeEnablerFormthe form for this EdgeEnabler
Returnosid.topology.rules.EdgeEnablerthe new EdgeEnabler
ErrorsILLEGAL_STATE edgeEnablerForm already used in a create transaction
INVALID_ARGUMENTone or more of the form elements is invalid
NULL_ARGUMENT edgeEnablerForm is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED edgeEnablerForm did not originate from getEdgeEnablerFormForCreate()
CompliancemandatoryThis method must be implemented.
MethodcanUpdateEdgeEnablers
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 EdgeEnabler will result in a PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer update operations to an unauthorized user.

Returnboolean false if EdgeEnabler modification is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodgetEdgeEnablerFormForUpdate
Description

Gets the edge enabler form for updating an existing edge enabler. A new edge enabler form should be requested for each update transaction.

Parametersosid.id.IdedgeEnablerIdthe Id of the EdgeEnabler
Returnosid.topology.rules.EdgeEnablerFormthe edge enabler form
ErrorsNOT_FOUND edgeEnablerId is not found
NULL_ARGUMENT edgeEnablerId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodupdateEdgeEnabler
Description

Updates an existing edge enabler.

Parametersosid.topology.rules.EdgeEnablerFormedgeEnablerFormthe form containing the elements to be updated
ErrorsILLEGAL_STATE edgeEnablerForm already used in an update transaction
INVALID_ARGUMENTthe form contains an invalid value
NULL_ARGUMENT edgeEnablerId or edgeEnablerForm is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED edgeEnablerForm did not originate from getEdgeEnablerFormForUpdate()
CompliancemandatoryThis method must be implemented.
MethodcanDeleteEdgeEnablers
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 EdgeEnabler will result in a PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer delete operations to an unauthorized user.

Returnboolean false if EdgeEnabler deletion is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethoddeleteEdgeEnabler
Description

Deletes an EdgeEnabler.

Parametersosid.id.IdedgeEnablerIdthe Id of the EdgeEnabler to remove
ErrorsNOT_FOUND edgeEnablerId not found
NULL_ARGUMENT edgeEnablerId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanManageEdgeEnablerAliases
Description

Tests if this user can manage Id aliases for edge enablers. A return of true does not guarantee successful authorization. A return of false indicates that it is known changing an alias will result in a PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer alias operations to an unauthorized user.

Returnboolean false if EdgeEnabler aliasing is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodaliasEdgeEnabler
Description

Adds an Id to an EdgeEnabler for the purpose of creating compatibility. The primary Id of the EdgeEnabler is determined by the provider. The new Id performs as an alias to the primary Id . If the alias is a pointer to another edge enabler. it is reassigned to the given edge enabler Id.

Parametersosid.id.IdedgeEnablerIdthe Id of an EdgeEnabler
osid.id.IdaliasIdthe alias Id
ErrorsALREADY_EXISTS aliasId is already assigned
NOT_FOUND edgeEnablerId not found
NULL_ARGUMENT edgeEnablerId or aliasId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.