Deprecated API

Contents

• Deprecated Classes
• Deprecated Fields
• Deprecated Methods
• Deprecated Constructors
• Deprecated Enum Constants

Deprecated Classes

Class and Description
org.openmrs.util.MemoryAppender As of 2.4.4, 2.5.1, and 2.6.0 this class is moved to the org.openmrs.logging package
org.openmrs.migration.MigrationHelper since 2.2.0
org.openmrs.liquibase.OpenmrsClassLoaderResourceAccessor As of 2.7.0, replaced by the usage of ClassLoaderResourceAccessor.search(String, boolean) or ClassLoaderResourceAccessor.getAll(String), as this provides a better handling of paths that map to multiple resources using Liquibase's DUPLICATE_FILE_MODE. Refer to GlobalConfiguration.DUPLICATE_FILE_MODE for the configuration and usage details.
org.openmrs.api.db.hibernate.PatientSearchCriteria since 2.1.0 (in favor of Hibernate Search)

Deprecated Fields

Field and Description
org.openmrs.util.OpenmrsConstants.GP_HOST_URL as of 2.6.0, replaced by OpenmrsConstants.GP_PASSWORD_RESET_URL

Deprecated Methods

Method and Description
org.openmrs.person.PersonMergeLogData.addCreatedProgram(String)
org.openmrs.util.OpenmrsUtil.applyLogLevel(String, String) As of 2.4.4, 2.5.1, and 2.6.0; replaced by OpenmrsLoggingUtil.applyLogLevel(String, String)
org.openmrs.util.OpenmrsUtil.applyLogLevels() As of 2.4.4, 2.5.1, and 2.6.0; replaced by OpenmrsLoggingUtil.applyLogLevels()
org.openmrs.api.context.Context.authenticate(String, String) as of 2.3.0, replaced by Context.authenticate(Credentials) Used to authenticate user within the context
org.openmrs.PatientIdentifier.compareTo(PatientIdentifier) since 1.12. Use DefaultComparator instead. Note: this comparator imposes orderings that are inconsistent with equals.
org.openmrs.PersonAttributeType.compareTo(PersonAttributeType) since 1.12. Use DefaultComparator instead. Note: this comparator imposes orderings that are inconsistent with equals.
org.openmrs.util.Security.decrypt(String) As of version 2.4.0, this method is not referenced in openmrs-core or any other projects under the GitHub OpenMRS organisation.
org.openmrs.util.Security.encrypt(String) As of version 2.4.0, this method is not referenced in openmrs-core or any other projects under the GitHub OpenMRS organisation.
org.openmrs.util.DatabaseUpdater.executeChangelog(String, Map<String, Object>) as of 2.4 see DatabaseUpdater.executeChangelog(String, ChangeSetExecutorCallback)
org.openmrs.User.findPossibleValues(String)
org.openmrs.Location.findPossibleValues(String)
org.openmrs.Concept.findPossibleValues(String)
org.openmrs.Attributable.findPossibleValues(String) Data provided by this method can be better achieved from appropriate service at point of use.
org.openmrs.util.AttributableDate.findPossibleValues(String)
org.openmrs.util.OpenmrsConstants.GENDER() As of 2.2, replaced by OpenmrsConstants.GENDERS
org.openmrs.OpenmrsMetadata.getChangedBy() As of version 2.2 OpenmrsMetadata is immutable by default, it's up to the subclasses to make themselves mutable by extending BaseChangeableOpenmrsMetadata, this method will be removed in 2.3
org.openmrs.OpenmrsData.getChangedBy() As of version 2.2, OpenmrsData is immutable by default, it's up to the subclasses to make themselves mutable by extending BaseChangeableOpenmrsData, this method will be removed in 2.3
org.openmrs.BaseOpenmrsMetadata.getChangedBy() as of version 2.2
org.openmrs.BaseOpenmrsData.getChangedBy() as of version 2.2
org.openmrs.api.CohortService.getCohort(String) use CohortService.getCohortByName(String)
org.openmrs.api.CohortService.getCohortsContainingPatient(Patient) use CohortService.getCohortsContainingPatientId(Integer) Find all Cohorts that contain the given patient. (Not including voided Cohorts)
org.openmrs.Cohort.getCommaSeparatedPatientIds() since 2.1.0 cohorts are more complex than just a set of patient ids, so there is no one-line replacement
org.openmrs.Allergy.getComment() as of 2.3.0, replaced by Allergy.getComments()
org.openmrs.api.ObsService.getComplexObs(Integer, String) as of 2.1.0, use ObsService.getObs(Integer)
org.openmrs.api.db.ConceptDAO.getConceptsByMapping(String, String, boolean) As of 2.5.0, this method has been deprecated in favor of ConceptDAO.getConceptIdsByMapping(String, String, boolean)
org.openmrs.api.db.hibernate.HibernateConceptDAO.getConceptsByMapping(String, String, boolean)
org.openmrs.person.PersonMergeLogData.getCreatedPrograms()
org.openmrs.OpenmrsMetadata.getDateChanged() As of version 2.2 OpenmrsMetadata is immutable by default, it's up to the subclasses to make themselves mutable by extending BaseChangeableOpenmrsMetadata, this method will be removed in 2.3
org.openmrs.OpenmrsData.getDateChanged() As of version 2.2, OpenmrsData is immutable by default, it's up to the subclasses to make themselves mutable by extending BaseChangeableOpenmrsData, this method will be removed in 2.3
org.openmrs.BaseOpenmrsMetadata.getDateChanged() as of version 2.2
org.openmrs.BaseOpenmrsData.getDateChanged() as of version 2.2
org.openmrs.api.EncounterService.getEncounters(Patient, Location, Date, Date, Collection<Form>, Collection<EncounterType>, Collection<Provider>, Collection<VisitType>, Collection<Visit>, boolean) As of 2.0, replaced by EncounterService.getEncounters(EncounterSearchCriteria)
org.openmrs.api.impl.EncounterServiceImpl.getEncounters(Patient, Location, Date, Date, Collection<Form>, Collection<EncounterType>, Collection<Provider>, Collection<VisitType>, Collection<Visit>, boolean) As of 2.0, replaced by EncounterServiceImpl.getEncounters(EncounterSearchCriteria)
org.openmrs.obs.handler.AbstractHandler.getExtension(String) since 2.1.3 use FilenameUtils.getExtension(String) instead.
org.openmrs.Cohort.getMemberIds() since 2.1.0 cohorts are more complex than just a set of patient ids, so there is no one-line replacement
org.openmrs.util.OpenmrsUtil.getMemoryAppender() As of 2.4.4, 2.5.1, and 2.6.0; replaced by OpenmrsLoggingUtil.getMemoryAppender() instead
org.openmrs.module.Module.getMessages() as of 2.0 because messages are automatically loaded from the classpath
org.openmrs.util.OpenmrsUtil.getOpenmrsLogLocation() As of 2.4.4, 2.5.1, and 2.6.0; replaced by OpenmrsLoggingUtil.getOpenmrsLogLocation()
org.openmrs.User.getPossibleValues()
org.openmrs.Location.getPossibleValues()
org.openmrs.Concept.getPossibleValues()
org.openmrs.Attributable.getPossibleValues() Data provided by this method can be better achieved from appropriate service at point of use.
org.openmrs.util.AttributableDate.getPossibleValues()
org.openmrs.api.DiagnosisService.getPrimaryDiagnoses(Encounter) since 2.5.0, use DiagnosisService.getDiagnosesByEncounter(org.openmrs.Encounter, boolean, boolean)
org.openmrs.Cohort.getSize() use Cohort.size()
org.openmrs.migration.MigrationHelper.importLocations(Document) since 2.2.0 migrate the method to your code base if needed
org.openmrs.migration.MigrationHelper.importProgramsAndStatuses(List<String>) since 2.2.0 migrate the method to your code base if needed
org.openmrs.migration.MigrationHelper.importRelationships(Collection<String>, boolean, boolean) since 2.2.0 migrate the method to your code base if needed
org.openmrs.migration.MigrationHelper.importUsers(Document) since 2.2.0 migrate the method to your code base if needed
org.openmrs.ConceptNumeric.isAllowDecimal() as of 2.0, use ConceptNumeric.getAllowDecimal()
org.openmrs.Person.isBirthdateEstimated() as of 2.0, use Person.getBirthdateEstimated()
org.openmrs.Drug.isCombination() as of 2.0, use Drug.getCombination()
org.openmrs.Person.isDead() as of 2.0, use Person.getDead()
org.openmrs.GlobalProperty.isDirty() as of 2.0, use GlobalProperty.getDirty()
org.openmrs.FormResource.isDirty() as of 2.0, use FormResource.getDirty()
org.openmrs.FieldAnswer.isDirty() as of 2.0, use FieldAnswer.getDirty()
org.openmrs.ConceptMapType.isHidden() as of 2.0, use ConceptMapType.getIsHidden()
org.openmrs.ConceptName.isLocalePreferred() as of 2.0, use ConceptName.getLocalePreferred()
org.openmrs.Person.isPatient() as of 2.0, use Person.getIsPatient()
org.openmrs.Person.isPersonVoided() as of 2.0, use Person.getPersonVoided()
org.openmrs.RelationshipType.isPreferred() as of 2.0, use RelationshipType.getPreferred()
org.openmrs.PersonName.isPreferred() as of 2.0, use PersonName.getPreferred()
org.openmrs.PersonAddress.isPreferred() as of 2.0, use PersonAddress.getPreferred()
org.openmrs.PatientIdentifier.isPreferred() as of 2.0, use PatientIdentifier.getPreferred()
org.openmrs.FormField.isRequired() as of 2.0, use FormField.getRequired()
org.openmrs.Retireable.isRetired() as of 2.0, use Retireable.getRetired()
org.openmrs.Concept.isRetired() as of 2.0, use Concept.getRetired()
org.openmrs.BaseOpenmrsMetadata.isRetired() as of 2.0, use BaseOpenmrsMetadata.getRetired()
org.openmrs.PersonAttributeType.isSearchable() as of 2.0, use PersonAttributeType.getSearchable()
org.openmrs.Field.isSelectMultiple() as of 2.0, use Field.getSelectMultiple()
org.openmrs.Concept.isSet() as of 2.0, use Concept.getSet()
org.openmrs.Voidable.isVoided() as of 2.0, use Voidable.getVoided()
org.openmrs.ConceptNameTag.isVoided() as of 2.0, use ConceptNameTag.getVoided()
org.openmrs.ConceptName.isVoided() as of 2.0, use ConceptName.getVoided()
org.openmrs.BaseOpenmrsData.isVoided() as of 2.0, use BaseOpenmrsData.getVoided()
org.openmrs.util.OpenmrsUtil.join(Collection<E>, String) as of 2.2 use Java's String.join(java.lang.CharSequence, java.lang.CharSequence...) or Apache Commons StringUtils.join for iterables which do not extend CharSequence
org.openmrs.module.ModuleFileParser.parse() since 2.2.0 use ModuleFileParser.parse(File)
org.openmrs.migration.MigrationHelper.parseDate(String) since 2.2.0 migrate the method to your code base if needed
org.openmrs.migration.MigrationHelper.parseXml(String) since 2.2.0 migrate the method to your code base if needed
org.openmrs.api.CohortService.removePatientFromCohort(Cohort, Patient) since 2.1.0 you should explicitly call either CohortService.endCohortMembership(CohortMembership, Date) or CohortService.voidCohortMembership(CohortMembership, String)
org.openmrs.OpenmrsMetadata.setChangedBy(User) As of version 2.2 OpenmrsMetadata is immutable by default, it's up to the subclasses to make themselves mutable by extending BaseChangeableOpenmrsMetadata, this method will be removed in 2.3
org.openmrs.OpenmrsData.setChangedBy(User) As of version 2.2, OpenmrsData is immutable by default, it's up to the subclasses to make themselves mutable by extending BaseChangeableOpenmrsData, this method will be removed in 2.3
org.openmrs.BaseOpenmrsMetadata.setChangedBy(User) as of version 2.2
org.openmrs.BaseOpenmrsData.setChangedBy(User) as of version 2.2
org.openmrs.Allergy.setComment(String) as of 2.3.0, replaced by Allergy.setComments(String)
org.openmrs.OpenmrsMetadata.setDateChanged(Date) As of version 2.2 OpenmrsMetadata is immutable by default, it's up to the subclasses to make themselves mutable by extending BaseChangeableOpenmrsMetadata, this method will be removed in 2.3
org.openmrs.OpenmrsData.setDateChanged(Date) As of version 2.2, OpenmrsData is immutable by default, it's up to the subclasses to make themselves mutable by extending BaseChangeableOpenmrsData, this method will be removed in 2.3
org.openmrs.BaseOpenmrsMetadata.setDateChanged(Date) as of version 2.2
org.openmrs.BaseOpenmrsData.setDateChanged(Date) as of version 2.2
org.openmrs.Cohort.setMemberIds(Set<Integer>) since 2.1.0 cohorts are more complex than just a set of patient ids, so there is no one-line replacement
org.openmrs.module.Module.setMessages(Map<String, Properties>) as of 2.0 because messages are automatically loaded from the classpath
org.openmrs.util.OpenmrsUtil.setupLogAppenders() As of 2.4.4, 2.5.1, and 2.6.0; replaced by OpenmrsLoggingUtil.reloadLoggingConfiguration()
org.openmrs.api.context.Context.updateDatabase(Map<String, Object>) as of 2.4
org.openmrs.validator.PersonNameValidator.validatePersonName(PersonName, Errors, boolean, boolean) as of 2.2.0, use PersonNameValidator.validate(Object, Errors)

Deprecated Constructors

Constructor and Description
org.openmrs.module.ModuleFileParser(File) since 2.2.0 use ModuleFileParser(MessageSourceService)
org.openmrs.module.ModuleFileParser(InputStream) since 2.2.0 use ModuleFileParser(MessageSourceService)
org.openmrs.parameter.OrderSearchCriteria(Patient, CareSetting, Collection<Concept>, Collection<OrderType>, Date, Date, boolean, Date, Date, Order.Action, Order.FulfillerStatus, Boolean, boolean, boolean, boolean)
org.openmrs.serialization.SimpleXStreamSerializer(XStream) since 2.7.0, 2.6.2, 2.5.13 use SimpleXStreamSerializer(XStream, AdministrationService)

Deprecated Enum Constants

Enum Constant and Description
org.openmrs.ConditionClinicalStatus.HISTORY_OF as of 2.6.0