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

This session creates and removes auction constrainer enablers. The data for create and update is provided via the AuctionConstrainerEnablerForm.

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.
MethodcanCreateAuctionConstrainerEnabler
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.

Returnboolean false if AuctionConstrainerEnabler creation is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodcanCreateAuctionConstrainerEnablerWithRecordTypes
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.

Parametersosid.type.Type[]auctionConstrainerEnablerRecordTypesarray of auction constrainer enabler record types
Returnboolean true if AuctionConstrainerEnabler creation using the specified record Types is supported, false otherwise
ErrorsNULL_ARGUMENT auctionConstrainerEnablerRecordTypes is null
CompliancemandatoryThis method must be implemented.
MethodgetAuctionConstrainerEnablerFormForCreate
Description

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

Parametersosid.type.Type[]auctionConstrainerEnablerRecordTypesarray of auction constrainer enabler record types
Returnosid.bidding.rules.AuctionConstrainerEnablerFormthe auction constrainer enabler form
ErrorsNULL_ARGUMENT auctionConstrainerEnablerRecordTypes is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTEDunable to get form for requested record types
CompliancemandatoryThis method must be implemented.
MethodcreateAuctionConstrainerEnabler
Description

Creates a new AuctionConstrainerEnabler.

Parametersosid.bidding.rules.AuctionConstrainerEnablerFormauctionConstrainerEnablerFormthe form for this AuctionConstrainerEnabler
Returnosid.bidding.rules.AuctionConstrainerEnablerthe new AuctionConstrainerEnabler
ErrorsILLEGAL_STATE auctionConstrainerEnablerForm already used in a create transaction
INVALID_ARGUMENTone or more of the form elements is invalid
NULL_ARGUMENT auctionConstrainerEnablerForm is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED auctionConstrainerEnablerForm did not originate from getAuctionConstrainerEnablerFormForCreate()
CompliancemandatoryThis method must be implemented.
MethodcanUpdateAuctionConstrainerEnablers
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.

Returnboolean false if AuctionConstrainerEnabler modification is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodgetAuctionConstrainerEnablerFormForUpdate
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.

Parametersosid.id.IdauctionConstrainerEnablerIdthe Id of the AuctionConstrainerEnabler
Returnosid.bidding.rules.AuctionConstrainerEnablerFormthe auction constrainer enabler form
ErrorsNOT_FOUND auctionConstrainerEnablerId is not found
NULL_ARGUMENT auctionConstrainerEnablerId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodupdateAuctionConstrainerEnabler
Description

Updates an existing auction constrainer enabler.

Parametersosid.bidding.rules.AuctionConstrainerEnablerFormauctionConstrainerEnablerFormthe form containing the elements to be updated
ErrorsILLEGAL_STATE auctionConstrainerEnablerForm already used in an update transaction
INVALID_ARGUMENTthe form contains an invalid value
NULL_ARGUMENT auctionConstrainerEnablerForm is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED auctionConstrainerEnablerForm did not originate from getAuctionConstrainerEnablerFormForUpdate()
CompliancemandatoryThis method must be implemented.
MethodcanDeleteAuctionConstrainerEnablers
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.

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

Deletes an AuctionConstrainerEnabler.

Parametersosid.id.IdauctionConstrainerEnablerIdthe Id of the AuctionConstrainerEnabler to remove
ErrorsNOT_FOUND auctionConstrainerEnablerId not found
NULL_ARGUMENT auctionConstrainerEnablerId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanManageAuctionConstrainerEnablerAliases
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.

Returnboolean false if AuctionConstrainerEnabler aliasing is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodaliasAuctionConstrainerEnabler
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.

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