com.dslplatform.api.patterns

SearchableRepository

trait SearchableRepository[TSearchable <: Searchable] extends AnyRef

Service for searching and counting domain objects. Search can be performed using Specification specification, paged using limit and offset arguments. Custom sort can be provided using Seq of property->direction pairs.

Specification can be declared in DSL or custom search can be built on client and sent to server.

When permissions are applied, server can restrict which results will be returned to the client. Service should be used when Future is a preferred way of interacting with the remote server.

Linear Supertypes
AnyRef, Any
Known Subclasses
PersistableRepository, Repository
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. SearchableRepository
  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 def count(specification: Option[Specification[TSearchable]]): Future[Long]

    Returns a number of elements satisfying provided specification.

    Returns a number of elements satisfying provided specification.

    specification

    search predicate

    returns

    future to number of domain objects which satisfy specification

  2. abstract def search(specification: Option[Specification[TSearchable]] = None, limit: Option[Int] = None, offset: Option[Int] = None, order: Map[String, Boolean] = Map.empty): Future[Seq[TSearchable]]

    Returns a Seq of domain objects satisfying Specification[TSearchable] specification with up to limit results.

    Returns a Seq of domain objects satisfying Specification[TSearchable] specification with up to limit results. offset can be used to skip initial results. order should be given as a Seq of pairs of where first is a property name and second is whether it should be sorted ascending over this property.

    specification

    search predicate

    limit

    maximum number of results

    offset

    number of results to be skipped

    order

    custom ordering

    returns

    future to domain objects which satisfy search predicate

Concrete Value Members

  1. final def !=(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  2. final def !=(arg0: Any): Boolean

    Definition Classes
    Any

  3. final def ##(): Int

    Definition Classes
    AnyRef → Any

  4. final def ==(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  5. final def ==(arg0: Any): Boolean

    Definition Classes
    Any

  6. final def asInstanceOf[T0]: T0

    Definition Classes
    Any

  7. def clone(): AnyRef

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

  8. def count(specification: Specification[TSearchable]): Future[Long]

    Helper method for counting domain objects.

    Helper method for counting domain objects. Returns a number of elements satisfying provided specification.

    specification

    search predicate

    returns

    future to number of domain objects which satisfy specification

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

    Definition Classes
    AnyRef

  10. def equals(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any

  11. def finalize(): Unit

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

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

    Definition Classes
    AnyRef → Any

  13. def hashCode(): Int

    Definition Classes
    AnyRef → Any

  14. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any

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

    Definition Classes
    AnyRef

  16. final def notify(): Unit

    Definition Classes
    AnyRef

  17. final def notifyAll(): Unit

    Definition Classes
    AnyRef

  18. def search(specification: Specification[TSearchable], limit: Int): Future[Seq[TSearchable]]

    Helper method for searching domain objects.

    Helper method for searching domain objects. Returns a Seq of domain objects satisfying Specification[TSearchable] specification with up to limit results.

    specification

    search predicate

    limit

    maximum number of results

    returns

    future to domain objects which satisfy search predicate

  19. def search(specification: Specification[TSearchable]): Future[Seq[TSearchable]]

    Helper method for searching domain objects.

    Helper method for searching domain objects. Returns a Seq of domain objects satisfying Specification[TSearchable] specification

    specification

    search predicate

    returns

    future to domain objects which satisfy search predicate

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

    Definition Classes
    AnyRef

  21. def toString(): String

    Definition Classes
    AnyRef → Any

  22. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from AnyRef

Inherited from Any

Ungrouped