Packages

final case class ServiceGuarantee(Document: Document = null, applicationPeriod: String = null, automaticPay: Boolean = false, payAmount: Double = 0.0, serviceRequirement: String = null) extends Element with Product with Serializable

A service guarantee, often imposed by a regulator, defines conditions that, if not satisfied, will result in the utility making a monetary payment to the customer.

Note that guarantee's identifier is in the 'name' attribute and the status of the guarantee is in the 'Status.status' attribute. Example service requirements include: 1) If power is not restored within 24 hours, customers can claim $50 for residential customers or $100 for commercial and industrial customers. In addition for each extra period of 12 hours the customer's supply has not been activated, the customer can claim $25. 2) If a customer has a question about their electricity bill, the utility will investigate and respond to the inquiry within 15 working days. If utility fails to meet its guarantee, utility will automatically pay the customer $50.

Document

Document Reference to the superclass object.

applicationPeriod

Period in which this service guantee applies.

automaticPay

True if utility must autmatically pay the specified amount whenever the condition is not satisified, otherwise customer must make a claim to receive payment.

payAmount

Amount to be paid by the service provider to the customer for each violation of the 'serviceRequirement'.

serviceRequirement

Explanation of the requirement and conditions for satisfying it.

Linear Supertypes
Element, Product, Equals, Cloneable, Cloneable, Row, Serializable, Serializable, AnyRef, Any
Ordering
  1. Grouped
  2. Alphabetic
  3. By Inheritance
Inherited
  1. ServiceGuarantee
  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 ServiceGuarantee(Document: Document = null, applicationPeriod: String = null, automaticPay: Boolean = false, payAmount: Double = 0.0, serviceRequirement: String = null)

    Document

    Document Reference to the superclass object.

    applicationPeriod

    Period in which this service guantee applies.

    automaticPay

    True if utility must autmatically pay the specified amount whenever the condition is not satisified, otherwise customer must make a claim to receive payment.

    payAmount

    Amount to be paid by the service provider to the customer for each violation of the 'serviceRequirement'.

    serviceRequirement

    Explanation of the requirement and conditions for satisfying it.

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 Document: Document
  5. 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
  6. def anyNull: Boolean
    Definition Classes
    Row
  7. val applicationPeriod: String
  8. def apply(i: Int): Any
    Definition Classes
    Row
  9. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  10. val automaticPay: Boolean
  11. def baseclass: String

    This class name.

    This class name.

    returns

    the class name without the package prefixes

    Definition Classes
    Element
  12. 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
  13. 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
  14. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native() @HotSpotIntrinsicCandidate()
  15. 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
    ServiceGuarantee → Row
  16. 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"/>

  17. 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>

  18. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  19. def equals(o: Any): Boolean
    Definition Classes
    Row → AnyRef → Any
  20. 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
    ServiceGuarantee → Element
  21. 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
    ServiceGuarantee → Element
  22. def fieldIndex(name: String): Int
    Definition Classes
    Row
  23. 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
  24. def getAs[T](fieldName: String): T
    Definition Classes
    Row
  25. def getAs[T](i: Int): T
    Definition Classes
    Row
  26. def getBoolean(i: Int): Boolean
    Definition Classes
    Row
  27. def getByte(i: Int): Byte
    Definition Classes
    Row
  28. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  29. def getDate(i: Int): Date
    Definition Classes
    Row
  30. def getDecimal(i: Int): BigDecimal
    Definition Classes
    Row
  31. def getDouble(i: Int): Double
    Definition Classes
    Row
  32. def getFloat(i: Int): Float
    Definition Classes
    Row
  33. def getInstant(i: Int): Instant
    Definition Classes
    Row
  34. def getInt(i: Int): Int
    Definition Classes
    Row
  35. def getJavaMap[K, V](i: Int): Map[K, V]
    Definition Classes
    Row
  36. def getList[T](i: Int): List[T]
    Definition Classes
    Row
  37. def getLocalDate(i: Int): LocalDate
    Definition Classes
    Row
  38. def getLong(i: Int): Long
    Definition Classes
    Row
  39. def getMap[K, V](i: Int): Map[K, V]
    Definition Classes
    Row
  40. def getSeq[T](i: Int): Seq[T]
    Definition Classes
    Row
  41. def getShort(i: Int): Short
    Definition Classes
    Row
  42. def getString(i: Int): String
    Definition Classes
    Row
  43. def getStruct(i: Int): Row
    Definition Classes
    Row
  44. def getTimestamp(i: Int): Timestamp
    Definition Classes
    Row
  45. def getValuesMap[T](fieldNames: Seq[String]): Map[String, T]
    Definition Classes
    Row
  46. def hashCode(): Int
    Definition Classes
    Row → AnyRef → Any
  47. 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
  48. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  49. def isNullAt(i: Int): Boolean
    Definition Classes
    Row
  50. def json: String
    Definition Classes
    Row
    Annotations
    @Unstable()
  51. 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
  52. 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
  53. def mkString(start: String, sep: String, end: String): String
    Definition Classes
    Row
  54. def mkString(sep: String): String
    Definition Classes
    Row
  55. def mkString: String
    Definition Classes
    Row
  56. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  57. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  58. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  59. val payAmount: Double
  60. def prettyJson: String
    Definition Classes
    Row
    Annotations
    @Unstable()
  61. def schema: StructType
    Definition Classes
    Row
  62. val serviceRequirement: String
  63. def size: Int
    Definition Classes
    Row
  64. def sup: Document

    Return the superclass object.

    Return the superclass object.

    returns

    The typed superclass nested object.

    Definition Classes
    ServiceGuarantee → Element
  65. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  66. def toSeq: Seq[Any]
    Definition Classes
    Row
  67. def toString(): String
    Definition Classes
    Row → AnyRef → Any
  68. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  69. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  70. 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