org.openmrs
Class LocationTag

java.lang.Object
  extended by org.openmrs.BaseOpenmrsObject
      extended by org.openmrs.BaseOpenmrsMetadata
          extended by org.openmrs.LocationTag
All Implemented Interfaces:
java.io.Serializable, Auditable, OpenmrsMetadata, OpenmrsObject, Retireable

public class LocationTag
extends BaseOpenmrsMetadata
implements java.io.Serializable

An LocationTag allows categorization of Locations

Since:
1.5
See Also:
Location, Serialized Form

Field Summary
static long serialVersionUID
           
 
Constructor Summary
LocationTag()
          default constructor
LocationTag(java.lang.Integer locationTagId)
          constructor with id
LocationTag(java.lang.String name, java.lang.String description)
          Required values constructor.
 
Method Summary
 boolean equals(java.lang.Object obj)
          Compares two LocationTag objects for similarity
 java.lang.Integer getId()
           
 java.lang.Integer getLocationTagId()
           
 java.lang.String getTag()
          Deprecated. use BaseOpenmrsMetadata.getName() instead
 int hashCode()
           
 void setId(java.lang.Integer id)
           
 void setLocationTagId(java.lang.Integer locationTagId)
           
 void setTag(java.lang.String tag)
          Deprecated. use BaseOpenmrsMetadata.setName(String) instead
 java.lang.String toString()
           
 
Methods inherited from class org.openmrs.BaseOpenmrsMetadata
getChangedBy, getCreator, getDateChanged, getDateCreated, getDateRetired, getDescription, getName, getRetired, getRetiredBy, getRetireReason, isRetired, setChangedBy, setCreator, setDateChanged, setDateCreated, setDateRetired, setDescription, setName, setRetired, setRetiredBy, setRetireReason
 
Methods inherited from class org.openmrs.BaseOpenmrsObject
getUuid, setUuid
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface org.openmrs.OpenmrsObject
getUuid, setUuid
 

Field Detail

serialVersionUID

public static final long serialVersionUID
See Also:
Constant Field Values
Constructor Detail

LocationTag

public LocationTag()
default constructor


LocationTag

public LocationTag(java.lang.Integer locationTagId)
constructor with id


LocationTag

public LocationTag(java.lang.String name,
                   java.lang.String description)
Required values constructor. This is the minimum number of values that must be non-null in order to have a successful save to the database

Parameters:
name - the name of this encounter type
description - a short description of why this encounter type exists
Method Detail

equals

public boolean equals(java.lang.Object obj)
Compares two LocationTag objects for similarity

Overrides:
equals in class java.lang.Object
Parameters:
obj - The LocationTag object to be compared.
Returns:
Returns true if the objects share the same locationTagId, false otherwise.

hashCode

public int hashCode()
Overrides:
hashCode in class java.lang.Object
See Also:
Object.hashCode()

getLocationTagId

public java.lang.Integer getLocationTagId()
Returns:
Returns the locationTagId.

setLocationTagId

public void setLocationTagId(java.lang.Integer locationTagId)
Parameters:
locationTagId - The locationTagId to set.

getTag

@Deprecated
public java.lang.String getTag()
Deprecated. use BaseOpenmrsMetadata.getName() instead

Returns:
Returns the tag.

setTag

@Deprecated
public void setTag(java.lang.String tag)
Deprecated. use BaseOpenmrsMetadata.setName(String) instead

Parameters:
tag - The tag to set.

toString

public java.lang.String toString()
Overrides:
toString in class java.lang.Object

getId

public java.lang.Integer getId()
Specified by:
getId in interface OpenmrsObject
Returns:
id - The unique Identifier for the object
See Also:
OpenmrsObject.getId()

setId

public void setId(java.lang.Integer id)
Specified by:
setId in interface OpenmrsObject
Parameters:
id - - The unique Identifier for the object
See Also:
OpenmrsObject.setId(java.lang.Integer)

OpenMRS-1.7.x

Generated Apr 27 2012 10:06 PM. NOTE - these libraries are in active development and subject to change