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.
- Grouped
- Alphabetic
- By Inheritance
- AuxiliaryAgreement
- Element
- Product
- Equals
- Cloneable
- Cloneable
- Row
- Serializable
- Serializable
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Instance Constructors
-
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
-
final
def
!=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
##(): Int
- Definition Classes
- AnyRef → Any
-
final
def
==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- val Agreement: Agreement
- val AuxiliaryAccounts: List[String]
- val CustomerAgreement: String
-
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
-
def
anyNull: Boolean
- Definition Classes
- Row
-
def
apply(i: Int): Any
- Definition Classes
- Row
- val arrearsInterest: Double
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
- val auxCycle: String
- val auxPriorityCode: String
-
def
baseclass: String
This class name.
-
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
-
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
-
def
clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native() @HotSpotIntrinsicCandidate()
-
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
-
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
<cim:Location.CoordinateSystem rdf:resource="#wgs84"/>
Example: -
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
<cim:IdentifiedObject.name>WGS 84</cim:IdentifiedObject.name>
Example: -
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
equals(o: Any): Boolean
- Definition Classes
- Row → AnyRef → Any
-
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
- AuxiliaryAgreement → Element
-
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
- AuxiliaryAgreement → Element
-
def
fieldIndex(name: String): Int
- Definition Classes
- Row
- val fixedAmount: Double
-
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
-
def
getAs[T](fieldName: String): T
- Definition Classes
- Row
-
def
getAs[T](i: Int): T
- Definition Classes
- Row
-
def
getBoolean(i: Int): Boolean
- Definition Classes
- Row
-
def
getByte(i: Int): Byte
- Definition Classes
- Row
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
-
def
getDate(i: Int): Date
- Definition Classes
- Row
-
def
getDecimal(i: Int): BigDecimal
- Definition Classes
- Row
-
def
getDouble(i: Int): Double
- Definition Classes
- Row
-
def
getFloat(i: Int): Float
- Definition Classes
- Row
-
def
getInstant(i: Int): Instant
- Definition Classes
- Row
-
def
getInt(i: Int): Int
- Definition Classes
- Row
-
def
getJavaMap[K, V](i: Int): Map[K, V]
- Definition Classes
- Row
-
def
getList[T](i: Int): List[T]
- Definition Classes
- Row
-
def
getLocalDate(i: Int): LocalDate
- Definition Classes
- Row
-
def
getLong(i: Int): Long
- Definition Classes
- Row
-
def
getMap[K, V](i: Int): Map[K, V]
- Definition Classes
- Row
-
def
getSeq[T](i: Int): Seq[T]
- Definition Classes
- Row
-
def
getShort(i: Int): Short
- Definition Classes
- Row
-
def
getString(i: Int): String
- Definition Classes
- Row
-
def
getStruct(i: Int): Row
- Definition Classes
- Row
-
def
getTimestamp(i: Int): Timestamp
- Definition Classes
- Row
-
def
getValuesMap[T](fieldNames: Seq[String]): Map[String, T]
- Definition Classes
- Row
-
def
hashCode(): Int
- Definition Classes
- Row → AnyRef → Any
-
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
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
-
def
isNullAt(i: Int): Boolean
- Definition Classes
- Row
-
def
json: String
- Definition Classes
- Row
- Annotations
- @Unstable()
-
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
-
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
- val minAmount: Double
-
def
mkString(start: String, sep: String, end: String): String
- Definition Classes
- Row
-
def
mkString(sep: String): String
- Definition Classes
- Row
-
def
mkString: String
- Definition Classes
- Row
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- val payCycle: String
-
def
prettyJson: String
- Definition Classes
- Row
- Annotations
- @Unstable()
-
def
schema: StructType
- Definition Classes
- Row
-
def
size: Int
- Definition Classes
- Row
- val subType: String
-
def
sup: Agreement
Return the superclass object.
Return the superclass object.
- returns
The typed superclass nested object.
- Definition Classes
- AuxiliaryAgreement → Element
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
def
toSeq: Seq[Any]
- Definition Classes
- Row
-
def
toString(): String
- Definition Classes
- Row → AnyRef → Any
- val vendPortion: Double
- val vendPortionArrear: Double
-
final
def
wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native()
-
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
Deprecated Value Members
-
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.