orca.shirako.api
Interface IClientReservation

All Superinterfaces:

IRecover, IReservation, IReservationStatus, IResourceReservation, ISerialize

All Known Subinterfaces:

IServiceManagerReservation

All Known Implementing Classes:

CodBarrierReservation, CodPredecessorReservation, CodReservation, ReservationClient

public interface IClientReservation
extends IResourceReservation

IClientReservation defines the reservation interface for actors acting as clients of other actors.

Field Summary

Fields inherited from interface orca.shirako.api.IReservation

CategoryAll, CategoryAuthority, CategoryBroker, CategoryClient, PropertyClass, PropertyID

Method Summary

IBrokerProxy	getBroker() Returns a proxy to the broker linked to this reservation.
Term	getPreviousTicketTerm() Returns the previous ticket term.
int	getSequence() Returns the reservation sequence number for outgoing messages.
ResourceSet	getSuggestedResources() Returns the resources suggested to the policy for a new/extend request for the reservation.
Term	getSuggestedTerm() Returns the term suggested to the policy for a new/extend request for the reservation.
ResourceType	getSuggestedType() Returns the most recently suggest resource type.
Term	getTicketTerm() Returns the current ticket term.
boolean	isPendingRecover() Checks if a recovery operation is in progress for the reservation.
void	setBroker(IBrokerProxy broker) Sets the broker who will issue tickets for the reservation.
void	setPendingRecover(boolean pendingRecover) Indicates if a recovery operation for the reservation is/is going to be in progress.
void	setRenewable(boolean renewable) Controls the renewable flag.
void	setSequence(int sequence) Sets the reservation sequence number for outgoing messages.
void	setSuggested() Indicates that a suggestion to the policy for resources and/or term has been made.
void	setSuggested(Term term, ResourceSet resources) Sets the term and resources suggested to the policy for a new/extend request for the reservation.
void	setSuggestedResources(ResourceSet resources) Sets the resources suggested to the policy for a new/extend request for the reservation.

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

setRenewable

void setRenewable(boolean renewable)

Controls the renewable flag.

Parameters:

true - if the reservation should be set marked as renewable or false otherwise

setBroker

void setBroker(IBrokerProxy broker)
               throws java.lang.Exception

Sets the broker who will issue tickets for the reservation. This method can be called only for reservations in the Nascent state.

Parameters:

broker - broker request tickets from

Throws:

java.lang.Exception - if the reservation is in the wrong state

getBroker

IBrokerProxy getBroker()

Returns a proxy to the broker linked to this reservation. Can be null.

Returns:

broker linked to this reservation. Can be null.

getSequence

int getSequence()

Returns the reservation sequence number for outgoing messages.

Returns:

reservation sequence number for outgoing messages

setSequence

void setSequence(int sequence)

Sets the reservation sequence number for outgoing messages.

Parameters:

sequence - sequence number

getTicketTerm

Term getTicketTerm()

Returns the current ticket term.

Returns:

current ticket term

getPreviousTicketTerm

Term getPreviousTicketTerm()

Returns the previous ticket term.

Returns:

previous ticket term

getSuggestedTerm

Term getSuggestedTerm()

Returns the term suggested to the policy for a new/extend request for the reservation.

Returns:

suggested term

setSuggestedResources

void setSuggestedResources(ResourceSet resources)

Sets the resources suggested to the policy for a new/extend request for the reservation.

Parameters:

resources - suggested resources

getSuggestedResources

ResourceSet getSuggestedResources()

Returns the resources suggested to the policy for a new/extend request for the reservation.

Returns:

suggested resources

setSuggested

void setSuggested(Term term,
                  ResourceSet resources)

Sets the term and resources suggested to the policy for a new/extend request for the reservation.

Parameters:

term - suggested term

resources - suggested resources

setSuggested

void setSuggested()

Indicates that a suggestion to the policy for resources and/or term has been made.

getSuggestedType

ResourceType getSuggestedType()

Returns the most recently suggest resource type.

Returns:

suggested resource type.

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

setPendingRecover

void setPendingRecover(boolean pendingRecover)

Indicates if a recovery operation for the reservation is/is going to be in progress.

Parameters:

pendingRecover - true, a recovery operation is in progress, false - no recovery operation is in progress.