OSID - osid.bidding.AuctionHouseAdminSession Service Interface Definition

Interface	osid.bidding.AuctionHouseAdminSession
Implements	`osid.OsidSession`
Implemented By	`osid.bidding.batch.AuctionHouseBatchAdminSession`
Used By	`osid.bidding.BiddingManager`
Used By	`osid.bidding.BiddingProxyManager`
Description	This session creates, updates, and deletes `AuctionHouses`. 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 `AuctionHouse`, an `AuctionHouseForm` is requested using `getAuctionHouseFormForCreate()` specifying the desired record `Types` or none if no record `Types` are needed. The returned `AuctionHouseForm` 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 `AuctionHouseForm` is submiited to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each `AuctionHouseForm` corresponds to an attempted transaction. For updates, `AuctionHouseForms` are requested to the `AuctionHouse` `Id` that is to be updated using `getAuctionHouseFormForUpdate()`. Similarly, the `AuctionHouseForm` has metadata about the data that can be updated and it can perform validation before submitting the update. The `AuctionHouseForm` can only be used once for a successful update and cannot be reused. The delete operations delete `AuctionHouses`. This session includes an `Id` aliasing mechanism to assign an external `Id` to an internally assigned Id.
Method	canCreateAuctionHouses
Description	Tests if this user can create `AuctionHouses`. A return of true does not guarantee successful authorization. A return of false indicates that it is known creating an `AuctionHouse`. 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 `AuctionHouse` creation is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	canCreateAuctionHouseWithRecordTypes
Description	Tests if this user can create a single `AuctionHouse` using the desired record types. While `BiddingManager.getAuctionHouseRecordTypes()` can be used to examine which records are supported, this method tests which record(s) are required for creating a specific `AuctionHouse`. Providing an empty array tests if an `AuctionHouse` can be created with no records.
Parameters	`osid.type.Type[]`	`auctionHouseRecordTypes`	array of auction house record types
Return	`boolean`		`true` if `AuctionHouse` creation using the specified record `Types` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`auctionHouseRecordTypes` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getAuctionHouseFormForCreate
Description	Gets the auction house form for creating new auction houses. A new form should be requested for each create transaction.
Parameters	`osid.type.Type[]`	`auctionHouseRecordTypes`	array of auction house record types
Return	`osid.bidding.AuctionHouseForm`		the auction house form
Errors	NULL_ARGUMENT		`auctionHouseRecordTypes` 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	createAuctionHouse
Description	Creates a new `AuctionHouse`.
Parameters	`osid.bidding.AuctionHouseForm`	`auctionHouseForm`	the form for this `AuctionHouse`
Return	`osid.bidding.AuctionHouse`		the new `AuctionHouse`
Errors	ILLEGAL_STATE		`auctionHouseForm` already used in a create transaction
	INVALID_ARGUMENT		one or more of the form elements is invalid
	NULL_ARGUMENT		`auctionHouseForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`auctionHouseForm` did not originate from `getAuctionHouseFormForCreate()`
Compliance	`mandatory`		This method must be implemented.
Method	canUpdateAuctionHouses
Description	Tests if this user can update `Auction Houses`. A return of true does not guarantee successful authorization. A return of false indicates that it is known updating an `AuctionHouse` 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 `AuctionHouse` modification is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getAuctionHouseFormForUpdate
Description	Gets the auction house form for updating an existing auction house. A new auction house form should be requested for each update transaction.
Parameters	`osid.id.Id`	`auctionHouseId`	the `Id` of the `AuctionHouse`
Return	`osid.bidding.AuctionHouseForm`		the auction house form
Errors	NOT_FOUND		`auctionHouseId` is not found
	NULL_ARGUMENT		`auctionHouseId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	updateAuctionHouse
Description	Updates an existing auction house
Parameters	`osid.bidding.AuctionHouseForm`	`auctionHouseForm`	the form containing the elements to be updated
Errors	ILLEGAL_STATE		`auctionHouseForm` already used in an update transaction
	INVALID_ARGUMENT		the form contains an invalid value
	NULL_ARGUMENT		`auctionHouseForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`auctionHouseForm` did not originate from `getAuctionHouseFormForUpdate()`
Compliance	`mandatory`		This method must be implemented.
Method	canDeleteAuctionHouses
Description	Tests if this user can delete `AuctionHouses`. A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting an `AuctionHouse` 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 `AuctionHouse` deletion is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	deleteAuctionHouse
Description	Deletes an `AuctionHouse`.
Parameters	`osid.id.Id`	`auctionHouseId`	the `Id` of the `AuctionHouse` to remove
Errors	NOT_FOUND		`auctionHouseId` not found
	NULL_ARGUMENT		`auctionHouseId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canManageAuctionHouseAliases
Description	Tests if this user can manage `Id` aliases for `Auction Houses`. 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 `AuctionHouse` aliasing is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	aliasAuctionHouse
Description	Adds an `Id` to an `AuctionHouse` for the purpose of creating compatibility. The primary `Id` of the `AuctionHouse` is determined by the provider. The new `Id` performs as an alias to the primary `Id`.
Parameters	`osid.id.Id`	`auctionHouseId`	the `Id` of an `AuctionHouse`
Parameters	`osid.id.Id`	`aliasId`	the alias `Id`
Errors	ALREADY_EXISTS		`aliasId` is already assigned
	NOT_FOUND		`auctionHouseId` not found
	NULL_ARGUMENT		`auctionHouseId` or `aliasId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.