java.telephony.provider.html

JTAPI_html 用于JTAPI的HTML文档.

  public abstract <a href="java.lang.String.html#_top_">String</a> getName() throws <a href="java.telephony.PlatformException.html#_top_">PlatformException</a>
</pre>
<dl>
  <dd> Returns the unique string name of the Provider. Each different Provider must
have a unique string associated with it. This is the same string which the
application passed to the <EM>JtapiPeer.getProvider()</EM> method
to create this Provider instance.
<p>
  <dl>
    <dt> <b>Returns:</b>
    <dd> The URL-string name of the Provider.
    <dt> <b>Throws:</b> <a href="java.telephony.PlatformException.html#_top_">PlatformException</a>
    <dd> A platform-specific exception occurred.
    <dt> <b>See Also:</b>
    <dd> <a href="java.telephony.JtapiPeer
<p>.html#_top_">JtapiPeer
<p></a>
  </dl>
</dl>
<a name="getCalls()"><img src="images/red-ball.gif" width=12 height=12 alt=" o "></a>
<a name="getCalls"><b>getCalls</b></a>
<pre>
  public abstract <a href="java.telephony.Call.html#_top_">Call</a>[] getCalls() throws <a href="java.telephony.PlatformException.html#_top_">PlatformException</a>
</pre>
<dl>
  <dd> Returns an array of Call objects currently associated with the Provider.
When a Call moves into the Call.INVALID state, the Provider loses its
reference to this Call. Therefore, all Calls returned by this method
must either be in the Call.IDLE or Call.ACTIVE state. This method
returns null if the Provider has zero calls associated with it.
<p>
The pre-conditions for this method are:
<OL>
<LI>this.getState() == Provider.IN_SERVICE
</OL>
The post-conditions for this method are:
<OL>
<p>
<LI>this.getState() == Provider.IN_SERVICE
<LI>Let Calls calls[] = Provider.getCalls()
<LI>calls == null or calls.length >= 1
<LI>For all i, calls[i].getState() == Call.IDLE or Call.ACTIVE
</OL>
<p>
  <dl>
    <dt> <b>Returns:</b>
    <dd> An array of Call objects currently known by this Provider.
    <dt> <b>Throws:</b> <a href="java.telephony.PlatformException.html#_top_">PlatformException</a>
    <dd> A platform-specific exception occurred.
  </dl>
</dl>
<a name="getAddress(java.lang.String)"><img src="images/red-ball.gif" width=12 height=12 alt=" o "></a>
<a name="getAddress"><b>getAddress</b></a>
<pre>
  public abstract <a href="java.telephony.Address.html#_top_">Address</a> getAddress(<a href="java.lang.String.html#_top_">String</a> number) throws <a href="java.telephony.InvalidArgumentException.html#_top_">InvalidArgumentException</a>, <a href="java.telephony.PlatformException.html#_top_">PlatformException</a>
</pre>
<dl>
  <dd> Returns an Address object which corresponds to the telephone number
string provided. If the provided name does not correspond to an
Address known by the Provider and within the Provider's domain,
the InvalidArgumentException is thrown. In other words, the Address
must appear in the list generated by Provider.getAddresses().
<p>
The pre-conditions for this method are:
<OL>
<LI>this.getState() == Provider.IN_SERVICE
<LI>Let Address addr = this.getAddress(number);
<LI>addr is an element of this.getAddresses();
</OL>
<p>
The post-conditions for this method are:
<OL>
<LI>this.getState() == Provider.IN_SERVICE
<LI>Let Address addr = this.getAddress(number);
<LI>addr is an element of this.getAddresses();
</OL>
<p>
  <dl>
    <dt> <b>Parameters:</b>
    <dd> number - The telephone address string.
    <dt> <b>Returns:</b>
    <dd> The Address object corresponding to the given telephone
number.
    <dt> <b>Throws:</b> <a href="java.telephony.InvalidArgumentException.html#_top_">InvalidArgumentException</a>
    <dd> The name of the Address does not
correspond to the name of any Address object known to the Provider or
within the Provider's domain.
    <dt> <b>Throws:</b> <a href="java.telephony.PlatformException.html#_top_">PlatformException</a>
    <dd> A platform-specific exception occurred.
  </dl>
</dl>
<a name="getAddresses()"><img src="images/red-ball.gif" width=12 height=12 alt=" o "></a>
<a name="getAddresses"><b>getAddresses</b></a>
<pre>
  public abstract <a href="java.telephony.Address.html#_top_">Address</a>[] getAddresses() throws <a href="java.telephony.PlatformException.html#_top_">PlatformException</a>
</pre>
<dl>
  <dd> Returns a list of Addresses associated with the Provider and within the
Provider's domain. This list is static (i.e. is does not change) after
the Provider is first created. The Provider must be Provider.IN_SERVICE.
If no Address objects are associated with this Provider, then this method
returns null.
<p>
The pre-condition predicates for this method is:
<OL>
<LI>this.getState() == Provider.IN_SERVICE
</OL>
<p>
The post-condition predicates for this method is:
<OL>
<LI>this.getState() == Provider.IN_SERVICE
<LI>Let Address[] addr = this.getAddresses()
<LI>addr == null or addr.length >= 1
</OL>
<p>
  <dl>
    <dt> <b>Returns:</b>
    <dd> An array of Addresses known by this provider.
    <dt> <b>Throws:</b> <a href="java.telephony.PlatformException.html#_top_">PlatformException</a>
    <dd> A platform-specific exception occurred.
  </dl>
</dl>
<a name="getTerminals()"><img src="images/red-ball.gif" width=12 height=12 alt=" o "></a>
<a name="getTerminals"><b>getTerminals</b></a>
<pre>
  public abstract <a href="java.telephony.Terminal.html#_top_">Terminal</a>[] getTerminals() throws <a href="java.telephony.PlatformException.html#_top_">PlatformException</a>
</pre>
<dl>
  <dd> Returns a list of Terminals associated with the Provider and within the
Provider's domain.  Each Terminal possesses a unique
name, which is assigned to it by the JTAPI implementation.
The Provider must be Provider.IN_SERVICE. If
there are no Terminals associated with this Provider, then this method
returns null.
<p>
The pre-condition predicate for this method is:
<OL>
<LI>this.getState() == Provider.IN_SERVICE
</OL>
<p>
The post-condition predicate for this method is:
<OL>
<LI>this.getState() == Provider.IN_SERVICE
<LI>Let Terminal[] term = this.getTerminals()
<LI>term == null or term.length >= 1
</OL>
<p>
  <dl>
    <dt> <b>Returns:</b>
    <dd> An array of Terminals known by this provider.
    <dt> <b>Throws:</b> <a href="java.telephony.PlatformException.html#_top_">PlatformException</a>
    <dd> A platform-specific exception occurred.
  </dl>
</dl>
<a name="getTerminal(java.lang.String)"><img src="images/red-ball.gif" width=12 height=12 alt=" o "></a>
<a name="getTerminal"><b>getTerminal</b></a>
<pre>
  public abstract <a href="java.telephony.Terminal.html#_top_">Terminal</a> getTerminal(<a href="java.lang.String.html#_top_">String</a> name) throws <a href="java.telephony.InvalidArgumentException.html#_top_">InvalidArgumentException</a>, <a href="java.telephony.PlatformException.html#_top_">PlatformException</a>
</pre>
<dl>
  <dd> Returns an instance of the Terminal class which corresponds to the
given name. Each Terminal has a unique name associated with it, which
is assigned to it by the JTAPI implementation.  If
no Terminal is available for the given name within the Provider's
domain, this method throws the InvalidArgumentException. This Terminal
must be in the array generated by <EM>Provider.getTerminals().</EM>
<p>
The pre-condition predicates for this method is:
<OL>
<LI>this.getState() == Provider.IN_SERVICE
<LI>this.getTerminal(name) is an element of this.getTerminals()
</OL>
<p>
The post-condition predicates for this method are:
<OL>
<LI>this.getState() == Provider.IN_SERVICE
<LI>this.getTerminal(name) is an element of this.getTerminals()
</OL>
<p>
  <dl>
    <dt> <b>Parameters:</b>
    <dd> name - The name of desired Terminal object.
    <dt> <b>Returns:</b>
    <dd> The Terminal object associated with the given name.
    <dt> <b>Throws:</b> <a href="java.telephony.InvalidArgumentException.html#_top_">InvalidArgumentException</a>
    <dd> The name provided does not correspond
to a name of any Terminal known to the Provider or within the Provider's
domain.
    <dt> <b>Throws:</b> <a href="java.telephony.PlatformException.html#_top_">PlatformException</a>
    <dd> A platform-specific exception occurred.
  </dl>
</dl>
<a name="shutdown()"><img src="images/red-ball.gif" width=12 height=12 alt=" o "></a>
<a name="shutdown"><b>shutdown</b></a>
<pre>
  public abstract void shutdown() throws <a href="java.telephony.InvalidStateException.html#_top_">InvalidStateException</a>, <a href="java.telephony.PlatformException.html#_top_">PlatformException</a>
</pre>
<dl>
  <dd> Instructs the Provider to shut itself down and perform all neccessary
cleanup. Applications invoke this method when they no longer intend to
use the Provider, most often right before they exit. This
method is intended to allow the Provider to perform any neccessary
cleanup which would not be taken care of when the Java objects are
garbage collected. This method causes the Provider to move into the
Provider.SHUTDOWN state, in which it will stay indefinitely.
<p>
The pre-conditions for this method are:
<OL>
<LI>this.getState() == Provider.IN_SERVICE
</OL>
<p>
The post-conditions for this method are:
<OL>
<LI>this.getState() == Provider.SHUTDOWN
</OL>
<p>
  <dl>
    <dt> <b>Throws:</b> <a href="java.telephony.InvalidStateException.html#_top_">InvalidStateException</a>
    <dd> This Provider object is not in the
Provider.IN_SERVICE state.
    <dt> <b>Throws:</b> <a href="java.telephony.PlatformException.html#_top_">PlatformException</a>
    <dd> A platform-specific exception occurred.
  </dl>
</dl>
<a name="createCall()"><img src="images/red-ball.gif" width=12 height=12 alt=" o "></a>
<a name="createCall"><b>createCall</b></a>
<pre>
  public abstract <a href="java.telephony.Call.html#_top_">Call</a> createCall() throws <a href="java.telephony.ResourceUnavailableException.html#_top_">ResourceUnavailableException</a>, <a href="java.telephony.InvalidStateException.html#_top_">InvalidStateException</a>, <a href="java.telephony.PrivilegeViolationException.html#_top_">PrivilegeViolationException</a>, <a href="java.telephony.MethodNotSupportedException.html#_top_">MethodNotSupportedException</a>, <a href="java.telephony.PlatformException.html#_top_">PlatformException</a>
</pre>
<dl>
  <dd> Creates and returns a new instance of the Call object. This new call
object is in the Call.IDLE state and has no connections. An exception is
generated if a new call cannot be created.
<p>
The pre-condition predicates for this method are:
<OL>
<LI>this.getState() == Provider.IN_SERVICE
</OL>
<p>
The post-condition predicates for this method are:
<OL>
<LI>this.getState() == Provider.IN_SERVICE
<LI>Let Call call = this.createCall();