sapiopycommons 2024.8.28a314__tar.gz → 2024.8.28a315__tar.gz

{sapiopycommons-2024.8.28a314 → sapiopycommons-2024.8.28a315}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: sapiopycommons
-Version: 2024.8.28a314
+Version: 2024.8.28a315
 Summary: Official Sapio Python API Utilities Package
 Project-URL: Homepage, https://github.com/sapiosciences
 Author-email: Jonathan Steck <jsteck@sapiosciences.com>, Yechen Qiao <yqiao@sapiosciences.com>

{sapiopycommons-2024.8.28a314 → sapiopycommons-2024.8.28a315}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "sapiopycommons"
-version='2024.08.28a314'
+version='2024.08.28a315'
 authors = [
     { name="Jonathan Steck", email="jsteck@sapiosciences.com" },
     { name="Yechen Qiao", email="yqiao@sapiosciences.com" },

{sapiopycommons-2024.8.28a314 → sapiopycommons-2024.8.28a315}/src/sapiopycommons/callbacks/callback_util.py

@@ -1,7 +1,7 @@
 from __future__ import annotations
 
 import io
-from typing import Any
+from weakref import WeakValueDictionary
 
 from sapiopylib.rest.ClientCallbackService import ClientCallback
 from sapiopylib.rest.DataMgmtService import DataMgmtServer
@@ -15,16 +15,17 @@ from sapiopylib.rest.pojo.datatype.FieldDefinition import AbstractVeloxFieldDefi
 from sapiopylib.rest.pojo.webhook.ClientCallbackRequest import OptionDialogRequest, ListDialogRequest, \
     FormEntryDialogRequest, InputDialogCriteria, TableEntryDialogRequest, ESigningRequestPojo, \
     DataRecordDialogRequest, InputSelectionRequest, FilePromptRequest, MultiFilePromptRequest, \
-    TempTableSelectionRequest
+    TempTableSelectionRequest, DisplayPopupRequest, PopupType
 from sapiopylib.rest.pojo.webhook.ClientCallbackResult import ESigningResponsePojo
-from sapiopylib.rest.pojo.webhook.WebhookContext import SapioWebhookContext
 from sapiopylib.rest.pojo.webhook.WebhookEnums import FormAccessLevel, ScanToSelectCriteria, SearchType
 from sapiopylib.rest.utils.DataTypeCacheManager import DataTypeCacheManager
 from sapiopylib.rest.utils.FormBuilder import FormBuilder
 from sapiopylib.rest.utils.recorddatasinks import InMemoryRecordDataSink
 from sapiopylib.rest.utils.recordmodel.RecordModelWrapper import WrappedType
 
-from sapiopycommons.general.aliases import FieldMap, SapioRecord, AliasUtil, RecordIdentifier
+from sapiopycommons.files.file_util import FileUtil
+from sapiopycommons.general.aliases import FieldMap, SapioRecord, AliasUtil, RecordIdentifier, FieldValue, \
+    UserIdentifier
 from sapiopycommons.general.custom_report_util import CustomReportUtil
 from sapiopycommons.general.exceptions import SapioUserCancelledException, SapioException, SapioUserErrorException
 from sapiopycommons.recordmodel.record_handler import RecordHandler
@@ -37,26 +38,86 @@ class CallbackUtil:
     width_pixels: int | None
     width_percent: float | None
 
-    def __init__(self, context: SapioWebhookContext | SapioUser):
+    __instances: WeakValueDictionary[SapioUser, CallbackUtil] = WeakValueDictionary()
+    __initialized: bool
+
+    def __new__(cls, context: UserIdentifier):
+        """
+        :param context: The current webhook context or a user object to send requests from.
+        """
+        user = AliasUtil.to_sapio_user(context)
+        obj = cls.__instances.get(user)
+        if not obj:
+            obj = object.__new__(cls)
+            obj.__initialized = False
+            cls.__instances[user] = obj
+        return obj
+
+    def __init__(self, context: UserIdentifier):
         """
         :param context: The current webhook context or a user object to send requests from.
         """
-        self.user = context if isinstance(context, SapioUser) else context.user
+        if self.__initialized:
+            return
+        self.__initialized = True
+
+        self.user = AliasUtil.to_sapio_user(context)
         self.callback = DataMgmtServer.get_client_callback(self.user)
         self.dt_cache = DataTypeCacheManager(self.user)
         self.width_pixels = None
         self.width_percent = None
 
-    def set_dialog_width(self, width_pixels: int | None, width_percent: float | None):
+    def set_dialog_width(self, width_pixels: int | None = None, width_percent: float | None = None):
         """
         Set the width that dialogs will appear as for those dialogs that support specifying their width.
 
         :param width_pixels: The number of pixels wide that dialogs will appear as.
-        :param width_percent: The percentage of the client's screen width that dialogs will appear as.
+        :param width_percent: The percentage (as a value between 0 and 1) of the client's screen width that dialogs
+            will appear as.
         """
+        if width_pixels is not None and width_percent is not None:
+            raise SapioException("Cannot set both width_pixels and width_percent at once.")
         self.width_pixels = width_pixels
         self.width_percent = width_percent
-    
+
+    def toaster_popup(self, message: str, title: str = "", popup_type: PopupType = PopupType.Info) -> None:
+        """
+        Display a toaster popup in the bottom right corner of the user's screen.
+
+        :param message: The message to display in the toaster.
+        :param title: The title to display at the top of the toaster.
+        :param popup_type: The popup type to use for the toaster. This controls the color that the toaster appears with.
+            Info is blue, Success is green, Warning is yellow, and Error is red
+        """
+        self.callback.display_popup(DisplayPopupRequest(title, message, popup_type))
+
+    def display_info(self, message: str) -> None:
+        """
+        Display an info message to the user in a dialog. Repeated calls to this function will append the new messages
+        to the same dialog if it is still opened by the user.
+
+        :param message: The message to display to the user.
+        """
+        self.callback.display_info(message)
+
+    def display_warning(self, message: str) -> None:
+        """
+        Display a warning message to the user in a dialog. Repeated calls to this function will append the new messages
+        to the same dialog if it is still opened by the user.
+
+        :param message: The message to display to the user.
+        """
+        self.callback.display_warning(message)
+
+    def display_error(self, message: str) -> None:
+        """
+        Display an error message to the user in a dialog. Repeated calls to this function will append the new messages
+        to the same dialog if it is still opened by the user.
+
+        :param message: The message to display to the user.
+        """
+        self.callback.display_error(message)
+
     def option_dialog(self, title: str, msg: str, options: list[str], default_option: int = 0,
                       user_can_cancel: bool = False) -> str:
         """
@@ -71,7 +132,8 @@ class CallbackUtil:
             SapioUserCancelledException is thrown.
         :return: The name of the button that the user selected.
         """
-        request = OptionDialogRequest(title, msg, options, default_option, user_can_cancel)
+        request = OptionDialogRequest(title, msg, options, default_option, user_can_cancel,
+                                      width_in_pixels=self.width_pixels, width_percentage=self.width_percent)
         response: int | None = self.callback.show_option_dialog(request)
         if response is None:
             raise SapioUserCancelledException()
@@ -111,16 +173,20 @@ class CallbackUtil:
         """
         return self.option_dialog(title, msg, ["Yes", "No"], 0 if default_yes else 1, False) == "Yes"
 
-    def list_dialog(self, title: str, options: list[str], multi_select: bool = False) -> list[str]:
+    def list_dialog(self, title: str, options: list[str], multi_select: bool = False,
+                    preselected_values: list[str] | None = None) -> list[str]:
         """
         Create a list dialog with the given options for the user to choose from.
 
         :param title: The title of the dialog.
         :param options: The list options that the user has to choose from.
         :param multi_select: Whether the user is able to select multiple options from the list.
+        :param preselected_values: A list of values that will already be selected when the list dialog is created. The
+            user can unselect these values if they want to.
         :return: The list of options that the user selected.
         """
-        request = ListDialogRequest(title, multi_select, options)
+        request = ListDialogRequest(title, multi_select, options, preselected_values,
+                                    width_in_pixels=self.width_pixels, width_percentage=self.width_percent)
         response: list[str] | None = self.callback.show_list_dialog(request)
         if response is None:
             raise SapioUserCancelledException()
@@ -163,8 +229,6 @@ class CallbackUtil:
         builder = FormBuilder(data_type, display_name, plural_display_name)
         for field_def in fields:
             field_name = field_def.data_field_name
-            if values and hasattr(field_def, "default_value"):
-                field_def.default_value = values.get(field_name)
             column: int = 0
             span: int = 4
             if column_positions and field_name in column_positions:
@@ -173,7 +237,8 @@ class CallbackUtil:
                 span = position[1]
             builder.add_field(field_def, column, span)
 
-        request = FormEntryDialogRequest(title, msg, builder.get_temporary_data_type())
+        request = FormEntryDialogRequest(title, msg, builder.get_temporary_data_type(), values,
+                                         width_in_pixels=self.width_pixels, width_percentage=self.width_percent)
         response: FieldMap | None = self.callback.show_form_entry_dialog(request)
         if response is None:
             raise SapioUserCancelledException()
@@ -215,13 +280,13 @@ class CallbackUtil:
         modifier = FieldModifier(visible=True, editable=editable)
 
         # Build the form using only those fields that are desired.
+        values: dict[str, FieldValue] = {}
         builder = FormBuilder(data_type, type_def.display_name, type_def.plural_display_name)
         for field_name in fields:
             field_def = field_defs.get(field_name)
             if field_def is None:
                 raise SapioException(f"No field of name \"{field_name}\" in field definitions of type \"{data_type}\"")
-            if hasattr(field_def, "default_value"):
-                field_def.default_value = record.get_field_value(field_name)
+            values[field_name] = record.get_field_value(field_name)
             column: int = 0
             span: int = 4
             if column_positions and field_name in column_positions:
@@ -230,13 +295,14 @@ class CallbackUtil:
                 span = position[1]
             builder.add_field(modifier.modify_field(field_def), column, span)
 
-        request = FormEntryDialogRequest(title, msg, builder.get_temporary_data_type())
+        request = FormEntryDialogRequest(title, msg, builder.get_temporary_data_type(), values,
+                                         width_in_pixels=self.width_pixels, width_percentage=self.width_percent)
         response: FieldMap | None = self.callback.show_form_entry_dialog(request)
         if response is None:
             raise SapioUserCancelledException()
         return response
 
-    def input_dialog(self, title: str, msg: str, field: AbstractVeloxFieldDefinition) -> Any:
+    def input_dialog(self, title: str, msg: str, field: AbstractVeloxFieldDefinition) -> FieldValue:
         """
         Create an input dialog where the user must input data for a singular field.
 
@@ -245,8 +311,9 @@ class CallbackUtil:
         :param field: The definition for a field that the user must provide input to.
         :return: The response value from the user for the given field.
         """
-        request = InputDialogCriteria(title, msg, field, self.width_pixels, self.width_percent)
-        response: Any | None = self.callback.show_input_dialog(request)
+        request = InputDialogCriteria(title, msg, field,
+                                      width_in_pixels=self.width_pixels, width_percentage=self.width_percent)
+        response: FieldValue | None = self.callback.show_input_dialog(request)
         if response is None:
             raise SapioUserCancelledException()
         return response
@@ -322,6 +389,8 @@ class CallbackUtil:
                      msg: str,
                      fields: list[AbstractVeloxFieldDefinition],
                      values: list[FieldMap],
+                     group_by: str | None = None,
+                     image_data: list[bytes] | None = None,
                      *,
                      data_type: str = "Default",
                      display_name: str | None = None,
@@ -335,6 +404,10 @@ class CallbackUtil:
         :param fields: The definitions of the fields to display as table columns. Fields will be displayed in the order
             they are provided in this list.
         :param values: The values to set for each row of the table.
+        :param group_by: If provided, the created table dialog will be grouped by the field with this name by default.
+            The user may remove this grouping if they want to.
+        :param image_data: The bytes to the images that should be displayed in the rows of the table. Each element in
+            the image data list corresponds to the element at the same index in the values list.
         :param data_type: The data type name for the temporary data type that will be created for this table.
         :param display_name: The display name for the temporary data type. If not provided, defaults to the data type
             name.
@@ -356,7 +429,9 @@ class CallbackUtil:
         for field in fields:
             builder.add_field(modifier.modify_field(field))
 
-        request = TableEntryDialogRequest(title, msg, builder.get_temporary_data_type(), values)
+        request = TableEntryDialogRequest(title, msg, builder.get_temporary_data_type(), values,
+                                          record_image_data_list=image_data, group_by_field=group_by,
+                                          width_in_pixels=self.width_pixels, width_percentage=self.width_percent)
         response: list[FieldMap] | None = self.callback.show_table_entry_dialog(request)
         if response is None:
             raise SapioUserCancelledException()
@@ -367,7 +442,9 @@ class CallbackUtil:
                             msg: str,
                             fields: list[str],
                             records: list[SapioRecord],
-                            editable: bool | None = True) -> list[FieldMap]:
+                            editable: bool | None = True,
+                            group_by: str | None = None,
+                            image_data: list[bytes] | None = None) -> list[FieldMap]:
         """
         Create a table dialog where the user may input data into the fields of the table. The table is constructed from
         a given list of records of a singular type. Provided field names must match fields on the definition of the data
@@ -384,6 +461,10 @@ class CallbackUtil:
             they are provided in this list.
         :param editable: If true, all fields are displayed as editable. If false, all fields are displayed as
             uneditable. If none, only those fields that are defined as editable by the data designer will be editable.
+        :param group_by: If provided, the created table dialog will be grouped by the field with this name by default.
+            The user may remove this grouping if they want to.
+        :param image_data: The bytes to the images that should be displayed in the rows of the table. Each element in
+            the image data list corresponds to the element at the same index in the records list.
         :return: A list of dictionaries mapping the data field names of the given field definitions to the response
             value from the user for that field for each row.
         """
@@ -410,7 +491,9 @@ class CallbackUtil:
                 raise SapioException(f"No field of name \"{field_name}\" in field definitions of type \"{data_type}\"")
             builder.add_field(modifier.modify_field(field_def))
 
-        request = TableEntryDialogRequest(title, msg, builder.get_temporary_data_type(), field_map_list)
+        request = TableEntryDialogRequest(title, msg, builder.get_temporary_data_type(), field_map_list,
+                                          record_image_data_list=image_data, group_by_field=group_by,
+                                          width_in_pixels=self.width_pixels, width_percentage=self.width_percent)
         response: list[FieldMap] | None = self.callback.show_table_entry_dialog(request)
         if response is None:
             raise SapioUserCancelledException()
@@ -522,10 +605,10 @@ class CallbackUtil:
             field_names.append(name)
 
         # Get the values for each row.
-        values: list[dict[str, Any]] = []
+        values: list[dict[str, FieldValue]] = []
         for row in row_contents:
             # The final values for this row:
-            row_values: dict[str, Any] = {}
+            row_values: dict[str, FieldValue] = {}
 
             # Map the records for this row by their data type. If a field map is provided, its data type is Default.
             row_records: dict[str, SapioRecord | FieldMap] = {}
@@ -567,7 +650,8 @@ class CallbackUtil:
         for field in final_fields:
             builder.add_field(field)
 
-        request = TableEntryDialogRequest(title, msg, builder.get_temporary_data_type(), values)
+        request = TableEntryDialogRequest(title, msg, builder.get_temporary_data_type(), values,
+                                          width_in_pixels=self.width_pixels, width_percentage=self.width_percent)
         response: list[FieldMap] | None = self.callback.show_table_entry_dialog(request)
         if response is None:
             raise SapioUserCancelledException()
@@ -616,7 +700,8 @@ class CallbackUtil:
                 raise SapioException(f"The data type \"{data_type}\" does not have a layout by the name "
                                      f"\"{layout_name}\" in the system.")
 
-        request = DataRecordDialogRequest(title, record, layout, minimized, access_level, plugin_path_list)
+        request = DataRecordDialogRequest(title, record, layout, minimized, access_level, plugin_path_list,
+                                          width_in_pixels=self.width_pixels, width_percentage=self.width_percent)
         response: bool = self.callback.data_record_form_view_dialog(request)
         if not response:
             raise SapioUserCancelledException()
@@ -663,7 +748,7 @@ class CallbackUtil:
         return response
     
     def record_selection_dialog(self, msg: str, fields: list[str], records: list[SapioRecord],
-                                multi_select: bool = True) -> list[FieldMap]:
+                                multi_select: bool = True) -> list[SapioRecord]:
         """
         Create a record selection dialog for a list of records for the user to choose from. Provided field names must
         match fields on the definition of the data type of the given records.
@@ -676,7 +761,7 @@ class CallbackUtil:
             they are provided in this list.
         :param records: The records to display as rows in the table.
         :param multi_select: Whether the user is able to select multiple records from the list.
-        :return: A list of field maps corresponding to the chosen input records.
+        :return: A list of the selected records.
         """
         data_types: set[str] = {x.data_type_name for x in records}
         if len(data_types) > 1:
@@ -774,7 +859,7 @@ class CallbackUtil:
 
         # If CustomReportCriteria was provided, it must be wrapped as a CustomReport.
         if isinstance(custom_search, CustomReportCriteria):
-            custom_search: CustomReport = CustomReport(False, None, custom_search)
+            custom_search: CustomReport = CustomReport(False, [], custom_search)
         # If a string was provided, locate the report criteria for the predefined search in the system matching this
         # name.
         if isinstance(custom_search, str):
@@ -807,14 +892,15 @@ class CallbackUtil:
             for field in additional_fields:
                 builder.add_field(field)
             temp_dt = builder.get_temporary_data_type()
-        request = ESigningRequestPojo(title, msg, show_comment, temp_dt)
+        request = ESigningRequestPojo(title, msg, show_comment, temp_dt,
+                                      width_in_pixels=self.width_pixels, width_percentage=self.width_percent)
         response: ESigningResponsePojo | None = self.callback.show_esign_dialog(request)
         if response is None:
             raise SapioUserCancelledException()
         return response
 
     def request_file(self, title: str, exts: list[str] | None = None,
-                     show_image_editor: bool = False, show_camera_button: bool = False) -> (str, bytes):
+                     show_image_editor: bool = False, show_camera_button: bool = False) -> tuple[str, bytes]:
         """
         Request a single file from the user.
 
@@ -847,7 +933,7 @@ class CallbackUtil:
         return file_path, sink.data
 
     def request_files(self, title: str, exts: list[str] | None = None,
-                      show_image_editor: bool = False, show_camera_button: bool = False):
+                      show_image_editor: bool = False, show_camera_button: bool = False) -> dict[str, bytes]:
         """
         Request multiple files from the user.
 
@@ -878,7 +964,7 @@ class CallbackUtil:
         return ret_dict
 
     @staticmethod
-    def __verify_file(file_path: str, file_bytes: bytes, allowed_extensions: list[str]):
+    def __verify_file(file_path: str, file_bytes: bytes, allowed_extensions: list[str]) -> None:
         """
         Verify that the provided file was read (i.e. the file path and file bytes aren't None or empty) and that it
         has the correct file extension. Raises a user error exception if something about the file is incorrect.
@@ -892,7 +978,7 @@ class CallbackUtil:
         if len(allowed_extensions) != 0:
             matches: bool = False
             for ext in allowed_extensions:
-                if file_path.endswith("." + ext):
+                if file_path.endswith("." + ext.lstrip(".")):
                     matches = True
                     break
             if matches is False:
@@ -906,9 +992,19 @@ class CallbackUtil:
         :param file_name: The name of the file.
         :param file_data: The data of the file, provided as either a string or as a bytes array.
         """
-        data = io.StringIO(file_data) if isinstance(file_data, str) else io.BytesIO(file_data)
+        data = io.BytesIO(file_data.encode() if isinstance(file_data, str) else file_data)
         self.callback.send_file(file_name, False, data)
 
+    def write_zip_file(self, zip_name: str, files: dict[str, str | bytes]) -> None:
+        """
+        Send a collection of files to the user in a zip file.
+
+        :param zip_name: The name of the zip file.
+        :param files: A dictionary of the files to add to the zip file.
+        """
+        data = io.BytesIO(FileUtil.zip_files(files))
+        self.callback.send_file(zip_name, False, data)
+
 
 class FieldModifier:
     """

sapiopycommons-2024.8.28a315/src/sapiopycommons/customreport/column_builder.py

@@ -0,0 +1,60 @@
+from sapiopylib.rest.pojo.CustomReport import ReportColumn
+from sapiopylib.rest.pojo.datatype.FieldDefinition import FieldType
+
+from sapiopycommons.general.aliases import DataTypeIdentifier, FieldIdentifier, AliasUtil
+from sapiopycommons.general.exceptions import SapioException
+
+# The system fields that every record has and their field types. System fields aren't generated as record model fields
+# for all platform version, hence the need to create a dict for them in the off chance that they're not present on
+# the model wrapper.
+SYSTEM_FIELDS: dict[str, FieldType] = {
+    "DataRecordName": FieldType.IDENTIFIER,
+    "RecordId": FieldType.LONG,
+    "DateCreated": FieldType.DATE,
+    "CreatedBy": FieldType.STRING,
+    "VeloxLastModifiedDate": FieldType.DATE,
+    "VeloxLastModifiedBy": FieldType.STRING
+}
+
+
+class ColumnBuilder:
+    """
+    A class for building report columns for custom reports.
+    """
+    @staticmethod
+    def build_column(data_type: DataTypeIdentifier, field: FieldIdentifier, field_type: FieldType | None = None) \
+            -> ReportColumn:
+        """
+        Build a ReportColumn from a variety of possible inputs.
+
+        :param data_type: An object that can be used to identify a data type.
+        :param field: An object that can be used to identify a data field.
+        :param field_type: The field type of the provided field. This is only required if the field type cannot be
+            determined from the given data type and field, which occurs when the given field is a string and the
+            given data type is not a wrapped record model or record model wrapper.
+        :return: A ReportColumn for the inputs.
+        """
+        # Get the data type and field names from the inputs.
+        data_type_name = AliasUtil.to_data_type_name(data_type)
+        field_name = AliasUtil.to_data_field_name(field)
+        if field_type is None:
+            field_type = ColumnBuilder.__field_type(data_type, field)
+        if field_type is None:
+            raise SapioException("The field_type parameter is required for the provided data_type and field inputs.")
+        return ReportColumn(data_type_name, field_name, field_type)
+
+    @staticmethod
+    def __field_type(data_type: DataTypeIdentifier, field: FieldIdentifier) -> FieldType | None:
+        """
+        Given a record model wrapper and a field name, return the field type for that field. Accounts for system fields.
+
+        :param data_type: The record model wrapper that the field is on.
+        :param field: The field name to return the type of.
+        :return: The field type of the given field name.
+        """
+        # Check if the field name is a system field. If it us, use the field type defined in this file.
+        field_name: str = AliasUtil.to_data_field_name(field)
+        if field_name in SYSTEM_FIELDS:
+            return SYSTEM_FIELDS.get(field_name)
+        # Otherwise, check if the field type can be found from the wrapper.
+        return AliasUtil.to_field_type(field_name, data_type)

sapiopycommons-2024.8.28a315/src/sapiopycommons/customreport/custom_report_builder.py

@@ -0,0 +1,125 @@
+from sapiopylib.rest.pojo.CustomReport import ReportColumn, CustomReportCriteria, AbstractReportTerm, \
+    ExplicitJoinDefinition, RelatedRecordCriteria, QueryRestriction, FieldCompareReportTerm
+from sapiopylib.rest.pojo.datatype.FieldDefinition import FieldType
+
+from sapiopycommons.customreport.column_builder import ColumnBuilder
+from sapiopycommons.general.aliases import DataTypeIdentifier, FieldIdentifier, AliasUtil, SapioRecord
+from sapiopycommons.general.exceptions import SapioException
+
+
+class CustomReportBuilder:
+    """
+    A class used for building custom reports. Look into using the TermBuilder and ColumnBuilder classes for building
+    parts of a custom report.
+    """
+    root_data_type: DataTypeIdentifier
+    data_type_name: str
+    root_term: AbstractReportTerm | None
+    record_criteria: RelatedRecordCriteria
+    column_list: list[ReportColumn]
+    join_list: list[ExplicitJoinDefinition]
+
+    def __init__(self, root_data_type: DataTypeIdentifier):
+        """
+        :param root_data_type: An object that can be used to identify a data type name. Used as the root data type name
+            of this search.
+        """
+        self.root_data_type = root_data_type
+        self.data_type_name = AliasUtil.to_data_type_name(root_data_type)
+        self.root_term = None
+        self.record_criteria = RelatedRecordCriteria(QueryRestriction.QUERY_ALL)
+        self.column_list = []
+        self.join_list = []
+
+    def has_root_term(self) -> bool:
+        """
+        :return: Whether this report builder has had its root term set.
+        """
+        return self.root_term is not None
+
+    def set_root_term(self, term: AbstractReportTerm) -> None:
+        """
+        Set the root term of the report. Use the TermBuilder class to construct the report terms.
+
+        :param term: The term to set as the root term.
+        """
+        self.root_term = term
+
+    def has_columns(self) -> bool:
+        """
+        :return: Whether this report builder has any report columns.
+        """
+        return bool(self.column_list)
+
+    def add_column(self, field: FieldIdentifier, field_type: FieldType = None,
+                   *, data_type: DataTypeIdentifier | None = None) -> None:
+        """
+        Add a column to this report builder.
+
+        :param field: An object that can be used to identify a data field.
+        :param field_type: The field type of the provided field. This is only required if the field type cannot be
+            determined from the given data type and field, which occurs when the given field is a string and the
+            given data type is not a wrapped record model or record model wrapper.
+        :param data_type: An object that can be used to identify a data type. If not provided, uses the root data type
+            provided when this builder was initialized. You'll only want to specify this value when adding a column
+            that is from a different data type than the root data type.
+        """
+        if data_type is None:
+            data_type = self.root_data_type
+        self.column_list.append(ColumnBuilder.build_column(data_type, field, field_type))
+
+    def add_columns(self, fields: list[FieldIdentifier], *, data_type: DataTypeIdentifier | None = None) -> None:
+        """
+        Add columns to this report builder.
+
+        :param fields: A list of objects that can be used to identify data fields.
+        :param data_type: An object that can be used to identify a data type. If not provided, uses the root data type
+            provided when this builder was initialized. You'll only want to specify this value when adding a column
+            that is from a different data type than the root data type.
+        """
+        for field in fields:
+            self.add_column(field, data_type=data_type)
+
+    def set_query_restriction(self, base_record: SapioRecord, search_related: QueryRestriction) -> None:
+        """
+        Set a restriction on the report for this report builder such that the returned results must be related in
+        some way to the provided base record. Without this, the report searches all records in the system that match the
+        root term.
+
+        :param base_record: The base record to run the search from.
+        :param search_related: Determine the relationship of the related records that can appear in the search, be those
+            children, parents, descendants, or ancestors.
+        """
+        if search_related == QueryRestriction.QUERY_ALL:
+            raise SapioException("The search_related must be something other than QUERY_ALL when setting a query restriction.")
+        self.record_criteria = RelatedRecordCriteria(search_related,
+                                                     AliasUtil.to_record_id(base_record),
+                                                     AliasUtil.to_data_type_name(base_record))
+
+    def add_join(self, comparison_term: FieldCompareReportTerm) -> None:
+        """
+        Add a join statement to this report builder.
+
+        :param comparison_term: The field comparison term to join with. The left side data type name of this term will
+            be the data type that is joined against.
+        """
+        self.join_list.append(ExplicitJoinDefinition(comparison_term.left_data_type_name, comparison_term))
+
+    def build_report_criteria(self, page_size: int = 0, page_number: int = -1, case_sensitive: bool = False,
+                              owner_restriction_set: list[str] = None) -> CustomReportCriteria:
+        """
+        Generate a CustomReportCriteria using the column list, root term, and root data type from this report builder.
+        You can use the CustomReportManager or CustomReportUtil to run the constructed report.
+
+        :param page_size: The page size of the custom report.
+        :param page_number: The page number of the current report.
+        :param case_sensitive: When searching texts, should the search be case-sensitive?
+        :param owner_restriction_set: Specifies to only return records if the record is owned by this list of usernames.
+        :return: A CustomReportCriteria from this report builder.
+        """
+        if not self.has_root_term():
+            raise SapioException("Cannot build a report with no root term.")
+        if not self.has_columns():
+            raise SapioException("Cannot build a report with no columns.")
+        return CustomReportCriteria(self.column_list, self.root_term, self.record_criteria, self.data_type_name,
+                                    case_sensitive, page_size, page_number, owner_restriction_set, self.join_list)