com.ibm.soa.parlayx21.terminal_status
Interface TerminalStatus

All Superinterfaces:
java.rmi.Remote
All Known Subinterfaces:
TerminalStatus_RI
All Known Implementing Classes:
TerminalStatusBindingStub, TerminalStatusProxy

public interface TerminalStatus
extends java.rmi.Remote

Request the status for a terminal or set of terminals.


Method Summary
 Status getStatus(java.net.URI address)
          This operation is intended to retrieve the status for a single terminal.
 StatusData[] getStatusForGroup(java.net.URI[] addresses)
          This operation initiates a retrieval activity, where one or more terminals, or groups of terminals, may have their status determined.
 

Method Detail

getStatus

Status getStatus(java.net.URI address)
                 throws java.rmi.RemoteException,
                        PolicyException,
                        ServiceException

This operation is intended to retrieve the status for a single terminal. The URI provided is for a single terminal, not a group URI. If a group URI is provided, a PolicyException will be returned to the application.

Referenced faults

ServiceException from ES 202 391-1 [2]:
  * SVC0001: Service error.
  * SVC0002: Invalid input value.

PolicyException from ES 202 391-1 [2]:
  * POL0001: Policy error.
  * POL0002: Privacy error.
  * POL0006: Groups not allowed.

Parameters:
address - xsd:anyURI Terminal to request status for
Returns:
result Status Status for the terminal for which status was requested
Throws:
java.rmi.RemoteException
PolicyException
ServiceException

getStatusForGroup

StatusData[] getStatusForGroup(java.net.URI[] addresses)
                               throws java.rmi.RemoteException,
                                      PolicyException,
                                      ServiceException

This operation initiates a retrieval activity, where one or more terminals, or groups of terminals, may have their status determined.

The Web Service may return a result set that does not include complete information, allowing the Web Service implementation to choose to deliver a partial set of results to accommodate other conditions, such as avoiding timeouts. In this case, the addresses for which no attempt was made to provide data will be marked NotRetrieved in the result for each address this applies to.

Referenced faults

ServiceException from ES 202 391-1 [2]:
  * SVC0001: Service error.
  * SVC0002: Invalid input value.
  * SVC0004: No valid addresses.
  * SVC0006: Invalid group.

PolicyException from ES 202 391-1 [2]:
  * POL0001: Policy error.
  * POL0003: Too many addresses.
  * POL0006: Groups not allowed.
  * POL0007: Nested groups not allowed.

Parameters:
addresses - xsd:anyURI [1..unbounded] List of URIs to get status for, including group URIs
Returns:
result StatusData [1..unbounded] Set of results for the request
Throws:
java.rmi.RemoteException
PolicyException
ServiceException


Copyright © 2003 IBM Corp. All Rights Reserved.