public interface AuctionHouseNotificationSession extends OsidSession
This session defines methods to receive notifications on adds/changes
to AuctionHouse
objects. 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.
Modifier and Type | Method and Description |
---|---|
boolean |
canRegisterForAuctionHouseNotifications()
Tests if this user can register for
AuctionHouse
notifications. |
void |
registerForChangedAuctionHouse(Id auctionHouseId)
Registers for notification of an updated auction house.
|
void |
registerForChangedAuctionHouses()
Registers for notification of updated auction houses.
|
void |
registerForDeletedAuctionHouse(Id auctionHouseId)
Registers for notification of a deleted auction house.
|
void |
registerForDeletedAuctionHouseAncestors(Id auctionHouseId)
Registers for notification if an ancestor is removed from the
specified auction house in the auction house hierarchy.
|
void |
registerForDeletedAuctionHouseDescendants(Id auctionHouseId)
Registers for notification if a descendant is removed from fthe
specified auction house in the auction house hierarchy.
|
void |
registerForDeletedAuctionHouses()
Registers for notification of deleted auction houses.
|
void |
registerForNewAuctionHouseAncestors(Id auctionHouseId)
Registers for notification if an ancestor is added to the specified
auction house in the auction house hierarchy.
|
void |
registerForNewAuctionHouseDescendants(Id auctionHouseId)
Registers for notification if a descendant is added to the specified
auction house in the auction house hierarchy.
|
void |
registerForNewAuctionHouses()
Register for notifications of new auction houses.
|
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
boolean canRegisterForAuctionHouseNotifications()
AuctionHouse
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. false
if notification methods are not
authorized, true
otherwisemandatory
- This method must be implemented. void registerForNewAuctionHouses() throws OperationFailedException, PermissionDeniedException
AuctionHouseReceiver.newAuctionHouse()
is invoked when a new
AuctionHouse
is created.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForNewAuctionHouseAncestors(Id auctionHouseId) throws OperationFailedException, PermissionDeniedException
AuctionHouseReceiver.newAuctionHouseAncestor()
is invoked when
the specified auction house experiences an addition in ancestry.auctionHouseId
- the Id
of the auction house to
monitorNullArgumentException
- auctionHouseId is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForNewAuctionHouseDescendants(Id auctionHouseId) throws OperationFailedException, PermissionDeniedException
AuctionHouseReceiver.newAuctionHouseDescendant()
is invoked
when the specified auction house experiences an addition in
descendants.auctionHouseId
- the Id
of the auction house to
monitorNullArgumentException
- auctionHouseId is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedAuctionHouses() throws OperationFailedException, PermissionDeniedException
AuctionHouseReceiver.changedAuctionHouse()
is invoked when an
auction house is changed.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedAuctionHouse(Id auctionHouseId) throws OperationFailedException, PermissionDeniedException
AuctionHouseReceiver.changedAuctionHouse()
is invoked when the
specified auction house is changed.auctionHouseId
- the Id of the AuctionHouse
to
monitorNullArgumentException
- auctionHouseId is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedAuctionHouses() throws OperationFailedException, PermissionDeniedException
AuctionHouseReceiver.deletedAuctionHouse()
is invoked when an
auction house is deleted.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedAuctionHouse(Id auctionHouseId) throws OperationFailedException, PermissionDeniedException
AuctionHouseReceiver.deletedAuctionHouse()
is invoked when the
specified auction house is deleted.auctionHouseId
- the Id
of the
AuctionHouse
to monitorNullArgumentException
- auctionHouseId is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedAuctionHouseAncestors(Id auctionHouseId) throws OperationFailedException, PermissionDeniedException
AuctionHouseReceiver.deletedAuctionHouseAncestor()
is invoked
when the specified auction house experiences a removal of an ancestor.auctionHouseId
- the Id
of the auction house to
monitorNullArgumentException
- auctionHouseId is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedAuctionHouseDescendants(Id auctionHouseId) throws OperationFailedException, PermissionDeniedException
AuctionHouseReceiver.deletedAuctionHouseDescednant()
is
invoked when the specified auction house experiences a removal of one
of its descdendents.auctionHouseId
- the Id
of the auction house to
monitorNullArgumentException
- auctionHouseId is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.