orca.shirako.api
Interface IServiceManagerReservation

All Superinterfaces:

IClientReservation, IRecover, IReservation, IReservationStatus, IResourceReservation, ISerialize

All Known Implementing Classes:

CodBarrierReservation, CodPredecessorReservation, CodReservation, ReservationClient

public interface IServiceManagerReservation
extends IClientReservation

Field Summary

Fields inherited from interface orca.shirako.api.IReservation

CategoryAll, CategoryAuthority, CategoryBroker, CategoryClient, PropertyClass, PropertyID

Method Summary

IAuthorityProxy	getAuthority() Returns the authority who issued the lease for this reservation.
IServiceManagerReservation	getJoinPredecessor() Returns the reservation's join predecessor.
int	getJoinState() Returns the join state.
java.lang.String	getJoinStateName() Returns the name of the join state.
ResourceSet	getLeasedResources() Returns the resources leased by the reservation.
Term	getLeaseTerm() Returns the term of the current lease.
Term	getPreviousLeaseTerm() Returns the previous lease term.
IServiceManagerReservation	getRedeemPredecessor() Returns the reservation's redeem predecessor.
long	getRedeemTime() Returns the time the reservation must be redeemed.
boolean	isActiveJoined() Returns true if this reservation is currently active, and has completed joining the guest, i.e., successor reservations (with join dependencies on this reservation) may now join.
boolean	isExported() Checks if the reservation represents exported resources.
void	setExported(boolean exported) Indicates whether the reservation represents exported resources.
void	setJoinPredecessor(IServiceManagerReservation predecessor) Sets the join predecessor: the reservation, for which the kernel must issue a join before a join may be issued for the current reservation.
void	setRedeemPredecessor(IServiceManagerReservation predecessor) Sets the redeem predecessor: the reservation, which must be redeemed before a redeem may be issued for the current reservation.
void	setRedeemTime(long time) Sets the time the reservation must be redeemed.

Methods inherited from interface orca.shirako.api.IClientReservation

getBroker, getPreviousTicketTerm, getSequence, getSuggestedResources, getSuggestedTerm, getSuggestedType, getTicketTerm, isPendingRecover, setBroker, setPendingRecover, setRenewable, setSequence, setSuggested, setSuggested, setSuggestedResources

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

getJoinState

int getJoinState()

Returns the join state.

Returns:

join state

getJoinStateName

java.lang.String getJoinStateName()

Returns the name of the join state.

Returns:

isActiveJoined

boolean isActiveJoined()

Returns true if this reservation is currently active, and has completed joining the guest, i.e., successor reservations (with join dependencies on this reservation) may now join. Note: if this reservation is closed or failed, activeJoined returns false and successors will remain blocked, i.e, the caller must close them.

getAuthority

IAuthorityProxy getAuthority()

Returns the authority who issued the lease for this reservation.

Returns:

site authority or null

getLeaseTerm

Term getLeaseTerm()

Returns the term of the current lease.

Returns:

current lease term

getPreviousLeaseTerm

Term getPreviousLeaseTerm()

Returns the previous lease term.

Returns:

previous lease term

getLeasedResources

ResourceSet getLeasedResources()

Returns the resources leased by the reservation. If the reservation has not yet issued a redeem request, returns null.

Returns:

resources leased by the reservation. Can be null.

setRedeemPredecessor

void setRedeemPredecessor(IServiceManagerReservation predecessor)

Sets the redeem predecessor: the reservation, which must be redeemed before a redeem may be issued for the current reservation.

Parameters:

predecessor - predecessor reservation

getRedeemPredecessor

IServiceManagerReservation getRedeemPredecessor()

Returns the reservation's redeem predecessor.

Returns:

redeem predecessor reservation

setJoinPredecessor

void setJoinPredecessor(IServiceManagerReservation predecessor)

Sets the join predecessor: the reservation, for which the kernel must issue a join before a join may be issued for the current reservation.

Parameters:

predecessor - predecessor reservation

getJoinPredecessor

IServiceManagerReservation getJoinPredecessor()

Returns the reservation's join predecessor.

Returns:

join predecessor reservation

getRedeemTime

long getRedeemTime()

Returns the time the reservation must be redeemed.

Returns:

redeem time

setRedeemTime

void setRedeemTime(long time)

Sets the time the reservation must be redeemed. Note: calling this method will not trigger redeem on the reservation. This is a helper method to record the redeem time for the reservation.

Parameters:

time - redeem time

isExported

boolean isExported()

Checks if the reservation represents exported resources.

Returns:

true if the reservation represents exported resources

setExported

void setExported(boolean exported)

Indicates whether the reservation represents exported resources.

Parameters:

true, - the reservation represents exported resources.