organisations.views package

Subpackages

• organisations.views.club_menu_tabs package
  • Submodules
  • organisations.views.club_menu_tabs.access module
    • access_advanced()
    • access_basic()
  • organisations.views.club_menu_tabs.comms module
    • email_preview_htmx()
  • organisations.views.club_menu_tabs.congresses module
  • organisations.views.club_menu_tabs.dashboard module
  • organisations.views.club_menu_tabs.finance module
    • organisation_transactions_filtered_data()
    • organisation_transactions_filtered_data_all()
    • organisation_transactions_filtered_data_combined()
    • organisation_transactions_filtered_data_congresses()
    • organisation_transactions_filtered_data_events()
    • organisation_transactions_filtered_data_sessions()
    • organisation_transactions_filtered_data_txntype()
    • pay_member_from_organisation()
    • top_up_member_from_organisation()
  • organisations.views.club_menu_tabs.import_data module
    • add_member_to_membership()
    • process_contact_import()
    • process_member_import()
    • state_from_postcode()
    • validate_header()
    • validate_start_and_end()
  • organisations.views.club_menu_tabs.members module
    • add_member_search_htmx()
    • add_misc_payment_pay()
    • club_admin_report_active_csv()
    • club_admin_report_all_csv()
    • email_unpaid()
    • get_mpc_details()
    • report_all_csv()
  • organisations.views.club_menu_tabs.results module
    • upload_results_file_valid()
  • organisations.views.club_menu_tabs.sessions module
  • organisations.views.club_menu_tabs.settings module
    • template_preview_htmx()
  • organisations.views.club_menu_tabs.utils module
    • get_club_members_from_system_number_list()
    • get_members_balance()
    • get_members_for_club()
  • Module contents

Submodules

organisations.views.admin module

organisations.views.admin.add_club_defaults(club: Organisation)

Add sensible default values when we create a new club

organisations.views.admin.admin_add_club(request)

Add a club to the system. For State or ABF Administrators

NOTE: For now the club must be defined in the Masterpoints Centre already

organisations.views.admin.admin_blocked_memberships(request)

organisations.views.admin.admin_club_rbac(request, club_id)

Manage RBAC basic set up for a Club

This doesn’t control who gets access - clubs can do that themselves, this controls whether it is basic or advanced RBAC configuration. It is the RBAC structure, not the content.

organisations.views.admin.admin_club_rbac_add_advanced(request, club_id)

Manage RBAC advanced set up for a Club

This doesn’t control who gets access - clubs can do that themselves, this controls whether it is basic or advanced RBAC configuration. It is the RBAC structure, not the content.

organisations.views.admin.admin_club_rbac_add_basic(request, club_id)

Manage RBAC basic set up for a Club

This doesn’t control who gets access - clubs can do that themselves, this controls whether it is basic or advanced RBAC configuration. It is the RBAC structure, not the content.

organisations.views.admin.admin_club_rbac_convert_advanced_to_basic(request, club_id)

Change rbac setup for a club advanced -> basic

organisations.views.admin.admin_club_rbac_convert_advanced_to_basic_sub(club)

Change rbac from advanced to basic. Do the actual changes. Does not check for permissions, the calling function must handle that.

Parameters:

club – Organisation

Returns:

Boolean - success or failure Str - error message or None

organisations.views.admin.admin_club_rbac_convert_basic_to_advanced(request, club_id)

Change rbac setup for a club basic -> advanced

organisations.views.admin.admin_club_rbac_convert_basic_to_advanced_sub(club)

Change rbac from basic to advanced. Do the actual changes. Does not check for permissions, the calling function must handle that.

Parameters:

club – Organisation

Returns:

Boolean - success or failure Str - error message or None

organisations.views.admin.admin_list_clubs(request)

List Clubs in the system. For State or ABF Administrators. Modified to show all organisations, not just clubs

organisations.views.admin.convert_manual_club_to_automatic(request, club_id)

This is a temporary function to convert clubs that were created before club admin to be set up as “normal” clubs.

If you are looking at this in the future, you can probably delete it.

organisations.views.admin.get_secretary_from_org_form(org_form)

on org form we have a secretary for the club. We use the Cobalt user search for this so extract details from form

organisations.views.admin.rbac_get_basic_and_advanced(club)

Get the setup for this club

organisations.views.ajax module

organisations.views.ajax.club_name_search_htmx(request)

Get list of matching club names from Masterpoints centre

organisations.views.ajax.get_club_details_htmx(request)

Get details about club from Masterpoints centre This request is called by HTMX and returns HTML, not json

organisations.views.ajax.org_detail_ajax(request)

Returns basic info on an org for the generic org search.

Ajax call to get basic info on an org. Will return an empty json array if the org number is invalid.

Parameters:

number (org_id - org)

Returns:

address etc.

Return type:

Json array

organisations.views.ajax.org_search_ajax(request)

Ajax org search function. Used by the generic org search.

Parameters:

for. (orgname - partial org name to search)

Returns:

HttpResponse - either a message or a list of users in HTML format.

organisations.views.club_menu module

Map

The entry point is club_menu() which loads the page menu.html Menu.html uses HTMX to load the tab pages e.g. tab_dashboard_htmx()

organisations.views.club_menu.club_menu(request, club_id, change_to_last_visited=False, show_tab='dashboard', click_id=None)

Main menu for club administrators to handle things.

This uses a tabbed navigation panel with each tab providing distinct information. We use a different sub function to prepare the information for each tab to keep it clean.

Parameters:

• view (club_id - organisation to)

• initially (show_tab - the name of the tab to be shown)

• entry (click_id - the html id of a control on teh tab to be sent a click event on)

Returns:

HttpResponse - page to edit organisation

organisations.views.club_menu.tab_comms_edit_batch_ep(request, club_id, batch_id_id)

Entry point for editing an email batch under the comms tab

Used when wanting to navigate from outside the club menu to the comms tab and editing a specific inflight batch

organisations.views.club_menu.tab_entry_point(request, club_id, tab_name)

Entry point for showing a specified tab

organisations.views.club_menu.tab_finance_statement(request, club_id)

Entry point for the new club finance statement, for COB-766

organisations.views.general module

organisations.views.general.club_staff(user)

Used by dashboard. Returns the first club found that this user is a staff member for or None

Note: Staff with orgs.org.all rather than orgs.org.<model_id>.all will not get an icon (returns None)

Parameters:

user – User objects

Returns:

If not None then model_id is the first organisation that this user has access to

Return type:

model_id

organisations.views.general.compare_form_with_mpc(form, club)

Compare data on this form with values from the Masterpoints Centre and flag any differences

organisations.views.general.generic_org_search_htmx(request)

basic search for organisation by name

We accept a few parameters passed in through hx-vars:

hidden_id_field: field to put the org id into display_name: field to put the name of the org into return_trigger: trigger to call when we return

organisations.views.general.get_active_club_statistics()

Returns active and inactive club counts by state/territory

organisations.views.general.get_club_data_from_masterpoints_centre(club_number)

Get data about a club from the Masterpoints Centre

Parameters:

club_number – ABF club number

Returns: dictionary of values

organisations.views.general.get_org_statistics()

return stats on organisations. called by utils statistics

organisations.views.general.get_rbac_model_for_state(state)

Take in a state name e.g. NSW and return the model that maps to that organisation. Assumes one state organisation per state.

organisations.views.general.is_admin_for_organisation(user, club)

Boolean. Does this user have admin access to this club

organisations.views.general.org_balance(org, text=None)

return organisation balance. If balance is zero return 0.0 unless text is True, then return “Nil”

organisations.views.general.org_edit(request, org_id)

Edit details about an organisation OLD - REMOVE ONCE NEW CLUB ADMIN IS DONE

Parameters:

edit (org_id - organisation to)

Returns:

HttpResponse - page to edit organisation

organisations.views.general.org_profile(request, org_id)

Show public profile for organisation

organisations.views.general.replace_unregistered_user_with_real_user(real_user: User)

All the data is keyed off system_number so all we really need to do is to delete club emails.

The calling function deletes the unregistered user

organisations.views.home module

organisations.views.home.home(request)

Home page for the organisations’ app - called from the sidebar

Module contents