RedCapServiceWSImpl

Instance Constructors

new RedCapServiceWSImpl(url: String, token: String, ws: WSClient, configuration: Configuration)

Annotations
@Inject()

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

Definition Classes
Any
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
def countRecords: Future[Int]

Count all records in reference field.
Count all records in reference field.
returns
The number of records matching the filter string.

Definition Classes
RedCapServiceWSImpl → RedCapService
Annotations
@Deprecated
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def equals(arg0: Any): Boolean

Definition Classes
AnyRef → Any
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def getExportField(id: String): Future[Seq[JsObject]]

Get the name of the field(s) specified by given id string.
Get the name of the field(s) specified by given id string.
id
String for matching with reference field.
returns
Sequence of field(s) matching id.

Definition Classes
RedCapServiceWSImpl → RedCapService
Annotations
@Deprecated
def getMetadata(id: String): Future[Seq[JsObject]]

Retrieve the metadata matching the filter.
Retrieve the metadata matching the filter.

Definition Classes
RedCapServiceWSImpl → RedCapService
Annotations
@Deprecated
def getRecord(id: String): Future[Seq[JsObject]]

Get the name of the field specified by given id string.
Get the name of the field specified by given id string.
id
String for matching with reference field.
returns
Json representation of matching record.

Definition Classes
RedCapServiceWSImpl → RedCapService
Annotations
@Deprecated
def hashCode(): Int

Definition Classes
AnyRef → Any
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
def listAllRecords: Future[Seq[JsObject]]

Retrieve all the records
Retrieve all the records
returns
Records

Definition Classes
RedCapServiceWSImpl → RedCapService
def listEventRecords(events: Seq[String]): Future[Seq[JsObject]]

List all the records for given events iteratively.
List all the records for given events iteratively.

Definition Classes
RedCapServiceWSImpl → RedCapService
def listEvents: Future[Seq[Event]]

Lists all the events (visits) associated with the study (token).
Lists all the events (visits) associated with the study (token).

Definition Classes
RedCapServiceWSImpl → RedCapService
def listExportFields: Future[Seq[ExportField]]

Create list of all field names.
Create list of all field names. Field names are sorted and filtered if they don't match filter criterion.
returns
Filtered and sorted list of records.

Definition Classes
RedCapServiceWSImpl → RedCapService
def listMetadatas: Future[Seq[Metadata]]

Retrieve all metadata fields matching the filtering criterion and order them according to a reference field.
Retrieve all metadata fields matching the filtering criterion and order them according to a reference field.
returns
Sorted records matching filter criterion.

Definition Classes
RedCapServiceWSImpl → RedCapService
def lock(action: RedCapLockAction.Value, record: String, event: Option[String], instrument: Option[String], instance: Option[Int], projectId: Option[Int]): Future[Seq[LockRecordResponse]]

Lock a given record
Lock a given record

Definition Classes
RedCapServiceWSImpl → RedCapService
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

Definition Classes
AnyRef → Any
final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )

Related Doc: package importers

class RedCapServiceWSImpl extends RedCapService

Instance Constructors

new RedCapServiceWSImpl(url: String, token: String, ws: WSClient, configuration: Configuration)

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

def clone(): AnyRef

def countRecords: Future[Int]

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def finalize(): Unit

final def getClass(): Class[_]

def getExportField(id: String): Future[Seq[JsObject]]

def getMetadata(id: String): Future[Seq[JsObject]]

def getRecord(id: String): Future[Seq[JsObject]]

def hashCode(): Int

final def isInstanceOf[T0]: Boolean

def listAllRecords: Future[Seq[JsObject]]

def listEventRecords(events: Seq[String]): Future[Seq[JsObject]]

def listEvents: Future[Seq[Event]]

def listExportFields: Future[Seq[ExportField]]

def listMetadatas: Future[Seq[Metadata]]

def lock(action: RedCapLockAction.Value, record: String, event: Option[String], instrument: Option[String], instance: Option[Int], projectId: Option[Int]): Future[Seq[LockRecordResponse]]

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

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

def toString(): String

final def wait(): Unit

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

final def wait(arg0: Long): Unit

Inherited from RedCapService

Inherited from AnyRef

Inherited from Any

Ungrouped