Class ServiceAgreement
Represents service level agreement (SLA) describing acceptable limits for a set of metrics for particular service.
Inherited Members
Namespace: Nevatech.Vsb.Repository.Entities
Assembly: Nevatech.Vsb.Repository.dll
Syntax
public class ServiceAgreement : DomainObjectBase, IValidator, IExtensibleDataObject, IEquatable<ServiceAgreement>, IFolderEntity
Constructors
ServiceAgreement()
Initializes an empty instance.
Declaration
public ServiceAgreement()
Properties
Description
Gets or sets service agreement description.
Declaration
public string Description { get; set; }
Property Value
| Type | Description |
|---|---|
| System.String |
EndDateTime
Gets or sets the end date/time when agreement expires (time is in the specified by TimeZoneId time zone). If not set, agreement never expires.
Declaration
public DateTime? EndDateTime { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Nullable<System.DateTime> |
Remarks
Note that in database this property is stored in UTC.
FolderId
Gets or sets identifier of the folder this service agreement belongs to.
Declaration
public int? FolderId { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Nullable<System.Int32> |
FriendlyName
Gets or sets service agreement friendly name.
Declaration
public string FriendlyName { get; set; }
Property Value
| Type | Description |
|---|---|
| System.String |
IsCurrentlyEffective
Gets flag indicating that service agreement is currently effective (is in active status, started, and not expired).
Declaration
public bool IsCurrentlyEffective { get; }
Property Value
| Type | Description |
|---|---|
| System.Boolean |
ObjectType
Gets object type identifier.
Declaration
public override EntityType ObjectType { get; }
Property Value
| Type | Description |
|---|---|
| EntityType |
Overrides
StartDateTime
Gets or sets the start date/time when agreement becomes effective (time is in the specified by TimeZoneId time zone).
Declaration
public DateTime StartDateTime { get; set; }
Property Value
| Type | Description |
|---|---|
| System.DateTime |
Remarks
Note that in database this property is stored in UTC.
Status
Gets or sets service agreement status (draft, active, or retired).
Declaration
public ServiceAgreementStatus Status { get; set; }
Property Value
| Type | Description |
|---|---|
| ServiceAgreementStatus |
TimeZone
Gets time zone associated with the current TimeZoneId property.
Declaration
public TimeZoneInfo TimeZone { get; }
Property Value
| Type | Description |
|---|---|
| System.TimeZoneInfo |
TimeZoneId
Gets or sets time zone identifier which corresponds to System.TimeZoneInfo.Id property. The time zone defined here is used for time aggregations and reporting service metrics by hours, days, etc.
Declaration
public string TimeZoneId { get; set; }
Property Value
| Type | Description |
|---|---|
| System.String |
Methods
Compress()
Clears unnecessary to runtime data to reduce message payload.
Declaration
public void Compress()
Equals(ServiceAgreement)
Determines whether the specified domain object is equal to the current object.
Declaration
public bool Equals(ServiceAgreement other)
Parameters
| Type | Name | Description |
|---|---|---|
| ServiceAgreement | other | The object to compare with the current object. |
Returns
| Type | Description |
|---|---|
| System.Boolean | True, if objects are equal. False, if objects are not equal. |
Equals(Object)
Determines whether the specified domain object is equal to the current object.
Declaration
public override bool Equals(object obj)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Object | obj | The object to compare with the current object. |
Returns
| Type | Description |
|---|---|
| System.Boolean | True, if objects are equal. False, if objects are not equal. |
Overrides
GetHashCode()
Returns the hash code for this instance.
Declaration
public override int GetHashCode()
Returns
| Type | Description |
|---|---|
| System.Int32 | Hash code of the current instance. |
Overrides
ToString()
Returns a string that represents the current object.
Declaration
public override string ToString()
Returns
| Type | Description |
|---|---|
| System.String | A string that represents the current object. |
Overrides
Validate()
Evaluates the state of this object.
Declaration
public override bool Validate()
Returns
| Type | Description |
|---|---|
| System.Boolean | True if state is valid; otherwise, false. |