---
name: "corelinux_Colleague"
section: "3"
platform: "linux"
package: "libcorelinux-dev"
version: "0.4.32-5"
release: "Debian 3.1 (Sarge)"
platforms: ["linux"]
url: "https://new.carta.tech/corelinux_Colleague"
---

# corelinux\_Colleague(3)

Colleague knows its Mediator object, communicates with its mediator whenever it would have otherwise communicated with another Colleague.

## NAME

corelinux::Colleague - **Colleague** knows its **Mediator** object, communicates with its mediator whenever it would have otherwise communicated with another **Colleague**.

## SYNOPSIS

`#include <Colleague.hpp>`

Inherited by **EditColleague**, **ListColleague**, and **SelectColleague**.

### Public Member Functions

**Colleague** (**MediatorPtr**)  throw ( NullPointerException )\
 *Default constructor requires a* **Mediator***.*  **Colleague** (**ColleagueCref**)\
 *Copy constructor copies the mediator reference.*  virtual **~Colleague** (void)\
 *Virtual destructor.*  **ColleagueRef** **operator=** (**ColleagueCref**)\
 *Assignment operator.*  bool **operator==** (**ColleagueCref**) const \
 *Equality operator.*  virtual void **getEventsGenerated** (EventIdentifiersRef)=0\
 *Implementation defined to return the identifiers of the events that this* **Colleague** *generates.*  virtual void **getInterestedEvents** (EventIdentifiersRef)=0\
 *Implementation defined to return the identifiers of the events that this* **Colleague** *is interested in.*  virtual void **action** (**Event**\< **Identifier** \> \*)=0\
 *Called by the mediator when another* **Colleague** *has generated an event that this colleague instance is interested in.*

### Protected Member Functions

**Colleague** (void)  throw ( Assertion )\
 *Default constructor not allowed.*  virtual void **invokeMediator** (**Event**\< **Identifier** \> \*)  throw ( NullPointerException )\
 *Called by the* **Colleague** *implementation to have the Mediator::action called with the event type.*

## Detailed Description

**Colleague** knows its **Mediator** object, communicates with its mediator whenever it would have otherwise communicated with another **Colleague**.

## Constructor & Destructor Documentation

### corelinux::Colleague::Colleague (MediatorPtr) throw ( NullPointerException )

Default constructor requires a **Mediator**. **Parameters:**

*Mediator* pointer

**Exceptions:**

*NullPointerException* if MediatorPtr is NULLPTR

### corelinux::Colleague::Colleague (ColleagueCref)

Copy constructor copies the mediator reference. **Parameters:**

*Colleague* const referencee

## Member Function Documentation

### virtual void corelinux::Colleague::action (Event\< Identifier \> \*)` [pure virtual]`

Called by the mediator when another **Colleague** has generated an event that this colleague instance is interested in. **Parameters:**

*Event* pointer to event

### virtual void corelinux::Colleague::getEventsGenerated (EventIdentifiersRef)` [pure virtual]`

Implementation defined to return the identifiers of the events that this **Colleague** generates. **Parameters:**

*EventIdentifiers* vector reference

Implemented in **EditColleague**, **ListColleague**, and **SelectColleague**.

### virtual void corelinux::Colleague::getInterestedEvents (EventIdentifiersRef)` [pure virtual]`

Implementation defined to return the identifiers of the events that this **Colleague** is interested in. **Parameters:**

*EventIdentifiers* vector reference

Implemented in **EditColleague**, **ListColleague**, and **SelectColleague**.

### void corelinux::Colleague::invokeMediator (Event\< Identifier \> \*) throw ( NullPointerException )` [protected, virtual]`

Called by the **Colleague** implementation to have the Mediator::action called with the event type. **Parameters:**

*Event* pointer to event

**Exceptions:**

*NullPointerException* if EventPtr is NULLPTR

## Author

Generated automatically by Doxygen for CoreLinux++ from the source code.