com.atomizesoftware.spin.models

UserDefinedFields

trait UserDefinedFields extends AnyRef

Linear Supertypes
AnyRef, Any
Known Subclasses
Cargo, CargoType, Company, Container, ContainerType, Customer, Device, Document, Equipment, Location, Movement, MovementType, Order
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. UserDefinedFields
  2. AnyRef
  3. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract val userDefinedFields: JValue

Concrete 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. final def asInstanceOf[T0]: T0

    Definition Classes
    Any

  5. def checkFieldValueForType(fieldType: String, fieldValue: JValue): Unit

    Checks whether the provided fieldValue can be converted to the provided fieldType.

    Checks whether the provided fieldValue can be converted to the provided fieldType. If the conversion cannot be done an exception is thrown.

    returns

    Unit.

  6. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  7. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  8. def equals(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any

  9. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )

  10. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any

  11. def hashCode(): Int

    Definition Classes
    AnyRef → Any

  12. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any

  13. implicit val jsonFormats: Formats

  14. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  15. final def notify(): Unit

    Definition Classes
    AnyRef

  16. final def notifyAll(): Unit

    Definition Classes
    AnyRef

  17. def parseUserDefinedFieldsJsonToString(lang: String): String

    Parses a userDefinedFields json's label and value into a string

    Parses a userDefinedFields json's label and value into a string

    returns

    a string representation of all the User Defined Fields separated by commas (Label:Value)

  18. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef

  19. def toString(): String

    Definition Classes
    AnyRef → Any

  20. def userDefinedField[A](code: String)(implicit m: Manifest[A]): Option[A]

    Returns the value of the user defined field with the specified code.

    Returns the value of the user defined field with the specified code.

    If a field with the specified code does not exist or has no value None will be returned. If the type of the field and the requested type are not a match None will be returned.

    returns

    the extracted value of the field if successful, None otherwise.

  21. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  22. final def wait(arg0: Long, arg1: Int): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  23. final def wait(arg0: Long): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  24. def withField(code: String, value: Any, definitions: JValue): JValue

    Updates the value of the userDefinedField with the specified code.

    Updates the value of the userDefinedField with the specified code.

    If the current userDefinedFields do not have the specified field code we check the definitions to see if it is registered. If it is we update the value of the definition and add it to the returned userDefinedFields.

    returns

    the updated userDefinedFields.

  25. def withFields(codeValues: List[(String, Any)], definitions: JValue): JValue

    Updates the userDefinedFields and sets the value of the fields with the specified code.

    Updates the userDefinedFields and sets the value of the fields with the specified code.

    returns

    the updated userDefinedFields

Inherited from AnyRef

Inherited from Any

Ungrouped