To get full access to the Kademi Hub existing customers can login here, or new customers can register here.
Attaches an organisation to an email job or an SMS job as an audience, so people within that organisation are recipients of the job. The same row can instead mark the organisation as an exclusion, in which case its people must not be sent the message. Exactly one of the email job or the SMS job is set, and deleting the row detaches it from the job it belonged to.
Group: Database Entities
Implements: Serializable, Relational
Properties
| Property | Returns | Description |
|---|---|---|
| exclusion | Boolean | Whether this organisation is excluded rather than included. True means people in the organisation must not be sent the message. Null means it was never set, which is treated as not excluded. |
| id | long | Database identifier for this recipient row, assigned when it is first saved. |
| job | BaseEmailJob | The email job this organisation is a recipient of. Null when the row belongs to an SMS job instead. |
| recipient | Organisation | The organisation whose people are the audience described by this row. Never null. |
| smsJob | GroupSmsJob | The SMS job this organisation is a recipient of. Null when the row belongs to an email job instead. |
Methods
getId()
Returns: long
Database identifier for this recipient row, assigned when it is first saved.
getJob()
Returns: BaseEmailJob
The email job this organisation is a recipient of. Null when the row belongs to an SMS job instead.
getRecipient()
Returns: Organisation
The organisation whose people are the audience described by this row. Never null.
isExclusion()
Returns: Boolean
Whether this organisation is excluded rather than included. True means people in the organisation must not be sent the message. Null means it was never set, which is treated as not excluded.
getSmsJob()
Returns: GroupSmsJob
The SMS job this organisation is a recipient of. Null when the row belongs to an email job instead.
© 2025 Kademi Ltd