com.cbs.ctr3ws.iservices.IExternalCtr3WS

Class Overview

description:the interface contains the CTR2 soap webservices.

Summary

Public Methods
abstract Long countWaitlistRecipients(WaitlistSearchCriteria dwlCriteria)
Get the count of the DWL waitlist organ requests that match the search criteria.
abstract <R extends Exception> WSPatient findPatient(String nationalID)
Get a CTR patient's basic information.
abstract List<WSWaitlistSearchResult> listWaitlistRecipients(WaitlistSearchCriteria dwlCriteria)
List the DWL national waitlist organ requests.
[Expand]
Inherited Methods
From interface com.cbs.ctr3ws.iservices.IExternalAllocation
From interface com.cbs.ctr3ws.iservices.IExternalAttachment
From interface com.cbs.ctr3ws.iservices.IExternalDonor
From interface com.cbs.ctr3ws.iservices.IExternalHealth
From interface com.cbs.ctr3ws.iservices.IExternalHla
From interface com.cbs.ctr3ws.iservices.IExternalOffers
From interface com.cbs.ctr3ws.iservices.IExternalRecipient

Public Methods

public abstract Long countWaitlistRecipients (WaitlistSearchCriteria dwlCriteria)

Get the count of the DWL waitlist organ requests that match the search criteria.

Sample soap requests: countWaitlistRecipients

Parameters
dwlCriteria the DWL waitlist search criteria that is used to filter the waitlist
required: FALSE
see: WaitlistSearchCriteria
note: when input 'dwlCriteria' is null, no filtering is applied and the whole national waitlist count will be returned.
Returns
  • the count of organ requests that match the search criteria.
Throws
SoapException the soap exception

public abstract WSPatient findPatient (String nationalID)

Get a CTR patient's basic information.

Sample soap requests: findPatient

Parameters
nationalID the CTR2 patient ID.
required: TRUE
see: nationalId info
Returns
  • the CTR basic patient information.
    see: WSPatient
Throws
SoapException

public abstract List<WSWaitlistSearchResult> listWaitlistRecipients (WaitlistSearchCriteria dwlCriteria)

List the DWL national waitlist organ requests.

Sample soap requests: listWaitlistRecipients

Parameters
dwlCriteria the DWL waitlist search criteria that is used to filter the waitlist
required: FALSE
note: when input 'dwlCriteria' is null, no filtering is applied and the whole national waitlist will be returned. see: WaitlistSearchCriteria
Returns
Throws
SoapException the soap exception