org.opensrp.api.domain

Class Event

java.lang.Object

org.opensrp.api.domain.BaseDataObject

org.opensrp.api.domain.Event

public class Event
extends BaseDataObject

An Event is a logical happening or experience of BaseEntity with the system as defined by the program workflow. The difference of an Event and other activities in system is that the data of Event is meaningful for business clients of system and also the data links back with international standard dictionaries. An Event in system is recorded via a form filled by data Provider. The form data is represented by FormSubmission

Constructor Summary

Constructors

Constructor and Description
Event()
Event(String baseEntityId, String eventType, org.joda.time.DateTime eventDate, String entityType, String providerId, String locationId, String formSubmissionId)

Method Summary

Modifier and Type	Method and Description
void	addDetails(String key, String val)
void	addIdentifier(String identifierType, String identifier)
void	addObs(Obs observation)
String	getBaseEntityId()
Map<String,String>	getDetails()
String	getEntityType()
org.joda.time.DateTime	getEventDate()
String	getEventType()
String	getFormSubmissionId()
String	getIdentifier(String identifierType)
String	getIdentifierMatchingRegex(String regex) Returns field matching the regex.
Map<String,String>	getIdentifiers()
String	getLocationId()
List<Obs>	getObs()
String	getProviderId()
long	getVersion()
void	removeIdentifier(String identifierType)
void	setBaseEntityId(String baseEntityId)
void	setDetails(Map<String,String> details)
void	setEntityType(String entityType)
void	setEventDate(org.joda.time.DateTime eventDate)
void	setEventType(String eventType)
void	setFormSubmissionId(String formSubmissionId)
void	setIdentifiers(Map<String,String> identifiers)
void	setLocationId(String locationId)
void	setObs(List<Obs> obs) WARNING: Overrides all existing obs
void	setProviderId(String providerId)
void	setVersion(long version)
String	toString()
Event	withBaseEntityId(String baseEntityId)
Event	withEntityType(String entityType)
Event	withEventDate(org.joda.time.DateTime eventDate)
Event	withEventType(String eventType)
Event	withFormSubmissionId(String formSubmissionId)
Event	withIdentifier(String identifierType, String identifier)
Event	withIdentifiers(Map<String,String> identifiers) WARNING: Overrides all existing identifiers
Event	withLocationId(String locationId)
Event	withObs(List<Obs> obs) WARNING: Overrides all existing obs
Event	withObs(Obs observation)
Event	withProviderId(String providerId)

Methods inherited from class org.opensrp.api.domain.BaseDataObject

getCreator, getDateCreated, getDateEdited, getDateVoided, getEditor, getVoided, getVoider, getVoidReason, setCreator, setDateCreated, setDateEdited, setDateVoided, setEditor, setVoided, setVoider, setVoidReason, withCreator, withDateCreated, withDateEdited, withDateVoided, withEditor, withVoided, withVoider, withVoidReason

Methods inherited from class java.lang.Object

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

Constructor Detail

Event

public Event()

Event

public Event(String baseEntityId,
             String eventType,
             org.joda.time.DateTime eventDate,
             String entityType,
             String providerId,
             String locationId,
             String formSubmissionId)

Method Detail

getObs

public List<Obs> getObs()

setObs

public void setObs(List<Obs> obs)

WARNING: Overrides all existing obs

Parameters:

obs -

addObs

public void addObs(Obs observation)

getBaseEntityId

public String getBaseEntityId()

setBaseEntityId

public void setBaseEntityId(String baseEntityId)

getIdentifiers

public Map<String,String> getIdentifiers()

getIdentifier

public String getIdentifier(String identifierType)

getIdentifierMatchingRegex

public String getIdentifierMatchingRegex(String regex)

Returns field matching the regex. Note that incase of multiple fields matching criteria function would return first match. The must be well formed to find out a single value

Parameters:

regex -

Returns:

setIdentifiers

public void setIdentifiers(Map<String,String> identifiers)

addIdentifier

public void addIdentifier(String identifierType,
                          String identifier)

removeIdentifier

public void removeIdentifier(String identifierType)

getLocationId

public String getLocationId()

setLocationId

public void setLocationId(String locationId)

getEventDate

public org.joda.time.DateTime getEventDate()

setEventDate

public void setEventDate(org.joda.time.DateTime eventDate)

getEventType

public String getEventType()

setEventType

public void setEventType(String eventType)

getFormSubmissionId

public String getFormSubmissionId()

setFormSubmissionId

public void setFormSubmissionId(String formSubmissionId)

getProviderId

public String getProviderId()

setProviderId

public void setProviderId(String providerId)

getEntityType

public String getEntityType()

setEntityType

public void setEntityType(String entityType)

getDetails

public Map<String,String> getDetails()

setDetails

public void setDetails(Map<String,String> details)

addDetails

public void addDetails(String key,
                       String val)

getVersion

public long getVersion()

setVersion

public void setVersion(long version)

withBaseEntityId

public Event withBaseEntityId(String baseEntityId)

withIdentifiers

public Event withIdentifiers(Map<String,String> identifiers)

WARNING: Overrides all existing identifiers

Parameters:

identifiers -

Returns:

withIdentifier

public Event withIdentifier(String identifierType,
                            String identifier)

withLocationId

public Event withLocationId(String locationId)

withEventDate

public Event withEventDate(org.joda.time.DateTime eventDate)

withEventType

public Event withEventType(String eventType)

withFormSubmissionId

public Event withFormSubmissionId(String formSubmissionId)

withProviderId

public Event withProviderId(String providerId)

withEntityType

public Event withEntityType(String entityType)

withObs

public Event withObs(List<Obs> obs)

WARNING: Overrides all existing obs

Parameters:

obs -

Returns:

withObs

public Event withObs(Obs observation)

toString

public String toString()

Overrides:

toString in class BaseDataObject