Class LABKEY.Domain.DomainDesign
DomainDesign static class to describe the shape and fields of a domain. The LABKEY.Domain
'getDomainDetails' and 'save' methods employ DomainDesign.
Defined in: Domain.js.
Constructor Attributes | Constructor Name and Description |
---|---|
Field Attributes | Field Name and Description |
---|---|
The description of this domain.
|
|
The unique ID of this domain.
|
|
The URI of this domain.
|
|
An array of objects that each describe a domain field.
|
|
An array of objects that each designate an index upon the domain.
|
|
The name of this domain.
|
Field Detail
{String}
description
The description of this domain.
{Integer}
domainId
The unique 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:
(Note: Not all properties below are expected to have values or will have values. See LABKEY.Domain 'Create' to see minimally required properties when creating a Domain.)
- 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)
- defaultDisplayValue: Default value to display. (string)
- defaultValue: Default value for the field. (string)
- defaultValueType: Default value type for the field. (string)
- hidden: Indicates whether this field is to be hidden or shown in a view. (boolean)
- isPrimaryKey: Indicates whether this field is a Primary Key. (boolean)
- lockType: Set lock level on this field. Expected value should be one of: "NotLocked" (can change all properties, this is default) or "PartiallyLocked" (can't change name and type property) or "FullyLocked" (can't change any of the properties). (string)
- phi: Set PHI level on this field. Expected value should be one of: "NotPhi" (default) or "Limited" or "PHI" or "Restricted". (string)
- scale: Scale for the field. (int)
- shownInDetailsView: Indicates whether this field is to be shown in Details view. (boolean)
- shownInInsertView: Indicates whether this field is to be shown in an Insert view. (boolean)
- shownInUpdateView: Indicates whether this field is to be shown in an Update view. (boolean)
- url: A url associated with this field. (string)
{Object}
indices
An array of objects that each designate an index upon the domain. Each object has the following properties:
- columnNames: An array of strings, where each string is the name of a domain field that will be an index. (array)
- unique: Indicates whether the domain field is allowed to contain any duplicate values. (boolean)
{String}
name
The name of this domain.