Show / Hide Table of Contents

    Class ServiceAgreementViolationsRequest

    Provides search criteria for selecting service agreement violations.

    Inheritance
    Object
    ServiceAgreementViolationsRequest
    Implements
    IValidator
    Inherited Members
    Object.ToString()
    Object.Equals(Object)
    Object.Equals(Object, Object)
    Object.ReferenceEquals(Object, Object)
    Object.GetHashCode()
    Object.GetType()
    Object.MemberwiseClone()
    Namespace: Nevatech.Vsb.Repository.Entities
    Assembly: Nevatech.Vsb.Repository.dll
    Syntax
    public sealed class ServiceAgreementViolationsRequest : IValidator

    Constructors

    ServiceAgreementViolationsRequest()

    Declaration
    public ServiceAgreementViolationsRequest()

    Properties

    EndDateTime

    Gets ors sets the end of the time interval when violations occurred (must be provided in the time zone of the corresponding service agreement). If not specified, all violations occured after StartDateTime will be returned.

    Declaration
    public DateTime? EndDateTime { get; set; }
    Property Value
    Type Description
    Nullable<DateTime>

    ErrorMessage

    Gets validation error message.

    Declaration
    public string ErrorMessage { get; }
    Property Value
    Type Description
    String

    FolderId

    Gets or sets the identifier of the folder containing service agreements. If not specified then all folders are considered. If it is set to 0 then only service aggrements in the root folder is considered. Folder and collection of metrics cannot be used together.

    Declaration
    public int? FolderId { get; set; }
    Property Value
    Type Description
    Nullable<Int32>

    Metrics

    Gets collection of service agreement metrics identifiers. All metrics must be defined within the same time zone. At least one metric must be provided, if search by metric is used. At most 10 metrics can be provided. Folder and collection of metrics cannot be used together.

    Declaration
    public Collection<int> Metrics { get; }
    Property Value
    Type Description
    Collection<Int32>

    SortField

    Gets or sets the field that result will be sorted by.

    Declaration
    public ServiceAgreementViolationsSortField SortField { get; set; }
    Property Value
    Type Description
    ServiceAgreementViolationsSortField

    SortOrder

    Gets or sets the result sort order.

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

    StartDateTime

    Gets or sets the begining of the time interval when violations occurred (must be provided in the time zone of the corresponding service agreement).

    Declaration
    public DateTime StartDateTime { get; set; }
    Property Value
    Type Description
    DateTime

    TimeZoneId

    Gets or sets the time zone identifier of the service agreements which violations need to be returned. This property is required.

    Declaration
    public string TimeZoneId { get; set; }
    Property Value
    Type Description
    String

    Methods

    Validate()

    Validates object properties returns the result.

    Declaration
    public bool Validate()
    Returns
    Type Description
    Boolean

    True, if object state is valid. False, if one or more properties have invalid values.

    Implements

    IValidator
    Back to top Nevatech Sentinet 6.5 Online Documentation