Show / Hide Table of Contents

Class CodeList

Provides a description of a set of categories that have a specific relationship, such as the categories Male and Female that can be grouped together as Gender. Categories (e.g., Male and Female) can belong to multiple code lists. The code list also provides the unique code values for each of the categories in the code list.

Inheritance
object
NotificationObject
IdentifiableBase
VersionableBase
DescribableBase
CodeList
Implements
INotifyPropertyChanged
IVersionable
IIdentifiable
IHasCustomFields
IDescribable
IVisitable
Inherited Members
DescribableBase.ItemName
DescribableBase.Label
DescribableBase.Description
DescribableBase.DisplayLabel
VersionableBase.Accept(IVersionableVisitor)
VersionableBase.IsDirty
VersionableBase.IsPublished
VersionableBase.ChildrenDereferenced
VersionableBase.IsPopulated
VersionableBase.Version
VersionableBase.VersionDate
VersionableBase.VersionResponsibility
VersionableBase.VersionRationale
VersionableBase.CompositeId
VersionableBase.OtherMaterials
VersionableBase.BasedOn
VersionableBase.SucceededBy
VersionableBase.Attachments
VersionableBase.ThumbnailImageUri
VersionableBase.BannerImageUri
VersionableBase.DisableChangeTracking
VersionableBase.RemoveChildHelper(IVersionable, params IList[])
VersionableBase.AddChild(IVersionable)
VersionableBase.ChildTypesAccepted
VersionableBase.TryReplaceChild<T>(Func<T>, Action<T>, IdentifierTriple, IVersionable)
VersionableBase.ToString()
IdentifiableBase.DefaultAgencyId
IdentifiableBase.AgencyId
IdentifiableBase.Identifier
IdentifiableBase.UserIds
IdentifiableBase.CustomFields
IdentifiableBase.UserAttributes
IdentifiableBase.GetUserIdValue(string)
IdentifiableBase.RemoveChildHelper(IdentifierTriple, params IList[])
NotificationObject.PropertyChanged
NotificationObject.RaisePropertyChanged(string)
NotificationObject.OnPropertyChanged(string)
NotificationObject.ResumePropertyEvents()
NotificationObject.SuspendPropertyEvents()
NotificationObject.PropertyEventsSuspended
NotificationObject.PropagateChildChanges(INotifyCollectionChanged, string)
NotificationObject.WatchProperty(INotifyPropertyChanged, string)
NotificationObject.WatchCollection(INotifyCollectionChanged, string)
object.Equals(object)
object.Equals(object, object)
object.ReferenceEquals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
Namespace: Algenta.Colectica.Model.Ddi
Assembly: Algenta.Colectica.Model.Ddi.dll
Syntax
public class CodeList : DescribableBase, INotifyPropertyChanged, IVersionable, IIdentifiable, IHasCustomFields, IDescribable, IVisitable

Constructors

CodeList()

Initializes a new instance of the CodeList class.

Declaration
public CodeList()

Properties

CategoryScheme

Gets or sets the category scheme that contains the categories in this code list.

Declaration
public CategoryScheme CategoryScheme { get; set; }
Property Value
Type Description
CategoryScheme

Codes

Gets the codes.

Declaration
public ObservableCollection<Code> Codes { get; }
Property Value
Type Description
ObservableCollection<Code>

ItemType

Gets the universally unique identifier representing the item's type.

Declaration
public override Guid ItemType { get; }
Property Value
Type Description
Guid

The identifier representing the item's type.

Overrides
VersionableBase.ItemType

Levels

Gets the levels of a hierarchical code list.

Declaration
public ObservableCollection<Level> Levels { get; }
Property Value
Type Description
ObservableCollection<Level>

Methods

GetChildren()

Gets the identifiers of the item's children.

Declaration
public override ChildItemCollection GetChildren()
Returns
Type Description
ChildItemCollection

The identifiers of the item's children.

Overrides
VersionableBase.GetChildren()

GetFlattenedCodes()

Returns all codes in the hierarchy as a flat list.

Declaration
public Collection<Code> GetFlattenedCodes()
Returns
Type Description
Collection<Code>

The flattened list of codes.

RemoveChild(IdentifierTriple)

Removes the specified child.

Declaration
public override int RemoveChild(IdentifierTriple child)
Parameters
Type Name Description
IdentifierTriple child

The child to be removed.

Returns
Type Description
int

The number of children removed from the item.

Overrides
VersionableBase.RemoveChild(IdentifierTriple)
Exceptions
Type Condition
ArgumentNullException

child

ReplaceChild(IdentifierTriple, IVersionable)

Replaces the child with the specified identifier with the provided item.

Declaration
public override int ReplaceChild(IdentifierTriple toReplace, IVersionable child)
Parameters
Type Name Description
IdentifierTriple toReplace

The identifier of the child to replace.

IVersionable child

The new child.

Returns
Type Description
int

The number of children replaced.

Overrides
VersionableBase.ReplaceChild(IdentifierTriple, IVersionable)
Exceptions
Type Condition
ArgumentNullException

child

WatchProperties()

Watch for property changed events

Declaration
protected override void WatchProperties()
Overrides
DescribableBase.WatchProperties()

Implements

INotifyPropertyChanged
IVersionable
IIdentifiable
IHasCustomFields
IDescribable
IVisitable

Extension Methods

VariableExtensions.AreAllNonMissingCodesNumeric(CodeList)
VersionableCustomFieldExtensions.GetCustomFieldMultilingualStringValue(IHasCustomFields, string)
VersionableCustomFieldExtensions.GetCustomFieldStringValue(IHasCustomFields, string)
VersionableCustomFieldExtensions.GetCustomFieldUriValue(IHasCustomFields, string)
VersionableCustomFieldExtensions.SetCustomField(IHasCustomFields, MultilingualString, IVersionable)
VersionableCustomFieldExtensions.SetCustomField(IHasCustomFields, MultilingualString, string)
VersionableCustomFieldExtensions.SetCustomField(IHasCustomFields, string, IVersionable)
VersionableCustomFieldExtensions.SetCustomField(IHasCustomFields, string, string)
Extensions.GetDdi32FragmentRepresentation(IVersionable, Ddi32Serializer)
Extensions.GetDdi33FragmentRepresentation(IVersionable, Ddi33Serializer)
Extensions.GetDdiFragmentRepresentation(IVersionable, DDIWorkflowSerializer, XmlDocument)
Extensions.GetMultilingualStrings(IVersionable)
NamingHelper.GetBaseFileNameForItem(IVersionable)
VersionableExtensions.GetHeader(IVersionable, bool)
VersionableExtensions.GetMetadata(IVersionable)
VersionableExtensions.GetUserAttribute(IVersionable, string)
VersionableExtensions.GetUserAttributeInt(IVersionable, string)
VersionableExtensions.SetUserAttribute(IVersionable, string, string)
VersionableUserIdExtensions.SetUserId(IVersionable, string, string)
In this article
Back to top Generated by DocFX