clsImageDocumentNameCodeCollection¶
clsImageDocumentNameCodeCollection is a BOF collection wrapper for clsImageDocumentNameCode. It exposes one helper for loading the full localized code list and another for resolving a document-name code from INTERNAL_DESCR.
Purpose¶
- Loads all
IMAGE_DOCUMENT_NAME_CODErows using the base retrieve SQL fromclsImageDocumentNameCode.Criteria. - Resolves a single document-name code by uppercase
INTERNAL_DESCR, returningString.Emptywhen the lookup is not unique.
Context¶
- Namespace:
SAIF.Business.Imaging - Assembly/package:
SAIF.BOF.Business.Imaging
Public members¶
| Member | Signature | Purpose |
|---|---|---|
GetImageDocumentNameCodes |
Public Shared Function GetImageDocumentNameCodes(ByVal inDPI As IDataPortalInfo, Optional cultureCode As String = "en") As clsImageDocumentNameCodeCollection |
Loads the full document-name-code collection with localized code_descr fallback behavior controlled by the supplied culture code. |
GetImageDocumentCodeByInternalDescr |
Public Shared Function GetImageDocumentCodeByInternalDescr(inDPI As IDataPortalInfo, inInternalDescr As String, Optional cultureCode As String = "en") As String |
Retrieves the single matching code whose INTERNAL_DESCR equals the uppercased input; otherwise returns String.Empty. |
Behavioral notes¶
- Both helpers reuse
clsImageDocumentNameCode.Criteria.RetrieveSqlStatementand execute throughclsBusinessCollection(Of clsImageDocumentNameCode).Load. GetImageDocumentCodeByInternalDescrappendsupper(INTERNAL_DESCR) = :InternalDescrto the base retrieve SQL before loading.
Constraints and usage notes¶
GetImageDocumentCodeByInternalDescronly returns a value when exactly one row matches; zero or multiple matches both collapse toString.Empty.
Sources¶
Business\SAIF.Business.Imaging\clsImageDocumentNameCode.vb