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

java.lang.Object
  extended by au.gov.nehta.vendorlibrary.pcehr.clients.common.Client<ihe.iti.xds_b._2007.DocumentRegistryPortType>
      extended by au.gov.nehta.vendorlibrary.pcehr.clients.view.GetDocumentListClient

public final class GetDocumentListClient
extends Client<ihe.iti.xds_b._2007.DocumentRegistryPortType>

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


Constructor Summary
GetDocumentListClient(javax.net.ssl.SSLSocketFactory sslSocketFactory, java.security.cert.X509Certificate x509Certificate, au.gov.nehta.xsp.CertificateVerifier certificateVerifier, java.security.PrivateKey privateKey, java.lang.String endpointAddress, boolean setLoggingEnabled)
          Constructor - accepts an optional certificate verifier.
GetDocumentListClient(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
 oasis.names.tc.ebxml_regrep.xsd.query._3.AdhocQueryResponse getDocumentList(au.net.electronichealth.ns.pcehr.xsd.common.commoncoreelements._1.PCEHRHeader commonHeader)
          Get the list of documents related to the PCEHR identified by commonHeader.ihiNumber.
 oasis.names.tc.ebxml_regrep.xsd.query._3.AdhocQueryResponse getDocumentList(au.net.electronichealth.ns.pcehr.xsd.common.commoncoreelements._1.PCEHRHeader commonHeader, DocumentQueryParams queryParams)
          Get the list of documents related to the PCEHR identified by commonHeader.ihiNumber, matching the supplied set of query parameters.
 
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

GetDocumentListClient

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

GetDocumentListClient

public GetDocumentListClient(javax.net.ssl.SSLSocketFactory sslSocketFactory,
                             java.security.cert.X509Certificate x509Certificate,
                             au.gov.nehta.xsp.CertificateVerifier certificateVerifier,
                             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

getDocumentList

public oasis.names.tc.ebxml_regrep.xsd.query._3.AdhocQueryResponse getDocumentList(au.net.electronichealth.ns.pcehr.xsd.common.commoncoreelements._1.PCEHRHeader commonHeader)
Get the list of documents related to the PCEHR identified by commonHeader.ihiNumber.

Parameters:
commonHeader - PCEHR common header.
Returns:
A list of the metadata of matching documents.

getDocumentList

public oasis.names.tc.ebxml_regrep.xsd.query._3.AdhocQueryResponse getDocumentList(au.net.electronichealth.ns.pcehr.xsd.common.commoncoreelements._1.PCEHRHeader commonHeader,
                                                                                   DocumentQueryParams queryParams)
Get the list of documents related to the PCEHR identified by commonHeader.ihiNumber, matching the supplied set of query parameters.

Parameters:
commonHeader - PCEHR common header.
queryParams - populated set of query parameters.
Returns:
A list of the metadata of matching documents.