GSUPoolReferenceAvp.java

/*
 * Mobicents, Communications Middleware
 * 
 * Copyright (c) 2008, Red Hat Middleware LLC or third-party contributors as
 * indicated by the @author tags or express copyright attribution
 * statements applied by the authors.  All third-party contributions are
 * distributed under license by Red Hat Middleware LLC.
 *
 * This copyrighted material is made available to anyone wishing to use, modify,
 * copy, or redistribute it subject to the terms and conditions of the GNU
 * Lesser General Public License, as published by the Free Software Foundation.
 *
 * This program is distributed in the hope that it will be useful, but 
 * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
 * or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public License
 * for more details.
 *
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this distribution; if not, write to:
 * Free Software Foundation, Inc.
 * 51 Franklin Street, Fifth Floor
 *
 * Boston, MA  02110-1301  USA
 */
package net.java.slee.resource.diameter.cca.events.avp;

import net.java.slee.resource.diameter.base.events.avp.GroupedAvp;

/**
 * <pre>
 *  <b>8.30. G-S-U-Pool-Reference AVP</b>
 * 
 * 
 *   The G-S-U-Pool-Reference AVP (AVP Code 457) is of type Grouped.  It
 *   is used in the Credit-Control-Answer message, and associates the
 *   Granted-Service-Unit AVP within which it appears with a credit pool
 *   within the session.
 * 
 *   The G-S-U-Pool-Identifier AVP specifies the credit pool from which
 *   credit is drawn for this unit type.
 * 
 *   The CC-Unit-Type AVP specifies the type of units for which credit is
 *   pooled.
 * 
 *   The Unit-Value AVP specifies the multiplier, which converts between
 *   service units of type CC-Unit-Type and abstract service units within
 *   the credit pool (and thus to service units of any other service or
 *   rating group associated with the same pool).
 * 
 *   The G-S-U-Pool-Reference AVP is defined as follows (per the grouped-
 *   avp-def of RFC 3588 [DIAMBASE]):
 * 
 *      G-S-U-Pool-Reference    ::= < AVP Header: 457 >
 *                                  { G-S-U-Pool-Identifier }
 *                                  { CC-Unit-Type }
 *                                  { Unit-Value }
 * </pre>
 *      
 * @author <a href="mailto:baranowb@gmail.com"> Bartosz Baranowski </a>
 * @author <a href="mailto:brainslog@gmail.com"> Alexandre Mendonca </a>
 */
public interface GSUPoolReferenceAvp extends GroupedAvp {
  /**
   * Returns the value of the CC-Unit-Type AVP, of type Enumerated. <br>
   * See: {@link CcUnitType}.
   * 
   * @return
   */
  CcUnitType getCreditControlUnitType();

  /**
   * Returns the value of the G-S-U-Pool-Identifier AVP, of type Unsigned32.
   * 
   * @return
   */
  long getGSUPoolIdentifier();

  /**
   * Returns the value of the Unit-Value AVP, of type Grouped.
   * 
   * @return
   */
  UnitValueAvp getUnitValue();

  /**
   * Returns true if the CC-Unit-Type AVP is present in the message.
   * 
   * @return
   */
  boolean hasCreditControlUnitType();

  /**
   * Returns true if the G-S-U-Pool-Identifier AVP is present in the message.
   * 
   * @return
   */
  boolean hasGSUPoolIdentifier();

  /**
   * Returns true if the Unit-Value AVP is present in the message.
   * 
   * @return
   */
  boolean hasUnitValue();

  /**
   * Sets the value of the CC-Unit-Type AVP, of type Enumerated. <br>
   * See: {@link CcUnitType}.
   * 
   * @param ccUnitType
   */
  void setCreditControlUnitType(CcUnitType ccUnitType);

  /**
   * Sets the value of the G-S-U-Pool-Identifier AVP, of type Unsigned32.
   * 
   * @param gsuPoolIdentifier
   */
  void setGSUPoolIdentifier(long gsuPoolIdentifier);

  /**
   * Sets the value of the Unit-Value AVP, of type Grouped. <br>
   * See
   * 
   * @param unitValue
   */
  void setUnitValue(UnitValueAvp unitValue);

}