Patient Cloud AppConnect Android API References
Public Member Functions | Protected Member Functions | List of all members
com.mdsol.babbage.model.Form

Inherits com.mdsol.babbage.model.DatastoreRelation.

Public Member Functions

native boolean canResume ()
 
native boolean equals (Object other)
 
native Date getCloseAt ()
 
native Date getCompletedAt ()
 
native Date getDueAt ()
 
native List< FieldgetFields ()
 
native String getFolderOID ()
 
native int getFolderOrdinal ()
 
native String getFormOID ()
 
native long getID ()
 
native Date getLastSynchronizedAt ()
 
native String getLastSyncMessage ()
 
native boolean getLastSyncSuccess ()
 
native Form getMostRecentAnytimeCompletion ()
 
native String getName ()
 
native Date getOpenAt ()
 
native Subject getParentSubject ()
 
native String getSignatureLabel ()
 
native Date getStartedAt ()
 
native String getUUID ()
 
native boolean isAnytime ()
 
native boolean isSignatureRequired ()
 
native boolean isSigned ()
 
native void setLastSynchronizedAt (Date newLastSynchronized)
 
native void setLastSyncMessage (String newLastSyncstatus)
 
native void setLastSyncSuccess (boolean success)
 
boolean sign (String signedPassword)
 
- Public Member Functions inherited from com.mdsol.babbage.model.DatastoreRelation
Datastore getDatastore ()
 

Protected Member Functions

void finalize ()
 

Additional Inherited Members

- Protected Attributes inherited from com.mdsol.babbage.model.DatastoreRelation
long mNativeObject
 

Detailed Description

The Form class represents a Medidata Rave EDC form. Once completed, you can submit forms to Rave.

Member Function Documentation

native boolean com.mdsol.babbage.model.Form.canResume ( )

Boolean indicating whether users can continue filling in form.

Returns
"Can resume" boolean.
native boolean com.mdsol.babbage.model.Form.equals ( Object  other)

Overrides objects' 'equal to' operator.

void com.mdsol.babbage.model.Form.finalize ( )
protected
native Date com.mdsol.babbage.model.Form.getCloseAt ( )

Gets the closing date of the time window for when users can no longer fill out the form.

Returns
Time window closing date if it exists. Otherwise null.
native Date com.mdsol.babbage.model.Form.getCompletedAt ( )

Gets the date when subjects completed the form.

Returns
Date when form was completed. If the date is not set, returns a null Date reference.
native Date com.mdsol.babbage.model.Form.getDueAt ( )

Gets the date when form is due.

Returns
Date when form is due. If the date is not set, returns a null Date reference.
native List<Field> com.mdsol.babbage.model.Form.getFields ( )

Returns lists of com.mdsol.babbage.model.Field objects in forms.

Returns
List of fields.
native String com.mdsol.babbage.model.Form.getFolderOID ( )

Returns folders' object identifier (OID) as they are assigned in Medidata Rave EDC where the folder exists.

Returns
Folder object identifier (OID).
native int com.mdsol.babbage.model.Form.getFolderOrdinal ( )

Returns folder ordinal for the host folder.

Returns
Folder ordinal.
native String com.mdsol.babbage.model.Form.getFormOID ( )

Returns form's object identifier (OID) as they are assigned in Medidata Rave EDC where the form exists.

Returns
Form object identifier (OID).
native long com.mdsol.babbage.model.Form.getID ( )

Gets unique form identifiers in the local storage database.

Returns
Form identifier.
native Date com.mdsol.babbage.model.Form.getLastSynchronizedAt ( )

Gets the date when the form was last synced.

Returns
the date when the form was last synced.
native String com.mdsol.babbage.model.Form.getLastSyncMessage ( )
native boolean com.mdsol.babbage.model.Form.getLastSyncSuccess ( )
native Form com.mdsol.babbage.model.Form.getMostRecentAnytimeCompletion ( )

Retrieve the most recent completion of an Anytime form. Returns a null form reference if the form is not an Anytime form or if the Anytime form has never been completed.

Returns
The most recently completed instance of this Anytime form.
native String com.mdsol.babbage.model.Form.getName ( )
native Date com.mdsol.babbage.model.Form.getOpenAt ( )

Gets the opening date of the time window for filling out the form.

Returns
Time window opening date if it exists. Otherwise null.
native Subject com.mdsol.babbage.model.Form.getParentSubject ( )

Returns form's parent com.mdsol.babbage.model.Subject object.

Returns
Form's parent subject object.
native String com.mdsol.babbage.model.Form.getSignatureLabel ( )

Gets prompts to display when you ask the user to sign form.

Returns
Signature labels.
native Date com.mdsol.babbage.model.Form.getStartedAt ( )

Gets the date when subjects started the form.

Returns
Date when subjects started the form. Otherwise, if the date is not set, returns a null Date reference.
native String com.mdsol.babbage.model.Form.getUUID ( )

Returns the form's universally unique identifier (UUID) as they exist in Rave EDC.

Returns
Universally unique identifier (UUID).
native boolean com.mdsol.babbage.model.Form.isAnytime ( )

Returns whether the form is an Anytime form.

Returns
whether the form is an Anytime form.
native boolean com.mdsol.babbage.model.Form.isSignatureRequired ( )

Gets whether form require a signature before they can be submitted.

Returns
Whether signatures are required.
native boolean com.mdsol.babbage.model.Form.isSigned ( )

Gets whether form is signed successfully.

Returns
Whether signatures are valid.
native void com.mdsol.babbage.model.Form.setLastSynchronizedAt ( Date  newLastSynchronized)

Sets the date when the form was last synched.

Exceptions
IllegalArgumentExceptionfor invalid input dates.
native void com.mdsol.babbage.model.Form.setLastSyncMessage ( String  newLastSyncstatus)
native void com.mdsol.babbage.model.Form.setLastSyncSuccess ( boolean  success)
boolean com.mdsol.babbage.model.Form.sign ( String  signedPassword)

Signs form by providing users' passwords as proof of identity.

Parameters
signedPasswordUsers' passwords.
Returns
Whether signatures are valid.