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

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