org.openmrs

Class ConceptNameTag

java.lang.Object

org.openmrs.BaseOpenmrsObject

org.openmrs.ConceptNameTag

All Implemented Interfaces:

Serializable, Auditable, Changeable, Creatable, OpenmrsObject, Voidable

public class ConceptNameTag
extends BaseOpenmrsObject
implements Auditable, Voidable, Serializable

ConceptNameTag is a textual tag which can be applied to a ConceptName.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static long	serialVersionUID

Constructor Summary

Constructors

Constructor and Description
ConceptNameTag() Default constructor.
ConceptNameTag(String tag, String description) Public constructor.

Method Summary

Modifier and Type	Method and Description
User	getChangedBy()
Integer	getConceptNameTagId()
User	getCreator()
Date	getDateChanged()
Date	getDateCreated()
Date	getDateVoided() Returns the Date this ConceptName was voided.
String	getDescription() Returns the description of this tag.
Integer	getId()
String	getTag() Returns the textual representation of this ConceptNameTag.
Boolean	getVoided() Returns whether the ConceptName has been voided.
User	getVoidedBy() Returns the User who voided this ConceptName.
String	getVoidReason() Returns the reason this ConceptName was voided.
Boolean	isVoided() Deprecated. as of 2.0, use getVoided()
void	setChangedBy(User changedBy)
void	setConceptNameTagId(Integer conceptNameTagId)
void	setCreator(User creator)
void	setDateChanged(Date dateChanged)
void	setDateCreated(Date dateCreated)
void	setDateVoided(Date dateVoided) Sets the Data this ConceptName was voided.
void	setDescription(String description) Sets the description of this tag.
void	setId(Integer id)
void	setTag(String tag) Sets the textual representation of this ConceptNametag.
void	setVoided(Boolean voided) Sets the voided status of the ConceptName.
void	setVoidedBy(User voidedBy) Sets the User who voided this ConceptName.
void	setVoidReason(String voidReason) Sets the reason this ConceptName was voided.
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

Methods inherited from interface org.openmrs.OpenmrsObject

getUuid, setUuid

Field Detail

serialVersionUID

public static final long serialVersionUID

See Also:

Constant Field Values

Constructor Detail

ConceptNameTag

public ConceptNameTag()

Default constructor.

ConceptNameTag

public ConceptNameTag(String tag,
                      String description)

Public constructor. Use factory methods to obtain copies of the desired tags.

Parameters:

tag -

description -

Method Detail

getTag

public String getTag()

Returns the textual representation of this ConceptNameTag.

Returns:

the textual representation of this ConceptNameTag.

setTag

public void setTag(String tag)

Sets the textual representation of this ConceptNametag.

Parameters:

tag - the textual representation

getDescription

public String getDescription()

Returns the description of this tag.

Returns:

the description of this tag

setDescription

public void setDescription(String description)

Sets the description of this tag.

Parameters:

description -

getCreator

public User getCreator()

Specified by:

getCreator in interface Creatable

Returns:

Returns the creator.

setCreator

public void setCreator(User creator)

Specified by:

setCreator in interface Creatable

Parameters:

creator - The creator to set.

getDateCreated

public Date getDateCreated()

Specified by:

getDateCreated in interface Creatable

Returns:

Returns the dateCreated.

setDateCreated

public void setDateCreated(Date dateCreated)

Specified by:

setDateCreated in interface Creatable

Parameters:

dateCreated - The dateCreated to set.

isVoided

@Deprecated
public Boolean isVoided()

Deprecated. as of 2.0, use getVoided()

Returns whether the ConceptName has been voided.

Specified by:

isVoided in interface Voidable

Returns:

true if the ConceptName has been voided, false otherwise.

getVoided

public Boolean getVoided()

Returns whether the ConceptName has been voided.

Specified by:

getVoided in interface Voidable

Returns:

true if the ConceptName has been voided, false otherwise.

setVoided

public void setVoided(Boolean voided)

Sets the voided status of the ConceptName.

Specified by:

setVoided in interface Voidable

Parameters:

voided - the voided status to set.

getVoidedBy

public User getVoidedBy()

Returns the User who voided this ConceptName.

Specified by:

getVoidedBy in interface Voidable

Returns:

the User who voided this ConceptName, or null if not set

setVoidedBy

public void setVoidedBy(User voidedBy)

Sets the User who voided this ConceptName.

Specified by:

setVoidedBy in interface Voidable

Parameters:

voidedBy - the user who voided this ConceptName.

getDateVoided

public Date getDateVoided()

Returns the Date this ConceptName was voided.

Specified by:

getDateVoided in interface Voidable

Returns:

the Date this ConceptName was voided.

setDateVoided

public void setDateVoided(Date dateVoided)

Sets the Data this ConceptName was voided.

Specified by:

setDateVoided in interface Voidable

Parameters:

dateVoided - the date the ConceptName was voided.

getVoidReason

public String getVoidReason()

Returns the reason this ConceptName was voided.

Specified by:

getVoidReason in interface Voidable

Returns:

the reason this ConceptName was voided

setVoidReason

public void setVoidReason(String voidReason)

Sets the reason this ConceptName was voided.

Specified by:

setVoidReason in interface Voidable

Parameters:

voidReason - the reason this ConceptName was voided

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

getConceptNameTagId

public Integer getConceptNameTagId()

Returns:

the conceptNameTagId

setConceptNameTagId

public void setConceptNameTagId(Integer conceptNameTagId)

Parameters:

conceptNameTagId - the conceptNameTagId 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)

getChangedBy

public User getChangedBy()

Specified by:

getChangedBy in interface Changeable

Returns:

Returns the changedBy.

setChangedBy

public void setChangedBy(User changedBy)

Specified by:

setChangedBy in interface Changeable

Parameters:

changedBy - The user that changed this object

getDateChanged

public Date getDateChanged()

Specified by:

getDateChanged in interface Changeable

Returns:

Returns the date this object was changed

setDateChanged

public void setDateChanged(Date dateChanged)

Specified by:

setDateChanged in interface Changeable

Parameters:

dateChanged - The date this object was changed