Packages

final case class AuxiliaryAgreement(Agreement: Agreement = null, arrearsInterest: Double = 0.0, auxCycle: String = null, auxPriorityCode: String = null, fixedAmount: Double = 0.0, minAmount: Double = 0.0, payCycle: String = null, subType: String = null, vendPortion: Double = 0.0, vendPortionArrear: Double = 0.0, AuxiliaryAccounts: List[String] = null, CustomerAgreement: String = null) extends Element with Product with Serializable

An ad-hoc auxiliary account agreement associated with a customer agreement, not part of the customer's account, but typically subject to formal agreement between customer and supplier (utility).

Typically this is used to collect revenue owed by the customer for other services or arrears accrued with the utility for other services. It is typically linked to a prepaid token purchase transaction, thus forcing the customer to make a payment towards settlement of the auxiliary account balance whenever the customer needs to purchase a prepaid token for electricity. The present status of the auxiliary agreement can be defined in the context of the utility's business rules, for example: enabled, disabled, pending, over recovered, under recovered, written off, etc.

Agreement

Agreement Reference to the superclass object.

arrearsInterest

The interest per annum to be charged prorata on 'AuxiliaryAccount.dueArrears' at the end of each 'payCycle'.

auxCycle

The frequency for automatically recurring auxiliary charges, where 'AuxiliaryAccount.initialCharge' is recursively added to 'AuxiliaryAccount.dueCurrent' at the start of each 'auxCycle'. For example: on a specified date and time; hourly; daily; weekly; monthly; 3-monthly; 6-monthly; 12-monthly; etc.

auxPriorityCode

The coded priority indicating the priority that this auxiliary agreement has above other auxiliary agreements (associated with the same customer agreement) when it comes to competing for settlement from a payment transaction or token purchase.

fixedAmount

The fixed amount that has to be collected from each vending transaction towards settlement of this auxiliary agreement. Note that there may be multiple tokens vended per vending transaction, but this is not relevant.

minAmount

The minimum amount that has to be paid at any transaction towards settling this auxiliary agreement or reducing the balance.

payCycle

The contractually expected payment frequency (by the customer). Examples are: ad-hoc; on specified date; hourly, daily, weekly, monthly. etc.

subType

Sub-classification of the inherited 'type' for this AuxiliaryAgreement.

vendPortion

The percentage of the transaction amount that has to be collected from each vending transaction towards settlement of this auxiliary agreement when payments are not in arrears. Note that there may be multiple tokens vended per vending transaction, but this is not relevant.

vendPortionArrear

The percentage of the transaction amount that has to be collected from each vending transaction towards settlement of this auxiliary agreement when payments are in arrears. Note that there may be multiple tokens vended per vending transaction, but this is not relevant.

AuxiliaryAccounts

AuxiliaryAccount All auxiliary accounts regulated by this agreement.

CustomerAgreement

CustomerAgreement Customer agreement this (non-service related) auxiliary agreement refers to.

Linear Supertypes
Element, Product, Equals, Cloneable, Cloneable, Row, Serializable, Serializable, AnyRef, Any
Ordering
  1. Grouped
  2. Alphabetic
  3. By Inheritance
Inherited
  1. AuxiliaryAgreement
  2. Element
  3. Product
  4. Equals
  5. Cloneable
  6. Cloneable
  7. Row
  8. Serializable
  9. Serializable
  10. AnyRef
  11. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new AuxiliaryAgreement(Agreement: Agreement = null, arrearsInterest: Double = 0.0, auxCycle: String = null, auxPriorityCode: String = null, fixedAmount: Double = 0.0, minAmount: Double = 0.0, payCycle: String = null, subType: String = null, vendPortion: Double = 0.0, vendPortionArrear: Double = 0.0, AuxiliaryAccounts: List[String] = null, CustomerAgreement: String = null)

    Agreement

    Agreement Reference to the superclass object.

    arrearsInterest

    The interest per annum to be charged prorata on 'AuxiliaryAccount.dueArrears' at the end of each 'payCycle'.

    auxCycle

    The frequency for automatically recurring auxiliary charges, where 'AuxiliaryAccount.initialCharge' is recursively added to 'AuxiliaryAccount.dueCurrent' at the start of each 'auxCycle'. For example: on a specified date and time; hourly; daily; weekly; monthly; 3-monthly; 6-monthly; 12-monthly; etc.

    auxPriorityCode

    The coded priority indicating the priority that this auxiliary agreement has above other auxiliary agreements (associated with the same customer agreement) when it comes to competing for settlement from a payment transaction or token purchase.

    fixedAmount

    The fixed amount that has to be collected from each vending transaction towards settlement of this auxiliary agreement. Note that there may be multiple tokens vended per vending transaction, but this is not relevant.

    minAmount

    The minimum amount that has to be paid at any transaction towards settling this auxiliary agreement or reducing the balance.

    payCycle

    The contractually expected payment frequency (by the customer). Examples are: ad-hoc; on specified date; hourly, daily, weekly, monthly. etc.

    subType

    Sub-classification of the inherited 'type' for this AuxiliaryAgreement.

    vendPortion

    The percentage of the transaction amount that has to be collected from each vending transaction towards settlement of this auxiliary agreement when payments are not in arrears. Note that there may be multiple tokens vended per vending transaction, but this is not relevant.

    vendPortionArrear

    The percentage of the transaction amount that has to be collected from each vending transaction towards settlement of this auxiliary agreement when payments are in arrears. Note that there may be multiple tokens vended per vending transaction, but this is not relevant.

    AuxiliaryAccounts

    AuxiliaryAccount All auxiliary accounts regulated by this agreement.

    CustomerAgreement

    CustomerAgreement Customer agreement this (non-service related) auxiliary agreement refers to.

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. val Agreement: Agreement
  5. val AuxiliaryAccounts: List[String]
  6. val CustomerAgreement: String
  7. def about: Boolean

    Flag for rdf:about elements.

    Flag for rdf:about elements.

    returns

    true if this is an rdf:about element, false otherwise.

    Definition Classes
    Element
  8. def anyNull: Boolean
    Definition Classes
    Row
  9. def apply(i: Int): Any
    Definition Classes
    Row
  10. val arrearsInterest: Double
  11. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  12. val auxCycle: String
  13. val auxPriorityCode: String
  14. def baseclass: String

    This class name.

    This class name.

    returns

    the class name without the package prefixes

    Definition Classes
    Element
  15. val bitfields: Array[Int]

    Valid fields bitmap.

    Valid fields bitmap.

    One (1) in a bit position means that field was found in parsing, zero means it has an indeterminate value. Field order is specified by the fields array.

    For classes constructed manually, we initially fill this in with the worst case scenario. ToDo: this won't work for classes with more than 128 fields (so far none).

    Definition Classes
    Element
  16. def classes: Seq[String]

    This class and the hierarchical list of classes this class derives from.

    This class and the hierarchical list of classes this class derives from.

    returns

    the list of classes without the package prefixes.

    Definition Classes
    Element
  17. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native() @HotSpotIntrinsicCandidate()
  18. def copy(): Row

    Return a copy of this object as a Row.

    Return a copy of this object as a Row.

    Creates a clone of this object for use in Row manipulations.

    returns

    The copy of the object.

    Definition Classes
    AuxiliaryAgreement → Row
  19. def emit_attribute(field: String, value: Any)(implicit clz: String, s: StringBuilder): Unit

    Emit one XML attribute.

    Emit one XML attribute.

    field

    The name of the field.

    value

    The value of the field.

    clz

    The class name (e.g. ACLineSegment) of this element

    s

    The builder to write into.

    Definition Classes
    Element
    Example:
    1. <cim:Location.CoordinateSystem rdf:resource="#wgs84"/>

  20. def emit_element(field: String, value: Any)(implicit clz: String, s: StringBuilder): Unit

    Emit one XML element.

    Emit one XML element.

    field

    The name of the field.

    value

    The value of the field.

    clz

    The class name (e.g. ACLineSegment) of this element

    s

    The builder to write into.

    Definition Classes
    Element
    Example:
    1. <cim:IdentifiedObject.name>WGS 84</cim:IdentifiedObject.name>

  21. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  22. def equals(o: Any): Boolean
    Definition Classes
    Row → AnyRef → Any
  23. def export: String

    Return a string containing this object as XML.

    Return a string containing this object as XML.

    returns

    The XML corresponding to this object.

    Definition Classes
    AuxiliaryAgreementElement
  24. def export_fields: String

    Return a string containing the fields of this object suitable for inclusion in an XML object.

    Return a string containing the fields of this object suitable for inclusion in an XML object.

    returns

    A string with the fields coded in XML

    Definition Classes
    AuxiliaryAgreementElement
  25. def fieldIndex(name: String): Int
    Definition Classes
    Row
  26. val fixedAmount: Double
  27. def get(i: Int): AnyRef

    Get the value of the field at index i.

    Get the value of the field at index i.

    i

    The index of the field desired.

    returns

    The value stored in the field, or null if none.

    Definition Classes
    Element → Row
  28. def getAs[T](fieldName: String): T
    Definition Classes
    Row
  29. def getAs[T](i: Int): T
    Definition Classes
    Row
  30. def getBoolean(i: Int): Boolean
    Definition Classes
    Row
  31. def getByte(i: Int): Byte
    Definition Classes
    Row
  32. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  33. def getDate(i: Int): Date
    Definition Classes
    Row
  34. def getDecimal(i: Int): BigDecimal
    Definition Classes
    Row
  35. def getDouble(i: Int): Double
    Definition Classes
    Row
  36. def getFloat(i: Int): Float
    Definition Classes
    Row
  37. def getInstant(i: Int): Instant
    Definition Classes
    Row
  38. def getInt(i: Int): Int
    Definition Classes
    Row
  39. def getJavaMap[K, V](i: Int): Map[K, V]
    Definition Classes
    Row
  40. def getList[T](i: Int): List[T]
    Definition Classes
    Row
  41. def getLocalDate(i: Int): LocalDate
    Definition Classes
    Row
  42. def getLong(i: Int): Long
    Definition Classes
    Row
  43. def getMap[K, V](i: Int): Map[K, V]
    Definition Classes
    Row
  44. def getSeq[T](i: Int): Seq[T]
    Definition Classes
    Row
  45. def getShort(i: Int): Short
    Definition Classes
    Row
  46. def getString(i: Int): String
    Definition Classes
    Row
  47. def getStruct(i: Int): Row
    Definition Classes
    Row
  48. def getTimestamp(i: Int): Timestamp
    Definition Classes
    Row
  49. def getValuesMap[T](fieldNames: Seq[String]): Map[String, T]
    Definition Classes
    Row
  50. def hashCode(): Int
    Definition Classes
    Row → AnyRef → Any
  51. def id: String

    Return the unique ID for the object, the mRID for IdentifiedObject derived classes.

    Return the unique ID for the object, the mRID for IdentifiedObject derived classes.

    returns

    The object ID.

    Definition Classes
    Element
  52. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  53. def isNullAt(i: Int): Boolean
    Definition Classes
    Row
  54. def json: String
    Definition Classes
    Row
    Annotations
    @Unstable()
  55. def length: Int

    The number of fields in the object definition.

    The number of fields in the object definition.

    returns

    The number of defined fields for use in Row manipulations.

    Definition Classes
    Element → Row
  56. def mask(position: Int): Boolean

    Is a field present predicate.

    Is a field present predicate.

    Determines if the field at the given position was encountered while parsing.

    position

    the field position in the fields array

    returns

    true if the field was parsed, false otherwise.

    Definition Classes
    Element
  57. val minAmount: Double
  58. def mkString(start: String, sep: String, end: String): String
    Definition Classes
    Row
  59. def mkString(sep: String): String
    Definition Classes
    Row
  60. def mkString: String
    Definition Classes
    Row
  61. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  62. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  63. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  64. val payCycle: String
  65. def prettyJson: String
    Definition Classes
    Row
    Annotations
    @Unstable()
  66. def schema: StructType
    Definition Classes
    Row
  67. def size: Int
    Definition Classes
    Row
  68. val subType: String
  69. def sup: Agreement

    Return the superclass object.

    Return the superclass object.

    returns

    The typed superclass nested object.

    Definition Classes
    AuxiliaryAgreementElement
  70. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  71. def toSeq: Seq[Any]
    Definition Classes
    Row
  72. def toString(): String
    Definition Classes
    Row → AnyRef → Any
  73. val vendPortion: Double
  74. val vendPortionArrear: Double
  75. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  76. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  77. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] ) @Deprecated @deprecated
    Deprecated

    (Since version ) see corresponding Javadoc for more information.

Inherited from Element

Inherited from Product

Inherited from Equals

Inherited from Cloneable

Inherited from Cloneable

Inherited from Row

Inherited from Serializable

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Hierarchy

Row

Serialization

Ungrouped