Interface BiddingProfile
- All Superinterfaces:
OsidProfile, Sourceable
- All Known Subinterfaces:
BiddingManager, BiddingProxyManager
The bidding profile describes the interoperability among bidding services.
-
Method Summary
Modifier and TypeMethodDescriptionGets the supportedAuctionHouserecord types.Gets the supportedAuctionHousesearch record types.Gets the supportedAuctionrecord types.Gets the supportedAuctionsearch types.Gets the supportedBidrecord types.Gets the supportedBidsearch record types.booleanTests if an auction administrative service is supported.booleanTests if an auction auction house lookup service is supported.booleanTests if an auction auction house assignment service is supported.booleanTests if auction house administrative service is supported.booleanTests for the availability of an auction house hierarchy traversal service.booleanTests for the availability of an auction house hierarchy design service.booleanTests if looking up auction houses is supported.booleanTests if an auction house notification service is supported.booleanTests if querying auction houses is supported.booleansupportsAuctionHouseRecordType(Type auctionHouseRecordType) Tests if the givenAuctionHouserecord type is supported.booleanTests if searching auction houses is supported.booleansupportsAuctionHouseSearchRecordType(Type auctionHouseSearchRecordType) Tests if the givenAuctionHousesearch record type is supported.booleanTests if looking up auctions is supported.booleanTests if an auction notification service is supported.booleanTests if querying auctions is supported.booleansupportsAuctionRecordType(Type auctionRecordType) Tests if the givenAuctionrecord type is supported.booleanTests if searching auctions is supported.booleansupportsAuctionSearchRecordType(Type auctionSearchRecordType) Tests if the givenAuctionsearch type is supported.booleanTests if an auction smart auction house service is supported.booleanTests if bid administrative service is supported.booleanTests if a bid auction house lookup service is supported.booleanTests if a bid auction house service is supported.booleanTests for the availability of a bidding batch service.booleanTests for the availability of a bidding rules service.booleanTests if looking up bids is supported.booleanTests if a bid notification service is supported.booleanTests if querying bids is supported.booleansupportsBidRecordType(Type bidRecordType) Tests if the givenBidrecord type is supported.booleanTests if searching bids is supported.booleansupportsBidSearchRecordType(Type bidSearchRecordType) Tests if the givenBidsearch record type is supported.booleanTests if a bid smart auction house lookup service is supported.booleanTests if a my auction service is supported for the current agent.booleanTests if a my auction notification service is supported for the current agent.booleanTests if any auction house federation is exposed.Methods inherited from interface OsidProfile
getBranch, getBranchId, getDescription, getDisplayName, getId, getLocales, getProxyRecordTypes, getReleaseDate, getVersion, supportsJournalBranching, supportsJournalRollback, supportsOSIDVersion, supportsProxyRecordTypeModifier and TypeMethodDescriptionGets this service branch.Gets theBranch Idrepresenting this service branch.Gets a description of this service implementation.Gets a display name for this service implementation.getId()Gets an identifier for this service implementation.Gets the locales supported in this service.Gets the proxy recordTypessupported in this service.Gets the date this service implementation was released.Gets the version of this service implementation.booleanTest for support of a journal branching service.booleanTest for support of a journaling rollback service.booleansupportsOSIDVersion(Version version) Test for support of an OSID specification version.booleansupportsProxyRecordType(Type proxyRecordType) Test for support of a proxy type.Methods inherited from interface Sourceable
getBranding, getBrandingIds, getLicense, getProvider, getProviderIdModifier and TypeMethodDescriptionGets a branding, such as an image or logo, expressed using theAssetinterface.Gets the branding assetIds.Gets the terms of usage.Gets theResourcerepresenting the provider.Gets theIdof the provider.
-
Method Details
-
supportsVisibleFederation
boolean supportsVisibleFederation()Tests if any auction house federation is exposed. Federation is exposed when a specific auction house may be identified, selected and used to create a lookup or admin session. Federation is not exposed when a set of auction houses appears as a single auction house.- Returns:
trueif visible federation is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsMyAuction
boolean supportsMyAuction()Tests if a my auction service is supported for the current agent.- Returns:
trueif my auction is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsMyAuctionNotification
boolean supportsMyAuctionNotification()Tests if a my auction notification service is supported for the current agent.- Returns:
trueif my auction notification is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsAuctionLookup
boolean supportsAuctionLookup()Tests if looking up auctions is supported.- Returns:
trueif auction lookup is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsAuctionQuery
boolean supportsAuctionQuery()Tests if querying auctions is supported.- Returns:
trueif auction query is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsAuctionSearch
boolean supportsAuctionSearch()Tests if searching auctions is supported.- Returns:
trueif auction search is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsAuctionAdmin
boolean supportsAuctionAdmin()Tests if an auction administrative service is supported.- Returns:
trueif auction administration is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsAuctionNotification
boolean supportsAuctionNotification()Tests if an auction notification service is supported.- Returns:
trueif auction notification is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsAuctionAuctionHouse
boolean supportsAuctionAuctionHouse()Tests if an auction auction house lookup service is supported.- Returns:
trueif an auction auction house lookup service is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsAuctionAuctionHouseAssignment
boolean supportsAuctionAuctionHouseAssignment()Tests if an auction auction house assignment service is supported.- Returns:
trueif an auction to auction house assignment service is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsAuctionSmartAuctionHouse
boolean supportsAuctionSmartAuctionHouse()Tests if an auction smart auction house service is supported.- Returns:
trueif a smart auction house service is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsBidLookup
boolean supportsBidLookup()Tests if looking up bids is supported.- Returns:
trueif bid lookup is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsBidQuery
boolean supportsBidQuery()Tests if querying bids is supported.- Returns:
trueif bid query is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsBidSearch
boolean supportsBidSearch()Tests if searching bids is supported.- Returns:
trueif bid search is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsBidAdmin
boolean supportsBidAdmin()Tests if bid administrative service is supported.- Returns:
trueif bid administration is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsBidNotification
boolean supportsBidNotification()Tests if a bid notification service is supported.- Returns:
trueif bid notification is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsBidAuctionHouse
boolean supportsBidAuctionHouse()Tests if a bid auction house lookup service is supported.- Returns:
trueif a bid auction house lookup service is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsBidAuctionHouseAssignment
boolean supportsBidAuctionHouseAssignment()Tests if a bid auction house service is supported.- Returns:
trueif bid to auction house assignment service is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsBidSmartAuctionHouse
boolean supportsBidSmartAuctionHouse()Tests if a bid smart auction house lookup service is supported.- Returns:
trueif a bid smart auction house service is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsAuctionHouseLookup
boolean supportsAuctionHouseLookup()Tests if looking up auction houses is supported.- Returns:
trueif auction house lookup is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsAuctionHouseQuery
boolean supportsAuctionHouseQuery()Tests if querying auction houses is supported.- Returns:
trueif an auction house query service is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsAuctionHouseSearch
boolean supportsAuctionHouseSearch()Tests if searching auction houses is supported.- Returns:
trueif auction house search is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsAuctionHouseAdmin
boolean supportsAuctionHouseAdmin()Tests if auction house administrative service is supported.- Returns:
trueif auction house administration is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsAuctionHouseNotification
boolean supportsAuctionHouseNotification()Tests if an auction house notification service is supported.- Returns:
trueif auction house notification is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsAuctionHouseHierarchy
boolean supportsAuctionHouseHierarchy()Tests for the availability of an auction house hierarchy traversal service.- Returns:
trueif auction house hierarchy traversal is available,falseotherwise- Compliance:
mandatory- This method must be implemented in all providers.
-
supportsAuctionHouseHierarchyDesign
boolean supportsAuctionHouseHierarchyDesign()Tests for the availability of an auction house hierarchy design service.- Returns:
trueif auction house hierarchy design is available,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsBiddingBatch
boolean supportsBiddingBatch()Tests for the availability of a bidding batch service.- Returns:
trueif a bidding batch service is available,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsBiddingRules
boolean supportsBiddingRules()Tests for the availability of a bidding rules service.- Returns:
trueifa bidding rules service is available,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
getAuctionRecordTypes
TypeList getAuctionRecordTypes()Gets the supportedAuctionrecord types.- Returns:
- a list containing the supported
Auctionrecord types - Compliance:
mandatory- This method must be implemented.
-
supportsAuctionRecordType
Tests if the givenAuctionrecord type is supported.- Parameters:
auctionRecordType- aTypeindicating anAuctionrecord type- Returns:
trueif the given record type is supported,falseotherwise- Throws:
NullArgumentException-auctionRecordTypeisnull- Compliance:
mandatory- This method must be implemented.
-
getAuctionSearchRecordTypes
TypeList getAuctionSearchRecordTypes()Gets the supportedAuctionsearch types.- Returns:
- a list containing the supported
Auctionsearch types - Compliance:
mandatory- This method must be implemented.
-
supportsAuctionSearchRecordType
Tests if the givenAuctionsearch type is supported.- Parameters:
auctionSearchRecordType- aTypeindicating anAuctionsearch type- Returns:
trueif the givenTypeis supported,falseotherwise- Throws:
NullArgumentException-auctionSearchRecordTypeisnull- Compliance:
mandatory- This method must be implemented.
-
getBidRecordTypes
TypeList getBidRecordTypes()Gets the supportedBidrecord types.- Returns:
- a list containing the supported
Bidrecord types - Compliance:
mandatory- This method must be implemented.
-
supportsBidRecordType
Tests if the givenBidrecord type is supported.- Parameters:
bidRecordType- aTypeindicating aBidrecord type- Returns:
trueif the given record type is supported,falseotherwise- Throws:
NullArgumentException-bidRecordTypeisnull- Compliance:
mandatory- This method must be implemented.
-
getBidSearchRecordTypes
TypeList getBidSearchRecordTypes()Gets the supportedBidsearch record types.- Returns:
- a list containing the supported
Bidsearch record types - Compliance:
mandatory- This method must be implemented.
-
supportsBidSearchRecordType
Tests if the givenBidsearch record type is supported.- Parameters:
bidSearchRecordType- aTypeindicating aBidsearch record type- Returns:
trueif the given search record type is supported,falseotherwise- Throws:
NullArgumentException-bidSearchRecordTypeisnull- Compliance:
mandatory- This method must be implemented.
-
getAuctionHouseRecordTypes
TypeList getAuctionHouseRecordTypes()Gets the supportedAuctionHouserecord types.- Returns:
- a list containing the supported
AuctionHousetypes - Compliance:
mandatory- This method must be implemented.
-
supportsAuctionHouseRecordType
Tests if the givenAuctionHouserecord type is supported.- Parameters:
auctionHouseRecordType- aTypeindicating anAuctionHouserecord type- Returns:
trueif the givenTypeis supported,falseotherwise- Throws:
NullArgumentException-auctionHouseRecordTypeisnull- Compliance:
mandatory- This method must be implemented.
-
getAuctionHouseSearchRecordTypes
TypeList getAuctionHouseSearchRecordTypes()Gets the supportedAuctionHousesearch record types.- Returns:
- a list containing the supported
AuctionHousesearch record types - Compliance:
mandatory- This method must be implemented.
-
supportsAuctionHouseSearchRecordType
Tests if the givenAuctionHousesearch record type is supported.- Parameters:
auctionHouseSearchRecordType- aTypeindicating anAuctionHousesearch record type- Returns:
trueif the givenTypeis supported,falseotherwise- Throws:
NullArgumentException-auctionHouseSearchRecordTypeisnull- Compliance:
mandatory- This method must be implemented.
-