AuctionProcessorEnabler

All Superinterfaces:: Browsable, Extensible, Identifiable, Operable, OsidEnabler, OsidObject, OsidRule, Temporal

public interface AuctionProcessorEnabler extends OsidEnabler

An AuctionProcessorEnabler describes the rules for making an AuctionProcessor effective.

Like all OsidObjects, AuctionProcessorEnabler is managed by its OsidSessions and may not be accessed by concurrent processing threads.

Method Summary

Modifier and Type

Method

Description

AuctionProcessorEnablerRecord

getAuctionProcessorEnablerRecord(Type auctionProcessorEnablerRecordType)

Gets the auction processor enabler record corresponding to the given AuctionProcessorEnabler record Type.

Methods inherited from interface Browsable
getProperties, getPropertiesByRecordType

Methods inherited from interface Extensible
getRecordTypes, hasRecordType

Methods inherited from interface Identifiable
getId, isCurrent

Methods inherited from interface Operable
isActive, isDisabled, isEnabled, isOperational

Methods inherited from interface OsidEnabler
getCyclicEvent, getCyclicEventId, getCyclicTimePeriod, getCyclicTimePeriodId, getEvent, getEventId, getSchedule, getScheduleId, getTimePeriod, getTimePeriodId, isOperationalDuringCyclicEvent, isOperationalDuringCyclicTimePeriod, isOperationalDuringEvent, isOperationalDuringTimePeriod, isOperationalOnSchedule, isRequirement

Methods inherited from interface OsidObject
getDescription, getDisplayName, getGenusType, isOfGenusType

Methods inherited from interface OsidRule
getConditionRecordTypes, getRule, getRuleId, hasRule

Methods inherited from interface Temporal
getEndDate, getStartDate, isEffective

Method Details
- getAuctionProcessorEnablerRecord
  
  AuctionProcessorEnablerRecord getAuctionProcessorEnablerRecord(Type auctionProcessorEnablerRecordType) throws OperationFailedException
  
  Gets the auction processor enabler record corresponding to the given AuctionProcessorEnabler record Type. This method is used to retrieve an object implementing the requested record. The auctionEnablerRecordType may be the Type returned in getRecordTypes() or any of its parents in a Type hierarchy where hasRecordType(auctionEnablerRecordType) is true.
  
  Parameters:
  
  auctionProcessorEnablerRecordType - the type of auction processor enabler record to retrieve
  
  Returns:
  
  the auction processor enabler record
  
  Throws:
  
  NullArgumentException - auctionProcessorEnablerRecordType is null
  
  OperationFailedException - unable to complete request
  
  UnsupportedException - hasRecordType(auctionProcessorEnablerRecordType) is false
  
  Compliance:
  mandatory - This method must be implemented.