Summary: Methods | [Expand All]
public interface

IExternalDonor

com.cbs.ctr3ws.iservices.IExternalDonor
Known Indirect Subclasses

Class Overview

description: the interface contains the CTR2-DWL-Donor soap webservices.

Summary

Public Methods
abstract WSDonor addDonor(WSDonorInput wsdi)
Add a DWL donor to the CTR registry.
abstract WSDonor findDonorByNationalDonorId(String nationalID)
Find a DWL donor record.
abstract WSDonorDeath findDonorDeath(String nationalID)
Find a DWL donor's death information.
abstract WSDonorOrganDispositions findDonorOrganState(String nationalID)
Find a DWL donor's organs disposition information.
abstract List<WsSerologyResult> findDonorSerology(String nationalDonorId)
Find a donor's serology test results.
abstract List<WSDonor> listDonor(DonorSearchCriteria criteria)
Get a filtered or unfiltered list of DWL donors.
abstract WSDonor updateDonor(WSDonorInput updatedDonor)
Update an existing DWL donor record.
abstract WSDonorDeath updateDonorDeath(WSDonorDeath donorDeath)
Update an existing DWL donor's death information.
abstract WSDonorOrganDispositions updateDonorOrganState(WSDonorOrganDispositions updatedDispositions)
Update a donor's organ disposition state.
abstract WsSerologyResult updateDonorSerology(WsSerologyResult inputSerology)
Add or update a donor's serology sample test results.

Public Methods

public abstract WSDonor addDonor (WSDonorInput wsdi)

Add a DWL donor to the CTR registry.

Sample soap requests: addDonor

Parameters
wsdi required: TRUE
see: WSDonorInput
Returns
  • the new DWL donor information.
    see: WSDonor
Throws
SoapException the soap exception

public abstract WSDonor findDonorByNationalDonorId (String nationalID)

Find a DWL donor record.

Sample soap requests: findDonorByNationalDonorId

Parameters
nationalID required: TRUE
see: nationalId info
Returns
  • the DWL donor information.
    see: WSDonor
Throws
SoapException the soap exception

public abstract WSDonorDeath findDonorDeath (String nationalID)

Find a DWL donor's death information.

Sample soap requests: findDonorDeath

Parameters
nationalID required: TRUE
see: nationalId info
Returns
Throws
SoapException the soap exception

public abstract WSDonorOrganDispositions findDonorOrganState (String nationalID)

Find a DWL donor's organs disposition information.

Sample soap requests: findDonorOrganState

Parameters
nationalID required: TRUE
see: nationalId info
Returns
Throws
SoapException the soap exception

public abstract List<WsSerologyResult> findDonorSerology (String nationalDonorId)

Find a donor's serology test results.

Sample soap requests: findDonorSerology

Parameters
nationalDonorId required: TRUE
see: nationalId info
Returns
  • the list of all the donor's serology test results, grouped by collected serum sample.
Throws
SoapException

public abstract List<WSDonor> listDonor (DonorSearchCriteria criteria)

Get a filtered or unfiltered list of DWL donors.
note: The list will only contains donors for which the user has READ and/or WRITE permissions.

Sample soap requests: listDonor

Parameters
criteria the donor search criteria.
required: TRUE
see: DonorSearchCriteria
Returns
  • the filtered list of DWL donors.
    see: WSDonor
Throws
SoapException the soap exception

public abstract WSDonor updateDonor (WSDonorInput updatedDonor)

Update an existing DWL donor record.

Sample soap requests: updateDonor

Parameters
updatedDonor required: TRUE
see: WSDonorInput
Returns
  • the updated DWL donor information.
    see: WSDonor
Throws
SoapException the soap exception

public abstract WSDonorDeath updateDonorDeath (WSDonorDeath donorDeath)

Update an existing DWL donor's death information.
note: the donor's unique death record is created when the DWL donor is create, hence one can only update this record and not add a new death record.

Sample soap requests: updateDonorDeath

Parameters
donorDeath required: TRUE
see: WSDonorDeath
Returns
  • the updated DWL donor death information.
    see: WSDonor
Throws
SoapException the soap exception

public abstract WSDonorOrganDispositions updateDonorOrganState (WSDonorOrganDispositions updatedDispositions)

Update a donor's organ disposition state.
note: the donor's consented organ records are created when the DWL donor is create, hence one can only update these records and not add new consented organ records.

Sample soap requests: updateDonorOrganState

Parameters
updatedDispositions required: TRUE
see: WSDonorOrganDispositions
Returns
Throws
SoapException the soap exception

public abstract WsSerologyResult updateDonorSerology (WsSerologyResult inputSerology)

Add or update a donor's serology sample test results.

Sample soap requests: updateDonorSerology

Parameters
inputSerology the added/updated serology sample test results.
see: WsSerologyResult
Returns
Throws
SoapException