Class Index | File Index

Classes


Class LABKEY.Exp.ExpObject

The experiment object base class describes basic characteristics of a protocol or an experimental run. Many experiment classes (such as LABKEY.Exp.Run, LABKEY.Exp.Data and LABKEY.Exp.Material) are subclasses of ExpObject, so they provide the fields defined by this object (e.g., name, lsid, etc). In a Java representation of these same classes, ExpObject is an abstract class.

Additional Documentation:


Defined in: Experiment.js.

Class Summary
Constructor Attributes Constructor Name and Description
 
This constructor isn't called directly, but is used by derived classes.
Config Summary
Config Attributes Config Name and Description
 
User editable comment.
 
When the ExpObject was created.
 
The person who created the ExpObject.
 
The id of the ExpObject.
 
The LSID of the ExpObject.
 
When the ExpObject was last modified.
 
The person who last modified the ExpObject.
 
The name of the ExpObject.
 
Map of property descriptor names to values.
 
The id of the ExpObject (alias of id property)
Class Detail
LABKEY.Exp.ExpObject(config)
This constructor isn't called directly, but is used by derived classes.
Parameters:
{Object} config Optional
Configuration object.
Config Detail
{String} config.comment
User editable comment.

{Date} config.created
When the ExpObject was created.

{String} config.createdBy
The person who created the ExpObject.

{number} config.id
The id of the ExpObject.

{String} config.lsid
The LSID of the ExpObject.

{Date} config.modified
When the ExpObject was last modified.

{String} config.modifiedBy
The person who last modified the ExpObject.

{String} config.name
The name of the ExpObject.

{Object} config.properties
Map of property descriptor names to values. Most types, such as strings and numbers, are just stored as simple properties. Properties of type FileLink will be returned by the server in the same format as LABKEY.Exp.Data objects (missing many properties such as id and createdBy if they exist on disk but have no row with metadata in the database). FileLink values are accepted from the client in the same way, or a simple value of the following three types: the data's RowId, the data's LSID, or the full path on the server's file system.

{number} config.rowId
The id of the ExpObject (alias of id property)

Documentation generated by JsDoc Toolkit 2.3.2 on Thu Mar 16 2017 20:36:35 GMT-0000 (UTC)