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

Interface	osid.bidding.rules.AuctionProcessorEnablerAdminSession
Implements	`osid.OsidSession`
Used By	`osid.bidding.rules.BiddingRulesManager`
Used By	`osid.bidding.rules.BiddingRulesProxyManager`
Description	This session creates and removes auction processor enablers. The data for create and update is provided via the `AuctionProcessorEnablerForm`.
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	canCreateAuctionProcessorEnabler
Description	Tests if this user can create auction processor enablers. A return of true does not guarantee successful authorization. A return of false indicates that it is known creating an `AuctionProcessorEnabler` 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 `AuctionProcessorEnabler` creation is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	canCreateAuctionProcessorEnablerWithRecordTypes
Description	Tests if this user can create a single `AuctionProcessorEnabler` using the desired record types. While `BiddingRulesManager.getAuctionProcessorEnablerRecordTypes()` can be used to examine which records are supported, this method tests which record(s) are required for creating a specific `AuctionProcessorEnabler`. Providing an empty array tests if an `AuctionProcessorEnabler` can be created with no records.
Parameters	`osid.type.Type[]`	`auctionProcessorEnablerRecordTypes`	array of auction processor enabler record types
Return	`boolean`		`true` if `AuctionProcessorEnabler` creation using the specified record `Types` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`auctionProcessorEnablerRecordTypes` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getAuctionProcessorEnablerFormForCreate
Description	Gets the auction processor enabler form for creating new auction processor enablers. A new form should be requested for each create transaction.
Parameters	`osid.type.Type[]`	`auctionProcessorEnablerRecordTypes`	array of auction processor enabler record types
Return	`osid.bidding.rules.AuctionProcessorEnablerForm`		the auction processor enabler form
Errors	NULL_ARGUMENT		`auctionProcessorEnablerRecordTypes` 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	createAuctionProcessorEnabler
Description	Creates a new `AuctionProcessorEnabler`.
Parameters	`osid.bidding.rules.AuctionProcessorEnablerForm`	`auctionProcessorEnablerForm`	the form for this `AuctionProcessorEnabler`
Return	`osid.bidding.rules.AuctionProcessorEnabler`		the new `AuctionProcessorEnabler`
Errors	ILLEGAL_STATE		`auctionProcessorEnablerForm` already used in a create transaction
	INVALID_ARGUMENT		one or more of the form elements is invalid
	NULL_ARGUMENT		`auctionProcessorEnablerForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`auctionProcessorEnablerForm did not originate from getAuctionProcessorEnablerFormForCreate()`
Compliance	`mandatory`		This method must be implemented.
Method	canUpdateAuctionProcessorEnablers
Description	Tests if this user can update auction processor enablers. A return of true does not guarantee successful authorization. A return of false indicates that it is known updating an `AuctionProcessorEnabler` 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 `AuctionProcessorEnabler` modification is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getAuctionProcessorEnablerFormForUpdate
Description	Gets the auction processor enabler form for updating an existing auction processor enabler. A new auction processor enabler form should be requested for each update transaction.
Parameters	`osid.id.Id`	`auctionProcessorEnablerId`	the `Id` of the `AuctionProcessorEnabler`
Return	`osid.bidding.rules.AuctionProcessorEnablerForm`		the auction processor enabler form
Errors	NOT_FOUND		`auctionProcessorEnablerId` is not found
	NULL_ARGUMENT		`auctionProcessorEnablerId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	updateAuctionProcessorEnabler
Description	Updates an existing auction processor enabler.
Parameters	`osid.bidding.rules.AuctionProcessorEnablerForm`	`auctionProcessorEnablerForm`	the form containing the elements to be updated
Errors	ILLEGAL_STATE		`auctionProcessorEnablerForm` already used in an update transaction
	INVALID_ARGUMENT		the form contains an invalid value
	NULL_ARGUMENT		`auctionProcessorEnablerForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`auctionProcessorEnablerForm did not originate from getAuctionProcessorEnablerFormForUpdate()`
Compliance	`mandatory`		This method must be implemented.
Method	canDeleteAuctionProcessorEnablers
Description	Tests if this user can delete auction processor enablers. A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting an `AuctionProcessorEnabler` 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 `AuctionProcessorEnabler` deletion is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	deleteAuctionProcessorEnabler
Description	Deletes an `AuctionProcessorEnabler`.
Parameters	`osid.id.Id`	`auctionProcessorEnablerId`	the `Id` of the `AuctionProcessorEnabler` to remove
Errors	NOT_FOUND		`auctionProcessorEnablerId` not found
	NULL_ARGUMENT		`auctionProcessorEnablerId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canManageAuctionProcessorEnablerAliases
Description	Tests if this user can manage `Id` aliases for auction processor enablers. 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 `AuctionProcessorEnabler` aliasing is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	aliasAuctionProcessorEnabler
Description	Adds an `Id` to an `AuctionProcessorEnabler` for the purpose of creating compatibility. The primary `Id` of the `AuctionProcessorEnabler` 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 processor enabler. it is reassigned to the given auction processor enabler `Id`.
Parameters	`osid.id.Id`	`auctionProcessorEnablerId`	the `Id` of an `AuctionProcessorEnabler`
Parameters	`osid.id.Id`	`aliasId`	the alias `Id`
Errors	ALREADY_EXISTS		`aliasId` is already assigned
	NOT_FOUND		`auctionProcessorEnablerId` not found
	NULL_ARGUMENT		`auctionProcessorEnablerId` or `aliasId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.