OSID - osid.sequencing.AntimatroidAdminSession Service Interface Definition

Interface	osid.sequencing.AntimatroidAdminSession
Implements	`osid.OsidSession`
Description	This session creates, updates, and deletes `Antimatroids.` 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 an `Antimatroid,` an `AntimatroidForm` is requested using `getAntimatroidFormForCreate()` specifying the desired record `Types` or none if no record `Types` are needed. The returned `AntimatroidForm` 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 `AntimatroidForm` is submiited to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each `AntimatroidForm` corresponds to an attempted transinput. For updates, `AntimatroidForms` are requested to the `Antimatroid` `Id` that is to be updated using `getAntimatroidFormForUpdate().` Similarly, the `AntimatroidForm` has metadata about the data that can be updated and it can perform validation before submitting the update. The `AntimatroidForm` can only be used once for a successful update and cannot be reused. The delete operations delete `Antimatroids.` This session includes an `Id` aliasing mechanism to assign an external `Id` to an internally assigned Id.
Method	canCreateAntimatroids
Description	Tests if this user can create `Antimatroids.` A return of true does not guarantee successful authorization. A return of false indicates that it is known creating an `Antimatroid.` 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 `Antimatroid` creation is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	canCreateAntimatroidWithRecordTypes
Description	Tests if this user can create a single `Antimatroid` using the desired record types. While `SequencingManager.getAntimatroidRecordTypes()` can be used to examine which records are supported, this method tests which record(s) are required for creating a specific `Antimatroid.` Providing an empty array tests if an `Antimatroid` can be created with no records.
Parameters	`osid.type.Type[]`	`antimatroidRecordTypes`	array of antimatroid record types
Return	`boolean`		`true` if `Antimatroid` creation using the specified record `Types` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`antimatroidRecordTypes` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getAntimatroidFormForCreate
Description	Gets the antimatroid form for creating new antimatroids. A new form should be requested for each create transinput.
Parameters	`osid.type.Type[]`	`antimatroidRecordTypes`	array of antimatroid record types
Return	`osid.sequencing.AntimatroidForm`		the antimatroid form
Errors	NULL_ARGUMENT		`antimatroidRecordTypes` 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	createAntimatroid
Description	Creates a new `Antimatroid.`
Parameters	`osid.sequencing.AntimatroidForm`	`antimatroidForm`	the form for this `Antimatroid`
Return	`osid.sequencing.Antimatroid`		the new `Antimatroid`
Errors	ILLEGAL_STATE		`antimatroidForm` already used in a create transinput
	INVALID_ARGUMENT		one or more of the form elements is invalid
	NULL_ARGUMENT		`antimatroidForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`antimatroidForm` did not originate from `getAntimatroidFormForCreate()`
Compliance	`mandatory`		This method must be implemented.
Method	canUpdateAntimatroids
Description	Tests if this user can update `Antimatroids.` A return of true does not guarantee successful authorization. A return of false indicates that it is known updating an `Antimatroid` 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 `Antimatroid` modification is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getAntimatroidFormForUpdate
Description	Gets the antimatroid form for updating an existing antimatroid. A new antimatroid form should be requested for each update transinput.
Parameters	`osid.id.Id`	`antimatroidId`	the `Id` of the `Antimatroid`
Return	`osid.sequencing.AntimatroidForm`		the antimatroid form
Errors	NOT_FOUND		`antimatroidId` is not found
	NULL_ARGUMENT		`antimatroidId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	updateAntimatroid
Description	Updates an existing antimatroid
Parameters	`osid.sequencing.AntimatroidForm`	`antimatroidForm`	the form containing the elements to be updated
Errors	ILLEGAL_STATE		`antimatroidForm` already used in an update transinput
	INVALID_ARGUMENT		the form contains an invalid value
	NULL_ARGUMENT		`antimatroidForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`antimatroidForm` did not originate from `getAntimatroidFormForUpdate()`
Compliance	`mandatory`		This method must be implemented.
Method	canDeleteAntimatroids
Description	Tests if this user can delete `Antimatroids.` A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting an `Antimatroid` 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 `Antimatroid` deletion is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	deleteAntimatroid
Description	Deletes an `Antimatroid.`
Parameters	`osid.id.Id`	`antimatroidId`	the `Id` of the `Antimatroid` to remove
Errors	NOT_FOUND		`antimatroidId` not found
	NULL_ARGUMENT		`antimatroidId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canManageAntimatroidAliases
Description	Tests if this user can manage `Id` aliases for `Antimatroids.` 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 `Antimatroid` aliasing is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	aliasAntimatroid
Description	Adds an `Id` to an `Antimatroid` for the purpose of creating compatibility. The primary `Id` of the `Antimatroid` is determined by the provider. The new `Id` performs as an alias to the primary `Id.`
Parameters	`osid.id.Id`	`antimatroidId`	the `Id` of an `Antimatroid`
Parameters	`osid.id.Id`	`aliasId`	the alias `Id`
Errors	ALREADY_EXISTS		`aliasId` is already assigned
	NOT_FOUND		`antimatroidId` not found
	NULL_ARGUMENT		`antimatroidId` or `aliasId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.