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

This session provides methods for retrieving AuctionConstrainerEnablers.

This session defines views that offer differing behaviors when retrieving multiple objects.

  • comparative view: elements may be silently omitted or re-ordered
  • plenary view: provides a complete set or is an error condition
  • isolated auction house view: All auction constrainer enabler methods in this session operate, retrieve and pertain to auction constrainer enablers defined explicitly in the current auction house. Using an isolated view is useful for managing AuctionConstrainerEnablers with the AuctionConstrainerEnablerAdminSession.
  • federated auction house view: All auction constrainer enabler methods in this session operate, retrieve and pertain to all auction constrainer enablers defined in this auction house and any other auction constrainer enablers implicitly available in this auction house through auction house inheritence.
  • activee auction constrainer enabler view: All auction constrainer enabler lookup methods return active auction constrainer enablers.
  • any status auction constrainer enabler view: auction constrainer enablers of any active or inactive status are returned from methods.

Generally, the comparative view should be used for most applications as it permits operation even if there is data that cannot be accessed. The methods useFederatedDistributorView() and useIsolatedDistributorView() behave as a radio group and one should be selected before invoking the methods in this session.

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

Tests if this user can perform AuctionConstrainerEnablers lookups. A return of true does not guarantee successful authorization. A return of false indicates that it is known all 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.

Returnboolean false if lookup methods are not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethoduseComparativeAuctionConstrainerEnablerView
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.

CompliancemandatoryThis method is must be implemented.
MethodusePlenaryAuctionConstrainerEnablerView
Description

A complete view of the AuctionConstrainerEnabler 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.

CompliancemandatoryThis method is must be implemented.
MethoduseFederatedAuctionHouseView
Description

Federates the view for methods in this session. A federated view will include auction constrainer enablers in auction houses which are children of this auction house in the auction house hierarchy.

CompliancemandatoryThis method is must be implemented.
MethoduseIsolatedAuctionHouseView
Description

Isolates the view for methods in this session. An isolated view restricts lookups to this auction house only.

CompliancemandatoryThis method is must be implemented.
MethoduseActiveAuctionConstrainerEnablerView
Description

Only active auction constrainer enablers are returned by methods in this session.

CompliancemandatoryThis method is must be implemented.
MethoduseAnyStatusAuctionConstrainerEnablerView
Description

All active and inactive auction constrainer enablers are returned by methods in this session.

CompliancemandatoryThis method is must be implemented.
MethodgetAuctionConstrainerEnabler
Description

Gets the AuctionConstrainerEnabler specified by its Id.

In plenary mode, the exact Id is found or a NOT_FOUND results. Otherwise, the returned AuctionConstrainerEnabler may have a different Id than requested, such as the case where a duplicate Id was assigned to an AuctionConstrainerEnabler and retained for compatibility.

In active mode, auction constrainer enablers are returned that are currently active. In any status mode, active and inactive auction constrainer enablers are returned.

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

Gets an AuctionConstrainerEnablerList corresponding to the given IdList.

In plenary mode, the returned list contains all of the auction constrainer enablers specified in the Id list, in the order of the list, including duplicates, or an error results if an Id in the supplied list is not found or inaccessible. Otherwise, inaccessible AuctionConstrainerEnablers may be omitted from the list and may present the elements in any order including returning a unique set.

In active mode, auction constrainer enablers are returned that are currently active. In any status mode, active and inactive auction constrainer enablers are returned.

Parametersosid.id.IdListauctionConstrainerEnablerIdsthe list of Ids to retrieve
Returnosid.bidding.rules.AuctionConstrainerEnablerListthe returned AuctionConstrainerEnabler list
ErrorsNOT_FOUNDan Id was not found
NULL_ARGUMENT auctionConstrainerEnablerIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetAuctionConstrainerEnablersByGenusType
Description

Gets an AuctionConstrainerEnablerList corresponding to the given auction constrainer enabler genus Type which does not include auction constrainer enablers of genus types derived from the specified Type.

In plenary mode, the returned list contains all known auction constrainer enablers or an error results. Otherwise, the returned list may contain only those auction constrainer enablers that are accessible through this session.

In active mode, auction constrainer enablers are returned that are currently active. In any status mode, active and inactive auction constrainer enablers are returned.

Parametersosid.type.TypeauctionConstrainerEnablerGenusTypean auction constrainer enabler genus type
Returnosid.bidding.rules.AuctionConstrainerEnablerListthe returned AuctionConstrainerEnabler list
ErrorsNULL_ARGUMENT auctionConstrainerEnablerGenusType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetAuctionConstrainerEnablersByParentGenusType
Description

Gets an AuctionConstrainerEnablerList corresponding to the given auction constrainer enabler genus Type and include any additional auction constrainer enablers with genus types derived from the specified Type.

In plenary mode, the returned list contains all known auction constrainer enablers or an error results. Otherwise, the returned list may contain only those auction constrainer enablers that are accessible through this session.

In active mode, auction constrainer enablers are returned that are currently active. In any status mode, active and inactive auction constrainer enablers are returned.

Parametersosid.type.TypeauctionConstrainerEnablerGenusTypean auction constrainer enabler genus type
Returnosid.bidding.rules.AuctionConstrainerEnablerListthe returned AuctionConstrainerEnabler list
ErrorsNULL_ARGUMENT auctionConstrainerEnablerGenusType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetAuctionConstrainerEnablersByRecordType
Description

Gets an AuctionConstrainerEnablerList containing the given auction constrainer enabler record Type.

In plenary mode, the returned list contains all known auction constrainer enablers or an error results. Otherwise, the returned list may contain only those auction constrainer enablers that are accessible through this session.

In active mode, auction constrainer enablers are returned that are currently active. In any status mode, active and inactive auction constrainer enablers are returned.

Parametersosid.type.TypeauctionConstrainerEnablerRecordTypean auction constrainer enabler record type
Returnosid.bidding.rules.AuctionConstrainerEnablerListthe returned AuctionConstrainerEnabler list
ErrorsNULL_ARGUMENT auctionConstrainerEnablerRecordType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetAuctionConstrainerEnablersOnDate
Description

Gets an AuctionConstrainerEnablerList that are effective for the entire given date range but not confined to the date range.

In plenary mode, the returned list contains all known auction constrainer enablers or an error results. Otherwise, the returned list may contain only those auction constrainer enablers that are accessible through this session.

In active mode, auction constrainer enablers are returned that are currently active in addition to being effective during the given date range. In any status mode, active and inactive auction constrainer enablers are returned.

Parametersosid.calendaring.DateTimefroma start date
osid.calendaring.DateTimetoan end date
Returnosid.bidding.rules.AuctionConstrainerEnablerListthe returned AuctionConstrainerEnabler list
ErrorsINVALID_ARGUMENT from is greater than to
NULL_ARGUMENT from or to is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetAuctionConstrainerEnablersOnDateWithAgent
Description

Gets an AuctionConstrainerEnablerList that are effective for the entire given date range but not confined to the date range and evaluated against the given agent.

In plenary mode, the returned list contains all known auction constrainer enablers or an error results. Otherwise, the returned list may contain only those auction constrainer enablers that are accessible through this session.

In active mode, auction constrainer enablers are returned that are currently active in addition to being effective during the given date range. In any status mode, active and inactive auction constrainer enablers are returned.

Parametersosid.id.IdagentIdan agent Id
osid.calendaring.DateTimefroma start date
osid.calendaring.DateTimetoan end date
Returnosid.bidding.rules.AuctionConstrainerEnablerListthe returned AuctionConstrainerEnabler list
ErrorsINVALID_ARGUMENT from is greater than to
NULL_ARGUMENT agentId, from, or to is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetAuctionConstrainerEnablers
Description

Gets all AuctionConstrainerEnablers.

In plenary mode, the returned list contains all known auction constrainer enablers or an error results. Otherwise, the returned list may contain only those auction constrainer enablers that are accessible through this session.

In active mode, auction constrainer enablers are returned that are currently active. In any status mode, active and inactive auction constrainer enablers are returned.

Returnosid.bidding.rules.AuctionConstrainerEnablerListthe returned AuctionConstrainerEnabler list
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.