Class LABKEY.Domain.DomainDesign
DomainDesign static class to describe the shape and fields of a domain. The LABKEY.Domain
'get' and 'set' methods employ DomainDesign.
Defined in: Domain.js.
Constructor Attributes | Constructor Name and Description |
---|---|
Field Attributes | Field Name and Description |
---|---|
description
The description of this domain.
|
|
The uinque ID of this domain.
|
|
The URI of this domain.
|
|
An array of objects that each describe a domain field.
|
|
name
The name of this domain.
|
Field Detail
{String}
description
The description of this domain.
{Integer}
domainId
The uinque ID of this domain.
{String}
domainURI
The URI of this domain.
{Object}
fields
An array of objects that each describe a domain field. Each object has the following properties:
- propertyId: The unique ID of this field. (integer)
- propertyURI: The URI of this field. (string)
- ontologyURI: The URI of the ontology this field belongs to. (string)
- name: The name of this field. (string)
- description: The description of this field (may be blank). (string)
- rangeURI: The URI for this field's range definition. (string)
- conceptURI: The URI of this field's concept. (string)
- label: The friendly label for this field. (string)
- searchTerms: The search terms for this field. (string)
- semanticType: The semantic type of this field. (string)
- format: The format string defined for this field. (string)
- required: Indicates whether this field is required to have a value (i.e. cannot be null). (boolean)
- lookupContainer: If this domain field is a lookup, this holds the container in which to look. (string)
- lookupSchema: If this domain field is a lookup, this holds the schema in which to look. (string)
- lookupQuery: if this domain field is a lookup, this holds the query in which to look. (string)
{String}
name
The name of this domain.