aboutsummaryrefslogtreecommitdiffstats
path: root/src/net/java/sip/communicator/service/protocol/OperationSetTelephonyBLF.java
blob: 028c2aeec292ae3847eca8e86da35b9775a3f250 (plain)
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
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
/*
 * Jitsi, the OpenSource Java VoIP and Instant Messaging client.
 *
 * Copyright @ 2015 Atlassian Pty Ltd
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package net.java.sip.communicator.service.protocol;

import java.util.*;

import net.java.sip.communicator.service.protocol.event.*;
import net.java.sip.communicator.util.*;

/**
 * Provides operations necessary to monitor line activity and pickup calls
 * if needed. BLF stands for Busy Lamp Field.
 * @author Damian Minkov
 */
public interface OperationSetTelephonyBLF
    extends OperationSet
{
    /**
     * Adds BLFStatus listener
     * @param listener the listener to add.
     */
    public void addStatusListener(BLFStatusListener listener);

    /**
     * Removes BLFStatus listener.
     * @param listener the listener to remove.
     */
    public void removeStatusListener(BLFStatusListener listener);

    /**
     * To pickup the call for the monitored line if possible.
     *
     * @param line to try to pick up.
     *
     * @throws OperationFailedException if <tt>line</tt> address is not valid.
     */
    public void pickup(Line line)
        throws OperationFailedException;

    /**
     * List of currently monitored lines.
     * @return list of currently monitored lines.
     */
    public List<Line> getCurrentlyMonitoredLines();

    /**
     * The monitored line.
     */
    public static class Line
        extends DataObject
    {
        /**
         * The address of the line.
         */
        private String address;

        /**
         * The display name of the line.
         */
        private String name;

        /**
         * The group under witch to display the line.
         */
        private String group;

        /**
         * The parent provider.
         */
        private ProtocolProviderService provider;

        /**
         * Constructs Line.
         *
         * @param address the address of the line.
         * @param name the display name if any
         * @param group the group name if any
         * @param provider the parent provider.
         */
        public Line(String address, String name, String group,
                    ProtocolProviderService provider)
        {
            this.address = address;
            this.name = name;
            this.group = group;
            this.provider = provider;
        }

        /**
         * The address of the line.
         * @return address of the line.
         */
        public String getAddress()
        {
            return address;
        }

        /**
         * The name of the line.
         * @return the name of the line.
         */
        public String getName()
        {
            return name;
        }

        /**
         * The group name.
         * @return the group name.
         */
        public String getGroup()
        {
            return group;
        }

        /**
         * The provider.
         * @return the provider.
         */
        public ProtocolProviderService getProvider()
        {
            return provider;
        }

        @Override
        public boolean equals(Object o)
        {
            if(this == o) return true;
            if(o == null || getClass() != o.getClass()) return false;

            Line line = (Line) o;

            return address.equals(line.address);

        }

        @Override
        public int hashCode()
        {
            return address.hashCode();
        }
    }
}