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

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

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.
MethodcanCreateAuctionProcessor
Description

Tests if this user can create auction processors. A return of true does not guarantee successful authorization. A return of false indicates that it is known creating an AuctionProcessor 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 AuctionProcessor creation is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodcanCreateAuctionProcessorWithRecordTypes
Description

Tests if this user can create a single AuctionProcessor using the desired record types. While BiddingRulesManager.getAuctionProcessorRecordTypes() can be used to examine which records are supported, this method tests which record(s) are required for creating a specific AuctionProcessor. Providing an empty array tests if an AuctionProcessor can be created with no records.

Parametersosid.type.Type[]auctionProcessorRecordTypesarray of auction processor record types
Returnboolean true if AuctionProcessor creation using the specified record Types is supported, false otherwise
ErrorsNULL_ARGUMENT auctionProcessorRecordTypes is null
CompliancemandatoryThis method must be implemented.
MethodgetAuctionProcessorFormForCreate
Description

Gets the auction processor form for creating new auction processors. A new form should be requested for each create transaction.

Parametersosid.type.Type[]auctionProcessorRecordTypesarray of auction processor record types
Returnosid.bidding.rules.AuctionProcessorFormthe auction processor form
ErrorsNULL_ARGUMENT auctionProcessorRecordTypes is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTEDunable to get form for requested record types
CompliancemandatoryThis method must be implemented.
MethodcreateAuctionProcessor
Description

Creates a new AuctionProcessor.

Parametersosid.bidding.rules.AuctionProcessorFormauctionProcessorFormthe form for this AuctionProcessor
Returnosid.bidding.rules.AuctionProcessorthe new AuctionProcessor
ErrorsILLEGAL_STATE auctionProcessorForm already used in a create transaction
INVALID_ARGUMENTone or more of the form elements is invalid
NULL_ARGUMENT auctionProcessorForm is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED auctionProcessorForm did not originate from getAuctionProcessorFormForCreate()
CompliancemandatoryThis method must be implemented.
MethodcanUpdateAuctionProcessors
Description

Tests if this user can update auction processors. A return of true does not guarantee successful authorization. A return of false indicates that it is known updating an AuctionProcessor 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 AuctionProcessor modification is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodgetAuctionProcessorFormForUpdate
Description

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

Parametersosid.id.IdauctionProcessorIdthe Id of the AuctionProcessor
Returnosid.bidding.rules.AuctionProcessorFormthe auction processor form
ErrorsNOT_FOUND auctionProcessorId is not found
NULL_ARGUMENT auctionProcessorId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodupdateAuctionProcessor
Description

Updates an existing auction processor.

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

Tests if this user can delete auction processors. A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting an AuctionProcessor 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 AuctionProcessor deletion is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethoddeleteAuctionProcessor
Description

Deletes an AuctionProcessor.

Parametersosid.id.IdauctionProcessorIdthe Id of the AuctionProcessor to remove
ErrorsNOT_FOUND auctionProcessorId not found
NULL_ARGUMENT auctionProcessorId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanManageAuctionProcessorAliases
Description

Tests if this user can manage Id aliases for auction processors. 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 AuctionProcessor aliasing is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodaliasAuctionProcessor
Description

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

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