orca.shirako.api
Interface IAuthorityReservation

All Superinterfaces:

IRecover, IReservation, IReservationStatus, IResourceReservation, ISerialize, IServerReservation

All Known Implementing Classes:

AuthorityReservation

public interface IAuthorityReservation
extends IServerReservation

IAuthorityReservation defines the reservation interface for authorities processing requests for resources.

Field Summary

Fields inherited from interface orca.shirako.api.IReservation

CategoryAll, CategoryAuthority, CategoryBroker, CategoryClient, PropertyClass, PropertyID

Method Summary

int	getDeficit() Returns the number of concrete units this reservation is short or in excess of.
ResourceSet	getTicket() Returns the ticket backing the reservation.
boolean	isPendingRecover() Checks if there is a recovery operation in progress for the reservation.
void	setPendingRecover(boolean pendingRecover) Indicates whether a recovery operation is in progress for the reservation.
void	setSendWithDeficit(boolean value) Sets the "send with deficit" flag.

Methods inherited from interface orca.shirako.api.IServerReservation

getCallback, getClientAuthToken, getProcessTime, getSequenceIn, getSequenceOut, getServerAuthToken, setOwner, setProcessTime, setSequenceIn

Methods inherited from interface orca.shirako.api.IResourceReservation

count, fail, fail, failWarn, forecastUnits, getApprovedResources, getApprovedTerm, getApprovedType, getApprovedUnits, getLeasedAbstractUnits, getLeasedUnits, getPreviousResources, getPreviousTerm, getRequestedResources, getRequestedTerm, getRequestedType, getRequestedUnits, getResources, getTerm, getType, getUnits, holding, isApproved, isBidPending, isRenewable, setApproved, setApproved, setApprovedResources, setApprovedTerm, setBidPending

Methods inherited from interface orca.shirako.api.IReservation

awaitActive, awaitClosed, awaitTicketed, clearDirty, getActor, getCategory, getCloseTime, getPendingState, getPendingStateName, getPreviousReservationState, getReservationID, getReservationState, getSlice, getState, getStateName, hasUncommittedTransition, isDirty, registerListener, setCloseTime, setDirty, setSlice, unregisterListener

Methods inherited from interface orca.shirako.api.ISerialize

reset, save, save

Methods inherited from interface orca.shirako.api.IRecover

revisit

Methods inherited from interface orca.shirako.api.IReservationStatus

isActive, isActiveTicketed, isClosed, isClosing, isExpired, isExpired, isExtended, isExtendingLease, isExtendingTicket, isFailed, isNascent, isNoPending, isPriming, isRedeeming, isTerminal, isTicketed, isTicketing, setExpired

Method Detail

getDeficit

int getDeficit()

Returns the number of concrete units this reservation is short or in excess of.

Returns:

number of concrete units this reservation is short or in excess of

getTicket

ResourceSet getTicket()

Returns the ticket backing the reservation.

Returns:

ticket

isPendingRecover

boolean isPendingRecover()

Checks if there is a recovery operation in progress for the reservation.

Returns:

true if a recovery operation is in progress for the reservation

setPendingRecover

void setPendingRecover(boolean pendingRecover)

Indicates whether a recovery operation is in progress for the reservation.

Parameters:

pendingRecover - true, and operation is in progress; false, no operation is in progress

setSendWithDeficit

void setSendWithDeficit(boolean value)

Sets the "send with deficit" flag.

Parameters:

value - true, reservations with no pending operations but with a deficit will be send back without attempting to fix the deficit, false - if a deficit exists, the system will attempt to fix it.