|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Objectau.gov.nehta.vendorlibrary.pcehr.clients.common.type.DocumentQueryParams
public final class DocumentQueryParams
Parameters used to query for documents.
The IHINumber of the PCEHR ($XDSDocumentEntryPatientId) is present in the PCEHRHeader.
| Constructor Summary | |
|---|---|
DocumentQueryParams()
Default constructor. |
|
DocumentQueryParams(DocumentStatus... status)
Constructor. |
|
| Method Summary | |
|---|---|
java.util.List<Author> |
getAuthorIndividuals()
Gets the value of the authorIndividuals property. |
java.util.List<CodedValue> |
getClinicalSpecialties()
Gets the value of the clinicalSpecialties property. |
java.util.List<CodedValue> |
getDocumentClasses()
Gets the value of the documentClass property. |
java.lang.String |
getDocumentCreationTimeFrom()
Returns the lower value of documentCreationTime
Equivalent to the $XDSDocumentEntryCreationTimeFrom query
parameter. |
java.lang.String |
getDocumentCreationTimeTo()
Returns the upper value of documentCreationTime
Equivalent to the $XDSDocumentEntryCreationTimeTo query
parameter. |
java.util.List<CodedValue> |
getDocumentTypes()
Gets the value of the documentTypes property. |
java.util.List<CodedValue> |
getHealthcareFacilityTypes()
Gets the value of the healthcareFacilityTypes property. |
java.util.Set<java.lang.String> |
getKeywords()
Gets the value of the keywords property. |
java.lang.String |
getServiceStartTimeFrom()
Returns the lower value of serviceStartTime
Equivalent to the $XDSDocumentEntryServiceStartTimeFrom query
parameter. |
java.lang.String |
getServiceStartTimeTo()
Returns the upper value of serviceStartTime
Equivalent to the $XDSDocumentEntryServiceStartTimeTo query
parameter. |
java.lang.String |
getServiceStopTimeFrom()
Returns the lower value of serviceStopTime
Equivalent to the $XDSDocumentEntryServiceStopTimeFrom query
parameter. |
java.lang.String |
getServiceStopTimeTo()
Returns the upper value of serviceStopTime
Equivalent to the $XDSDocumentEntryServiceStopTimeTo query
parameter. |
java.util.Set<DocumentStatus> |
getStatuses()
Gets the value of the statuses property. |
java.util.List<CodedValue> |
getTemplateIds()
Gets the value of the templateIds property. |
boolean |
hasAuthorIndividuals()
Are there any authorIndividuals in the query parameters? |
boolean |
hasClinicalSpecialties()
Are there any clinicalSpecialties in the query parameters? |
boolean |
hasDocumentClasses()
Are there any documentTypes in the query parameters? |
boolean |
hasDocumentTypes()
Are there any documentTypes in the query parameters? |
boolean |
hasHealthcareFacilityTypes()
Are there any healthcareFacilityTypes in the query
parameters? |
boolean |
hasKeywords()
Are there any keywords in the query parameters? |
boolean |
hasStatuses()
Are there any statuses in the query parameters? |
boolean |
hasTemplateIds()
Are there any templateIds in the query parameters? |
boolean |
matches(DocumentMetadata documentMetadata)
Check whether the query parameters match the document metadata. |
void |
setDocumentCreationTimeFrom(java.lang.String documentCreationTimeFrom)
Sets the lower value of documentCreationTime
Equivalent to the $XDSDocumentEntryCreationTimeFrom query
parameter. |
void |
setDocumentCreationTimeTo(java.lang.String documentCreationTimeTo)
Sets the upper value of documentCreationTime
Equivalent to the $XDSDocumentEntryCreationTimeTo query
parameter. |
void |
setServiceStartTimeFrom(java.lang.String serviceStartTimeFrom)
Sets the lower value of serviceStartTime
Equivalent to the $XDSDocumentEntryServiceStartTimeFrom query
parameter. |
void |
setServiceStartTimeTo(java.lang.String serviceStartTimeTo)
Sets the upper value of serviceStartTime
Equivalent to the $XDSDocumentEntryServiceStartTimeTo query
parameter. |
void |
setServiceStopTimeFrom(java.lang.String serviceStopTimeFrom)
Sets the lower value of serviceStopTime
Equivalent to the $XDSDocumentEntryServiceStopTimeFrom query
parameter. |
void |
setServiceStopTimeTo(java.lang.String serviceStopTimeTo)
Sets the upper value of serviceStopTime
Equivalent to the $XDSDocumentEntryServiceStopTimeTo query
parameter. |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Constructor Detail |
|---|
public DocumentQueryParams()
public DocumentQueryParams(DocumentStatus... status)
status - variable list of DocumentStatus types.| Method Detail |
|---|
public boolean hasAuthorIndividuals()
authorIndividuals in the query parameters?
authorIndividuals in the query
parameters.public java.util.List<Author> getAuthorIndividuals()
authorIndividuals property.
If multiple values are specified than they will be considered to represent
'OR' semantics.
The value for this parameter is a pattern compatible with the SQL keyword
LIKE which allows the use of the following wildcard characters: % to match
any (or no) characters and _ to match a single character.
This accessor method returns a reference to the live list, not a snapshot.
This is why there is not a set method for the
authorIndividuals property.
For example, to add a new item, do as follows:
getAuthorIndividuals().add(newItem);Equivalent to the
$XDSDocumentEntryAuthorPerson query
parameter.
public boolean hasDocumentTypes()
documentTypes in the query parameters?
documentTypes in the query
parameters.public java.util.List<CodedValue> getDocumentTypes()
documentTypes property.
If multiple values are specified than they will be considered to represent
'OR' semantics.
This accessor method returns a reference to the live list, not a snapshot.
This is why there is not a set method for the
documentTypes property.
For example, to add a new item, do as follows:
getDocumentTypes().add(newItem);Equivalent to the
$XDSDocumentEntryTypeCode query parameter.
public boolean hasDocumentClasses()
documentTypes in the query parameters?
documentTypes in the query
parameters.public java.util.List<CodedValue> getDocumentClasses()
documentClass property.
If multiple values are specified than they will be considered to represent
'OR' semantics.
This accessor method returns a reference to the live list, not a snapshot.
This is why there is not a set method for the
documentTypes property.
For example, to add a new item, do as follows:
getDocumentTypes().add(newItem);Equivalent to the
$XDSDocumentEntryClassCode query parameter.
public boolean hasTemplateIds()
templateIds in the query parameters?
templateIds in the query
parameters.public java.util.List<CodedValue> getTemplateIds()
templateIds property.
If multiple values are specified than they will be considered to represent
'OR' semantics.
This accessor method returns a reference to the live list, not a snapshot.
This is why there is not a set method for the
templateIds property.
For example, to add a new item, do as follows:
getTemplateIds().add(newItem);Equivalent to the
$XDSDocumentEntryFormatCode query parameter.
public java.lang.String getDocumentCreationTimeFrom()
documentCreationTime
Equivalent to the $XDSDocumentEntryCreationTimeFrom query
parameter.
documentCreationTimepublic void setDocumentCreationTimeFrom(java.lang.String documentCreationTimeFrom)
documentCreationTime
Equivalent to the $XDSDocumentEntryCreationTimeFrom query
parameter.
documentCreationTimeFrom - lower value of documentCreationTimepublic java.lang.String getDocumentCreationTimeTo()
documentCreationTime
Equivalent to the $XDSDocumentEntryCreationTimeTo query
parameter.
documentCreationTimepublic void setDocumentCreationTimeTo(java.lang.String documentCreationTimeTo)
documentCreationTime
Equivalent to the $XDSDocumentEntryCreationTimeTo query
parameter.
documentCreationTimeTo - upper value of documentCreationTimepublic java.lang.String getServiceStartTimeFrom()
serviceStartTime
Equivalent to the $XDSDocumentEntryServiceStartTimeFrom query
parameter.
serviceStartTimepublic void setServiceStartTimeFrom(java.lang.String serviceStartTimeFrom)
serviceStartTime
Equivalent to the $XDSDocumentEntryServiceStartTimeFrom query
parameter.
serviceStartTimeFrom - lower value of serviceStartTimepublic java.lang.String getServiceStartTimeTo()
serviceStartTime
Equivalent to the $XDSDocumentEntryServiceStartTimeTo query
parameter.
serviceStartTimepublic void setServiceStartTimeTo(java.lang.String serviceStartTimeTo)
serviceStartTime
Equivalent to the $XDSDocumentEntryServiceStartTimeTo query
parameter.
serviceStartTimeTo - upper value of serviceStartTimepublic java.lang.String getServiceStopTimeFrom()
serviceStopTime
Equivalent to the $XDSDocumentEntryServiceStopTimeFrom query
parameter.
serviceStopTimepublic void setServiceStopTimeFrom(java.lang.String serviceStopTimeFrom)
serviceStopTime
Equivalent to the $XDSDocumentEntryServiceStopTimeFrom query
parameter.
serviceStopTimeFrom - lower value of serviceStopTimepublic java.lang.String getServiceStopTimeTo()
serviceStopTime
Equivalent to the $XDSDocumentEntryServiceStopTimeTo query
parameter.
serviceStopTimepublic void setServiceStopTimeTo(java.lang.String serviceStopTimeTo)
serviceStopTime
Equivalent to the $XDSDocumentEntryServiceStopTimeTo query
parameter.
serviceStopTimeTo - upper value of serviceStopTimepublic boolean hasHealthcareFacilityTypes()
healthcareFacilityTypes in the query
parameters?
healthcareFacilityTypes in
the query parameters.public java.util.List<CodedValue> getHealthcareFacilityTypes()
healthcareFacilityTypes property.
If multiple values are specified than they will be considered to represent
'OR' semantics.
This accessor method returns a reference to the live list, not a snapshot.
This is why there is not a set method for the
healthcareFacilityTypes property.
For example, to add a new item, do as follows:
getHealthcareFacilityTypes().add(newItem);Equivalent to the
$XDSDocumentEntryHealthcareFacilityTypeCode
query parameter.
public boolean hasClinicalSpecialties()
clinicalSpecialties in the query parameters?
clinicalSpecialties in the
query parameters.public java.util.List<CodedValue> getClinicalSpecialties()
clinicalSpecialties property.
If multiple values are specified than they will be considered to represent
'OR' semantics.
This accessor method returns a reference to the live list, not a snapshot.
This is why there is not a set method for the
clinicalSpecialties property.
For example, to add a new item, do as follows:
getClinicalSpecialties().add(newItem);Equivalent to the
$XDSDocumentEntryPracticeSettingCode query
parameter.
public boolean hasKeywords()
keywords in the query parameters?
keywords in the query
parameters.public java.util.Set<java.lang.String> getKeywords()
keywords property.
If multiple values are specified than they will be considered to represent
'OR' semantics.
This accessor method returns a reference to the live list, not a snapshot.
This is why there is not a set method for the
keywords property.
For example, to add a new item, do as follows:
getKeywords().add(newItem);Equivalent to the
$XDSDocumentEntryEventCodeList query
parameter.
public boolean hasStatuses()
statuses in the query parameters?
statuses in the query
parameters.public java.util.Set<DocumentStatus> getStatuses()
statuses property.
If multiple values are specified than they will be considered to represent
'OR' semantics.
This accessor method returns a reference to the live list, not a snapshot.
This is why there is not a set method for the
keywords property.
For example, to add a new item, do as follows:
getStatuses().add(newItem);Equivalent to the
$XDSDocumentEntryStatus query parameter.
public boolean matches(DocumentMetadata documentMetadata)
documentMetadata - Document metadata.
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||