au.gov.nehta.vendorlibrary.hi.hpio
Class ProviderSearchHIProviderDirectoryForOrganisationClient

java.lang.Object
  extended by au.gov.nehta.vendorlibrary.hi.hpio.ProviderSearchHIProviderDirectoryForOrganisationClient

public class ProviderSearchHIProviderDirectoryForOrganisationClient
extends java.lang.Object

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


Nested Class Summary
static class ProviderSearchHIProviderDirectoryForOrganisationClient.ArgumentValidator
          Validates search parameters are correct for the various search types.
 
Field Summary
static java.lang.String EMPTY
          Empty String variable.
 
Constructor Summary
ProviderSearchHIProviderDirectoryForOrganisationClient(java.lang.String serviceEndpoint, au.net.electronichealth.ns.hi.common.qualifiedidentifier._3_0.QualifiedId individualQualifiedId, javax.xml.ws.Holder<au.net.electronichealth.ns.hi.common.commoncoreelements._3_0.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.
ProviderSearchHIProviderDirectoryForOrganisationClient(java.lang.String serviceEndpoint, au.net.electronichealth.ns.hi.common.qualifiedidentifier._3_0.QualifiedId individualQualifiedId, au.net.electronichealth.ns.hi.common.qualifiedidentifier._3_0.QualifiedId organisationQualifiedId, javax.xml.ws.Holder<au.net.electronichealth.ns.hi.common.commoncoreelements._3_0.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, with the optional contracted service providers HPI-O organisation qualified ID set.
 
Method Summary
 au.net.electronichealth.ns.hi.svc.hiproviderdirectoryfororganisation._3_2_0.SearchHIProviderDirectoryForOrganisationResponse demographicSearch(au.net.electronichealth.ns.hi.svc.hiproviderdirectoryfororganisation._3_2_0.SearchHIProviderDirectoryForOrganisation request)
          Executes a Demographic HPI-O search.
 java.lang.String getLastSoapRequest()
          Getter for lastSoapRequest.
 java.lang.String getLastSoapResponse()
          Getter for lastSoapResponse.
 au.net.electronichealth.ns.hi.svc.hiproviderdirectoryfororganisation._3_2_0.SearchHIProviderDirectoryForOrganisationResponse identifierSearch(au.net.electronichealth.ns.hi.svc.hiproviderdirectoryfororganisation._3_2_0.SearchHIProviderDirectoryForOrganisation request)
          Executes an Identifier HPI-O search.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

EMPTY

public static final java.lang.String EMPTY
Empty String variable.

See Also:
Constant Field Values
Constructor Detail

ProviderSearchHIProviderDirectoryForOrganisationClient

public ProviderSearchHIProviderDirectoryForOrganisationClient(java.lang.String serviceEndpoint,
                                                              au.net.electronichealth.ns.hi.common.qualifiedidentifier._3_0.QualifiedId individualQualifiedId,
                                                              javax.xml.ws.Holder<au.net.electronichealth.ns.hi.common.commoncoreelements._3_0.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 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

ProviderSearchHIProviderDirectoryForOrganisationClient

public ProviderSearchHIProviderDirectoryForOrganisationClient(java.lang.String serviceEndpoint,
                                                              au.net.electronichealth.ns.hi.common.qualifiedidentifier._3_0.QualifiedId individualQualifiedId,
                                                              au.net.electronichealth.ns.hi.common.qualifiedidentifier._3_0.QualifiedId organisationQualifiedId,
                                                              javax.xml.ws.Holder<au.net.electronichealth.ns.hi.common.commoncoreelements._3_0.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, 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
Method Detail

identifierSearch

public final au.net.electronichealth.ns.hi.svc.hiproviderdirectoryfororganisation._3_2_0.SearchHIProviderDirectoryForOrganisationResponse identifierSearch(au.net.electronichealth.ns.hi.svc.hiproviderdirectoryfororganisation._3_2_0.SearchHIProviderDirectoryForOrganisation request)
                                                                                                                                                    throws au.net.electronichealth.ns.hi.svc.hiproviderdirectoryfororganisation._3_2_0.StandardErrorMsg
Executes an Identifier HPI-O search.

Parameters:
request - the SearchHIProviderDirectoryForIndividual request object containing the following mandatory fields: HPI-O and the following optional fields: Link Search Type
Returns:
the response from the SearchHIProviderDirectoryForIndividual service
Throws:
au.net.electronichealth.ns.hi.svc.hiproviderdirectoryfororganisation._3_2_0.StandardErrorMsg - if the Web Service call fails.

demographicSearch

public final au.net.electronichealth.ns.hi.svc.hiproviderdirectoryfororganisation._3_2_0.SearchHIProviderDirectoryForOrganisationResponse demographicSearch(au.net.electronichealth.ns.hi.svc.hiproviderdirectoryfororganisation._3_2_0.SearchHIProviderDirectoryForOrganisation request)
                                                                                                                                                     throws au.net.electronichealth.ns.hi.svc.hiproviderdirectoryfororganisation._3_2_0.StandardErrorMsg
Executes a Demographic HPI-O search.

Parameters:
request - the SearchHIProviderDirectoryForIndividual request object containing the following mandatory fields: 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.hiproviderdirectoryfororganisation._3_2_0.StandardErrorMsg - if the Web Service call fails.

getLastSoapResponse

public final java.lang.String getLastSoapResponse()
Getter for lastSoapResponse.

Returns:
lastSoapResponse the lastSoapResponse instance variable

getLastSoapRequest

public final java.lang.String getLastSoapRequest()
Getter for lastSoapRequest.

Returns:
lastSoapRequest the lastSoapRequest instance variable (Mandatory)