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

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.providerbatchasyncsearchforproviderindividual._5_1.SearchForProviderIndividualBatchAsyncPortType>
          extended by au.gov.nehta.vendorlibrary.hi.hpii.SearchForProviderIndividualBatchAsyncClient

public class SearchForProviderIndividualBatchAsyncClient
extends BaseClient_3<au.net.electronichealth.ns.hi.svc.providerbatchasyncsearchforproviderindividual._5_1.SearchForProviderIndividualBatchAsyncPortType>

An implementation of a Healthcare Identifiers (HI) - Healthcare Provider Identifier Organisation (HPI-O) search client for Batch Asynchronous requests. This class may be used to connect to the Medicare HI Service to do Provider Search HI Provider Directory For Organisation searches.


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
SearchForProviderIndividualBatchAsyncClient(java.lang.String serviceEndpoint, 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 Client using the wrapped version of the product type with an endpoint and an SSL Socket Factory.
SearchForProviderIndividualBatchAsyncClient(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 Client with an endpoint and an SSL Socket Factory.
SearchForProviderIndividualBatchAsyncClient(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 ProviderSearchForProviderOrganisation 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.providerbatchasyncsearchforproviderindividual._5_1.RetrieveSearchForProviderIndividualResponse retrieveSearch(au.net.electronichealth.ns.hi.svc.providerbatchasyncsearchforproviderindividual._5_1.RetrieveSearchForProviderIndividual request)
          Retrieves provider asynchronous search.
 au.net.electronichealth.ns.hi.svc.providerbatchasyncsearchforproviderindividual._5_1.RetrieveSearchForProviderIndividualResponse retrieveSearch(au.net.electronichealth.ns.hi.svc.providerbatchasyncsearchforproviderindividual._5_1.RetrieveSearchForProviderIndividual request, QualifiedId individualId)
          Retrieves provider asynchronous search.
 void retrieveSearchCheck(au.net.electronichealth.ns.hi.svc.providerbatchasyncsearchforproviderindividual._5_1.RetrieveSearchForProviderIndividual request)
          Checks that only the correct parameters for a Retrieve search request are set.
 au.net.electronichealth.ns.hi.svc.providerbatchasyncsearchforproviderindividual._5_1.SubmitSearchForProviderIndividualResponse submitSearch(ProviderIndividualBatchSearch request)
          Submits provider asynchronous search.
 au.net.electronichealth.ns.hi.svc.providerbatchasyncsearchforproviderindividual._5_1.SubmitSearchForProviderIndividualResponse submitSearch(ProviderIndividualBatchSearch request, QualifiedId individualId)
          Submits provider asynchronous search.
 void submitSearchCheck(au.net.electronichealth.ns.hi.svc.providerbatchasyncsearchforproviderindividual._5_1.SubmitSearchForProviderIndividual request)
          Checks that only the correct parameters for a batch search request are set.
 
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

SearchForProviderIndividualBatchAsyncClient

public SearchForProviderIndividualBatchAsyncClient(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 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 ProviderSearchHIProviderDirectoryForOrganisation service (Mandatory)
productHeader - The product header data for connecting to the ProviderSearchHIProviderDirectoryForOrganisation 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

SearchForProviderIndividualBatchAsyncClient

public SearchForProviderIndividualBatchAsyncClient(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 ProviderSearchForProviderOrganisation 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 ProviderSearchHIProviderDirectoryForOrganisation service (Mandatory)
organisationQualifiedId - The qualified organisation ID for connecting to the ProviderSearchHIProviderDirectoryForOrganisation service (Optional)
productHeader - The product header data for connecting to the ProviderSearchHIProviderDirectoryForOrganisation 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.

SearchForProviderIndividualBatchAsyncClient

public SearchForProviderIndividualBatchAsyncClient(java.lang.String serviceEndpoint,
                                                   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 Client using the wrapped version of the product type with an endpoint and an SSL Socket Factory. This type constructed client assumes the individual qualified user id will be supplied per request

Parameters:
serviceEndpoint - the Web Service endpoint for the Medicare HI Service interface (Mandatory)
productHeader - The product header data for connecting to the ProviderSearchHIProviderDirectoryForOrganisation 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

submitSearch

public au.net.electronichealth.ns.hi.svc.providerbatchasyncsearchforproviderindividual._5_1.SubmitSearchForProviderIndividualResponse submitSearch(ProviderIndividualBatchSearch request)
                                                                                                                                            throws au.net.electronichealth.ns.hi.svc.providerbatchasyncsearchforproviderindividual._5_1.StandardErrorMsg
Submits provider asynchronous search.

Parameters:
request - the SearchForProviderIndividual request object containing the following mandatory fields: FamilyName
Returns:
the response from the SearchForProviderIndividual service
Throws:
au.net.electronichealth.ns.hi.svc.providerbatchasyncsearchforproviderindividual._5_1.StandardErrorMsg - if the Web Service call fails.

submitSearch

public au.net.electronichealth.ns.hi.svc.providerbatchasyncsearchforproviderindividual._5_1.SubmitSearchForProviderIndividualResponse submitSearch(ProviderIndividualBatchSearch request,
                                                                                                                                                   QualifiedId individualId)
                                                                                                                                            throws au.net.electronichealth.ns.hi.svc.providerbatchasyncsearchforproviderindividual._5_1.StandardErrorMsg
Submits provider asynchronous search.

Parameters:
request - the SearchForProviderIndividual request object containing the following mandatory fields: FamilyName
individualId - the qualified user id of the user making the request
Returns:
the response from the SearchForProviderIndividual service
Throws:
au.net.electronichealth.ns.hi.svc.providerbatchasyncsearchforproviderindividual._5_1.StandardErrorMsg - if the Web Service call fails.

retrieveSearch

public au.net.electronichealth.ns.hi.svc.providerbatchasyncsearchforproviderindividual._5_1.RetrieveSearchForProviderIndividualResponse retrieveSearch(au.net.electronichealth.ns.hi.svc.providerbatchasyncsearchforproviderindividual._5_1.RetrieveSearchForProviderIndividual request,
                                                                                                                                                       QualifiedId individualId)
                                                                                                                                                throws au.net.electronichealth.ns.hi.svc.providerbatchasyncsearchforproviderindividual._5_1.StandardErrorMsg
Retrieves provider asynchronous search.

Parameters:
request - the SearchForProviderIndividual request object containing the following mandatory fields: FamilyName
individualId - the qualified user id of the user making the request
Returns:
the response from the SearchForProviderIndividual service
Throws:
au.net.electronichealth.ns.hi.svc.providerbatchasyncsearchforproviderindividual._5_1.StandardErrorMsg - if the Web Service call fails.

retrieveSearch

public au.net.electronichealth.ns.hi.svc.providerbatchasyncsearchforproviderindividual._5_1.RetrieveSearchForProviderIndividualResponse retrieveSearch(au.net.electronichealth.ns.hi.svc.providerbatchasyncsearchforproviderindividual._5_1.RetrieveSearchForProviderIndividual request)
                                                                                                                                                throws au.net.electronichealth.ns.hi.svc.providerbatchasyncsearchforproviderindividual._5_1.StandardErrorMsg
Retrieves provider asynchronous search.

Parameters:
request - the SearchForProviderIndividual request object containing the following mandatory fields: FamilyName
Returns:
the response from the SearchForProviderIndividual service
Throws:
au.net.electronichealth.ns.hi.svc.providerbatchasyncsearchforproviderindividual._5_1.StandardErrorMsg - if the Web Service call fails.

retrieveSearchCheck

public void retrieveSearchCheck(au.net.electronichealth.ns.hi.svc.providerbatchasyncsearchforproviderindividual._5_1.RetrieveSearchForProviderIndividual request)
Checks that only the correct parameters for a Retrieve search request are set.

Parameters:
request - the search request object containing the parameters to be checked.

submitSearchCheck

public void submitSearchCheck(au.net.electronichealth.ns.hi.svc.providerbatchasyncsearchforproviderindividual._5_1.SubmitSearchForProviderIndividual request)
Checks that only the correct parameters for a batch search request are set.

Parameters:
request - the search request object containing the parameters to be checked.