OSID - osid.bidding.AuctionAdminSession Service Interface Definition

Interface	osid.bidding.AuctionAdminSession
Implements	`osid.OsidSession`
Description	This session creates, updates, and deletes `Auctions.` 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 `Auction,` an `AuctionForm` is requested using `getAuctionFormForCreate()` specifying the desired record `Types` or none if no record `Types` are needed. The returned `AuctionForm` 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 `AuctionForm` is submiited to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each `AuctionForm` corresponds to an attempted transaction. For updates, `AuctionForms` are requested to the `Auction` `Id` that is to be updated using `getAuctionFormForUpdate().` Similarly, the `AuctionForm` has metadata about the data that can be updated and it can perform validation before submitting the update. The `AuctionForm` can only be used once for a successful update and cannot be reused. The delete operations delete `Auctions.` To unmap an `Auction` from the current `AuctionHouse,` the `AuctionAuctionHouseAssignmentSession` should be used. These delete operations attempt to remove the `Auction` itself thus removing it from all known `AuctionHouse` catalogs. This session includes an `Id` aliasing mechanism to assign an external `Id` to an internally assigned Id.
Method	getAuctionHouseId
Description	Gets the `AuctionHouse` `Id` associated with this session.
Return	`osid.id.Id`		the `AuctionHouse Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getAuctionHouse
Description	Gets the `AuctionHouse` associated with this session.
Return	`osid.bidding.AuctionHouse`		the auction house
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canCreateAuctions
Description	Tests if this user can create `Auctions.` A return of true does not guarantee successful authorization. A return of false indicates that it is known creating an `Auction` 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.
Return	`boolean`		`false` if `Auction` creation is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	canCreateAuctionWithRecordTypes
Description	Tests if this user can create a single `Auction` using the desired record types. While `BiddingManager.getAuctionRecordTypes()` can be used to examine which records are supported, this method tests which record(s) are required for creating a specific `Auction.` Providing an empty array tests if an `Auction` can be created with no records.
Parameters	`osid.type.Type[]`	`auctionRecordTypes`	array of auction record types
Return	`boolean`		`true` if `Auction` creation using the specified record `Types` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`auctionRecordTypes` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getAuctionFormForCreate
Description	Gets the auction form for creating new auctions. A new form should be requested for each create transaction.
Parameters	`osid.type.Type[]`	`auctionRecordTypes`	array of auction record types
Return	`osid.bidding.AuctionForm`		the auction form
Errors	NULL_ARGUMENT		`auctionRecordTypes` 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	createAuction
Description	Creates a new `Auction.`
Parameters	`osid.bidding.AuctionForm`	`auctionForm`	the form for this `Auction`
Return	`osid.bidding.Auction`		the new `Auction`
Errors	ILLEGAL_STATE		`auctionForm` already used in a create transaction
	INVALID_ARGUMENT		one or more of the form elements is invalid
	NULL_ARGUMENT		`auctionForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`auctionForm` did not originate from `getAuctionFormForCreate()`
Compliance	`mandatory`		This method must be implemented.
Method	canUpdateAuctions
Description	Tests if this user can update `Auctions.` A return of true does not guarantee successful authorization. A return of false indicates that it is known updating an `Auction` 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.
Return	`boolean`		`false` if `Auction` modification is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getAuctionFormForUpdate
Description	Gets the auction form for updating an existing auction. A new auction form should be requested for each update transaction.
Parameters	`osid.id.Id`	`auctionId`	the `Id` of the `Auction`
Return	`osid.bidding.AuctionForm`		the auction form
Errors	NOT_FOUND		`auctionId` is not found
	NULL_ARGUMENT		`auctionId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	updateAuction
Description	Updates an existing auction.
Parameters	`osid.bidding.AuctionForm`	`auctionForm`	the form containing the elements to be updated
Errors	ILLEGAL_STATE		`auctionForm` already used in an update transaction
	INVALID_ARGUMENT		the form contains an invalid value
	NULL_ARGUMENT		`auctionForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`auctionForm` did not originate from `getAuctionFormForUpdate()`
Compliance	`mandatory`		This method must be implemented.
Method	canDeleteAuctions
Description	Tests if this user can delete `Auctions.` A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting an `Auction` 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.
Return	`boolean`		`false` if `Auction` deletion is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	deleteAuction
Description	Deletes an `Auction.`
Parameters	`osid.id.Id`	`auctionId`	the `Id` of the `Auction` to remove
Errors	NOT_FOUND		`auctionId` not found
	NULL_ARGUMENT		`auctionId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canManageAuctionAliases
Description	Tests if this user can manage `Id` aliases for `Auctions.` 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 `Auction` aliasing is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	aliasAuction
Description	Adds an `Id` to an `Auction` for the purpose of creating compatibility. The primary `Id` of the `Auction` is determined by the provider. The new `Id` performs as an alias to the primary `Id.` If the alias is a pointer to another auction, it is reassigned to the given auction `Id.`
Parameters	`osid.id.Id`	`auctionId`	the `Id` of an `Auction`
Parameters	`osid.id.Id`	`aliasId`	the alias `Id`
Errors	ALREADY_EXISTS		`aliasId` is already assigned
	NOT_FOUND		`auctionId` not found
	NULL_ARGUMENT		`auctionId` or `aliasId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.