Package psidev.psi.mi.jami.binary

Interface BinaryInteraction<T extends Participant>

All Superinterfaces:

Interaction<T>

All Known Subinterfaces:

BinaryInteractionEvidence, ModelledBinaryInteraction

All Known Implementing Classes:

AbstractBinaryInteraction, AbstractBinaryInteractionWrapper, AbstractExtendedXmlBinaryInteraction, AbstractXmlBinaryInteraction, AbstractXmlBinaryInteractionEvidence, BinaryInteractionEvidenceWrapper, BinaryInteractionWrapper, CsvBinaryInteractionEvidence, DefaultBinaryInteraction, DefaultBinaryInteractionEvidence, DefaultModelledBinaryInteraction, DefaultNamedBinaryInteraction, DefaultNamedBinaryInteractionEvidence, DefaultNamedModelledBinaryInteraction, MitabBinaryInteraction, MitabBinaryInteractionEvidence, MitabModelledBinaryInteraction, ModelledBinaryInteractionWrapper, XmlBinaryInteraction, XmlBinaryInteractionEvidence, XmlBinaryInteractionEvidence, XmlBinaryInteractionEvidence, XmlBinaryInteractionEvidenceWrapper, XmlBinaryInteractionEvidenceWrapper, XmlBinaryInteractionWrapper, XmlModelledBinaryInteraction, XmlModelledBinaryInteraction, XmlModelledBinaryInteractionWrapper, XmlModelledBinaryInteractionWrapper

public interface BinaryInteraction<T extends Participant>
extends Interaction<T>

A Binary interaction is an interaction only composed of two participants. It can be a 'true' binary interaction (the complexExpansion is null) or it can be an expanded binary interaction from an original n-ary interaction (the complex expansion is not null)

Since:

04/06/13

Version:

$Id$

Author:

Marine Dumousseau (marine@ebi.ac.uk)

Method Summary

Modifier and Type	Method	Description
CvTerm	getCausalRegulatoryMechanism()	The causal regulatory mechanism for the binary interaction
CvTerm	getComplexExpansion()	The complex expansion method if this binary interaction is expanded from a complex or n-ary interaction.
T	getParticipantA()	The first participant of the binary interaction.
T	getParticipantB()	The second participant of the binary interaction
void	setCausalRegulatoryMechanism(CvTerm causalRegulatoryMechanism)	Sets the causal regulatory mechanism of this binary interaction
void	setComplexExpansion(CvTerm expansion)	Sets the complex expansion of this binary interaction
void	setParticipantA(T participantA)	Sets the first participant of this interaction
void	setParticipantB(T participantB)	Sets the second participant of this interaction

Methods inherited from interface psidev.psi.mi.jami.model.Interaction

addAllParticipants, addParticipant, getAnnotations, getChecksums, getCreatedDate, getIdentifiers, getInteractionType, getParticipants, getRigid, getShortName, getUpdatedDate, getXrefs, removeAllParticipants, removeParticipant, setCreatedDate, setInteractionType, setRigid, setShortName, setUpdatedDate

Method Detail

getParticipantA

T getParticipantA()

The first participant of the binary interaction.

Returns:

first participant of the binary interaction

getParticipantB

T getParticipantB()

The second participant of the binary interaction

Returns:

second participant of the binary interaction

setParticipantA

void setParticipantA(T participantA)

Sets the first participant of this interaction

Parameters:

participantA - : the first participant

setParticipantB

void setParticipantB(T participantB)

Sets the second participant of this interaction

Parameters:

participantB - : the second participant

getComplexExpansion

CvTerm getComplexExpansion()

The complex expansion method if this binary interaction is expanded from a complex or n-ary interaction. This is a controlled vocabulary term and can be null if the binary interaction has not been expanded.

Returns:

the complex expansion method

setComplexExpansion

void setComplexExpansion(CvTerm expansion)

Sets the complex expansion of this binary interaction

Parameters:

expansion - : the complex expansion

getCausalRegulatoryMechanism

CvTerm getCausalRegulatoryMechanism()

The causal regulatory mechanism for the binary interaction

Returns:

the complex regulatory mechanism CvTerm

setCausalRegulatoryMechanism

void setCausalRegulatoryMechanism(CvTerm causalRegulatoryMechanism)

Sets the causal regulatory mechanism of this binary interaction

Parameters:

causalRegulatoryMechanism - : the complex regulatory mechanism CvTerm