IRatingRecord.java

/* ====================================================================
 * Limited Evaluation License:
 *
 * This software is open source, but licensed. The license with this package
 * is an evaluation license, which may not be used for productive systems. If
 * you want a full license, please contact us.
 *
 * The exclusive owner of this work is the OpenRate project.
 * This work, including all associated documents and components
 * is Copyright of the OpenRate project 2006-2015.
 *
 * The following restrictions apply unless they are expressly relaxed in a
 * contractual agreement between the license holder or one of its officially
 * assigned agents and you or your organisation:
 *
 * 1) This work may not be disclosed, either in full or in part, in any form
 *    electronic or physical, to any third party. This includes both in the
 *    form of source code and compiled modules.
 * 2) This work contains trade secrets in the form of architecture, algorithms
 *    methods and technologies. These trade secrets may not be disclosed to
 *    third parties in any form, either directly or in summary or paraphrased
 *    form, nor may these trade secrets be used to construct products of a
 *    similar or competing nature either by you or third parties.
 * 3) This work may not be included in full or in part in any application.
 * 4) You may not remove or alter any proprietary legends or notices contained
 *    in or on this work.
 * 5) This software may not be reverse-engineered or otherwise decompiled, if
 *    you received this work in a compiled form.
 * 6) This work is licensed, not sold. Possession of this software does not
 *    imply or grant any right to you.
 * 7) You agree to disclose any changes to this work to the copyright holder
 *    and that the copyright holder may include any such changes at its own
 *    discretion into the work
 * 8) You agree not to derive other works from the trade secrets in this work,
 *    and that any such derivation may make you liable to pay damages to the
 *    copyright holder
 * 9) You agree to use this software exclusively for evaluation purposes, and
 *    that you shall not use this software to derive commercial profit or
 *    support your business or personal activities.
 *
 * This software is provided "as is" and any expressed or impled warranties,
 * including, but not limited to, the impled warranties of merchantability
 * and fitness for a particular purpose are disclaimed. In no event shall
 * The OpenRate Project or its officially assigned agents be liable to any
 * direct, indirect, incidental, special, exemplary, or consequential damages
 * (including but not limited to, procurement of substitute goods or services;
 * Loss of use, data, or profits; or any business interruption) however caused
 * and on theory of liability, whether in contract, strict liability, or tort
 * (including negligence or otherwise) arising in any way out of the use of
 * this software, even if advised of the possibility of such damage.
 * This software contains portions by The Apache Software Foundation, Robert
 * Half International.
 * ====================================================================
 */

package OpenRate.record;

import java.io.Serializable;
import java.util.List;

/**
 * IRatingRecord type used for data being passed through the Pipeline. The
 * primitive record ancestor for all rating records that can pass through a
 * framework.
 */
public interface IRatingRecord extends Serializable
{
 /**
  * Get the value of an existing RUM, or 0 if not found
  *
  * @param RUM The RUM value to get
  * @return The current value of the RUM
  */
  public double getRUMValue(String RUM);

 /**
  * Get the existing RUM values
  *
  * @return The current RUM list
  */
  public List<RUMInfo> getRUMs();

 /**
  * Set the value of a RUM overwriting any existing value.
  *
  * @param RUM The RUM value to set
  * @param newValue The new value to set
  */
  public void setRUMValue(String RUM, double newValue);

 /**
  * Set the value of a RUM, return true if OK, false if not OK (e.g. overwrite
  * existing value)
  *
  * @param RUM The RUM value to set
  * @param valueDelta The delta to apply to the RUM value
  * @return true if the delta was applied, otherwise false
  */
  public boolean updateRUMValue(String RUM, double valueDelta);

 /**
  * Get the UTC event date of the rating record
  *
  * @return The long UTC event date of the record
  */
  public long getUTCEventDate();

 /**
  * Get the number of balance impacts that are available. This is implemented as
  * a function to allow the charge packet definition to be overwritten.
  *
  * @return The number of balance impacts
  */
  public int getBalanceImpactCount();

 /**
  * This returns the balance impact at the given index.
  *
  * @param index The index to use for the retrieval
  * @return The requested balance impact
  */
  public BalanceImpact getBalanceImpact(int index);

  /* This returns all balance impacts.
  *
  * @return The requested balance impacts
  */
  public List<BalanceImpact> getBalanceImpacts();
  
 /**
  * Adds a balance impact
  *
  * @param newBI The new balance impact to add
  */
  public void addBalanceImpact(BalanceImpact newBI);

 /**
  * Create a charge packet
  *
  * @return the new charge packet
  */
  public BalanceImpact newBalanceImpact();

}