Class NcObligationType

A data type for something that is owed to an entity.

Inheritance

System.Object

NcObligationType

Implements

System.IEquatable<NcObligationType>

Inherited Members

System.Object.Equals(System.Object, System.Object)

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

Namespace: NiemTypes

Assembly: EidoLib.dll

Syntax

[DataContract]
public class NcObligationType : IEquatable<NcObligationType>

Properties

Category

A kind of obligation. NIEM reference is nc:ObligationCategoryText

Declaration

[DataMember(Name = "category")]
public List<NcTextType> Category { get; set; }

Property Value

Type	Description
System.Collections.Generic.List<NcTextType>	A kind of obligation. NIEM reference is nc:ObligationCategoryText

Context

ncObligationType JSON-LD context

Declaration

[DataMember(Name = "@context")]
public NcObligationType.ContextEnum? Context { get; set; }

Property Value

Type	Description
System.Nullable<NcObligationType.ContextEnum>	ncObligationType JSON-LD context

DueAmount

An amount of a payment obligation that has not been made. NIEM reference is nc:ObligationDueAmount

Declaration

[DataMember(Name = "dueAmount")]
public List<NcAmountType> DueAmount { get; set; }

Property Value

Type	Description
System.Collections.Generic.List<NcAmountType>	An amount of a payment obligation that has not been made. NIEM reference is nc:ObligationDueAmount

DueDate

A date by which an obligation must be fulfilled. NIEM reference is nc:ObligationDueDate

Declaration

[DataMember(Name = "dueDate")]
public List<NcDateType> DueDate { get; set; }

Property Value

Type	Description
System.Collections.Generic.List<NcDateType>	A date by which an obligation must be fulfilled. NIEM reference is nc:ObligationDueDate

DueDuration

A quantity of time still required to be spent in order to fulfill an obligation. NIEM reference is nc:ObligationDueDuration

Declaration

[DataMember(Name = "dueDuration")]
public List<NiemXsduration> DueDuration { get; set; }

Property Value

Type	Description
System.Collections.Generic.List<NiemXsduration>	A quantity of time still required to be spent in order to fulfill an obligation. NIEM reference is nc:ObligationDueDuration

Entity

An entity that must fulfill an obligation. NIEM reference is nc:ObligationEntity

Declaration

[DataMember(Name = "entity")]
public List<NcEntityType> Entity { get; set; }

Property Value

Type	Description
System.Collections.Generic.List<NcEntityType>	An entity that must fulfill an obligation. NIEM reference is nc:ObligationEntity

Exemption

A waiving or dismissal of an obligation. NIEM reference is nc:ObligationExemption

Declaration

[DataMember(Name = "exemption")]
public List<NcObligationExemptionType> Exemption { get; set; }

Property Value

Type	Description
System.Collections.Generic.List<NcObligationExemptionType>	A waiving or dismissal of an obligation. NIEM reference is nc:ObligationExemption

IsComplete

True if an obligation has been fulfilled; false otherwise. NIEM reference is nc:ObligationCompleteIndicator

Declaration

[DataMember(Name = "isComplete")]
public List<NiemXsboolean> IsComplete { get; set; }

Property Value

Type	Description
System.Collections.Generic.List<NiemXsboolean>	True if an obligation has been fulfilled; false otherwise. NIEM reference is nc:ObligationCompleteIndicator

IsCompliance

True if a person with an obligation is in compliance with the requirements; false otherwise. NIEM reference is nc:ObligationComplianceIndicator

Declaration

[DataMember(Name = "isCompliance")]
public List<NiemXsboolean> IsCompliance { get; set; }

Property Value

Type	Description
System.Collections.Generic.List<NiemXsboolean>	True if a person with an obligation is in compliance with the requirements; false otherwise. NIEM reference is nc:ObligationComplianceIndicator

IsExemption

True if an obligation has been waived or dismissed; false otherwise. NIEM reference is nc:ObligationExemptionIndicator

Declaration

[DataMember(Name = "isExemption")]
public List<NiemXsboolean> IsExemption { get; set; }

Property Value

Type	Description
System.Collections.Generic.List<NiemXsboolean>	True if an obligation has been waived or dismissed; false otherwise. NIEM reference is nc:ObligationExemptionIndicator

ItAugmentation

Additional information about an obligation. NIEM reference is it:ObligationAugmentation

Declaration

[DataMember(Name = "itAugmentation")]
public List<ItObligationAugmentationType> ItAugmentation { get; set; }

Property Value

Type	Description
System.Collections.Generic.List<ItObligationAugmentationType>	Additional information about an obligation. NIEM reference is it:ObligationAugmentation

JAugmentation

Additional information about a Obligation. NIEM reference is j:ObligationAugmentation

Declaration

[DataMember(Name = "jAugmentation")]
public List<JObligationAugmentationType> JAugmentation { get; set; }

Property Value

Type	Description
System.Collections.Generic.List<JObligationAugmentationType>	Additional information about a Obligation. NIEM reference is j:ObligationAugmentation

PaidAmount

An amount of a payment obligation that has been made. NIEM reference is nc:ObligationPaidAmount

Declaration

[DataMember(Name = "paidAmount")]
public List<NcAmountType> PaidAmount { get; set; }

Property Value

Type	Description
System.Collections.Generic.List<NcAmountType>	An amount of a payment obligation that has been made. NIEM reference is nc:ObligationPaidAmount

PaidDate

A date an obligation was fulfilled. NIEM reference is nc:ObligationPaidDate

Declaration

[DataMember(Name = "paidDate")]
public List<NcDateType> PaidDate { get; set; }

Property Value

Type	Description
System.Collections.Generic.List<NcDateType>	A date an obligation was fulfilled. NIEM reference is nc:ObligationPaidDate

PaidDuration

A quantity of time that has been spent towards fulfilling an obligation. NIEM reference is nc:ObligationPaidDuration

Declaration

[DataMember(Name = "paidDuration")]
public List<NiemXsduration> PaidDuration { get; set; }

Property Value

Type	Description
System.Collections.Generic.List<NiemXsduration>	A quantity of time that has been spent towards fulfilling an obligation. NIEM reference is nc:ObligationPaidDuration

ProgressDescription

A description of the progress that has been made in fulfilling an obligation. NIEM reference is nc:ObligationProgressDescriptionText

Declaration

[DataMember(Name = "progressDescription")]
public List<NcTextType> ProgressDescription { get; set; }

Property Value

Type	Description
System.Collections.Generic.List<NcTextType>	A description of the progress that has been made in fulfilling an obligation. NIEM reference is nc:ObligationProgressDescriptionText

Recipient

An entity to whom an obligation must be fulfilled. NIEM reference is nc:ObligationRecipient

Declaration

[DataMember(Name = "recipient")]
public List<NcEntityType> Recipient { get; set; }

Property Value

Type	Description
System.Collections.Generic.List<NcEntityType>	An entity to whom an obligation must be fulfilled. NIEM reference is nc:ObligationRecipient

Recurrence

A periodic basis on which an obligation must be met. NIEM reference is nc:ObligationRecurrence

Declaration

[DataMember(Name = "recurrence")]
public List<NcObligationRecurrenceType> Recurrence { get; set; }

Property Value

Type	Description
System.Collections.Generic.List<NcObligationRecurrenceType>	A periodic basis on which an obligation must be met. NIEM reference is nc:ObligationRecurrence

RequirementDescription

A description of what is necessary in order to fulfill an obligation. NIEM reference is nc:ObligationRequirementDescriptionText

Declaration

[DataMember(Name = "requirementDescription")]
public List<NcTextType> RequirementDescription { get; set; }

Property Value

Type	Description
System.Collections.Generic.List<NcTextType>	A description of what is necessary in order to fulfill an obligation. NIEM reference is nc:ObligationRequirementDescriptionText

TotalAmount

A total amount of money to be charged or paid to meet a financial obligation. NIEM reference is nc:ObligationTotalAmount

Declaration

[DataMember(Name = "totalAmount")]
public List<NcAmountType> TotalAmount { get; set; }

Property Value

Type	Description
System.Collections.Generic.List<NcAmountType>	A total amount of money to be charged or paid to meet a financial obligation. NIEM reference is nc:ObligationTotalAmount

TotalDuration

A quantity of time that must be spent in order to fulfill an obligation. NIEM reference is nc:ObligationTotalDuration

Declaration

[DataMember(Name = "totalDuration")]
public List<NiemXsduration> TotalDuration { get; set; }

Property Value

Type	Description
System.Collections.Generic.List<NiemXsduration>	A quantity of time that must be spent in order to fulfill an obligation. NIEM reference is nc:ObligationTotalDuration

Methods

Equals(NcObligationType)

Returns true if NcObligationType instances are equal

Declaration

public bool Equals(NcObligationType other)

Parameters

Type	Name	Description
NcObligationType	other	Instance of NcObligationType to be compared

Returns

Type	Description
System.Boolean	Boolean

Equals(Object)

Returns true if objects are equal

Declaration

public override bool Equals(object obj)

Parameters

Type	Name	Description
System.Object	obj	Object to be compared

Returns

Type	Description
System.Boolean	Boolean

Overrides

System.Object.Equals(System.Object)

GetHashCode()

Gets the hash code

Declaration

public override int GetHashCode()

Returns

Type	Description
System.Int32	Hash code

Overrides

System.Object.GetHashCode()

ToJson()

Returns the JSON string presentation of the object

Declaration

public string ToJson()

Returns

Type	Description
System.String	JSON string presentation of the object

ToString()

Returns the string presentation of the object

Declaration

public override string ToString()

Returns

Type	Description
System.String	String presentation of the object

Overrides

System.Object.ToString()

Operators

Equality(NcObligationType, NcObligationType)

Declaration

public static bool operator ==(NcObligationType left, NcObligationType right)

Parameters

Type	Name	Description
NcObligationType	left
NcObligationType	right

Returns

Type	Description
System.Boolean

Inequality(NcObligationType, NcObligationType)

Declaration

public static bool operator !=(NcObligationType left, NcObligationType right)

Parameters

Type	Name	Description
NcObligationType	left
NcObligationType	right

Returns

Type	Description
System.Boolean

Implements

System.IEquatable<T>