Records a profile joining or leaving a group within an organisation, along with who or what triggered the change, where it happened, and its previous group or organisation when it was a move rather than a first sign-up. A row is written by logSignup when a membership is created and by deletedSignuplog when one is removed, and the static finders on this class support sign-up and unsubscribe reporting, including date-bucketed and per-group counts.

Implements: Relational

---

Properties

---

Methods

getId() · getProfile() · setProfile(Profile profile) · getGroupEntity() · setGroupEntity(Group group) · getMembershipOrg() · setMembershipOrg(Organisation membershipOrg) · setOrganisation(Organisation organisation) · getWebsite() · setWebsite(Website website) · getReqDate() · setReqDate(Date reqDate) · getReqYear() · setReqYear(int reqYear) · getReqMonth() · setReqMonth(int reqMonth) · getReqDay() · setReqDay(int reqDay) · getReqHour() · setReqHour(int reqHour) · getDeletedDate() · setDeletedDate(Date deletedDate) · getPreviousOrg() · setPreviousOrg(Organisation previousOrg) · getPreviousGroup() · setPreviousGroup(Group previousGroup) · getChangedBy() · setChangedBy(Profile changedBy) · getOpSource() · setOpSource(String opSource) · getOpId() · setOpId(String opId) · getIpAddress() · setIpAddress(String ipAddress) · isChangedOrg()

getId()

Returns: long

Database primary key of this sign-up log entry.

getProfile()

Returns: Profile

Profile that the sign-up or membership change applies to.

setProfile(Profile profile)

Returns: void

Sets the profile the entry applies to.

getGroupEntity()

Returns: Group

Group the profile joined (or, for a deletion entry, was removed from).

setGroupEntity(Group group)

Returns: void

Sets the group involved in the membership change.

getMembershipOrg()

Returns: Organisation

Organisation that the group membership itself is associated with, which may differ from the admin organisation that recorded the entry.

setMembershipOrg(Organisation membershipOrg)

Returns: void

Sets the organisation the membership is associated with.

setOrganisation(Organisation organisation)

Returns: void

Sets the admin organisation this entry is recorded against.

getWebsite()

Returns: Website

Website that recorded the sign-up, if the change occurred through a website rather than the admin console or a background process.

setWebsite(Website website)

Returns: void

Sets the website that recorded the sign-up.

getReqDate()

Returns: Date

Date and time the membership change was recorded. Never null.

setReqDate(Date reqDate)

Returns: void

Sets the date and time the membership change was recorded.

getReqYear()

Returns: int

Calendar year the request date falls in. Stored alongside the request date so reports can group and filter by year without recomputing it.

setReqYear(int reqYear)

Returns: void

Sets the calendar year the request date falls in.

getReqMonth()

Returns: int

Calendar month the request date falls in, using java.util.Calendar's zero-based numbering (0 for January).

setReqMonth(int reqMonth)

Returns: void

Sets the calendar month the request date falls in.

getReqDay()

Returns: int

Day of the month the request date falls on.

setReqDay(int reqDay)

Returns: void

Sets the day of the month the request date falls on.

getReqHour()

Returns: int

Hour of the day the request date falls in, in 24 hour format.

setReqHour(int reqHour)

Returns: void

Sets the hour of the day the request date falls in.

getDeletedDate()

Returns: Date

Date and time the membership was removed, for an entry created by deletedSignuplog.

setDeletedDate(Date deletedDate)

Returns: void

Sets the date and time the membership was removed.

getPreviousOrg()

Returns: Organisation

Organisation the membership was associated with before this change, when the entry records a move between organisations rather than a first sign-up.

setPreviousOrg(Organisation previousOrg)

Returns: void

Sets the organisation the membership was associated with before this change.

getPreviousGroup()

Returns: Group

Group the profile belonged to before this change, when the entry records a move between groups rather than a first sign-up.

setPreviousGroup(Group previousGroup)

Returns: void

Sets the group the profile belonged to before this change.

getChangedBy()

Returns: Profile

User who performed this membership change. May be null when the change happened outside of a request, for example a background or async job.

setChangedBy(Profile changedBy)

Returns: void

Sets the user who performed this membership change.

getOpSource()

Returns: String

The operation that resulted in this change, i.e. an HTTP request URL or an async job's task name, truncated to 200 characters.

setOpSource(String opSource)

Returns: void

Sets the operation that resulted in this change.

getOpId()

Returns: String

The id or other reference for the specific item that is the source of the operation, i.e. the request id or async job id, truncated to 2000 characters.

setOpId(String opId)

Returns: void

Sets the id or other reference for the source of the operation.

getIpAddress()

Returns: String

The client IP the signup came from. Recorded so that fraud rules can ask how many signups have come from one address recently, which the operation source and id cannot answer.

setIpAddress(String ipAddress)

Returns: void

Sets the client IP the signup came from.

isChangedOrg()

Returns: boolean

Whether this entry records the membership moving to a different organisation, i.e. it has a previous organisation that differs from the current membership organisation.