au.gov.nehta.vendorlibrary.pcehr.clients.view
Class GetViewClient

java.lang.Object
  extended by au.gov.nehta.vendorlibrary.pcehr.clients.common.Client<au.net.electronichealth.ns.pcehr.svc.getview._1.GetViewPortType>
      extended by au.gov.nehta.vendorlibrary.pcehr.clients.view.GetViewClient

public class GetViewClient
extends Client<au.net.electronichealth.ns.pcehr.svc.getview._1.GetViewPortType>

A JAX-WS client to the PCEHR 'Get View' web service.


Constructor Summary
GetViewClient(javax.net.ssl.SSLSocketFactory sslSocketFactory, java.security.cert.X509Certificate x509Certificate, au.gov.nehta.xsp.CertificateValidator certificateValidator, java.security.PrivateKey privateKey, java.lang.String endpointAddress, boolean setLoggingEnabled)
          Constructor - accepts an optional certificate verifier.
GetViewClient(javax.net.ssl.SSLSocketFactory sslSocketFactory, java.security.cert.X509Certificate x509Certificate, java.security.PrivateKey privateKey, java.lang.String endpointAddress, boolean setLoggingEnabled)
          Constructor - no certificate verification performed.
 
Method Summary
 TypedViewResponse<au.net.electronichealth.ns.pcehr.xsd.interfaces.diagnosticimagingreportview._1.DiagnosticImagingReportViewResponse> getView(au.net.electronichealth.ns.pcehr.xsd.common.commoncoreelements._1.PCEHRHeader commonHeader, au.net.electronichealth.ns.pcehr.xsd.interfaces.diagnosticimagingreportview._1.DiagnosticImagingReportView getViewRequestObject)
          Invokes the web service operation that returns a list of representatives associated with a particular individual's PCEHR.
 au.net.electronichealth.ns.pcehr.xsd.interfaces.getview._1.GetViewResponse getView(au.net.electronichealth.ns.pcehr.xsd.common.commoncoreelements._1.PCEHRHeader commonHeader, au.net.electronichealth.ns.pcehr.xsd.interfaces.healthcheckscheduleview._1.HealthCheckScheduleView getViewRequestObject)
          Invokes the web service operation that returns a list of representatives associated with a particular individual's PCEHR.
 TypedViewResponse<au.net.electronichealth.ns.pcehr.xsd.interfaces.healthrecordoverview._1.HealthRecordOverviewResponse> getView(au.net.electronichealth.ns.pcehr.xsd.common.commoncoreelements._1.PCEHRHeader commonHeader, au.net.electronichealth.ns.pcehr.xsd.interfaces.healthrecordoverview._1.HealthRecordOverView getViewRequestObject)
          Invokes the web service operation that returns a list of representatives associated with a particular individual's PCEHR.
 au.net.electronichealth.ns.pcehr.xsd.interfaces.getview._1.GetViewResponse getView(au.net.electronichealth.ns.pcehr.xsd.common.commoncoreelements._1.PCEHRHeader commonHeader, au.net.electronichealth.ns.pcehr.xsd.interfaces.medicareoverview._1.MedicareOverview getViewRequestObject)
          Invokes the web service operation that returns a list of representatives associated with a particular individual's PCEHR.
 au.net.electronichealth.ns.pcehr.xsd.interfaces.getview._1.GetViewResponse getView(au.net.electronichealth.ns.pcehr.xsd.common.commoncoreelements._1.PCEHRHeader commonHeader, java.lang.Object getViewRequestObject)
           
 au.net.electronichealth.ns.pcehr.xsd.interfaces.getview._1.GetViewResponse getView(au.net.electronichealth.ns.pcehr.xsd.common.commoncoreelements._1.PCEHRHeader commonHeader, au.net.electronichealth.ns.pcehr.xsd.interfaces.observationview._1.ObservationView getViewRequestObject)
          Invokes the web service operation that returns a list of representatives associated with a particular individual’s PCEHR.
 TypedViewResponse<au.net.electronichealth.ns.pcehr.xsd.interfaces.pathologyreportview._1.PathologyReportViewResponse> getView(au.net.electronichealth.ns.pcehr.xsd.common.commoncoreelements._1.PCEHRHeader commonHeader, au.net.electronichealth.ns.pcehr.xsd.interfaces.pathologyreportview._1.PathologyReportView getViewRequestObject)
          Invokes the web service operation that returns a list of representatives associated with a particular individual's PCEHR.
 au.net.electronichealth.ns.pcehr.xsd.interfaces.getview._1.GetViewResponse getView(au.net.electronichealth.ns.pcehr.xsd.common.commoncoreelements._1.PCEHRHeader commonHeader, au.net.electronichealth.ns.pcehr.xsd.interfaces.prescriptionanddispenseview._1.PrescriptionAndDispenseView getViewRequestObject)
          Invokes the web service operation that returns a list of representatives associated with a particular individual's PCEHR.
 
Methods inherited from class au.gov.nehta.vendorlibrary.pcehr.clients.common.Client
getHandlerChain, getLastSoapRequest, getLastSoapResponse, getPort, setMTOMEnabled, setProperty
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

GetViewClient

public GetViewClient(javax.net.ssl.SSLSocketFactory sslSocketFactory,
                     java.security.cert.X509Certificate x509Certificate,
                     java.security.PrivateKey privateKey,
                     java.lang.String endpointAddress,
                     boolean setLoggingEnabled)
Constructor - no certificate verification performed.

Parameters:
sslSocketFactory - the SSLSocketFactory to be used when connecting to the web service provider (mandatory).
x509Certificate - the certificate key to be used for signing (mandatory)
privateKey - the private key to be used for signing (mandatory)
endpointAddress - the endpoint address of the web service (mandatory).
setLoggingEnabled - set to true to enable logging (mandatory).

GetViewClient

public GetViewClient(javax.net.ssl.SSLSocketFactory sslSocketFactory,
                     java.security.cert.X509Certificate x509Certificate,
                     au.gov.nehta.xsp.CertificateValidator certificateValidator,
                     java.security.PrivateKey privateKey,
                     java.lang.String endpointAddress,
                     boolean setLoggingEnabled)
Constructor - accepts an optional certificate verifier.

Parameters:
sslSocketFactory - the SSLSocketFactory to be used when connecting to the web service provider (mandatory).
x509Certificate - the certificate key to be used for signing (mandatory)
certificateVerifier - CertificateVerifier implementation (optional).
privateKey - the private key to be used for signing (mandatory)
endpointAddress - the endpoint address of the web service (mandatory).
setLoggingEnabled - set to true to enable logging (mandatory).
Method Detail

getView

public final au.net.electronichealth.ns.pcehr.xsd.interfaces.getview._1.GetViewResponse getView(au.net.electronichealth.ns.pcehr.xsd.common.commoncoreelements._1.PCEHRHeader commonHeader,
                                                                                                au.net.electronichealth.ns.pcehr.xsd.interfaces.medicareoverview._1.MedicareOverview getViewRequestObject)
                                                                                         throws au.net.electronichealth.ns.pcehr.svc.getview._1.StandardErrorMsg
Invokes the web service operation that returns a list of representatives associated with a particular individual's PCEHR.

Parameters:
commonHeader - populated PCEHRHeader request object (Mandatory).
getViewRequestObject - a MedicareOverview object for request
Returns:
response (type GetViewResponse)
Throws:
au.net.electronichealth.ns.pcehr.svc.getview._1.StandardErrorMsg - Thrown in the event that the operation fails.

getView

public final au.net.electronichealth.ns.pcehr.xsd.interfaces.getview._1.GetViewResponse getView(au.net.electronichealth.ns.pcehr.xsd.common.commoncoreelements._1.PCEHRHeader commonHeader,
                                                                                                au.net.electronichealth.ns.pcehr.xsd.interfaces.observationview._1.ObservationView getViewRequestObject)
                                                                                         throws au.net.electronichealth.ns.pcehr.svc.getview._1.StandardErrorMsg
Invokes the web service operation that returns a list of representatives associated with a particular individual’s PCEHR.

Parameters:
commonHeader - populated PCEHRHeader request object (Mandatory).
getViewRequestObject - a ObservationView object for request
Returns:
response (type GetViewResponse)
Throws:
au.net.electronichealth.ns.pcehr.svc.getview._1.StandardErrorMsg - Thrown in the event that the operation fails.

getView

public final au.net.electronichealth.ns.pcehr.xsd.interfaces.getview._1.GetViewResponse getView(au.net.electronichealth.ns.pcehr.xsd.common.commoncoreelements._1.PCEHRHeader commonHeader,
                                                                                                au.net.electronichealth.ns.pcehr.xsd.interfaces.prescriptionanddispenseview._1.PrescriptionAndDispenseView getViewRequestObject)
                                                                                         throws au.net.electronichealth.ns.pcehr.svc.getview._1.StandardErrorMsg
Invokes the web service operation that returns a list of representatives associated with a particular individual's PCEHR.

Parameters:
commonHeader - populated PCEHRHeader request object (Mandatory).
getViewRequestObject - a PrescriptionAndDispenseView object for request
Returns:
response (type GetViewResponse)
Throws:
au.net.electronichealth.ns.pcehr.svc.getview._1.StandardErrorMsg - Thrown in the event that the operation fails.

getView

public final TypedViewResponse<au.net.electronichealth.ns.pcehr.xsd.interfaces.pathologyreportview._1.PathologyReportViewResponse> getView(au.net.electronichealth.ns.pcehr.xsd.common.commoncoreelements._1.PCEHRHeader commonHeader,
                                                                                                                                           au.net.electronichealth.ns.pcehr.xsd.interfaces.pathologyreportview._1.PathologyReportView getViewRequestObject)
                                                                                                                                    throws au.net.electronichealth.ns.pcehr.svc.getview._1.StandardErrorMsg
Invokes the web service operation that returns a list of representatives associated with a particular individual's PCEHR.

Parameters:
commonHeader - populated PCEHRHeader request object (Mandatory).
getViewRequestObject - a PathologyReportView object for request
Returns:
response (type TypedViewResponse
Throws:
au.net.electronichealth.ns.pcehr.svc.getview._1.StandardErrorMsg - Thrown in the event that the operation fails.

getView

public final TypedViewResponse<au.net.electronichealth.ns.pcehr.xsd.interfaces.diagnosticimagingreportview._1.DiagnosticImagingReportViewResponse> getView(au.net.electronichealth.ns.pcehr.xsd.common.commoncoreelements._1.PCEHRHeader commonHeader,
                                                                                                                                                           au.net.electronichealth.ns.pcehr.xsd.interfaces.diagnosticimagingreportview._1.DiagnosticImagingReportView getViewRequestObject)
                                                                                                                                                    throws au.net.electronichealth.ns.pcehr.svc.getview._1.StandardErrorMsg
Invokes the web service operation that returns a list of representatives associated with a particular individual's PCEHR.

Parameters:
commonHeader - populated PCEHRHeader request object (Mandatory).
getViewRequestObject - a DiagnosticImagingReportView object for request
Returns:
response (type TypedViewResponse)
Throws:
au.net.electronichealth.ns.pcehr.svc.getview._1.StandardErrorMsg - Thrown in the event that the operation fails.

getView

public final TypedViewResponse<au.net.electronichealth.ns.pcehr.xsd.interfaces.healthrecordoverview._1.HealthRecordOverviewResponse> getView(au.net.electronichealth.ns.pcehr.xsd.common.commoncoreelements._1.PCEHRHeader commonHeader,
                                                                                                                                             au.net.electronichealth.ns.pcehr.xsd.interfaces.healthrecordoverview._1.HealthRecordOverView getViewRequestObject)
                                                                                                                                      throws au.net.electronichealth.ns.pcehr.svc.getview._1.StandardErrorMsg
Invokes the web service operation that returns a list of representatives associated with a particular individual's PCEHR.

Parameters:
commonHeader - populated PCEHRHeader request object (Mandatory).
getViewRequestObject - a HealthRecordOverView object for request
Returns:
response (type TypedViewResponse)
Throws:
au.net.electronichealth.ns.pcehr.svc.getview._1.StandardErrorMsg - Thrown in the event that the operation fails.

getView

public final au.net.electronichealth.ns.pcehr.xsd.interfaces.getview._1.GetViewResponse getView(au.net.electronichealth.ns.pcehr.xsd.common.commoncoreelements._1.PCEHRHeader commonHeader,
                                                                                                au.net.electronichealth.ns.pcehr.xsd.interfaces.healthcheckscheduleview._1.HealthCheckScheduleView getViewRequestObject)
                                                                                         throws au.net.electronichealth.ns.pcehr.svc.getview._1.StandardErrorMsg
Invokes the web service operation that returns a list of representatives associated with a particular individual's PCEHR. This is the type-safe interface that will guarantee no JAXB exceptions

Parameters:
commonHeader - populated PCEHRHeader request object (Mandatory).
getViewRequestObject - a HealthCheckScheduleView object for request
Returns:
response (type GetViewResponse)
Throws:
au.net.electronichealth.ns.pcehr.svc.getview._1.StandardErrorMsg - Thrown in the event that the operation fails.

getView

public au.net.electronichealth.ns.pcehr.xsd.interfaces.getview._1.GetViewResponse getView(au.net.electronichealth.ns.pcehr.xsd.common.commoncoreelements._1.PCEHRHeader commonHeader,
                                                                                          java.lang.Object getViewRequestObject)
                                                                                   throws au.net.electronichealth.ns.pcehr.svc.getview._1.StandardErrorMsg
Parameters:
commonHeader - populated PCEHRHeader request object (Mandatory).
getViewRequestObject - getView Request Object, this object must be 'known' to the client software otherwise there will be a binding error JAXBException
Returns:
response (type GetViewResponse)
Throws:
au.net.electronichealth.ns.pcehr.svc.getview._1.StandardErrorMsg - thrown in the event that the operation fails.
javax.xml.bind.JAXBException - thrown if there is a binding error or the GetView request object is not known to the JAXB context