org.osid.bidding.rules

Interface AuctionConstrainerEnablerNotificationSession

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, OsidSession

public interface AuctionConstrainerEnablerNotificationSession
extends OsidSession

This session defines methods to receive notifications on adds/changes to AuctionConstrainerEnabler objects in this AuctionHouse. This also includes existing AuctionConstrainerEnablers that may appear or disappear due to changes in the AuctionHouse hierarchy, This session is intended for consumers needing to synchronize their state with this service without the use of polling. Notifications are cancelled when this session is closed.

The two views defined in this session correspond to the views in the AuctionConstrainerEnablerLookupSession.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canRegisterForAuctionConstrainerEnablerNotifications() Tests if this user can register for AuctionConstrainerEnabler notifications.
AuctionHouse	getAuctionHouse() Gets the AuctionHouse associated with this session.
Id	getAuctionHouseId() Gets the AuctionHouse Id associated with this session.
void	registerForChangedAuctionConstrainerEnabler(Id auctionConstrainerEnablerId) Registers for notification of an updated auction constrainer enabler.
void	registerForChangedAuctionConstrainerEnablers() Registers for notification of updated auction constrainer enablers.
void	registerForDeletedAuctionConstrainerEnabler(Id auctionConstrainerEnablerId) Registers for notification of a deleted auction constrainer enabler.
void	registerForDeletedAuctionConstrainerEnablers() Registers for notification of deleted auction constrainer enablers.
void	registerForNewAuctionConstrainerEnablers() Register for notifications of new auction constrainer enablers.
void	useFederatedAuctionHouseView() Federates the view for methods in this session.
void	useIsolatedAuctionHouseView() Isolates the view for methods in this session.

Methods inherited from interface org.osid.OsidSession

getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions

Methods inherited from interface org.osid.binding.java.OsidSession

close

Methods inherited from interface java.io.Closeable

close

Method Detail

getAuctionHouseId

Id getAuctionHouseId()

Gets the AuctionHouse Id associated with this session.

Returns:

the AuctionHouse Id associated with this session

Compliance:

mandatory - This method must be implemented.

getAuctionHouse

AuctionHouse getAuctionHouse()
                             throws OperationFailedException,
                                    PermissionDeniedException

Gets the AuctionHouse associated with this session.

Returns:

the auction house

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canRegisterForAuctionConstrainerEnablerNotifications

boolean canRegisterForAuctionConstrainerEnablerNotifications()

Tests if this user can register for AuctionConstrainerEnabler notifications. 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 notification operations.

Returns:

false if notification methods are not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

useFederatedAuctionHouseView

void useFederatedAuctionHouseView()

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

Compliance:

mandatory - This method is must be implemented.

useIsolatedAuctionHouseView

void useIsolatedAuctionHouseView()

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

Compliance:

mandatory - This method is must be implemented.

registerForNewAuctionConstrainerEnablers

void registerForNewAuctionConstrainerEnablers()
                                              throws OperationFailedException,
                                                     PermissionDeniedException

Register for notifications of new auction constrainer enablers. AuctionConstrainerEnablerReceiver.newAuctionConstrainerEnabler() is invoked when a new AuctionConstrainerEnabler appears in this auction house.

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForChangedAuctionConstrainerEnablers

void registerForChangedAuctionConstrainerEnablers()
                                                  throws OperationFailedException,
                                                         PermissionDeniedException

Registers for notification of updated auction constrainer enablers. AuctionConstrainerEnablerReceiver.changedAuctionConstrainerEnabler() is invoked when an auction constrainer enabler in this auction house is changed.

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForChangedAuctionConstrainerEnabler

void registerForChangedAuctionConstrainerEnabler(Id auctionConstrainerEnablerId)
                                                 throws OperationFailedException,
                                                        PermissionDeniedException

Registers for notification of an updated auction constrainer enabler. ProvisionableReceiver.changedAuctionConstrainerEnabler() is invoked when the specified auction constrainer enabler in this auction house is changed.

Parameters:

auctionConstrainerEnablerId - the Id of the AuctionConstrainerEnabler to monitor

Throws:

NullArgumentException - auctionConstrainerEnablerId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForDeletedAuctionConstrainerEnablers

void registerForDeletedAuctionConstrainerEnablers()
                                                  throws OperationFailedException,
                                                         PermissionDeniedException

Registers for notification of deleted auction constrainer enablers. AuctionConstrainerEnablerReceiver.deletedAuctionConstrainerEnabler() is invoked when an auction constrainer enabler is deleted or removed from this auction house.

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForDeletedAuctionConstrainerEnabler

void registerForDeletedAuctionConstrainerEnabler(Id auctionConstrainerEnablerId)
                                                 throws OperationFailedException,
                                                        PermissionDeniedException

Registers for notification of a deleted auction constrainer enabler. AuctionConstrainerEnablerReceiver.deletedAuctionConstrainerEnabler() is invoked when the specified auction constrainer enabler is deleted or removed from this auction house.

Parameters:

auctionConstrainerEnablerId - the Id of the AuctionConstrainerEnabler to monitor

Throws:

NullArgumentException - auctionConstrainerEnablerId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.