Class Index | File Index

Classes


Class LABKEY.SchemaKey


Extends LABKEY.QueryKey.
SchemaKey identifies a schema path. Use LABKEY.SchemaKey.fromString() or LABKEY.SchemaKey.fromParts() to create new SchemaKey.
Defined in: FieldKey.js.

Class Summary
Constructor Attributes Constructor Name and Description
 
LABKEY.SchemaKey(parent, name)
Method Summary
Method Attributes Method Name and Description
<static>  
LABKEY.SchemaKey.equals(other)
Compares QueryKeys for equality.
<static>  
LABKEY.SchemaKey.fromParts(parts)
Create new SchemaKey from an Array of unencoded SchemaKey string parts.
<static>  
LABKEY.SchemaKey.fromString(str)
Create new SchemaKey from a SchemaKey encoded string with parts separated by '.
<static>  
LABKEY.SchemaKey.getName()
Get the unencoded QueryKey name.
<static>  
LABKEY.SchemaKey.getParts()
Returns an Array of unencoded QueryKey parts.
<static>  
LABKEY.SchemaKey.toDisplayString()
Returns a string suitable for display to the user.
<static>  
LABKEY.SchemaKey.toJSON()
Returns the encoded QueryKey string as the JSON representation of a QueryKey.
 
Returns an encoded SchemaKey string suitable for sending to the server.
Class Detail
LABKEY.SchemaKey(parent, name)
Parameters:
{string} name
The FieldKey's unencoded name.
{LABKEY.SchemaKey} parent
The parent SchemaKey or null.
Method Detail
<static> {boolean} LABKEY.SchemaKey.equals(other)
Compares QueryKeys for equality.
Parameters:
{QueryKey} other
Returns:
{boolean} true if this QueryKey and the other are the same.

<static> {LABKEY.FieldKey} LABKEY.SchemaKey.fromParts(parts)
Create new SchemaKey from an Array of unencoded SchemaKey string parts.
Parameters:
{Array} parts
Array of unencoded SchemaKey string parts.
Returns:
{LABKEY.FieldKey}

<static> {LABKEY.SchemaKey} LABKEY.SchemaKey.fromString(str)
Create new SchemaKey from a SchemaKey encoded string with parts separated by '.' characters.
Parameters:
{string} str
SchemaKey string with SchemaKey encoded parts separated by '.' characters.
Returns:
{LABKEY.SchemaKey}

<static> {string} LABKEY.SchemaKey.getName()
Get the unencoded QueryKey name.
Returns:
{string}

<static> {Array} LABKEY.SchemaKey.getParts()
Returns an Array of unencoded QueryKey parts.
Returns:
{Array} Array of unencoded QueryKey parts.

<static> LABKEY.SchemaKey.toDisplayString()
Returns a string suitable for display to the user.

<static> LABKEY.SchemaKey.toJSON()
Returns the encoded QueryKey string as the JSON representation of a QueryKey. Called by JSON.stringify().

{string} toString()
Returns an encoded SchemaKey string suitable for sending to the server.
Returns:
{string} Encoded SchemaKey string.

Documentation generated by JsDoc Toolkit 2.3.2 on Tue Sep 11 2018 10:11:00 GMT-0000 (UTC)