com.atomizesoftware.spin.models

Document

case class Document(id: Long = 1, number: String, documentTypeId: Long, date: github.nscala_time.time.Imports.DateTime, archived: Boolean, notes: Option[String] = None, userId: Long, fieldsToUpdateInDatabase: Seq[String] = Seq(), userDefinedFields: JValue = JNothing, documentType: Option[DocumentType] = None, user: Option[User] = None, files: Option[List[DocumentFile]] = None) extends BaseModel with UserDefinedFields with Product with Serializable

Linear Supertypes
Serializable, Serializable, Product, Equals, UserDefinedFields, BaseModel, AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Document
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. UserDefinedFields
  7. BaseModel
  8. AnyRef
  9. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

  1. new Document(id: Long = 1, number: String, documentTypeId: Long, date: github.nscala_time.time.Imports.DateTime, archived: Boolean, notes: Option[String] = None, userId: Long, fieldsToUpdateInDatabase: Seq[String] = Seq(), userDefinedFields: JValue = JNothing, documentType: Option[DocumentType] = None, user: Option[User] = None, files: Option[List[DocumentFile]] = None)

Type Members

  1. type T = Document

    Definition Classes
    Document → BaseModel

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 allFields: Seq[String]

    Definition Classes
    Document → BaseModel

  5. val archived: Boolean

  6. final def asInstanceOf[T0]: T0

    Definition Classes
    Any

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

    Definition Classes
    UserDefinedFields

  8. def chooseAllFieldsForUpdate: T

    Definition Classes
    BaseModel

  9. def clone(): AnyRef

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

  10. def copy(id: Long = id, number: String = number, documentTypeId: Long = documentTypeId, date: github.nscala_time.time.Imports.DateTime = date, archived: Boolean = archived, notes: Option[String] = notes, userId: Long = userId, fieldsToUpdateInDatabase: Seq[String] = fieldsToUpdateInDatabase, userDefinedFields: JValue = userDefinedFields, documentType: Option[DocumentType] = documentType, user: Option[User] = user, files: Option[List[DocumentFile]] = files): Document

  11. val date: github.nscala_time.time.Imports.DateTime

  12. val documentType: Option[DocumentType]

  13. val documentTypeId: Long

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

    Definition Classes
    AnyRef

  15. def fieldsToTrack(currentValues: Seq[Any], copyValues: Seq[Any], oldFields: Seq[String]): Seq[String]

    Attributes
    protected
    Definition Classes
    BaseModel

  16. val fieldsToUpdateInDatabase: Seq[String]

    Definition Classes
    Document → BaseModel

  17. val files: Option[List[DocumentFile]]

  18. def finalize(): Unit

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

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

    Definition Classes
    AnyRef → Any

  20. val id: Long

  21. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any

  22. implicit val jsonFormats: Formats

    Definition Classes
    UserDefinedFields

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

    Definition Classes
    AnyRef

  24. val notes: Option[String]

  25. final def notify(): Unit

    Definition Classes
    AnyRef

  26. final def notifyAll(): Unit

    Definition Classes
    AnyRef

  27. val number: String

  28. 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)

    Definition Classes
    UserDefinedFields

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

    Definition Classes
    AnyRef

  30. def updateAllFields: Boolean

    Definition Classes
    BaseModel

  31. def updateOnly(fields: Option[Seq[String]] = None): T

    Definition Classes
    BaseModel

  32. def updateThese(fields: Seq[String]): Document

    Definition Classes
    Document → BaseModel

  33. val user: Option[User]

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

    Definition Classes
    UserDefinedFields

  35. val userDefinedFields: JValue

    Definition Classes
    Document → UserDefinedFields

  36. val userId: Long

  37. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  40. def withField(code: String, value: Any)(implicit s: scala.slick.jdbc.JdbcBackend.Session, udfRepo: UserDefinedFieldsRepository): JValue

    Updates the values of the user defined field with the code provided.

    Updates the values of the user defined field with the code provided.

    returns

    the updated user defined fields.

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

    Definition Classes
    UserDefinedFields

  42. def withFields(codeValues: List[(String, Any)])(implicit s: scala.slick.jdbc.JdbcBackend.Session, udfRepo: UserDefinedFieldsRepository): JValue

    Updates the values of the user defined fields with the codes provided.

    Updates the values of the user defined fields with the codes provided.

    returns

    the updated user defined fields.

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

    Definition Classes
    UserDefinedFields

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from UserDefinedFields

Inherited from BaseModel

Inherited from AnyRef

Inherited from Any

Ungrouped