OSID - osid.id.IdAdminSession Service Interface Definition

Interface	osid.id.IdAdminSession
Implements	`osid.OsidSession`
Description	This session is used to manually create new `Ids.`
Method	canCreateIds
Description	Tests if this user can create `Ids.` A return of true does not guarantee successful authorization. A return of false indicates that it is known create methods in this session will result in a `PERMISSION_DENIED.` This is intended as a hint to an application that may opt not to offer create operations.
Return	`boolean`		`false` if create methods are not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getIdFormForCreate
Description	Gets the `Id` form for creating new Ids. A new form should be requested for each create transaction.
Return	`osid.id.IdForm`		the `Id` form
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	createId
Description	Creates a new `Id.` A new `IdForm` should be requested for each create transaction.
Parameters	`osid.id.IdForm`	`idForm`	the `Id` form
Return	`osid.id.Id`		the created `Id`
Errors	ALREADY_EXISTS		an `Id` for the authority, namespace, and identifier already exists
	ILLEGAL_STATE		`idForm` already used in a create transaction
	INVALID_ARGUMENT		one or more of the form elements is invalid
	NULL_ARGUMENT		`idForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`idForm` did not originate from `getIdFormForCreate()`
Compliance	`mandatory`		This method must be implemented.
Method	canAliasIds
Description	Tests if this user can alias `Ids.` A return of true does not guarantee successful authorization. A return of false indicates that it is known add methods in this session will result in a `PERMISSION_DENIED.` This is intended as a hint to an application that may opt not to offer alias operations.
Return	`boolean`		`false` if alias methods are not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	aliasId
Description	Makes two `Ids` equivalent. The primary and equivalent `Ids` are already known to this service `.` If the external `Id` is already mapped to another `Id,` it is changed to map to the given primary `Id.` Calls to `IdLookupSession.getId(equivalentId)` return the `primaryId.`
Parameters	`osid.id.Id`	`primaryId`	the primary `Id`
Parameters	`osid.id.Id`	`equivalentId`	an `Id` to be made equivalent
Errors	NOT_FOUND		`primaryId` or `equivalentId` is not found
	NULL_ARGUMENT		`primaryId` or `equivalentId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	removeAlias
Description	Removes equivalence from two `Ids.`
Parameters	`osid.id.Id`	`primaryId`	the primary `Id`
Parameters	`osid.id.Id`	`equivalentId`	the equivalent `Id`
Errors	NOT_FOUND		`primaryId` or `equivalentId` is not found or `equivalentId` not mapped to `primaryId`
	NULL_ARGUMENT		`primaryId` or `equivalentId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.