clsTaskActionCode¶
clsTaskActionCode represents a single, read-only row of the TASK_ACTION_CODE reference table, used to translate a task's stored action code into a human-readable description. All write-SQL properties throw, enforcing that action codes are reference data only (BR-023).
Purpose¶
- Load and expose one action code / description pair from
TASK_ACTION_CODE(SQL-003). - Guarantee action codes cannot be modified from application code by throwing on any write-SQL property access (BR-023).
Context¶
- Namespace:
SAIF.Business.Tasks - Assembly/package:
SAIF.Business.Tasks(embedded in theLegalMaintenanceweb deployment)
Public members¶
| Member | Signature | Purpose |
|---|---|---|
Code |
ReadOnly Property Code As String |
The action code value (TASK_ACTION_CODE.CODE). |
Description |
ReadOnly Property Description As String |
Human-readable description (TASK_ACTION_CODE.CODE_DESCR). |
Equals |
Function Equals(obj As Object) As Boolean |
Value-equality comparison, likely keyed on Code*. |
GetHashCode |
Function GetHashCode() As Integer |
Hash code consistent with Equals*. |
ToString |
Function ToString() As String |
Returns a display string for the action code*. |
GetCode |
Shared Function GetCode(dpi As IDataPortalInfo, inCode As String) As clsTaskActionCode |
Factory/retrieval entry point that loads a single action code by value (SQL-003). |
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
clsBusinessBase, giving it the standard BOF business-object lifecycle even though only the retrieve path is functional.
Constraints and usage notes¶
- Any attempt to use
CreateSQL/InsertSQL/UpdateSQL/DeleteSQLon this type'sCriteriathrowsApplicationException(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.
Related documentation¶
Sources¶
- SAIF.Business.Tasks/clsTaskActionCode.vb