com.platform.ego
Interface ConsumerPlan


public interface ConsumerPlan

ConsumerPlan specifies plan for a consumer. A consumer plan holds the ownership/share/lend/borrow policy for a consumer in the specified resource group.

Version:
1.2.3

Method Summary
 int getBorrowed()
          Get the number of borrowed slots of the current plan.
 codegen.databinding.com.platform.www.BorrowFromDocument.BorrowFrom[] getBorrowFrom()
          Get the lender array of the current plan.
 codegen.databinding.com.platform.www.BorrowFromDocument.BorrowFrom[] getBorrowFrom(java.util.Calendar calendar)
          Get the lender array for the given day/time.
 int getBorrowLimit()
          Get the borrow limit of the current plan.
 int getBorrowLimit(java.util.Calendar calendar)
          Get the borrow limit for the given day/time.
 java.lang.String getConsumerName()
          Get name of consumer.
 int getLendLimit()
          Get the lend limit of the current plan.
 int getLendLimit(java.util.Calendar calendar)
          Get the lend limit for the given day/time.
 codegen.databinding.com.platform.www.LendToDocument.LendTo[] getLendTo()
          Get the borrower array of the current plan.
 codegen.databinding.com.platform.www.LendToDocument.LendTo[] getLendTo(java.util.Calendar calendar)
          Get the borrower array for the given day/time.
 int getLent()
          Get the number of lent slots of the current plan.
 int getOwned()
          Get the number of owned slots of the current plan.
 int getOwned(java.util.Calendar calendar)
          Get the number of owned slots for the interval that contains the given day/time.
 int getOwnedInUse()
          Get the number of owned slots in use in the current plan.
 codegen.databinding.com.platform.www.ConsumerDocument.Consumer getPlan()
          Get the resource plan
 int getPriority()
          Get the priority of the consumer for the current plan.
 int getPriority(java.util.Calendar calendar)
          Get the priority of the consumer for the interval that contain the given time.
 java.lang.String getResourceGroupName()
          Get name of ResourceGroup.
 int getShareInUse()
          Get the number of shared slots in use in the current plan.
 int getShareLimit()
          Get the share limit of the current plan.
 int getShareLimit(java.util.Calendar calendar)
          Get the share limit for the given day/time.
 int getShareRatio()
          Get the share ratio of the current plan.
 int getShareRatio(java.util.Calendar calendar)
          Get the share ratio for the interval that contains given day/time.
 int getShareReserved()
          Get the number of shared slots reserved in the current plan.
 void setBorrowFrom(codegen.databinding.com.platform.www.BorrowFromDocument.BorrowFrom[] borrowFrom)
          Set the lender array of the current plan.
 void setBorrowFrom(java.util.Calendar calendar, codegen.databinding.com.platform.www.BorrowFromDocument.BorrowFrom[] borrowFrom)
          Set the lender array for the interval that contains the given day/time.
 void setBorrowLimit(java.util.Calendar calendar, int count)
          Set the borrow limit for the interval that contains the given day/time.
 void setBorrowLimit(int count)
          Set the borrow limit of the current plan.
 void setLendLimit(java.util.Calendar calendar, int count)
          Set the lend limit for the interval that contains the given day/time.
 void setLendLimit(int count)
          Set the lend limit of the current plan.
 void setLendTo(java.util.Calendar calendar, codegen.databinding.com.platform.www.LendToDocument.LendTo[] lendTo)
          Set the borrower array for the interval that contains the given day/time.
 void setLendTo(codegen.databinding.com.platform.www.LendToDocument.LendTo[] lendTo)
          Set the borrower array of the current plan.
 void setOwned(java.util.Calendar calendar, int count)
          Set the number of owned slots for the interval that contains the given day/time.
 void setOwned(int count)
          Set the number of owned slots of the current plan.
 void setPlan()
          Set the resource plan.
 void setPriority(java.util.Calendar calendar, int count)
          Set the priority of the consumer for the interval that contain the given time.
 void setPriority(int count)
          Set the priority of the consumer for the current plan.
 void setShareLimit(java.util.Calendar calendar, int count)
          Set the share limit for the interval that contains the given day/time.
 void setShareLimit(int count)
          Set the share limit of the current plan.
 void setShareRatio(java.util.Calendar calendar, int count)
          Set the share ratio for the interval that contains the given day/time.
 void setShareRatio(int count)
          Set the share ratio of the current plan.
 

Method Detail

getConsumerName

java.lang.String getConsumerName()
Get name of consumer.

Returns:
name of consumer.

getResourceGroupName

java.lang.String getResourceGroupName()
Get name of ResourceGroup.

Returns:
name of ResourceGroup.

getOwned

int getOwned()
             throws EGOException
Get the number of owned slots of the current plan.

Returns:
number of owned slots
Throws:
EGOException

getShareRatio

int getShareRatio()
                  throws EGOException
Get the share ratio of the current plan.

Returns:
number of share ratio
Throws:
EGOException

getShareLimit

int getShareLimit()
                  throws EGOException
Get the share limit of the current plan.

Returns:
number of share limit
Throws:
EGOException

getBorrowLimit

int getBorrowLimit()
                   throws EGOException
Get the borrow limit of the current plan.

Returns:
number of borrow limit
Throws:
EGOException

getLendLimit

int getLendLimit()
                 throws EGOException
Get the lend limit of the current plan.

Returns:
number of lend limit
Throws:
EGOException

getBorrowFrom

codegen.databinding.com.platform.www.BorrowFromDocument.BorrowFrom[] getBorrowFrom()
                                                                                   throws EGOException
Get the lender array of the current plan.

Returns:
name of the lender
Throws:
EGOException

getLendTo

codegen.databinding.com.platform.www.LendToDocument.LendTo[] getLendTo()
                                                                       throws EGOException
Get the borrower array of the current plan.

Returns:
name of the borrower
Throws:
EGOException

getLent

int getLent()
            throws EGOException
Get the number of lent slots of the current plan.

Returns:
number of lented slots
Throws:
EGOException

getBorrowed

int getBorrowed()
                throws EGOException
Get the number of borrowed slots of the current plan.

Returns:
numer of borrowed slots
Throws:
EGOException

getOwnedInUse

int getOwnedInUse()
                  throws EGOException
Get the number of owned slots in use in the current plan.

Returns:
number of owned slots which in use
Throws:
EGOException

getShareInUse

int getShareInUse()
                  throws EGOException
Get the number of shared slots in use in the current plan.

Returns:
number of shared slots which in use
Throws:
EGOException

getShareReserved

int getShareReserved()
                     throws EGOException
Get the number of shared slots reserved in the current plan.

Returns:
number of share slots reserved
Throws:
EGOException

setOwned

void setOwned(int count)
              throws EGOException
Set the number of owned slots of the current plan.

Parameters:
count - : specifies the number of owned slots
Throws:
EGOException

setShareRatio

void setShareRatio(int count)
                   throws EGOException
Set the share ratio of the current plan.

Parameters:
count - : specifies the number of share ratio
Throws:
EGOException

setShareLimit

void setShareLimit(int count)
                   throws EGOException
Set the share limit of the current plan.

Parameters:
count - : specifies the number of share limit
Throws:
EGOException

setBorrowLimit

void setBorrowLimit(int count)
                    throws EGOException
Set the borrow limit of the current plan.

Parameters:
count - : specifies the number of borrow limit
Throws:
EGOException

setLendLimit

void setLendLimit(int count)
                  throws EGOException
Set the lend limit of the current plan.

Parameters:
count - : specifies the numer of lend limit
Throws:
EGOException

setBorrowFrom

void setBorrowFrom(codegen.databinding.com.platform.www.BorrowFromDocument.BorrowFrom[] borrowFrom)
                   throws EGOException
Set the lender array of the current plan.

Parameters:
borrowFrom - : specifies the lender
Throws:
EGOException

setLendTo

void setLendTo(codegen.databinding.com.platform.www.LendToDocument.LendTo[] lendTo)
               throws EGOException
Set the borrower array of the current plan.

Parameters:
lendTo - : specifies the borrower
Throws:
EGOException

getPriority

int getPriority()
                throws EGOException
Get the priority of the consumer for the current plan.

Returns:
number of priority
Throws:
EGOException

setPriority

void setPriority(int count)
                 throws EGOException
Set the priority of the consumer for the current plan.

Parameters:
count - : specifies the number of priority
Throws:
EGOException

getPriority

int getPriority(java.util.Calendar calendar)
                throws EGOException
Get the priority of the consumer for the interval that contain the given time.

Parameters:
calendar - : specifies the calendar
Returns:
number of priority
Throws:
EGOException

setPriority

void setPriority(java.util.Calendar calendar,
                 int count)
                 throws EGOException
Set the priority of the consumer for the interval that contain the given time.

Parameters:
calendar - : specifies the calendar
count - : specifies the number of priority
Throws:
EGOException

getOwned

int getOwned(java.util.Calendar calendar)
             throws EGOException
Get the number of owned slots for the interval that contains the given day/time.

Parameters:
calendar - : specifies the calendar
Returns:
number of owned slots
Throws:
EGOException

setOwned

void setOwned(java.util.Calendar calendar,
              int count)
              throws EGOException
Set the number of owned slots for the interval that contains the given day/time.

Parameters:
calendar - : specifies the calender
count - : specifies the number of owned slots
Throws:
EGOException

getShareRatio

int getShareRatio(java.util.Calendar calendar)
                  throws EGOException
Get the share ratio for the interval that contains given day/time.

Parameters:
calendar - : specifies the calendar
Returns:
number of share ratio
Throws:
EGOException

setShareRatio

void setShareRatio(java.util.Calendar calendar,
                   int count)
                   throws EGOException
Set the share ratio for the interval that contains the given day/time.

Parameters:
calendar - : specifies the calendar
count - : specifies the number of share ratio
Throws:
EGOException

getShareLimit

int getShareLimit(java.util.Calendar calendar)
                  throws EGOException
Get the share limit for the given day/time.

Parameters:
calendar - : specifies the calendar
Returns:
number of share limit
Throws:
EGOException

setShareLimit

void setShareLimit(java.util.Calendar calendar,
                   int count)
                   throws EGOException
Set the share limit for the interval that contains the given day/time.

Parameters:
calendar - : specifies the calender
count -
Throws:
EGOException

getBorrowLimit

int getBorrowLimit(java.util.Calendar calendar)
                   throws EGOException
Get the borrow limit for the given day/time.

Parameters:
calendar - : specifies the calendar
Returns:
number of borrow limit
Throws:
EGOException

setBorrowLimit

void setBorrowLimit(java.util.Calendar calendar,
                    int count)
                    throws EGOException
Set the borrow limit for the interval that contains the given day/time.

Parameters:
calendar - : specifies the calendar
count - : specifies the number of borrow limit
Throws:
EGOException

getLendLimit

int getLendLimit(java.util.Calendar calendar)
                 throws EGOException
Get the lend limit for the given day/time.

Parameters:
calendar - : specifies the calendar
Returns:
number of lend limit
Throws:
EGOException

setLendLimit

void setLendLimit(java.util.Calendar calendar,
                  int count)
                  throws EGOException
Set the lend limit for the interval that contains the given day/time.

Parameters:
calendar - : specifies the calendar
count - : specifies the number of lend limit
Throws:
EGOException

getLendTo

codegen.databinding.com.platform.www.LendToDocument.LendTo[] getLendTo(java.util.Calendar calendar)
                                                                       throws EGOException
Get the borrower array for the given day/time.

Parameters:
calendar - : specifies the calendar
Returns:
name of borrower
Throws:
EGOException

setLendTo

void setLendTo(java.util.Calendar calendar,
               codegen.databinding.com.platform.www.LendToDocument.LendTo[] lendTo)
               throws EGOException
Set the borrower array for the interval that contains the given day/time.

Parameters:
calendar - : specifies the calendar
lendTo - : specifies the borrower
Throws:
EGOException

getBorrowFrom

codegen.databinding.com.platform.www.BorrowFromDocument.BorrowFrom[] getBorrowFrom(java.util.Calendar calendar)
                                                                                   throws EGOException
Get the lender array for the given day/time.

Parameters:
calendar - : specifies the calendar
Returns:
name of lender
Throws:
EGOException

setBorrowFrom

void setBorrowFrom(java.util.Calendar calendar,
                   codegen.databinding.com.platform.www.BorrowFromDocument.BorrowFrom[] borrowFrom)
                   throws EGOException
Set the lender array for the interval that contains the given day/time.

Parameters:
calendar - : specifies the calendar
borrowFrom - : specifies the lender
Throws:
EGOException

getPlan

codegen.databinding.com.platform.www.ConsumerDocument.Consumer getPlan()
                                                                       throws EGOException
Get the resource plan

Returns:
resource plan
Throws:
EGOException

setPlan

void setPlan()
             throws EGOException
Set the resource plan.

Throws:
EGOException


Copyright (C) 1992-2007 Platform Computing Corporation