orca.shirako.api
Interface IBrokerReservation

All Superinterfaces:

IRecover, IReservation, IReservationStatus, IResourceReservation, ISerialize, IServerReservation

All Known Implementing Classes:

BrokerReservation

public interface IBrokerReservation
extends IServerReservation

IBrokerReservation defines the reservation interface for brokers processing requests for resources.

Field Summary

Fields inherited from interface orca.shirako.api.IReservation

CategoryAll, CategoryAuthority, CategoryBroker, CategoryClient, PropertyClass, PropertyID

Method Summary

IAuthorityProxy	getAuthority() Returns a proxy to the authority in control of the resources represented by the reservation.
ReservationClient	getSource() Returns source for this reservation.
boolean	isClosedInPriming() Checks if the reservation was closed while it was in the Priming state.
boolean	isPendingRecover() Checks if a recovery operation is in progress for the reservation.
void	setAuthority(IAuthorityProxy authority) Sets the authority in control of the resources represented by the reservation.
void	setSource(ReservationClient source) Sets the source for this reservation.

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

setSource

void setSource(ReservationClient source)

Sets the source for this reservation. For optional use by policy to track where it filled this reservation from, e.g., for use on extends.

Parameters:

source - the source reservation.

getSource

ReservationClient getSource()

Returns source for this reservation. For optional use by policy to track where it filled this reservation from, e.g., for use on extends.

Returns:

the source reservation

getAuthority

IAuthorityProxy getAuthority()

Returns a proxy to the authority in control of the resources represented by the reservation.

Returns:

authority proxy

setAuthority

void setAuthority(IAuthorityProxy authority)

Sets the authority in control of the resources represented by the reservation.

Parameters:

authority - authority proxy

isClosedInPriming

boolean isClosedInPriming()

Checks if the reservation was closed while it was in the Priming state. Reservations closed in the priming state have a resources field that does not accurately represent the last allocation. This method is intended for use by policy classes when processing the closed() event. If the policy class does not keep track what resources it last allocated to a given reservation, the policy class must then use this method to determine where the information about allocated resources for the reservation is stored. If this method returns true, the last allocation, before the current update, will be in getPreviousResources(), and the current update that was applied to the reservation will be in getApprovedResources

Returns:

true if the reservation was closed while in the Priming state

isPendingRecover

boolean isPendingRecover()

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

Returns:

true if a recovery operation for the reservation is in progress