OSID Logo
OSID Specifications
bidding rules package
Version 3.0.0
Release Candidate Preview
Interfaceosid.bidding.rules.AuctionConstrainerAdminSession
Implementsosid.OsidSession
Description

This session creates and removes auction constrainers. The data for create and update is provided via the AuctionConstrainerForm.

MethodgetAuctionHouseId
Description

Gets the AuctionHouse Id associated with this session.

Returnosid.id.Idthe AuctionHouse Id associated with this session
CompliancemandatoryThis method must be implemented.
MethodgetAuctionHouse
Description

Gets the AuctionHouse associated with this session.

Returnosid.bidding.AuctionHousethe auction house
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanCreateAuctionConstrainer
Description

Tests if this user can create auction constrainers. A return of true does not guarantee successful authorization. A return of false indicates that it is known creating an AuctionConstrainer 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.

Returnboolean false if AuctionConstrainer creation is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodcanCreateAuctionConstrainerWithRecordTypes
Description

BiddingRulesManager.getAuctionConstrainerRecordTypes() can be used to examine which records are supported, this method tests which record(s) are required for creating a specific AuctionConstrainer. Providing an empty array tests if an AuctionConstrainer can be created with no records.

Parametersosid.type.Type[]auctionConstrainerRecordTypesarray of auction constrainer record types
Returnboolean true if AuctionConstrainer creation using the specified record Types is supported, false otherwise
ErrorsNULL_ARGUMENT auctionConstrainerRecordTypes is null
CompliancemandatoryThis method must be implemented.
MethodgetAuctionConstrainerFormForCreate
Description

Gets the auction constrainer form for creating new auction constrainers. A new form should be requested for each create transaction.

Parametersosid.type.Type[]auctionConstrainerRecordTypesarray of auction constrainer record types
Returnosid.bidding.rules.AuctionConstrainerFormthe auction constrainer form
ErrorsNULL_ARGUMENT auctionConstrainerRecordTypes is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTEDunable to get form for requested record types
CompliancemandatoryThis method must be implemented.
MethodcreateAuctionConstrainer
Description

Creates a new AuctionConstrainer.

Parametersosid.bidding.rules.AuctionConstrainerFormauctionConstrainerFormthe form for this AuctionConstrainer
Returnosid.bidding.rules.AuctionConstrainerthe new AuctionConstrainer
ErrorsILLEGAL_STATE auctionConstrainerForm already used in a create transaction
INVALID_ARGUMENTone or more of the form elements is invalid
NULL_ARGUMENT auctionConstrainerForm is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED auctionConstrainerForm did not originate from getAuctionConstrainerFormForCreate()
CompliancemandatoryThis method must be implemented.
MethodcanUpdateAuctionConstrainers
Description

Tests if this user can update auction constrainers. A return of true does not guarantee successful authorization. A return of false indicates that it is known updating an AuctionConstrainer 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.

Returnboolean false if AuctionConstrainer modification is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodgetAuctionConstrainerFormForUpdate
Description

Gets the auction constrainer form for updating an existing auction constrainer. A new auction constrainer form should be requested for each update transaction.

Parametersosid.id.IdauctionConstrainerIdthe Id of the AuctionConstrainer
Returnosid.bidding.rules.AuctionConstrainerFormthe auction constrainer form
ErrorsNOT_FOUND auctionConstrainerId is not found
NULL_ARGUMENT auctionConstrainerId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodupdateAuctionConstrainer
Description

Updates an existing auction constrainer.

Parametersosid.bidding.rules.AuctionConstrainerFormauctionConstrainerFormthe form containing the elements to be updated
ErrorsILLEGAL_STATE auctionConstrainerForm already used in an update transaction
INVALID_ARGUMENTthe form contains an invalid value
NULL_ARGUMENT auctionConstrainerForm is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED auctionConstrainerForm did not originate from getAuctionConstrainerFormForUpdate()
CompliancemandatoryThis method must be implemented.
MethodcanDeleteAuctionConstrainers
Description

Tests if this user can delete auction constrainers. A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting an AuctionConstrainer 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.

Returnboolean false if AuctionConstrainer deletion is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethoddeleteAuctionConstrainer
Description

Deletes an AuctionConstrainer.

Parametersosid.id.IdauctionConstrainerIdthe Id of the AuctionConstrainer to remove
ErrorsNOT_FOUND auctionConstrainerId not found
NULL_ARGUMENT auctionConstrainerId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanManageAuctionConstrainerAliases
Description

Tests if this user can manage Id aliases for auction constrainers. 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.

Returnboolean false if AuctionConstrainer aliasing is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodaliasAuctionConstrainer
Description

Adds an Id to an AuctionConstrainer for the purpose of creating compatibility. The primary Id of the AuctionConstrainer 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. it is reassigned to the given auction constrainer Id.

Parametersosid.id.IdauctionConstrainerIdthe Id of an AuctionConstrainer
osid.id.IdaliasIdthe alias Id
ErrorsALREADY_EXISTS aliasId is already assigned
NOT_FOUND auctionConstrainerId not found
NULL_ARGUMENT auctionConstrainerId or aliasId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.