OSID - osid.transport.EndpointAdminSession Service Interface Definition

Interface	osid.transport.EndpointAdminSession
Implements	`osid.OsidSession`
Used By	`osid.transport.TransportManager`
Used By	`osid.transport.TransportProxyManager`
Description	This session creates, updates, and deletes `Endpoints`. The data for create and update is provided by the consumer via the form object. `OsidForms` are requested for each create or update and may not be reused. Create and update operations differ in their usage. To create a `Endpoint`, a `EndpointForm` is requested using `getEndpointFormForCreate()` specifying the desired record `Types` or none if no record `Types` are needed. The returned `EndpointForm` will indicate that it is to be used with a create operation and can be used to examine metdata or validate data prior to creation. Once the `EndpointForm` is submiited to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each `EndpointForm` corresponds to an attempted transaction. For updates, `EndpointForms` are requested to the `Endpoint` `Id` that is to be updated using `getEndpointFormForUpdate()`. Similarly, the `EndpointForm` has metadata about the data that can be updated and it can perform validation before submitting the update. The `EndpointForm` can only be used once for a successful update and cannot be reused. The delete operations delete `Endpoints`. This session includes an `Id` aliasing mechanism to assign an external `Id` to an internally assigned Id.
Method	canCreateEndpoints
Description	Tests if this user can create `Endpoints`. A return of true does not guarantee successful authorization. A return of false indicates that it is known creating a `Endpoint` will result in a `PERMISSION_DENIED`. This is intended as a hint to an application that may not wish to offer create operations to unauthorized users.
Return	`boolean`		`false` if `Endpoint` creation is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	canCreateEndpointWithRecordTypes
Description	Tests if this user can create a single `Endpoint` using the desired record types. While `TransportManager.getEndpointRecordTypes()` can be used to examine which records are supported, this method tests which record(s) are required for creating a specific `Endpoint`. Providing an empty array tests if a `Endpoint` can be created with no records.
Parameters	`osid.type.Type[]`	`endpointRecordTypes`	array of endpoint record types
Return	`boolean`		`true` if `Endpoint` creation using the specified `Types` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`endpointRecordTypes` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getEndpointFormForCreate
Description	Gets the endpoint form for creating new endpoints.
Parameters	`osid.type.Type[]`	`endpointRecordTypes`	array of endpoint record types
Return	`osid.transport.EndpointForm`		the endpoint form
Errors	NULL_ARGUMENT		`endpointRecordTypes` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		unable to get form with requested record types
Compliance	`mandatory`		This method must be implemented.
Method	createEndpoint
Description	Creates a new `Endpoint`.
Parameters	`osid.transport.EndpointForm`	`endpointForm`	the form for this `Endpoint`
Return	`osid.transport.Endpoint`		the new `Endpoint`
Errors	ILLEGAL_STATE		`endpointForm` already used in a create transaction
	INVALID_ARGUMENT		one or more of the form elements is invalid
	NULL_ARGUMENT		`endpointForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`endpointForm` did not originate from `getEndpointFormForCreate()`
Compliance	`mandatory`		This method must be implemented.
Method	canUpdateEndpoints
Description	Tests if this user can update `Endpoints`. A return of true does not guarantee successful authorization. A return of false indicates that it is known updating a `Endpoint` will result in a `PERMISSION_DENIED`. This is intended as a hint to an application that may not wish to offer update operations to unauthorized users.
Return	`boolean`		`false` if `Endpoint` modification is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getEndpointFormForUpdate
Description	Gets the endpoint form for updating an existing endpoint. A new endpoint form should be requested for each update transaction.
Parameters	`osid.id.Id`	`endpointId`	the `Id` of the `Endpoint`
Return	`osid.transport.EndpointForm`		the endpoint form
Errors	NOT_FOUND		`endpointId` is not found
	NULL_ARGUMENT		`endpointId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	updateEndpoint
Description	Updates an existing endpoint.
Parameters	`osid.transport.EndpointForm`	`endpointForm`	the form containing the elements to be updated
Errors	ILLEGAL_STATE		`endpointForm` already used in an update transaction
	INVALID_ARGUMENT		the form contains an invalid value
	NULL_ARGUMENT		`endpointId` or `endpointForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`endpointForm` did not originate from `getEndpointFormForUpdate()`
Compliance	`mandatory`		This method must be implemented.
Method	canDeleteEndpoints
Description	Tests if this user can delete `Endpoints`. A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting a `Endpoint` will result in a `PERMISSION_DENIED`. This is intended as a hint to an application that may not wish to offer delete operations to unauthorized users.
Return	`boolean`		`false` if `Endpoint` deletion is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	deleteEndpoint
Description	Deletes a `Endpoint`.
Parameters	`osid.id.Id`	`endpointId`	the `Id` of the `Endpoint` to remove
Errors	NOT_FOUND		`endpointId` not found
	NULL_ARGUMENT		`endpointId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canManageEndpointAliases
Description	Tests if this user can manage `Id` aliases for `Endpoints`. 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.
Return	`boolean`		`false` if `Endpoint` aliasing is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	aliasEndpoint
Description	Adds an `Id` to a `Endpoint` for the purpose of creating compatibility. The primary `Id` of the `Endpoint` is determined by the provider. The new `Id` performs as an alias to the primary `Id`. If the alias is a pointer to another endpoint, it is reassigned to the given endpoint `Id`.
Parameters	`osid.id.Id`	`endpointId`	the `Id` of a `Endpoint`
Parameters	`osid.id.Id`	`aliasId`	the alias `Id`
Errors	ALREADY_EXISTS		`aliasId` is already assigned
	NOT_FOUND		`endpointId` not found
	NULL_ARGUMENT		`endpointId` or `aliasId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.