solid-instruments/src/RapidField.SolidInstruments.Messaging/IMessagingEntityPath.cs at master · RapidField/solid-instruments · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
// =================================================================================================================================
// Copyright (c) RapidField LLC. Licensed under the MIT License. See LICENSE.txt in the project root for license information.
// =================================================================================================================================

using RapidField.SolidInstruments.Core;
using System;

namespace RapidField.SolidInstruments.Messaging
{
    /// <summary>
    /// Represents a textual path that defines a route to a messaging entity.
    /// </summary>
    public interface IMessagingEntityPath : IComparable<IMessagingEntityPath>, IEquatable<IMessagingEntityPath>
    {
        /// <summary>
        /// Gets or sets the first label for the current <see cref="IMessagingEntityPath" />, or <see langword="null" /> if there is
        /// not a first label.
        /// </summary>
        /// <exception cref="StringArgumentPatternException">
        /// The specified value is invalid.
        /// </exception>
        public String LabelOne
        {
            get;
            set;
        }

        /// <summary>
        /// Gets or sets the third label for the current <see cref="IMessagingEntityPath" />, or <see langword="null" /> if there is
        /// not a third label.
        /// </summary>
        /// <exception cref="StringArgumentPatternException">
        /// The specified value is invalid.
        /// </exception>
        public String LabelThree
        {
            get;
            set;
        }

        /// <summary>
        /// Gets or sets the second label for the current <see cref="IMessagingEntityPath" />, or <see langword="null" /> if there
        /// is not a second label.
        /// </summary>
        /// <exception cref="StringArgumentPatternException">
        /// The specified value is invalid.
        /// </exception>
        public String LabelTwo
        {
            get;
            set;
        }

        /// <summary>
        /// Gets or sets the message type for the current <see cref="IMessagingEntityPath" />.
        /// </summary>
        /// <exception cref="ArgumentEmptyException">
        /// The specified value is empty.
        /// </exception>
        /// <exception cref="ArgumentNullException">
        /// The specified value is <see langword="null" />.
        /// </exception>
        /// <exception cref="StringArgumentPatternException">
        /// The specified value is invalid.
        /// </exception>
        public String MessageType
        {
            get;
            set;
        }

        /// <summary>
        /// Gets or sets the prefix for the current <see cref="IMessagingEntityPath" />, or <see langword="null" /> if there is not
        /// a prefix.
        /// </summary>
        /// <exception cref="StringArgumentPatternException">
        /// The specified value is invalid.
        /// </exception>
        public String Prefix
        {
            get;
            set;
        }
    }
}