au.gov.nehta.vendorlibrary.hi.hpii
Class ProviderSearchHIProviderDirectoryForIndividualClient

java.lang.Object
  extended by au.gov.nehta.vendorlibrary.hi.client.ClientBase<T>
      extended by au.gov.nehta.vendorlibrary.hi.client.BaseClient_3<au.net.electronichealth.ns.hi.svc.providersearchhiproviderdirectoryforindividual._3_2.ProviderSearchHIProviderDirectoryForIndividualPortType>
          extended by au.gov.nehta.vendorlibrary.hi.hpii.ProviderSearchHIProviderDirectoryForIndividualClient

public class ProviderSearchHIProviderDirectoryForIndividualClient
extends BaseClient_3<au.net.electronichealth.ns.hi.svc.providersearchhiproviderdirectoryforindividual._3_2.ProviderSearchHIProviderDirectoryForIndividualPortType>

An implementation of a Healthcare Identifiers (HI) - Healthcare Provider Identifier Individual (HPI-I) search client. This class may be used to connect to the Medicare HI Service to do Provider Search HI Provider Directory For Individual searches.


Nested Class Summary
static class ProviderSearchHIProviderDirectoryForIndividualClient.ArgumentValidator
          Validates search parameters are correct for the various search types.
 
Field Summary
 
Fields inherited from class au.gov.nehta.vendorlibrary.hi.client.BaseClient_3
individualQualifiedId, organisationQualifiedId, productHeader
 
Fields inherited from class au.gov.nehta.vendorlibrary.hi.client.ClientBase
certificateValidator, EMPTY, loggingHandler, port, QUALIFIED_ID_MISSING, signingCertificate, signingPrivateKey, SSL_SOCKET_FACTORY, SSL_SOCKET_FACTORY_INTERNAL, sslSocketFactory
 
Constructor Summary
ProviderSearchHIProviderDirectoryForIndividualClient(java.lang.String serviceEndpoint, ProductType productHeader, java.security.PrivateKey signingPrivateKey, java.security.cert.X509Certificate signingCertificate, javax.net.ssl.SSLSocketFactory sslSocketFactory)
          Constructor which creates a new ProviderSearchHIProviderDirectoryForIndividual Client with an endpoint and an SSL Socket Factory.
ProviderSearchHIProviderDirectoryForIndividualClient(java.lang.String serviceEndpoint, au.net.electronichealth.ns.hi.xsd.common.qualifiedidentifier._3.QualifiedId individualQualifiedId, au.net.electronichealth.ns.hi.xsd.common.commoncoreelements._3.ProductType productHeader, java.security.PrivateKey signingPrivateKey, java.security.cert.X509Certificate signingCertificate, javax.net.ssl.SSLSocketFactory sslSocketFactory)
          Constructor which creates a new ProviderSearchHIProviderDirectoryForIndividual Client with an endpoint and an SSL Socket Factory.
ProviderSearchHIProviderDirectoryForIndividualClient(java.lang.String serviceEndpoint, QualifiedId individualQualifiedId, ProductType productHeader, java.security.PrivateKey signingPrivateKey, java.security.cert.X509Certificate signingCertificate, javax.net.ssl.SSLSocketFactory sslSocketFactory)
          Constructor which creates a new ProviderSearchHIProviderDirectoryForIndividual Client with an endpoint and an SSL Socket Factory.
ProviderSearchHIProviderDirectoryForIndividualClient(java.lang.String serviceEndpoint, au.net.electronichealth.ns.hi.xsd.common.qualifiedidentifier._3.QualifiedId individualQualifiedId, au.net.electronichealth.ns.hi.xsd.common.qualifiedidentifier._3.QualifiedId organisationQualifiedId, au.net.electronichealth.ns.hi.xsd.common.commoncoreelements._3.ProductType productHeader, java.security.PrivateKey signingPrivateKey, java.security.cert.X509Certificate signingCertificate, javax.net.ssl.SSLSocketFactory sslSocketFactory, au.gov.nehta.xsp.CertificateValidator certificateValidator)
          Constructor which creates a new ProviderSearchHIProviderDirectoryForIndividual Client with an endpoint and an SSL Socket Factory, with the optional contracted service providers HPI-O organisation qualified ID set.
ProviderSearchHIProviderDirectoryForIndividualClient(java.lang.String serviceEndpoint, QualifiedId individualQualifiedId, QualifiedId organisationQualifiedId, ProductType productHeader, java.security.PrivateKey signingPrivateKey, java.security.cert.X509Certificate signingCertificate, javax.net.ssl.SSLSocketFactory sslSocketFactory, au.gov.nehta.xsp.CertificateValidator certificateValidator)
          Constructor which creates a new ProviderSearchHIProviderDirectoryForIndividual Client with an endpoint and an SSL Socket Factory, with the optional contracted service providers HPI-O organisation qualified ID set.
 
Method Summary
 au.net.electronichealth.ns.hi.svc.providersearchhiproviderdirectoryforindividual._3_2.SearchHIProviderDirectoryForIndividualResponse demographicSearch(au.net.electronichealth.ns.hi.svc.providersearchhiproviderdirectoryforindividual._3_2.SearchHIProviderDirectoryForIndividual request)
          Executes a Demographic HPI-I search.
 au.net.electronichealth.ns.hi.svc.providersearchhiproviderdirectoryforindividual._3_2.SearchHIProviderDirectoryForIndividualResponse demographicSearch(au.net.electronichealth.ns.hi.svc.providersearchhiproviderdirectoryforindividual._3_2.SearchHIProviderDirectoryForIndividual request, QualifiedId individualId)
          Executes a Demographic HPI-I search.
 au.net.electronichealth.ns.hi.svc.providersearchhiproviderdirectoryforindividual._3_2.SearchHIProviderDirectoryForIndividualResponse identifierSearch(au.net.electronichealth.ns.hi.svc.providersearchhiproviderdirectoryforindividual._3_2.SearchHIProviderDirectoryForIndividual request)
          Executes an Identifier HPI-I search.
 au.net.electronichealth.ns.hi.svc.providersearchhiproviderdirectoryforindividual._3_2.SearchHIProviderDirectoryForIndividualResponse identifierSearch(au.net.electronichealth.ns.hi.svc.providersearchhiproviderdirectoryforindividual._3_2.SearchHIProviderDirectoryForIndividual request, QualifiedId individualId)
          Executes an Identifier HPI-I search.
 
Methods inherited from class au.gov.nehta.vendorlibrary.hi.client.BaseClient_3
checkUserID, getTimestampHeader, hasNoOrganisationQualifiedId
 
Methods inherited from class au.gov.nehta.vendorlibrary.hi.client.ClientBase
configureEndpoint, getBindingProvider, getLastSoapRequest, getLastSoapResponse, getPort, isEmpty
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ProviderSearchHIProviderDirectoryForIndividualClient

public ProviderSearchHIProviderDirectoryForIndividualClient(java.lang.String serviceEndpoint,
                                                            au.net.electronichealth.ns.hi.xsd.common.qualifiedidentifier._3.QualifiedId individualQualifiedId,
                                                            au.net.electronichealth.ns.hi.xsd.common.commoncoreelements._3.ProductType productHeader,
                                                            java.security.PrivateKey signingPrivateKey,
                                                            java.security.cert.X509Certificate signingCertificate,
                                                            javax.net.ssl.SSLSocketFactory sslSocketFactory)
Constructor which creates a new ProviderSearchHIProviderDirectoryForIndividual Client with an endpoint and an SSL Socket Factory.

Parameters:
serviceEndpoint - the Web Service endpoint for the Medicare HI Service interface (Mandatory)
individualQualifiedId - The qualified user ID for connecting to the ProviderSearchHIProviderDirectoryForIndividual service (Mandatory)
productHeader - The product header data for connecting to the ProviderSearchHIProviderDirectoryForIndividual service (Mandatory)
signingPrivateKey - The private key to be used for signing (Mandatory)
signingCertificate - The certificate to be used for signing (Mandatory)
sslSocketFactory - the SSL Socket Factory to be used when connecting to the Web Service provider

ProviderSearchHIProviderDirectoryForIndividualClient

public ProviderSearchHIProviderDirectoryForIndividualClient(java.lang.String serviceEndpoint,
                                                            au.net.electronichealth.ns.hi.xsd.common.qualifiedidentifier._3.QualifiedId individualQualifiedId,
                                                            au.net.electronichealth.ns.hi.xsd.common.qualifiedidentifier._3.QualifiedId organisationQualifiedId,
                                                            au.net.electronichealth.ns.hi.xsd.common.commoncoreelements._3.ProductType productHeader,
                                                            java.security.PrivateKey signingPrivateKey,
                                                            java.security.cert.X509Certificate signingCertificate,
                                                            javax.net.ssl.SSLSocketFactory sslSocketFactory,
                                                            au.gov.nehta.xsp.CertificateValidator certificateValidator)
Constructor which creates a new ProviderSearchHIProviderDirectoryForIndividual Client with an endpoint and an SSL Socket Factory, with the optional contracted service providers HPI-O organisation qualified ID set.

Parameters:
serviceEndpoint - the Web Service endpoint for the Medicare HI Service interface (Mandatory)
individualQualifiedId - The qualified user ID for connecting to the ProviderSearchHIProviderDirectoryForIndividual service (Mandatory)
organisationQualifiedId - The qualified user ID for connecting to the ProviderSearchHIProviderDirectoryForIndividual service (Optional)
productHeader - The product header data for connecting to the ProviderSearchHIProviderDirectoryForIndividual service (Mandatory)
signingPrivateKey - The private key to be used for signing (Mandatory)
signingCertificate - The certificate to be used for signing (Mandatory)
sslSocketFactory - the SSL Socket Factory to be used when connecting to the Web Service provider
certificateValidator - (optional) a user supplied validator to authenticate the response certificate.

ProviderSearchHIProviderDirectoryForIndividualClient

public ProviderSearchHIProviderDirectoryForIndividualClient(java.lang.String serviceEndpoint,
                                                            QualifiedId individualQualifiedId,
                                                            ProductType productHeader,
                                                            java.security.PrivateKey signingPrivateKey,
                                                            java.security.cert.X509Certificate signingCertificate,
                                                            javax.net.ssl.SSLSocketFactory sslSocketFactory)
Constructor which creates a new ProviderSearchHIProviderDirectoryForIndividual Client with an endpoint and an SSL Socket Factory. This is an overloaded constructor for the generic qualifiedid and product types.

Parameters:
serviceEndpoint - the Web Service endpoint for the Medicare HI Service interface (Mandatory)
individualQualifiedId - The qualified user ID for connecting to the ProviderSearchHIProviderDirectoryForIndividual service (Mandatory)
productHeader - The product header data for connecting to the ProviderSearchHIProviderDirectoryForIndividual service (Mandatory)
signingPrivateKey - The private key to be used for signing (Mandatory)
signingCertificate - The certificate to be used for signing (Mandatory)
sslSocketFactory - the SSL Socket Factory to be used when connecting to the Web Service provider

ProviderSearchHIProviderDirectoryForIndividualClient

public ProviderSearchHIProviderDirectoryForIndividualClient(java.lang.String serviceEndpoint,
                                                            ProductType productHeader,
                                                            java.security.PrivateKey signingPrivateKey,
                                                            java.security.cert.X509Certificate signingCertificate,
                                                            javax.net.ssl.SSLSocketFactory sslSocketFactory)
Constructor which creates a new ProviderSearchHIProviderDirectoryForIndividual Client with an endpoint and an SSL Socket Factory. This is an overloaded constructor for the generic qualified id and product types.

Parameters:
serviceEndpoint - the Web Service endpoint for the Medicare HI Service interface (Mandatory)
individualQualifiedId - The qualified user ID for connecting to the ProviderSearchHIProviderDirectoryForIndividual service (Mandatory)
productHeader - The product header data for connecting to the ProviderSearchHIProviderDirectoryForIndividual service (Mandatory)
signingPrivateKey - The private key to be used for signing (Mandatory)
signingCertificate - The certificate to be used for signing (Mandatory)
sslSocketFactory - the SSL Socket Factory to be used when connecting to the Web Service provider

ProviderSearchHIProviderDirectoryForIndividualClient

public ProviderSearchHIProviderDirectoryForIndividualClient(java.lang.String serviceEndpoint,
                                                            QualifiedId individualQualifiedId,
                                                            QualifiedId organisationQualifiedId,
                                                            ProductType productHeader,
                                                            java.security.PrivateKey signingPrivateKey,
                                                            java.security.cert.X509Certificate signingCertificate,
                                                            javax.net.ssl.SSLSocketFactory sslSocketFactory,
                                                            au.gov.nehta.xsp.CertificateValidator certificateValidator)
Constructor which creates a new ProviderSearchHIProviderDirectoryForIndividual Client with an endpoint and an SSL Socket Factory, with the optional contracted service providers HPI-O organisation qualified ID set. This is an overloaded constructor for the generic qualified id and product types.

Parameters:
serviceEndpoint - the Web Service endpoint for the Medicare HI Service interface (Mandatory)
individualQualifiedId - The qualified user ID for connecting to the ProviderSearchHIProviderDirectoryForIndividual service (Mandatory)
organisationQualifiedId - The qualified user ID for connecting to the ProviderSearchHIProviderDirectoryForIndividual service (Optional)
productHeader - The product header data for connecting to the ProviderSearchHIProviderDirectoryForIndividual service (Mandatory)
signingPrivateKey - The private key to be used for signing (Mandatory)
signingCertificate - The certificate to be used for signing (Mandatory)
sslSocketFactory - the SSL Socket Factory to be used when connecting to the Web Service provider
certificateValidator - (optional) a user supplied validator to authenticate the response certificate.
Method Detail

identifierSearch

public final au.net.electronichealth.ns.hi.svc.providersearchhiproviderdirectoryforindividual._3_2.SearchHIProviderDirectoryForIndividualResponse identifierSearch(au.net.electronichealth.ns.hi.svc.providersearchhiproviderdirectoryforindividual._3_2.SearchHIProviderDirectoryForIndividual request)
                                                                                                                                                            throws au.net.electronichealth.ns.hi.svc.providersearchhiproviderdirectoryforindividual._3_2.StandardErrorMsg
Executes an Identifier HPI-I search.

Parameters:
request - the SearchHIProviderDirectoryForIndividual request object containing the following mandatory fields: HPI-I
Returns:
the response from the SearchHIProviderDirectoryForIndividual service
Throws:
au.net.electronichealth.ns.hi.svc.providersearchhiproviderdirectoryforindividual._3_2.StandardErrorMsg - if the Web Service call fails.

demographicSearch

public final au.net.electronichealth.ns.hi.svc.providersearchhiproviderdirectoryforindividual._3_2.SearchHIProviderDirectoryForIndividualResponse demographicSearch(au.net.electronichealth.ns.hi.svc.providersearchhiproviderdirectoryforindividual._3_2.SearchHIProviderDirectoryForIndividual request)
                                                                                                                                                             throws au.net.electronichealth.ns.hi.svc.providersearchhiproviderdirectoryforindividual._3_2.StandardErrorMsg
Executes a Demographic HPI-I search.

Parameters:
request - the SearchHIProviderDirectoryForIndividual request object containing the following mandatory fields: Family Name and the following optional fields: Either "Australian Address Criteria" OR "International Address Criteria" but not both.
Returns:
the response from the SearchHIProviderDirectoryForIndividual service
Throws:
au.net.electronichealth.ns.hi.svc.providersearchhiproviderdirectoryforindividual._3_2.StandardErrorMsg - if the Web Service call fails.

identifierSearch

public final au.net.electronichealth.ns.hi.svc.providersearchhiproviderdirectoryforindividual._3_2.SearchHIProviderDirectoryForIndividualResponse identifierSearch(au.net.electronichealth.ns.hi.svc.providersearchhiproviderdirectoryforindividual._3_2.SearchHIProviderDirectoryForIndividual request,
                                                                                                                                                                   QualifiedId individualId)
                                                                                                                                                            throws au.net.electronichealth.ns.hi.svc.providersearchhiproviderdirectoryforindividual._3_2.StandardErrorMsg
Executes an Identifier HPI-I search.

Parameters:
request - the SearchHIProviderDirectoryForIndividual request object containing the following mandatory fields: HPI-I
individualId - the qualified user id of the user making the request
Returns:
the response from the SearchHIProviderDirectoryForIndividual service
Throws:
au.net.electronichealth.ns.hi.svc.providersearchhiproviderdirectoryforindividual._3_2.StandardErrorMsg - if the Web Service call fails.

demographicSearch

public final au.net.electronichealth.ns.hi.svc.providersearchhiproviderdirectoryforindividual._3_2.SearchHIProviderDirectoryForIndividualResponse demographicSearch(au.net.electronichealth.ns.hi.svc.providersearchhiproviderdirectoryforindividual._3_2.SearchHIProviderDirectoryForIndividual request,
                                                                                                                                                                    QualifiedId individualId)
                                                                                                                                                             throws au.net.electronichealth.ns.hi.svc.providersearchhiproviderdirectoryforindividual._3_2.StandardErrorMsg
Executes a Demographic HPI-I search.

Parameters:
request - the SearchHIProviderDirectoryForIndividual request object containing the following mandatory fields: Family Name and the following optional fields: Either "Australian Address Criteria" OR "International Address Criteria" but not both.
individualId - the qualified user id of the user making the request
Returns:
the response from the SearchHIProviderDirectoryForIndividual service
Throws:
au.net.electronichealth.ns.hi.svc.providersearchhiproviderdirectoryforindividual._3_2.StandardErrorMsg - if the Web Service call fails.