Package org.labkey.remoteapi.domain

Class PropertyDescriptor

java.lang.Object

org.labkey.remoteapi.ResponseObject

org.labkey.remoteapi.domain.PropertyDescriptor

public class PropertyDescriptor
extends ResponseObject

Field Summary

Fields inherited from class org.labkey.remoteapi.ResponseObject

_allProperties

Constructor Summary

Constructors

Constructor	Description
PropertyDescriptor()
PropertyDescriptor(String name, String rangeURI)
PropertyDescriptor(String name, String label, String rangeURI)
PropertyDescriptor(org.json.JSONObject json)

Method Summary

Modifier and Type	Method	Description
List<ConditionalFormat>	getConditionalFormats()
String	getDerivationDataScope()
String	getDescription()
Boolean	getDimension()
String	getFormat()
Boolean	getHidden()
String	getLabel()
Boolean	getMeasure()
Boolean	getMvEnabled()
String	getName()
String	getPHI()
Long	getPropertyId()
String	getPropertyURI()
String	getRangeURI()
Boolean	getRequired()
PropertyDescriptor	setConditionalFormats(List<ConditionalFormat> conditionalFormats)
void	setDerivationDataScope(String derivationDataScope)
PropertyDescriptor	setDescription(String description)
PropertyDescriptor	setDimension(Boolean dimension)
PropertyDescriptor	setFormat(String format)
PropertyDescriptor	setHidden(Boolean hidden)
PropertyDescriptor	setLabel(String label)
PropertyDescriptor	setLookup(String schema, String query, String container)	Convenience function for creating lookups
PropertyDescriptor	setMeasure(Boolean measure)
PropertyDescriptor	setMvEnabled(Boolean mvEnabled)
void	setName(String name)
PropertyDescriptor	setPHI(String PHI)
PropertyDescriptor	setPropertyId(Long propertyId)
PropertyDescriptor	setPropertyURI(String propertyURI)
PropertyDescriptor	setRangeURI(String rangeURI)
PropertyDescriptor	setRequired(Boolean required)
org.json.JSONObject	toJSONObject()
org.json.JSONObject	toJSONObject(boolean forProtocol)

Methods inherited from class org.labkey.remoteapi.ResponseObject

getAllProperties

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

PropertyDescriptor

public PropertyDescriptor()

PropertyDescriptor

public PropertyDescriptor(String name,
 String rangeURI)

PropertyDescriptor

public PropertyDescriptor(String name,
 String label,
 String rangeURI)

PropertyDescriptor

public PropertyDescriptor(org.json.JSONObject json)

Method Details

toJSONObject

public org.json.JSONObject toJSONObject()

toJSONObject

public org.json.JSONObject toJSONObject(boolean forProtocol)

setLookup

public PropertyDescriptor setLookup(String schema,
 String query,
 String container)

Convenience function for creating lookups

Parameters:

schema - the schema for the lookup

query - the query for the lookup

container - set to null for current folder

Returns:

property descriptor for the lookup in the given container for the given schema and query

getName

public String getName()

setName

public void setName(String name)

getLabel

public String getLabel()

setLabel

public PropertyDescriptor setLabel(String label)

getDescription

public String getDescription()

setDescription

public PropertyDescriptor setDescription(String description)

getHidden

public Boolean getHidden()

setHidden

public PropertyDescriptor setHidden(Boolean hidden)

getRequired

public Boolean getRequired()

setRequired

public PropertyDescriptor setRequired(Boolean required)

getPHI

public String getPHI()

setPHI

public PropertyDescriptor setPHI(String PHI)

getPropertyId

public Long getPropertyId()

setPropertyId

public PropertyDescriptor setPropertyId(Long propertyId)

getFormat

public String getFormat()

setFormat

public PropertyDescriptor setFormat(String format)

getMeasure

public Boolean getMeasure()

setMeasure

public PropertyDescriptor setMeasure(Boolean measure)

getDimension

public Boolean getDimension()

setDimension

public PropertyDescriptor setDimension(Boolean dimension)

getPropertyURI

public String getPropertyURI()

setPropertyURI

public PropertyDescriptor setPropertyURI(String propertyURI)

getRangeURI

public String getRangeURI()

setRangeURI

public PropertyDescriptor setRangeURI(String rangeURI)

getMvEnabled

public Boolean getMvEnabled()

setMvEnabled

public PropertyDescriptor setMvEnabled(Boolean mvEnabled)

setConditionalFormats

public PropertyDescriptor setConditionalFormats(List<ConditionalFormat> conditionalFormats)

getConditionalFormats

public List<ConditionalFormat> getConditionalFormats()

getDerivationDataScope

public String getDerivationDataScope()

setDerivationDataScope

public void setDerivationDataScope(String derivationDataScope)