Carries the details of a pending group membership application, either to join an existing organisation or to register a new one. Created empty via UserManager.newMembershipApplicationRequest, populated by the caller with the member, group, any custom fields and either an existing organisation or new organisation details, then passed to UserManager.submitMembershipApplicationRequest to save it and trigger the pending subscription event.
Properties
| Property | Returns | Description |
|---|---|---|
| existingOrg | Organisation | The existing organisation the applicant applies within, when they are not registering a new organisation. |
| fields | NvSet | Custom field values submitted with the membership application. |
| group | Group | The group the member is applying to join. |
| member | Profile | The profile applying for membership. |
| newOrgAddress | AddressBean | The postal address for the new organisation the applicant is registering. |
| newOrgFields | Map<String,String> | Custom field values for the new organisation the applicant is registering, keyed by field name. |
| newOrgId | String | The org id chosen for the new organisation, when the applicant is registering one rather than joining an existing one. |
| newOrgTitle | String | The title of the new organisation the applicant is registering. |
| newOrgTypeName | String | The name of the org type to assign to the new organisation the applicant is registering. |
| sendVerificationEmail | boolean | Whether submitting this application should also send the applicant an email verification message. |
Methods
getMember() · setMember(Profile member) · getGroup() · setGroup(Group group) · getExistingOrg() · setExistingOrg(Organisation existingOrg) · getFields() · setFields(NvSet fields) · getNewOrgId() · setNewOrgId(String newOrgId) · getNewOrgTitle() · setNewOrgTitle(String newOrgTitle) · getNewOrgAddress() · setNewOrgAddress(AddressBean newOrgAddress) · getNewOrgTypeName() · setNewOrgTypeName(String newOrgTypeName) · getNewOrgFields() · setNewOrgFields(Map<String,String> newOrgFields) · getSendVerificationEmail() · setSendVerificationEmail(boolean sendVerificationEmail) · setNewOrgFields(NvSet newOrgFields)
getMember()
Returns: Profile
The profile applying for membership.
setMember(Profile member)
Returns: void
Sets the profile applying for membership.
| Parameter | Description |
|---|---|
member | the applying member |
getGroup()
Returns: Group
The group the member is applying to join.
setGroup(Group group)
Returns: void
Sets the group the member is applying to join.
| Parameter | Description |
|---|---|
group | the group being applied to |
getExistingOrg()
Returns: Organisation
The existing organisation the applicant applies within, when they are not registering a new organisation.
setExistingOrg(Organisation existingOrg)
Returns: void
Sets the existing organisation the applicant applies within.
| Parameter | Description |
|---|---|
existingOrg | the existing organisation |
getFields()
Returns: NvSet
Custom field values submitted with the membership application.
setFields(NvSet fields)
Returns: void
Sets the custom field values submitted with the membership application.
| Parameter | Description |
|---|---|
fields | the custom fields for this application |
getNewOrgId()
Returns: String
The org id chosen for the new organisation, when the applicant is registering one rather than joining an existing one.
setNewOrgId(String newOrgId)
Returns: void
Sets the org id chosen for the new organisation.
| Parameter | Description |
|---|---|
newOrgId | the new organisation's org id |
getNewOrgTitle()
Returns: String
The title of the new organisation the applicant is registering.
setNewOrgTitle(String newOrgTitle)
Returns: void
Sets the title of the new organisation the applicant is registering.
| Parameter | Description |
|---|---|
newOrgTitle | the new organisation's title |
getNewOrgAddress()
Returns: AddressBean
The postal address for the new organisation the applicant is registering.
setNewOrgAddress(AddressBean newOrgAddress)
Returns: void
Sets the postal address for the new organisation the applicant is registering.
| Parameter | Description |
|---|---|
newOrgAddress | the new organisation's address |
getNewOrgTypeName()
Returns: String
The name of the org type to assign to the new organisation the applicant is registering.
setNewOrgTypeName(String newOrgTypeName)
Returns: void
Sets the name of the org type to assign to the new organisation the applicant is registering.
| Parameter | Description |
|---|---|
newOrgTypeName | the new organisation's org type name |
getNewOrgFields()
Returns: Map<String,String>
Custom field values for the new organisation the applicant is registering, keyed by field name.
setNewOrgFields(Map<String,String> newOrgFields)
Returns: void
Sets the custom field values for the new organisation the applicant is registering, keyed by field name.
| Parameter | Description |
|---|---|
newOrgFields | a map of custom field name to value for the new organisation |
getSendVerificationEmail()
Returns: boolean
Whether submitting this application should also send the applicant an email verification message.
setSendVerificationEmail(boolean sendVerificationEmail)
Returns: void
Sets whether submitting this application should also send the applicant an email verification message.
| Parameter | Description |
|---|---|
sendVerificationEmail | true to send an email verification message on submission |
setNewOrgFields(NvSet newOrgFields)
Returns: void
Sets the custom field values for the new organisation the applicant is registering, converting them from a name/value pair set. Does nothing if newOrgFields is empty.
| Parameter | Description |
|---|---|
newOrgFields | the custom fields for the new organisation, as name/value pairs |