clsImageCategoryCodeCollection

clsImageCategoryCodeCollection is a BOF collection class that retrieves all rows from the IMAGE_CATEGORY_CODE code table with no filter criteria.

Purpose

• Loads the complete IMAGE_CATEGORY_CODE code table for use in dropdowns and lookups.

Context

• Namespace: SAIF.Business.Imaging
• Assembly/package: SAIF.BOF.Business.Imaging

Public members

Member	Signature	Purpose
ImageFileFilterCode	Public Property ImageFileFilterCode() As String	File code used by the filtered computed properties.
FilteredbyFileCode	Public ReadOnly Property FilteredbyFileCode() As clsImageCategoryCodeCollection	Returns items matching ImageFileFilterCode.
FilteredbyFileCodeNone	Public ReadOnly Property FilteredbyFileCodeNone() As clsImageCategoryCodeCollection	Returns items matching ImageFileFilterCode plus a "None" sentinel item.
FilteredbyFileCodeBlank	Public ReadOnly Property FilteredbyFileCodeBlank() As clsImageCategoryCodeCollection	Returns items matching ImageFileFilterCode plus a blank sentinel item.
MyCriteria	Public ReadOnly Property MyCriteria() As Criteria	Returns the nested criteria object used to assemble SQL and portal requests.*
Save	Public Overrides Function Save() As Boolean	Persists all pending changes.
Add	Public Shadows Function Add(ByVal inclsImageCategoryCode As clsImageCategoryCode) As Integer	Adds an item or value to the underlying collection or state container.*
Contains	Public Overloads Function Contains(ByVal inclsImageCategoryCode As clsImageCategoryCode) As Boolean	Returns whether the current collection or value store contains the supplied item/key.*
Contains	Public Overloads Function Contains(ByVal inCode As String) As Boolean	Returns whether the current collection or value store contains the supplied item/key.*
ContainsDeleted	Public Overloads Function ContainsDeleted(ByVal inclsImageCategoryCode As clsImageCategoryCode) As Boolean	Returns whether the deleted-items list contains the supplied child object.
ContainsDeleted	Public Overloads Function ContainsDeleted(ByVal inCode As String) As Boolean	Returns whether the deleted-items list contains the supplied child object.
Remove	Public Sub Remove(ByVal inclsImageCategoryCode As clsImageCategoryCode)	Removes an item by clsImageCategoryCode object or by code string.
Remove	Public Sub Remove(ByVal inCode As String)	Removes an item by clsImageCategoryCode object or by code string.
NewImageCategoryCodeCollection	Public Shared Function NewImageCategoryCodeCollection(ByVal inDataPortal As IDataPortalInfo, ByVal inFile As String, ByVal inCode As String) As clsImageCategoryCodeCollection	Factory: creates an empty collection scoped to a file code and code.
GetImageCategoryCodeCollection	Public Shared Function GetImageCategoryCodeCollection(ByVal inDataPortal As IDataPortalInfo, ByVal inImageFileCode As String) As clsImageCategoryCodeCollection	Factory: retrieves all category codes for a given file code.
GetImageCategoryCodeCollectionWithBlank	Public Shared Function GetImageCategoryCodeCollectionWithBlank(ByVal inDataPortal As IDataPortalInfo, ByVal inImageFileCode As String) As clsImageCategoryCodeCollection	Factory: retrieves all category codes for a file code with a blank item appended.
GetImageCatCodeCollection	Public Shared Function GetImageCatCodeCollection(ByVal inDataPortal As IDataPortalInfo) As clsImageCategoryCodeCollection	Factory: retrieves all category codes across all file codes.
FilterByFileCode	Public Function FilterByFileCode(ByVal inFileCode As String) As clsImageCategoryCodeCollection	Returns a filtered collection for a given file code.
AddNoneItem	Public Function AddNoneItem(ByRef inList As clsImageCategoryCodeCollection) As clsImageCategoryCodeCollection	Appends a "None" sentinel item to a collection.
AddBlankItem	Public Function AddBlankItem(ByRef inList As clsImageCategoryCodeCollection) As clsImageCategoryCodeCollection	Appends a blank sentinel item to a collection.
Criteria	Public Class Criteria	Nested criteria type that stores SQL text and request state for BOF data-portal operations.*

Inherited public members

Members in this section are inherited from clsBusinessCollectionBase and are available on this type through the standard BOF base-class contract.

Member	Signature	Purpose	Origin
MyGuid	Public ReadOnly Property MyGuid() As String	Returnst he unique GUID for this object.	Legacy\BusinessObjectFramework — clsBusinessCollectionBase
ItemByGuid	Public ReadOnly Property ItemByGuid(ByVal inGuid As String) As clsBusinessBase	Returns item by guid.*	Legacy\BusinessObjectFramework — clsBusinessCollectionBase
Contains	Public Function Contains(ByVal Item As clsBusinessBase) As Boolean	Used to see if the collection contains a specific child object.	Legacy\BusinessObjectFramework — clsBusinessCollectionBase
ContainsDeleted	Public Function ContainsDeleted(ByVal Item As clsBusinessBase) As Boolean	Used to see if the collection contains a reference to a child object that is marked for deletion.	Legacy\BusinessObjectFramework — clsBusinessCollectionBase
Rules	Public ReadOnly Property Rules() As clsRulesManager	Provides Access to the Objects Rules Manager	Legacy\BusinessObjectFramework — clsBusinessCollectionBase
ErrorCount	Public ReadOnly Property ErrorCount() As Integer	Returns the number of errors generated by the Object.	Legacy\BusinessObjectFramework — clsBusinessCollectionBase
ErrorMessages	Public ReadOnly Property ErrorMessages() As String()	Returns a string array of Error Messages generated by the Object.	Legacy\BusinessObjectFramework — clsBusinessCollectionBase
WarningCount	Public ReadOnly Property WarningCount() As Integer	Returns the Number of Warnings generated by the object.	Legacy\BusinessObjectFramework — clsBusinessCollectionBase
WarningMessages	Public ReadOnly Property WarningMessages() As String()	Returns a string array of Warning Messages generated by the Object.	Legacy\BusinessObjectFramework — clsBusinessCollectionBase
InformationalCount	Public ReadOnly Property InformationalCount() As Integer	Returns the number of errors generated by the Object.	Legacy\BusinessObjectFramework — clsBusinessCollectionBase
InformationalMessages	Public ReadOnly Property InformationalMessages() As String()	Returns a string array of Warning Messages generated by the Object.	Legacy\BusinessObjectFramework — clsBusinessCollectionBase
BeginEdit	Public Sub BeginEdit()	Starts a nested edit on the object.	Legacy\BusinessObjectFramework — clsBusinessCollectionBase
CancelEdit	Public Sub CancelEdit()	Cancels the current edit process, restoring the object's state to its previous values.	Legacy\BusinessObjectFramework — clsBusinessCollectionBase
ApplyEdit	Public Sub ApplyEdit()	Commits the current edit process.	Legacy\BusinessObjectFramework — clsBusinessCollectionBase
Clone	Public Function Clone() As Object Implements ICloneable.Clone	Creates a clone of the object.	Legacy\BusinessObjectFramework — clsBusinessCollectionBase
Save	Public Overridable Function Save() As Boolean	Saves the object to the database.	Legacy\BusinessObjectFramework — clsBusinessCollectionBase
SaveChild	Public Overridable Function SaveChild() As Boolean	Persists the current child object or child collection through the BOF child-save pipeline.	Legacy\BusinessObjectFramework — clsBusinessCollectionBase
IsManaged	Public ReadOnly Property IsManaged() As Boolean	Returns True if the Collection is in a Managed State	Legacy\BusinessObjectFramework — clsBusinessCollectionBase
IsFirst	Public ReadOnly Property IsFirst(ByVal inItem As clsBusinessBase) As Boolean Implements ITraversion.IsFirst	Returns True if the Objcet is the first Item in the collection.	Legacy\BusinessObjectFramework — clsBusinessCollectionBase
First	Public Function First() As clsBusinessBase Implements ITraversion.First	Sets the first item in the collection as the current item and returns a reference to it.	Legacy\BusinessObjectFramework — clsBusinessCollectionBase
FirstItem	Public ReadOnly Property FirstItem() As clsBusinessBase Implements ITraversion.FirstItem	Returns the first item in the collection without resetting the CurrentItem	Legacy\BusinessObjectFramework — clsBusinessCollectionBase
Next	Public Function [Next]() As clsBusinessBase Implements ITraversion.Next	Sets the next item in the collection as the current item and returns a reference to it.	Legacy\BusinessObjectFramework — clsBusinessCollectionBase
IsNext	Public ReadOnly Property IsNext(ByVal inItem As clsBusinessBase) As Boolean Implements ITraversion.IsNext	Returns True if the Item is the next to be traversed.	Legacy\BusinessObjectFramework — clsBusinessCollectionBase
NextItem	Public ReadOnly Property NextItem() As clsBusinessBase Implements ITraversion.NextItem	Returns the Next Item in the Collection without resetting the current item.	Legacy\BusinessObjectFramework — clsBusinessCollectionBase
NextItem	Public ReadOnly Property NextItem(ByVal inRefPoint As clsBusinessBase) As clsBusinessBase Implements ITraversion.NextItem	Returns the next item in the collections list using the passed in object as a reference point. If the Reference Object is the last item in the collection, the method returns Nothing. If the Refernce Object is not in the collection, the method throws an exception.	Legacy\BusinessObjectFramework — clsBusinessCollectionBase
IsLast	Public ReadOnly Property IsLast(ByVal inItem As clsBusinessBase) As Boolean Implements ITraversion.IsLast	Returns True if the Item is the last item in the collection.	Legacy\BusinessObjectFramework — clsBusinessCollectionBase
LastItem	Public ReadOnly Property LastItem() As clsBusinessBase Implements ITraversion.LastItem	Returns the Last Item in the Collection without resetting the current item.	Legacy\BusinessObjectFramework — clsBusinessCollectionBase
Last	Public Function Last() As clsBusinessBase Implements ITraversion.Last	Sets the CurrentItem to the last item in the collection and returns a reference to it.	Legacy\BusinessObjectFramework — clsBusinessCollectionBase
CurrentItem	Public ReadOnly Property CurrentItem() As clsBusinessBase Implements ITraversion.CurrentItem	Returns the CurrentItem in the collection.	Legacy\BusinessObjectFramework — clsBusinessCollectionBase
CurrentIndex	Public ReadOnly Property CurrentIndex() As Integer Implements ITraversion.CurrentIndex	Returns the Index of the current item.	Legacy\BusinessObjectFramework — clsBusinessCollectionBase
IsCurrent	Public ReadOnly Property IsCurrent(ByVal inItem As clsBusinessBase) As Boolean Implements ITraversion.IsCurrent	Returns True if the Item is the current Item.	Legacy\BusinessObjectFramework — clsBusinessCollectionBase
SetCurrent	Public Sub SetCurrent(ByRef inObject As clsBusinessBase) Implements ITraversion.SetCurrent	Sets the Item as the CurrentItem.	Legacy\BusinessObjectFramework — clsBusinessCollectionBase
SetCurrent	Public Sub SetCurrent(ByVal inIndex As Integer) Implements ITraversion.SetCurrent	Sets the Item at the associated index to the CurrentItem	Legacy\BusinessObjectFramework — clsBusinessCollectionBase
IndexOf	Public ReadOnly Property IndexOf(ByVal inObject As clsBusinessBase) As Integer Implements ITraversion.IndexOf	Returns the Index of the item within the collection.	Legacy\BusinessObjectFramework — clsBusinessCollectionBase
IsPrevious	Public ReadOnly Property IsPrevious(ByVal inItem As clsBusinessBase) As Boolean Implements ITraversion.IsPrevious	Returns True if the Item is the Last Item in the collection.	Legacy\BusinessObjectFramework — clsBusinessCollectionBase
Previous	Public Function Previous() As clsBusinessBase Implements ITraversion.Previous	Sets the previous item in the collection as the current item and returns a reference to it.	Legacy\BusinessObjectFramework — clsBusinessCollectionBase
PreviousItem	Public ReadOnly Property PreviousItem() As clsBusinessBase Implements ITraversion.PreviousItem	Returns a reference to the previous item in the collection without resetting the current item.	Legacy\BusinessObjectFramework — clsBusinessCollectionBase
PreviousItem	Public ReadOnly Property PreviousItem(ByVal inRefPoint As clsBusinessBase) As clsBusinessBase Implements ITraversion.PreviousItem	Returns the previous item in the collections list using the passed in object as a reference point. If the Reference Object is the first item in the collection, the method returns Nothing. If the Refernce Object is not in the collection, the method throws an exception.	Legacy\BusinessObjectFramework — clsBusinessCollectionBase
XMLElementName	Public Property XMLElementName() As String	Returns the Value used as the TagName when generating XML.	Legacy\BusinessObjectFramework — clsBusinessCollectionBase
XMLItemName	Public Property XMLItemName() As String	Returns the Value used as the TagName when generating XML.	Legacy\BusinessObjectFramework — clsBusinessCollectionBase
GetReportXML	Public Function GetReportXML(ByVal inElementName As String) As String	Retrieves report xml for the requested criteria or key values.*	Legacy\BusinessObjectFramework — clsBusinessCollectionBase
GetReportXML	Public Function GetReportXML(Optional ByVal inFileStream As System.IO.StreamWriter = Nothing) As String	Retrieves report xml for the requested criteria or key values.*	Legacy\BusinessObjectFramework — clsBusinessCollectionBase
ToXML	Public Function ToXML() As String	Returns to xml.*	Legacy\BusinessObjectFramework — clsBusinessCollectionBase
ToXml	Public Function ToXml(ByVal inTagName As String) As String	Returns to xml.*	Legacy\BusinessObjectFramework — clsBusinessCollectionBase

Note: Statements marked with * are inferred from code behavior rather than explicit documentation or comments.

Sources

• Business\SAIF.Business.Imaging\clsImageCategoryCodeCollection.vb
• Legacy\BusinessObjectFramework\clsBusinessCollectionBase.vb