org.openmrs

Class Relationship

java.lang.Object

org.openmrs.BaseOpenmrsObject

org.openmrs.BaseOpenmrsData

org.openmrs.Relationship

All Implemented Interfaces:

java.io.Serializable, Auditable, OpenmrsData, OpenmrsObject, Voidable

public class Relationship
extends BaseOpenmrsData
implements java.io.Serializable

Relationship

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static long	serialVersionUID

Fields inherited from class org.openmrs.BaseOpenmrsData

creator

Constructor Summary

Constructors

Constructor and Description
Relationship() default constructor
Relationship(java.lang.Integer relationshipId) constructor with id
Relationship(Person personA, Person personB, RelationshipType type)

Method Summary

Modifier and Type	Method and Description
Relationship	copy() Does a shallow copy of this Relationship.
protected Relationship	copyHelper(Relationship target) The purpose of this method is to allow subclasses of Relationship to delegate a portion of their copy() method back to the superclass, in case the base class implementation changes.
java.util.Date	getEndDate() If not null, this indicates that the relationship ended on a particular date
java.lang.Integer	getId()
Person	getPersonA()
Person	getPersonB()
java.lang.Integer	getRelationshipId()
RelationshipType	getRelationshipType()
java.util.Date	getStartDate() If not null, this indicates that the relationship started on a particular date
java.lang.Boolean	getVoided() Deprecated. Use isVoided()
void	setEndDate(java.util.Date endDate)
void	setId(java.lang.Integer id)
void	setPersonA(Person personA)
void	setPersonB(Person personB)
void	setRelationshipId(java.lang.Integer relationshipId)
void	setRelationshipType(RelationshipType type)
void	setStartDate(java.util.Date startDate)
java.lang.String	toString() Returns a string consisting of the name of the class of which the object is an instance and the uuid field surrounded by [ and ].

Methods inherited from class org.openmrs.BaseOpenmrsData

getChangedBy, getCreator, getDateChanged, getDateCreated, getDateVoided, getVoidedBy, getVoidReason, isVoided, setChangedBy, setCreator, setDateChanged, setDateCreated, setDateVoided, setVoided, setVoidedBy, setVoidReason

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

Relationship

public Relationship()

default constructor

Relationship

public Relationship(java.lang.Integer relationshipId)

constructor with id

Relationship

public Relationship(Person personA,
                    Person personB,
                    RelationshipType type)

Method Detail

copy

public Relationship copy()

Does a shallow copy of this Relationship. Does NOT copy relationshipId

Returns:

a copy of this relationship

copyHelper

protected Relationship copyHelper(Relationship target)

The purpose of this method is to allow subclasses of Relationship to delegate a portion of their copy() method back to the superclass, in case the base class implementation changes.

Parameters:

target - a Relationship that will have the state of this copied into it

Returns:

the Relationship that was passed in, with state copied into it

getPersonA

public Person getPersonA()

Returns:

Returns the personA.

setPersonA

public void setPersonA(Person personA)

Parameters:

personA - The person to set.

getRelationshipType

public RelationshipType getRelationshipType()

Returns:

Returns the relationship type.

setRelationshipType

public void setRelationshipType(RelationshipType type)

Parameters:

type - The relationship type to set.

getRelationshipId

public java.lang.Integer getRelationshipId()

Returns:

Returns the relationshipId.

setRelationshipId

public void setRelationshipId(java.lang.Integer relationshipId)

Parameters:

relationshipId - The relationshipId to set.

getPersonB

public Person getPersonB()

Returns:

Returns the personB.

setPersonB

public void setPersonB(Person personB)

Parameters:

personB - The relative to set.

getStartDate

public java.util.Date getStartDate()

If not null, this indicates that the relationship started on a particular date

Returns:

the relationship's start date.

Since:

1.9

setStartDate

public void setStartDate(java.util.Date startDate)

Parameters:

Sets - relationship's start date.

Since:

1.9

getEndDate

public java.util.Date getEndDate()

If not null, this indicates that the relationship ended on a particular date

Returns:

Returns relationship's end date.

Since:

1.9

setEndDate

public void setEndDate(java.util.Date endDate)

Parameters:

Sets - relationship's end date.

Since:

1.9

getVoided

public java.lang.Boolean getVoided()

Deprecated. Use isVoided()

Description copied from class: BaseOpenmrsData

This method delegates to BaseOpenmrsData.isVoided(). This is only needed for jstl syntax like ${person.voided} because the return type is a Boolean object instead of a boolean primitive type.

Overrides:

getVoided in class BaseOpenmrsData

Returns:

Returns the voided.

See Also:

BaseOpenmrsData.isVoided()

toString

public java.lang.String toString()

Description copied from class: BaseOpenmrsObject

Returns a string consisting of the name of the class of which the object is an instance and the uuid field surrounded by [ and ]. In other words, this method returns a string equal to the value of:

 getClass().getName() + '[' + uuid + ']'
 

If the uuid field is null, it delegates to Object.toString()

Overrides:

toString in class BaseOpenmrsObject

See Also:

Object.toString()

getId

public java.lang.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(java.lang.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)