GlobalProperty (OpenMRS 2.7.0-SNAPSHOT API)

java.lang.Object
- org.openmrs.BaseOpenmrsObject
- - org.openmrs.GlobalProperty

All Implemented Interfaces:

Serializable, CustomValueDescriptor, SingleCustomValue<GlobalProperty>, OpenmrsObject
```
public class GlobalProperty
extends BaseOpenmrsObject
implements CustomValueDescriptor, SingleCustomValue<GlobalProperty>
```
Global properties are simple key-value pairs persisted in the database GPs can be thought of as something similar to environment variables used in operating systems.

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description
`GlobalProperty()` Default empty constructor
`GlobalProperty(String property)` Constructor defining the key for this GP
`GlobalProperty(String property, String value)` Constructor defining the key and value of this GP
`GlobalProperty(String property, String value, String description)` Constructor defining key/value/description for this GP
`GlobalProperty(String property, String value, String description, Class<? extends CustomDatatype<?>> datatypeClass, String datatypeConfig)` Constructor defining key/value/description/customDatatype/datatypeConfig

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`User`	`getChangedBy()`
`String`	`getDatatypeClassname()` Return the name of a class that implements `CustomDatatype`.
`String`	`getDatatypeConfig()` May be null.
`Date`	`getDateChanged()`
`Privilege`	`getDeletePrivilege()` Get privilege which can delete this globalProperty
`String`	`getDescription()`
`GlobalProperty`	`getDescriptor()`
`boolean`	`getDirty()`
`Privilege`	`getEditPrivilege()` Gets privilege which can edit this globalProperty
`String`	`getHandlerConfig()` May be null.
`Integer`	`getId()`
`String`	`getPreferredHandlerClassname()` May be null.
`String`	`getProperty()`
`String`	`getPropertyValue()`
`Object`	`getValue()` Convenience method to get the typed version of the serializedValue.
`String`	`getValueReference()`
`Privilege`	`getViewPrivilege()` Gets privilege which can view this globalProperty
`boolean`	`isDirty()` Deprecated. as of 2.0, use `getDirty()`
`void`	`setChangedBy(User changedBy)`
`void`	`setDatatypeClassname(String datatypeClassname)`
`void`	`setDatatypeConfig(String datatypeConfig)`
`void`	`setDateChanged(Date dateChanged)`
`void`	`setDeletePrivilege(Privilege deletePrivilege)` Sets privilege which can delete this globalProperty
`void`	`setDescription(String description)`
`void`	`setEditPrivilege(Privilege editPrivilege)` Sets privilege which can edit this globalProperty
`void`	`setHandlerConfig(String handlerConfig)`
`void`	`setId(Integer id)`
`void`	`setPreferredHandlerClassname(String preferredHandlerClassname)`
`void`	`setProperty(String property)`
`void`	`setPropertyValue(String propertyValue)`
`<T> void`	`setValue(T typedValue)` Sets the typed value.
`void`	`setValueReferenceInternal(String valueToPersist)` Directly set the String value that OpenMRS should persist in the database in a varchar column.
`void`	`setViewPrivilege(Privilege viewPrivilege)` Sets privilege which can view this globalProperty
`String`	`toString()` Returns a string equal to the value of: ClassName{hashCode=..., uuid=...}

Methods inherited from class org.openmrs.BaseOpenmrsObject
equals, getUuid, hashCode, setUuid

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - GlobalProperty
```
public GlobalProperty()
```
    Default empty constructor
  - GlobalProperty
```
public GlobalProperty(String property)
```
    Constructor defining the key for this GP
    
    Parameters:
    
    property - key to name the property
  - GlobalProperty
```
public GlobalProperty(String property,
                      String value)
```
    Constructor defining the key and value of this GP
    
    Parameters:
    
    property - key to name the property
    
    value - value to give to the property
  - GlobalProperty
```
public GlobalProperty(String property,
                      String value,
                      String description)
```
    Constructor defining key/value/description for this GP
    
    Parameters:
    
    property - key to name the property
    
    value - value to give to the property
    
    description - description of how this property is used
  - GlobalProperty
```
public GlobalProperty(String property,
                      String value,
                      String description,
                      Class<? extends CustomDatatype<?>> datatypeClass,
                      String datatypeConfig)
```
    Constructor defining key/value/description/customDatatype/datatypeConfig
    
    Parameters:
    
    property -
    
    value -
    
    description -
    
    datatypeClass -
    
    datatypeConfig -
    
    Since:
    
    1.9
- Method Detail
  - getProperty
```
public String getProperty()
```
    Returns:
    
    Returns the property.
  - setProperty
```
public void setProperty(String property)
```
    Parameters:
    
    property - The property to set.
  - getPropertyValue
```
public String getPropertyValue()
```
    Returns:
    
    Returns the propertyValue.
  - setPropertyValue
```
public void setPropertyValue(String propertyValue)
```
    Parameters:
    
    propertyValue - The propertyValue to set.
  - getDescription
```
public String getDescription()
```
    Returns:
    
    the description
  - setDescription
```
public void setDescription(String description)
```
    Parameters:
    
    description - the description to set
  - getId
```
public Integer getId()
```
    Specified by:
    
    getId in interface OpenmrsObject
    
    Returns:
    
    id - The unique Identifier for the object
    
    Since:
    
    1.5
    
    See Also:
    
    OpenmrsObject.getId()
  - setId
```
public void setId(Integer id)
```
    Specified by:
    
    setId in interface OpenmrsObject
    
    Parameters:
    
    id - - The unique Identifier for the object
    
    Since:
    
    1.5
    
    See Also:
    
    OpenmrsObject.setId(java.lang.Integer)
  - getDatatypeClassname
```
public String getDatatypeClassname()
```
    Description copied from interface: CustomValueDescriptor
    
    Return the name of a class that implements CustomDatatype.
    
    Specified by:
    
    getDatatypeClassname in interface CustomValueDescriptor
    
    Returns:
    
    the datatype used to store this custom value
    
    Since:
    
    1.9
    
    See Also:
    
    CustomValueDescriptor.getDatatypeClassname()
  - setDatatypeClassname
```
public void setDatatypeClassname(String datatypeClassname)
```
    Parameters:
    
    datatypeClassname - the datatypeClassname to set
    
    Since:
    
    1.9
  - getDatatypeConfig
```
public String getDatatypeConfig()
```
    Description copied from interface: CustomValueDescriptor
    
    May be null.
    
    Specified by:
    
    getDatatypeConfig in interface CustomValueDescriptor
    
    Returns:
    
    the configuration to be passed to the datatype. For example if the datatype is RegexValidatedString the datatypeConfig would be the regular expression
    
    Since:
    
    1.9
    
    See Also:
    
    CustomValueDescriptor.getDatatypeConfig()
  - setDatatypeConfig
```
public void setDatatypeConfig(String datatypeConfig)
```
    Parameters:
    
    datatypeConfig - the datatypeConfig to set
    
    Since:
    
    1.9
  - getPreferredHandlerClassname
```
public String getPreferredHandlerClassname()
```
    Description copied from interface: CustomValueDescriptor
    
    May be null.
    
    Specified by:
    
    getPreferredHandlerClassname in interface CustomValueDescriptor
    
    Returns:
    
    the fully-qualified classname of the preferred CustomDatatypeHandler chosen by the system administrator for this attribute type.
    
    Since:
    
    1.9
    
    See Also:
    
    CustomValueDescriptor.getPreferredHandlerClassname()
  - setPreferredHandlerClassname
```
public void setPreferredHandlerClassname(String preferredHandlerClassname)
```
    Parameters:
    
    preferredHandlerClassname - the preferredHandlerClassname to set
    
    Since:
    
    1.9
  - getHandlerConfig
```
public String getHandlerConfig()
```
    Description copied from interface: CustomValueDescriptor
    
    May be null.
    
    Specified by:
    
    getHandlerConfig in interface CustomValueDescriptor
    
    Returns:
    
    the configuration to be passed to the handler for a datatype. For example if the datatype is "regex-validated-string", the handlerConfig would be the regular expression.
    
    Since:
    
    1.9
    
    See Also:
    
    CustomValueDescriptor.getHandlerConfig()
  - setHandlerConfig
```
public void setHandlerConfig(String handlerConfig)
```
    Parameters:
    
    handlerConfig - the handlerConfig to set
    
    Since:
    
    1.9
  - toString
```
public String toString()
```
    Description copied from class: BaseOpenmrsObject
    
    Returns a string equal to the value of:
    ClassName{hashCode=..., uuid=...}
    
    If the uuid field is null, it returns:
    ClassName{hashCode=...}
    Should include hashCode if uuid is null Should include uuid if not null
    
    Overrides:
    
    toString in class BaseOpenmrsObject
    
    See Also:
    
    Object.toString()
  - getDescriptor
```
public GlobalProperty getDescriptor()
```
    Specified by:
    
    getDescriptor in interface SingleCustomValue<GlobalProperty>
    
    Returns:
    
    metadata describing this custom value
    
    Since:
    
    1.9
    
    See Also:
    
    SingleCustomValue.getDescriptor()
  - getValueReference
```
public String getValueReference()
```
    Specified by:
    
    getValueReference in interface SingleCustomValue<GlobalProperty>
    
    Returns:
    
    the value persisted in a database in a varchar column. Not necessarily human-readable.
    
    Since:
    
    1.9
    
    See Also:
    
    SingleCustomValue.getValueReference()
  - setValueReferenceInternal
```
public void setValueReferenceInternal(String valueToPersist)
```
    Description copied from interface: SingleCustomValue
    
    Directly set the String value that OpenMRS should persist in the database in a varchar column. Implementations should validate this value and throw an InvalidCustomValueException if it's invalid, rather than setting it blindly. If you are coding against the OpenMRS API, you should use SingleCustomValue.setValue(Object) instead.
    
    Specified by:
    
    setValueReferenceInternal in interface SingleCustomValue<GlobalProperty>
    
    Since:
    
    1.9
    
    See Also:
    
    SingleCustomValue.setValueReferenceInternal(java.lang.String)
  - getValue
```
public Object getValue()
```
    Description copied from interface: SingleCustomValue
    
    Convenience method to get the typed version of the serializedValue. (This will result in a call to a CustomDatatype.fromReferenceString(String).)
    
    Specified by:
    
    getValue in interface SingleCustomValue<GlobalProperty>
    
    Returns:
    
    typed value, converted from serializedValue by a CustomDatatype
    
    Since:
    
    1.9
    
    See Also:
    
    SingleCustomValue.getValue()
  - setValue
```
public <T> void setValue(T typedValue)
```
    Description copied from interface: SingleCustomValue
    
    Sets the typed value. (This will result in a call to CustomDatatype.getReferenceStringForValue(Object)
    
    Specified by:
    
    setValue in interface SingleCustomValue<GlobalProperty>
    
    Since:
    
    1.9
    
    See Also:
    
    SingleCustomValue.setValue(java.lang.Object)
  - isDirty
```
@Deprecated
public boolean isDirty()
```
    Deprecated. as of 2.0, use getDirty()
    
    Specified by:
    
    isDirty in interface SingleCustomValue<GlobalProperty>
    
    Returns:
    
    whether or not setValue has been called (thus CustomDatatype.save(Object, String) needs to be called
    
    See Also:
    
    SingleCustomValue.isDirty()
  - getDirty
```
public boolean getDirty()
```
  - getChangedBy
```
public User getChangedBy()
```
    Returns:
    
    Returns the changedBy.
  - setChangedBy
```
public void setChangedBy(User changedBy)
```
    Parameters:
    
    changedBy - The user that changed this object
  - getDateChanged
```
public Date getDateChanged()
```
    Returns:
    
    Returns the date this object was changed
  - setDateChanged
```
public void setDateChanged(Date dateChanged)
```
    Parameters:
    
    dateChanged - The date this object was changed
  - getViewPrivilege
```
public Privilege getViewPrivilege()
```
    Gets privilege which can view this globalProperty
    
    Returns:
    
    the viewPrivilege the privilege instance
    
    Since:
    
    2.7.0
  - setViewPrivilege
```
public void setViewPrivilege(Privilege viewPrivilege)
```
    Sets privilege which can view this globalProperty
    
    Parameters:
    
    viewPrivilege - the viewPrivilege to set
    
    Since:
    
    2.7.0
  - getEditPrivilege
```
public Privilege getEditPrivilege()
```
    Gets privilege which can edit this globalProperty
    
    Returns:
    
    the editPrivilege the privilege instance
    
    Since:
    
    2.7.0
  - setEditPrivilege
```
public void setEditPrivilege(Privilege editPrivilege)
```
    Sets privilege which can edit this globalProperty
    
    Parameters:
    
    editPrivilege - the editPrivilege to set
    
    Since:
    
    2.7.0
  - getDeletePrivilege
```
public Privilege getDeletePrivilege()
```
    Get privilege which can delete this globalProperty
    
    Returns:
    
    the deletePrivilege the privilege instance
    
    Since:
    
    2.7.0
  - setDeletePrivilege
```
public void setDeletePrivilege(Privilege deletePrivilege)
```
    Sets privilege which can delete this globalProperty
    
    Parameters:
    
    deletePrivilege - the deletePrivilege to set
    
    Since:
    
    2.7.0

Class GlobalProperty

Constructor Summary

Method Summary

Methods inherited from class org.openmrs.BaseOpenmrsObject

Methods inherited from class java.lang.Object

Constructor Detail

GlobalProperty

GlobalProperty

GlobalProperty

GlobalProperty

GlobalProperty

Method Detail

getProperty

setProperty

getPropertyValue

setPropertyValue

getDescription

setDescription

getId

setId

getDatatypeClassname

setDatatypeClassname

getDatatypeConfig

setDatatypeConfig

getPreferredHandlerClassname

setPreferredHandlerClassname

getHandlerConfig

setHandlerConfig

toString

getDescriptor

getValueReference

setValueReferenceInternal

getValue

setValue

isDirty

getDirty

getChangedBy

setChangedBy

getDateChanged

setDateChanged

getViewPrivilege

setViewPrivilege

getEditPrivilege

setEditPrivilege

getDeletePrivilege

setDeletePrivilege