java.lang.Object
- org.openehealth.ipf.commons.audit.model.ParticipantObjectIdentificationType

All Implemented Interfaces:: Serializable, Validateable

public class ParticipantObjectIdentificationType
extends Object
implements Serializable, Validateable

Since:: 3.5
Author:: Christian Ohr
See Also:: Serialized Form

Constructor Summary

Constructors
Constructor	Description
`ParticipantObjectIdentificationType(String participantObjectID, ParticipantObjectIdType participantObjectIDTypeCode)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`protected boolean`	`canEqual(Object other)`
`boolean`	`equals(Object o)`
`ParticipantObjectDataLifeCycle`	`getParticipantObjectDataLifeCycle()`	Identifier for the data life-cycle stage for the participant object.
`List<DicomObjectDescriptionType>`	`getParticipantObjectDescriptions()`
`List<TypeValuePairType>`	`getParticipantObjectDetails()`	Implementation-defined data about specific details of the object accessed or used.
`@NonNull String`	`getParticipantObjectID()`	Identifies a specific instance of the participant object.
`@NonNull ParticipantObjectIdType`	`getParticipantObjectIDTypeCode()`	Describes the identifier that is contained in Participant Object ID.
`String`	`getParticipantObjectName()`	An instance-specific descriptor of the Participant Object ID audited, such as a person's name.
`byte[]`	`getParticipantObjectQuery()`	The actual query for a query-type participant object.
`String`	`getParticipantObjectSensitivity()`	Denotes policy-defined sensitivity for the Participant Object ID such as VIP, HIV status, mental health status, or similar topics.
`ParticipantObjectTypeCode`	`getParticipantObjectTypeCode()`	Code for the participant object type being audited.
`ParticipantObjectTypeCodeRole`	`getParticipantObjectTypeCodeRole()`	Code representing the functional application role of Participant Object being audited.
`int`	`hashCode()`
`void`	`setParticipantObjectDataLifeCycle(ParticipantObjectDataLifeCycle participantObjectDataLifeCycle)`	Identifier for the data life-cycle stage for the participant object.
`void`	`setParticipantObjectID(@NonNull String participantObjectID)`	Identifies a specific instance of the participant object.
`void`	`setParticipantObjectIDTypeCode(@NonNull ParticipantObjectIdType participantObjectIDTypeCode)`	Describes the identifier that is contained in Participant Object ID.
`void`	`setParticipantObjectName(String participantObjectName)`	An instance-specific descriptor of the Participant Object ID audited, such as a person's name.
`void`	`setParticipantObjectQuery(byte[] participantObjectQuery)`	The actual query for a query-type participant object.
`void`	`setParticipantObjectSensitivity(String participantObjectSensitivity)`	Denotes policy-defined sensitivity for the Participant Object ID such as VIP, HIV status, mental health status, or similar topics.
`void`	`setParticipantObjectTypeCode(ParticipantObjectTypeCode participantObjectTypeCode)`	Code for the participant object type being audited.
`void`	`setParticipantObjectTypeCodeRole(ParticipantObjectTypeCodeRole participantObjectTypeCodeRole)`	Code representing the functional application role of Participant Object being audited.
`void`	`validate()`	SOPClass is Required if ParticipantObjectIDTypeCode is (110180, DCM, "Study Instance UID") and any of the optional fields (AccessionNumber, ContainsMPPS, NumberOfInstances, ContainsSOPInstances,Encrypted,Anonymized) are present in this Participant Object.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - ParticipantObjectIdentificationType
```
public ParticipantObjectIdentificationType(String participantObjectID,
                                           ParticipantObjectIdType participantObjectIDTypeCode)
```
    Parameters:
    
    participantObjectID - Identifies a specific instance of the participant object.
    
    participantObjectIDTypeCode - Describes the identifier that is contained in Participant Object ID.
- Method Detail
  - getParticipantObjectDetails
```
public List<TypeValuePairType> getParticipantObjectDetails()
```
    Implementation-defined data about specific details of the object accessed or used. This element is a Type-value pair. The "type" attribute is an implementation-defined text string. The "value" attribute is base 64 encoded data. The value is suitable for conveying binary data.
    
    Returns:
    
    Implementation-defined data about specific details of the object accessed or used
  - getParticipantObjectDescriptions
```
public List<DicomObjectDescriptionType> getParticipantObjectDescriptions()
```
  - validate
```
public void validate()
```
    SOPClass is Required if ParticipantObjectIDTypeCode is (110180, DCM, "Study Instance UID") and any of the optional fields (AccessionNumber, ContainsMPPS, NumberOfInstances, ContainsSOPInstances,Encrypted,Anonymized) are present in this Participant Object. May be present if ParticipantObjectIDTypeCode is (110180, DCM, "Study Instance UID") even though none of the optional fields are present.
    
    Specified by:
    
    validate in interface Validateable
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - canEqual
```
protected boolean canEqual(Object other)
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - getParticipantObjectID
```
@NonNull
public @NonNull String getParticipantObjectID()
```
    Identifies a specific instance of the participant object.
  - setParticipantObjectID
```
public void setParticipantObjectID(@NonNull
                                   @NonNull String participantObjectID)
```
    Identifies a specific instance of the participant object.
  - getParticipantObjectIDTypeCode
```
@NonNull
public @NonNull ParticipantObjectIdType getParticipantObjectIDTypeCode()
```
    Describes the identifier that is contained in Participant Object ID.
  - setParticipantObjectIDTypeCode
```
public void setParticipantObjectIDTypeCode(@NonNull
                                           @NonNull ParticipantObjectIdType participantObjectIDTypeCode)
```
    Describes the identifier that is contained in Participant Object ID.
  - getParticipantObjectName
```
public String getParticipantObjectName()
```
    An instance-specific descriptor of the Participant Object ID audited, such as a person's name.
  - setParticipantObjectName
```
public void setParticipantObjectName(String participantObjectName)
```
    An instance-specific descriptor of the Participant Object ID audited, such as a person's name.
  - getParticipantObjectQuery
```
public byte[] getParticipantObjectQuery()
```
    The actual query for a query-type participant object.
  - setParticipantObjectQuery
```
public void setParticipantObjectQuery(byte[] participantObjectQuery)
```
    The actual query for a query-type participant object.
  - getParticipantObjectTypeCode
```
public ParticipantObjectTypeCode getParticipantObjectTypeCode()
```
    Code for the participant object type being audited. This value is distinct from the user's role or any user relationship to the participant object.
  - setParticipantObjectTypeCode
```
public void setParticipantObjectTypeCode(ParticipantObjectTypeCode participantObjectTypeCode)
```
    Code for the participant object type being audited. This value is distinct from the user's role or any user relationship to the participant object.
  - getParticipantObjectTypeCodeRole
```
public ParticipantObjectTypeCodeRole getParticipantObjectTypeCodeRole()
```
    Code representing the functional application role of Participant Object being audited. The ParticipantObjectTypeCodeRole identifies the role that the object played in the event that is being reported. Most events involve multiple participating objects. ParticipantObjectTypeCodeRole identifies which object took which role in the event. It also covers agents, multi-purpose entities, and multi-role entities. For the purpose of the event one primary role is chosen.
  - setParticipantObjectTypeCodeRole
```
public void setParticipantObjectTypeCodeRole(ParticipantObjectTypeCodeRole participantObjectTypeCodeRole)
```
    Code representing the functional application role of Participant Object being audited. The ParticipantObjectTypeCodeRole identifies the role that the object played in the event that is being reported. Most events involve multiple participating objects. ParticipantObjectTypeCodeRole identifies which object took which role in the event. It also covers agents, multi-purpose entities, and multi-role entities. For the purpose of the event one primary role is chosen.
  - getParticipantObjectDataLifeCycle
```
public ParticipantObjectDataLifeCycle getParticipantObjectDataLifeCycle()
```
    Identifier for the data life-cycle stage for the participant object. This can be used to provide an audit trail for data, over time, as it passes through the system.
  - setParticipantObjectDataLifeCycle
```
public void setParticipantObjectDataLifeCycle(ParticipantObjectDataLifeCycle participantObjectDataLifeCycle)
```
    Identifier for the data life-cycle stage for the participant object. This can be used to provide an audit trail for data, over time, as it passes through the system.
  - getParticipantObjectSensitivity
```
public String getParticipantObjectSensitivity()
```
    Denotes policy-defined sensitivity for the Participant Object ID such as VIP, HIV status, mental health status, or similar topics.
  - setParticipantObjectSensitivity
```
public void setParticipantObjectSensitivity(String participantObjectSensitivity)
```
    Denotes policy-defined sensitivity for the Participant Object ID such as VIP, HIV status, mental health status, or similar topics.

Class ParticipantObjectIdentificationType

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ParticipantObjectIdentificationType

Method Detail

getParticipantObjectDetails

getParticipantObjectDescriptions

validate

equals

canEqual

hashCode

getParticipantObjectID

setParticipantObjectID

getParticipantObjectIDTypeCode

setParticipantObjectIDTypeCode

getParticipantObjectName

setParticipantObjectName

getParticipantObjectQuery

setParticipantObjectQuery

getParticipantObjectTypeCode

setParticipantObjectTypeCode

getParticipantObjectTypeCodeRole

setParticipantObjectTypeCodeRole

getParticipantObjectDataLifeCycle

setParticipantObjectDataLifeCycle

getParticipantObjectSensitivity

setParticipantObjectSensitivity