Skip to content

clsTaskActionCodeCollection

clsTaskActionCodeCollection loads and holds every row of TASK_ACTION_CODE, used to populate full action-code lookup lists (e.g., for UI dropdowns). Like its single-row counterpart, it is strictly read-only.

Purpose

  • Retrieve the full TASK_ACTION_CODE reference list, ordered by description (SQL-004).
  • Provide the well-known constant for "no action required" so callers do not hard-code the literal code value.

Context

  • Namespace: SAIF.Business.Tasks
  • Assembly/package: SAIF.Business.Tasks (embedded in the LegalMaintenance web deployment)

Public members

Member Signature Purpose
cNoActionRequired Const cNoActionRequired As String = "NONE" Well-known code representing "no action required", avoiding a hard-coded literal in callers.
GetCodes Shared Function GetCodes(dpi As IDataPortalInfo) As clsTaskActionCodeCollection Factory/retrieval entry point that loads the entire action-code table (SQL-004).
Criteria Friend Class Criteria (nested, implements IBusinessCriteria) Read-only criteria for this code table; write-SQL properties throw ApplicationException(clsConstants.Messages.InvalidSQLProperty) (BR-023).

Behavioral notes

  • The class is <Serializable()>, consistent with remoting/session persistence of BOF objects across the web tier*.
  • Inherits from clsBusinessCollectionBase.

Constraints and usage notes

  • Any attempt to use CreateSQL/InsertSQL/UpdateSQL/DeleteSQL on this type's Criteria throws ApplicationException(clsConstants.Messages.InvalidSQLProperty) (BR-023).

Note: Statements marked with * were inferred from code structure, naming conventions, or contextual evidence where direct confirmation was not available in source artifacts. Statements marked with ** could not be confirmed; treat as unknown until verified.

Sources

  • SAIF.Business.Tasks/clsTaskActionCodeCollection.vb