WSAttachmentInfoCore
extends Objectimplements Serializable
| java.lang.Object | |
| ↳ | com.cbs.ctr3ws.dtos.attachment.WSAttachmentInfoCore |
 Known Direct Subclasses
|
Class Overview
description: a class containing core attachment info.
Summary
| Fields | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| public Long | attachmentID | description: the unique attachment record identifier. | |||||||||
| public WSLookup | attachmentSection | description: the CTR patient section to which the attachment is associated. | |||||||||
| public String | description | description: a description of the attachment. | |||||||||
| public String | nationalID | description: the CTR2 patient ID. | |||||||||
| public Long | ownerID | description: the unique identifier of the CTR object with which the uploaded attachment is associated. | |||||||||
| public Boolean | sideBysideFlag | description: a flag indicating if the attachment info is to be included in the side-by-side report. | |||||||||
| Public Constructors | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| WSAttachmentInfoCore() | |||||||||||
| Public Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| Boolean |
isSideBysideFlag()
Gets side-by-side flag value.
| ||||||||||
|
[Expand]
Inherited Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
|
From class
java.lang.Object
| |||||||||||
Fields
public Long attachmentID
description: the unique attachment record identifier.
required: TRUE-if - if the request( method: updateAttachment()) is updating an existing attachment information.
required: FALSE-if - not required if the request( method: uploadAttachment()) is uploading an attachment, in which case value can be = 0 or NULL.
see: id field info.
public WSLookup attachmentSection
description: the CTR patient section to which the attachment is associated.
required: TRUE
see: LT_USER_COMMENT_SECTION
public String description
description: a description of the attachment.
required: TRUE
see: free format text, max L=500
public Long ownerID
description: the unique identifier of the CTR object with which the uploaded attachment is associated.
required: TRUE-if - required if the attachment user section (field: attachmentSection) is one of the following LT_USER_COMMENT_SECTION:
- [id: 2, bizRef: ORGAN_REQUESTS]: the ownerID value is the unique identifier of the recipient's organ request
- [id: 13, bizRef: OFFERS_XM]: the ownerID value is the unique identifier of offer
- [id: 4, bizRef: DONOR_PARTICIPATIONS]: this option is listed for completeness, but webservices do not use this value as is only valid for LIVING Donor patient type
public Boolean sideBysideFlag
description: a flag indicating if the attachment info is to be included in the side-by-side report.
required: FALSE - when not input, default = FALSE
note:
- When uploadAttachment executed to add a new attachment THEN sideBySideFlag will set default=false if not input.
- When uploadAttachment executed to replace an existing attachment THEN sideBySideFlag will be replaced if input, else the original value remains.
Public Constructors
public WSAttachmentInfoCore ()
Public Methods
public Boolean isSideBysideFlag ()
Gets side-by-side flag value.
Returns
- the boolean