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

Interface	osid.bidding.rules.AuctionConstrainerRuleLookupSession
Implements	`osid.OsidSession`
Description	This session provides methods to retrieve `AuctionConstrainer` to `Auction` mappings. An `Auction` with multiple `AuctionConstrainers` means any positive rule evaluation across the result in an effective `Auction.` This lookup session defines several views: comparative view: elements may be silently omitted or re-ordered plenary view: provides a complete result set or is an error condition isolated auction house view: All methods in this session operate, retrieve and pertain auction constrainer defined explicitly in the current auction house federated auction house view: All methods in this session operate, retrieve and pertain to all auction constrainer defined in this auction house and any other auction constrainer implicitly available in this auction house through auction house inheritence.
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	canLookupAuctionConstrainerRules
Description	Tests if this user can perform lookups of auction constrainer/auction mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known lookup 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 looking up mappings is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	useComparativeAuctionConstrainerRuleView
Description	The returns from the lookup methods may omit or translate elements based on this session, such as authorization, and not result in an error. This view is used when greater interoperability is desired at the expense of precision.
Compliance	`mandatory`		This method is must be implemented.
Method	usePlenaryAuctionConstrainerRuleView
Description	A complete view of the `AuctionConstrainer` and `Auction` returns is desired. Methods will return what is requested or result in an error. This view is used when greater precision is desired at the expense of interoperability.
Compliance	`mandatory`		This method is must be implemented.
Method	useFederatedAuctionHouseView
Description	Federates the view for methods in this session. A federated view will include auction constrainer in auction houses which are children of this auction house in the auction house hierarchy.
Compliance	`mandatory`		This method is must be implemented.
Method	useIsolatedAuctionHouseView
Description	Isolates the view for methods in this session. An isolated view restricts lookups to this auction house only.
Compliance	`mandatory`		This method is must be implemented.
Method	getAuctionConstrainerIdsForAuction
Description	Gets the `AuctionConstrainer Id` associated with an `Auction.`
Parameters	`osid.id.Id`	`auctionId`	`Id` of the `Auction`
Return	`osid.id.IdList`		the auction constrainer `Ids`
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	getAuctionConstrainersForAuction
Description	Gets the `AuctionConstrainer` associated with an `Auction.`
Parameters	`osid.id.Id`	`auctionId`	`Id` of the `Auction`
Return	`osid.bidding.rules.AuctionConstrainerList`		the auction constrainers
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	getAuctionIdsForAuctionConstrainer
Description	Gets the `Auction` `Ids` mapped to an `AuctionConstrainer.`
Parameters	`osid.id.Id`	`auctionConstrainerId`	`Id` of an `AuctionConstrainer`
Return	`osid.id.IdList`		list of auction `Ids`
Errors	NOT_FOUND		`auctionConstrainerId` is not found
	NULL_ARGUMENT		`auctionConstrainerId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getAuctionsForAuctionConstrainer
Description	Gets the `Auctions` mapped to an `AuctionConstrainer.`
Parameters	`osid.id.Id`	`auctionConstrainerId`	`Id` of an `AuctionConstrainer`
Return	`osid.bidding.AuctionList`		list of auctions
Errors	NOT_FOUND		`auctionConstrainerId` is not found
	NULL_ARGUMENT		`auctionConstrainerId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.