Summary: Methods | [Expand All]
public interface

IExternalRecipient

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

Class Overview

description: the interface contains the CTR2-Recipient soap webservices.

Summary

Public Methods
abstract Recipient addRecipientByNationalRecipientId(WebServiceRecipient wsRecipient)
Add a recipient to the CTR registry.
abstract List<RecipientAcceptanceCriteria> findRecipientAcceptanceCriteriaByNationalRecipientId(String nationalID)
Find the acceptance criteria information for each recipient organ request.
abstract Recipient findRecipientByNationalRecipientID(String nationalID)
Find a recipient information.
abstract WsSocialDetails getSocialDetails(String nationalId)
Get the recipient's social details record.
abstract WsPgmExclusion updateOrganRequestParticipation(String nationalRecipientId, Long organRequestId, boolean preventProgramParticipation)
Update a recipient's participation to the IPOS Heart program.
abstract RecipientAcceptanceCriteria updateRecipientAcceptanceCriteriaByNationalRecipientId(String nationalID, WSRecipientAcceptanceCriteria updatedCriteria)
Update a recipient's organ request acceptance criteria record.
abstract Recipient updateRecipientByNationalRecipientId(String nationalID, WebServiceRecipient wsRecipient)
Update an existing recipient information.
abstract WsSocialDetails updateSocialDetails(String nationalId, WsSocialDetails wsInput)
Update a recipient's social details record.

Public Methods

public abstract Recipient addRecipientByNationalRecipientId (WebServiceRecipient wsRecipient)

Add a recipient to the CTR registry.

Sample soap requests: addRecipientByNationalRecipientId

Parameters
wsRecipient the recipient information.
required: TRUE
see: WebServiceRecipient
Returns
  • the recipient record that was added to the registry.
    see: Recipient
Throws
SoapException the soap exception

public abstract List<RecipientAcceptanceCriteria> findRecipientAcceptanceCriteriaByNationalRecipientId (String nationalID)

Find the acceptance criteria information for each recipient organ request.

Sample soap requests: findRecipientAcceptanceCriteriaByNationalRecipientId

Parameters
nationalID the CTR2 patient ID.
required: TRUE
see: nationalId info
Returns
Throws
SoapException the soap exception

public abstract Recipient findRecipientByNationalRecipientID (String nationalID)

Find a recipient information.

Sample soap requests: findRecipientByNationalRecipientID

Parameters
nationalID the CTR2 patient ID.
required: TRUE
see: nationalId info
Returns
Throws
SoapException the soap exception

public abstract WsSocialDetails getSocialDetails (String nationalId)

Get the recipient's social details record.

Sample soap requests: getSocialDetails

Parameters
nationalId the CTR2 patient ID.
required: TRUE
see: nationalId info
Returns
Throws
SoapException the soap exception

public abstract WsPgmExclusion updateOrganRequestParticipation (String nationalRecipientId, Long organRequestId, boolean preventProgramParticipation)

Update a recipient's participation to the IPOS Heart program.
note: The recusal or reinstatment applies to a specific DWL organ request.

Sample soap requests: updateOrganRequestParticipation

Parameters
nationalRecipientId the CTR2 patient ID.
required: TRUE
see: nationalId info
organRequestId the unique identifier of the organ request that is to be excluded or included from the IPOs program.
required: TRUE
see: id field info
preventProgramParticipation a flag indicating that the organ request is to be excluded or included from the IPOs program.
required: FALSE, when absent default to FALSE.
Returns
Throws
SoapException the soap exception

public abstract RecipientAcceptanceCriteria updateRecipientAcceptanceCriteriaByNationalRecipientId (String nationalID, WSRecipientAcceptanceCriteria updatedCriteria)

Update a recipient's organ request acceptance criteria record.
note: The method does no add an organ request acceptance criteria record, since a unique organ request acceptance criteria record is automatically created when an organ request is created.

Sample soap requests: updateRecipientAcceptanceCriteriaByNationalRecipientId

Parameters
nationalID the CTR2 patient ID.
required: TRUE
see: nationalId info
updatedCriteria the organ request acceptance criteria information.
required: TRUE
see: WSRecipientAcceptanceCriteria
Returns
Throws
SoapException the soap exception

public abstract Recipient updateRecipientByNationalRecipientId (String nationalID, WebServiceRecipient wsRecipient)

Update an existing recipient information.

*
Sample soap requests: updateRecipientByNationalRecipientId

Parameters
nationalID the CTR2 patient ID.
required: TRUE
see: nationalId info
wsRecipient the recipient information.
required: TRUE
see: WebServiceRecipient
Returns
Throws
SoapException the soap exception

public abstract WsSocialDetails updateSocialDetails (String nationalId, WsSocialDetails wsInput)

Update a recipient's social details record.
note: A recipient can have only 1 entry for each social detail item.
For example, it is not possible to have 2 "ltAcademicProgress" entries.
If a specific item already exists and the one attempts to add 2nd entry, the existing item entry will be updated.

Sample soap requests: updateSocialDetails

Parameters
nationalId the CTR2 patient ID.
required: TRUE
see: nationalId info
wsInput the added/social details record.
required: TRUE
see: WsSocialDetails
Returns
Throws
SoapException the soap exception