OSID - osid.bidding.rules.BidEnablerAdminSession Service Interface Definition

Interface	osid.bidding.rules.BidEnablerAdminSession
Implements	`osid.OsidSession`
Used By	`osid.bidding.rules.BiddingRulesManager`
Used By	`osid.bidding.rules.BiddingRulesProxyManager`
Description	This session creates, updates, and deletes `BidEnablers` . 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 `BidEnabler` , a `BidEnablerForm` is requested using `getBidEnablerFormForCreate()` specifying the desired record `Types` or none if no record `Types` are needed. The returned `BidEnablerForm` 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 `BidEnablerForm` is submiited to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each `BidEnablerForm` corresponds to an attempted transaction. For updates, `BidEnablerForms` are requested to the `BidEnabler` `Id` that is to be updated using `getBidEnablerFormForUpdate()` . Similarly, the `BidEnablerForm` has metadata about the data that can be updated and it can perform validation before submitting the update. The `BidEnablerForm` can only be used once for a successful update and cannot be reused. The delete operations delete `BidEnablers` . To unmap a `BidEnabler` from the current `AuctionHouse` , the `BidEnablerAuctionHouseAssignmentSession` should be used. These delete operations attempt to remove the `BidEnabler` 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	canCreateBidEnablers
Description	Tests if this user can create `BidEnablers` . A return of true does not guarantee successful authorization. A return of false indicates that it is known creating a `BidEnabler` will result in a `PERMISSION_DENIED. T` his is intended as a hint to an application that may opt not to offer create operations to an unauthorized user.
Return	`boolean`		`false` if `BidEnabler` creation is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	canCreateBidEnablerWithRecordTypes
Description	Tests if this user can create a single `BidEnabler` using the desired record types. While `BiddingRulesManager.getBidEnablerRecordTypes()` can be used to examine which records are supported, this method tests which record(s) are required for creating a specific `BidEnabler` . Providing an empty array tests if a `BidEnabler can be crea` ted with no records.
Parameters	`osid.type.Type[]`	`bidEnablerRecordTypes`	array of bid enabler record types
Return	`boolean`		`true` if `BidEnabler` creation using the specified record `Types` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`bidEnablerRecordTypes` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getBidEnablerFormForCreate
Description	Gets the bid enabler form for creating new bid enablers. A new form should be requested for each create transaction.
Parameters	`osid.type.Type[]`	`bidEnablerRecordTypes`	array of bid enabler record types
Return	`osid.bidding.rules.BidEnablerForm`		the bid enabler form
Errors	NULL_ARGUMENT		`bidEnablerRecordTypes` 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	createBidEnabler
Description	Creates a new `BidEnabler` .
Parameters	`osid.bidding.rules.BidEnablerForm`	`bidEnablerForm`	the form for this `BidEnabler`
Return	`osid.bidding.rules.BidEnabler`		the new `BidEnabler`
Errors	ILLEGAL_STATE		`bidEnablerForm` already used in a create transaction
	INVALID_ARGUMENT		one or more of the form elements is invalid
	NULL_ARGUMENT		`bidEnablerForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`bidEnablerForm` did not originate from `getBidEnablerFormForCreate()`
Compliance	`mandatory`		This method must be implemented.
Method	canUpdateBidEnablers
Description	Tests if this user can update `BidEnablers` . A return of true does not guarantee successful authorization. A return of false indicates that it is known updating a `BidEnabler` will result in a `PERMISSION_DENIED. T` his is intended as a hint to an application that may opt not to offer update operations to an unauthorized user.
Return	`boolean`		`false` if `BidEnabler` modification is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getBidEnablerFormForUpdate
Description	Gets the bid enabler form for updating an existing bid enabler. A new bid enabler form should be requested for each update transaction.
Parameters	`osid.id.Id`	`bidEnablerId`	the `Id` of the `BidEnabler`
Return	`osid.bidding.rules.BidEnablerForm`		the bid enabler form
Errors	NOT_FOUND		`bidEnablerId` is not found
	NULL_ARGUMENT		`bidEnablerId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	updateBidEnabler
Description	Updates an existing bid enabler.
Parameters	`osid.bidding.rules.BidEnablerForm`	`bidEnablerForm`	the form containing the elements to be updated
Errors	ILLEGAL_STATE		`bidEnablerForm` already used in an update transaction
	INVALID_ARGUMENT		the form contains an invalid value
	NULL_ARGUMENT		`bidEnablerForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`bidEnablerForm` did not originate from `getBidEnablerFormForUpdate()`
Compliance	`mandatory`		This method must be implemented.
Method	canDeleteBidEnablers
Description	Tests if this user can delete `BidEnablers` . A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting a `BidEnabler` will result in a `PERMISSION_DENIED. T` his is intended as a hint to an application that may opt not to offer delete operations to an unauthorized user.
Return	`boolean`		`false` if `BidEnabler` deletion is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	deleteBidEnabler
Description	Deletes a `BidEnabler` .
Parameters	`osid.id.Id`	`bidEnablerId`	the `Id` of the `BidEnabler` to remove
Errors	NOT_FOUND		`bidEnablerId` not found
	NULL_ARGUMENT		`bidEnablerId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canManageBidEnablerAliases
Description	Tests if this user can manage `Id` aliases for `BidEnablers` 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 `BidEnabler` aliasing is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	aliasBidEnabler
Description	Adds an `Id` to a `BidEnabler` for the purpose of creating compatibility. The primary `Id` of the `BidEnabler` is determined by the provider. The new `Id` performs as an alias to the primary `Id` . If the alias is a pointer to another bid enabler, it is reassigned to the given bid enabler `Id` .
Parameters	`osid.id.Id`	`bidEnablerId`	the `Id` of a `BidEnabler`
Parameters	`osid.id.Id`	`aliasId`	the alias `Id`
Errors	ALREADY_EXISTS		`aliasId` is already assigned
	NOT_FOUND		`bidEnablerId` not found
	NULL_ARGUMENT		`bidEnablerId` or `aliasId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.