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

Interface	osid.bidding.rules.AuctionConstrainerRuleApplicationSession
Implements	`osid.OsidSession`
Description	This session provides methods to apply `AuctionConstrainers` to `Auctions.` An `Auction` with multiple `AuctionConstrainers` means any positive rule evaluation across the result in an effective `Auction.`
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	canAssignAuctionConstrainers
Description	Tests if this user can alter auction constrainer/auction mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known mapping methods in this session will result in a `PERMISSION_DENIED.` This is intended as a hint to an application that may opt not to offer lookup operations to unauthorized users.
Return	`boolean`		`false` if mapping is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	assignAuctionConstrainerToAuction
Description	Adds an existing `AuctionConstrainer` to an `Auction.`
Parameters	`osid.id.Id`	`auctionConstrainerId`	the `Id` of the `AuctionConstrainer`
Parameters	`osid.id.Id`	`auctionId`	the `Id` of the `Auction`
Errors	ALREADY_EXISTS		`auctionConstrainerId` already applied to `auctionId`
	NOT_FOUND		`auctionConstrainerId` or `auctionId` not found
	NULL_ARGUMENT		`auctionConstrainerId` or `auctionId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	unassignAuctionConstrainerFromAuction
Description	Removes an `AuctionConstrainer` from an `Auction.`
Parameters	`osid.id.Id`	`auctionConstrainerId`	the `Id` of the `AuctionConstrainer`
Parameters	`osid.id.Id`	`auctionId`	the `Id` of the `Auction`
Errors	NOT_FOUND		`auctionConstrainerId` or `auctionId` not found or `auctionConstrainerId` already applied to `auctionId`
	NULL_ARGUMENT		`auctionConstrainerId` or `auctionId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canSequenceAuctionConstrainers
Description	Tests if this user can order `AuctionConstrainers.` A return of true does not guarantee successful authorization. A return of false indicates that it is known sequencing operations will result in a `PERMISSION_DENIED.` This is intended as a hint to an application that may opt not to offer sequencing operations to an unauthorized user.
Return	`boolean`		`false` if `AuctionConstrainer` ordering is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	moveAuctionConstrainerAhead
Description	Reorders auction constrainers for an auction by moving the specified auction constrainer in front of a reference auction constrainer.
Parameters	`osid.id.Id`	`auctionConstrainerId`	the `Id` of an `AuctionConstrainer`
	`osid.id.Id`	`auctionId`	the `Id` of an `Auction`
	`osid.id.Id`	`referenceId`	the reference auction constrainer `Id`
Errors	NOT_FOUND		`auctionConstrainerId, auctionId,` or `referenceId` not found or, `auctionConstrainerId` or `referenceId` not related to `auctionId`
	NULL_ARGUMENT		`auctionConstrainerId, auctionId,` or `referenceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	moveAuctionConstrainerBehind
Description	Reorders auction constrainers for an auction by moving the specified auction constrainer behind a reference auction constrainer.
Parameters	`osid.id.Id`	`auctionConstrainerId`	the `Id` of an `AuctionConstrainer`
	`osid.id.Id`	`auctionId`	the `Id` of an `Auction`
	`osid.id.Id`	`referenceId`	the reference auction constrainer `Id`
Errors	NOT_FOUND		`auctionConstrainerId, auctionId,` or `referenceId` not found or, `auctionConstrainerId` or `referenceId` not related to `auctionId`
	NULL_ARGUMENT		`auctionConstrainerId, auctionId,` or `referenceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	orderAuctionConstrainers
Description	Reorders a set of auction constrainers for an auction.
Parameters	`osid.id.Id[]`	`auctionConstrainerIds`	the `Ids` for a set of `AuctionConstrainers`
Parameters	`osid.id.Id`	`auctionId`	the `Id` of an `Auction`
Errors	NOT_FOUND		`auctionId` not found or, an `auctionConstrainerId` not related to `auctionId`
	NULL_ARGUMENT		`auctionConstrainerIds` or `auctionId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.