ParticipantCandidate (PSI :: JAMI - Java framework for molecular interactions 3.3.0 API)

All Superinterfaces:

Entity<F>

All Known Subinterfaces:

ExperimentalParticipantCandidate, ModelledParticipantCandidate

All Known Implementing Classes:

AbstractParticipantCandidate, CsvExperimentalParticipantCandidate, DefaultExperimentalParticipantCandidate, DefaultModelledParticipantCandidate, DefaultParticipantCandidate, XmlExperimentalParticipantCandidate, XmlExperimentalParticipantCandidate, XmlExperimentalParticipantCandidate, XmlExperimentalParticipantCandidateWrapper, XmlExperimentalParticipantCandidateWrapper, XmlExperimentalParticipantCandidateWrapper, XmlModelledParticipantCandidate, XmlModelledParticipantCandidate, XmlModelledParticipantCandidate, XmlParticipantCandidateWrapper, XmlParticipantCandidateWrapper, XmlParticipantCandidateWrapper
```
public interface ParticipantCandidate<P extends ParticipantPool,F extends Feature>
extends Entity<F>
```
A participant candidate is part of a participant pool and contains the molecule which can interact plus some participant details such as features and causal relationships
Since:
```
24/07/14
```
Version:

$Id$

Author:

Marine Dumousseau (marine@ebi.ac.uk)

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`P`	`getParentPool()`	The participant pool parent with which the candidate is involved.
`void`	`setParentPool(P pool)`	Sets the participant pool parent.

Methods inherited from interface psidev.psi.mi.jami.model.Entity
addAllFeatures, addFeature, getCausalRelationships, getChangeListener, getFeatures, getInteractor, getStoichiometry, removeAllFeatures, removeFeature, setChangeListener, setInteractor, setStoichiometry, setStoichiometry

- Method Detail
  - getParentPool
```
P getParentPool()
```
    The participant pool parent with which the candidate is involved. It can be null if the participant candidate is not part of any participant pool. It can happen if the participant candidate has been removed from a participant pool and is now invalid.
    
    Returns:
    
    the participant pool parent
  - setParentPool
```
void setParentPool(P pool)
```
    Sets the participant pool parent.
    
    Parameters:
    
    pool - : participant pool