public class AddressServiceImpl
extends java.lang.Object
implements com.nortel.soa.oi.cct.addressservice.AddressService
This service models an Address in the system
It provides methods to read and set the attributes of the address.
Prerequisites to usage: This represents the minimal data artifacts required to successfully invoke this web service.
Operations: View WSDL
Constructor and Description |
---|
AddressServiceImpl() |
Modifier and Type | Method and Description |
---|---|
void |
cancelForwarding(AddressRequest parameters)
Cancels any forwarding on the specified address
|
GetAddressCapabilitiesResponse |
getCapabilities(AddressRequest parameters)
Returns the address address capabilities
|
ConnectionResponse |
getConnection(ConnectionRequest parameters) |
GetConnectionsResponse |
getConnections(AddressRequest parameters)
Gets the list of connections on the adress
|
GetDoNotDisturbResponse |
getDoNotDisturb(AddressRequest parameters)
Returns the DoNotDisturb setting for the specified address
|
GetForwardingResponse |
getForwarding(AddressRequest parameters)
Returns the forwarding characteristics for the specified address
|
GetMessageWaitingResponse |
getMessageWaiting(AddressRequest parameters)
Determines if there is a message waiting on the specified address along with the number of messages waiting
|
GetPresenceResponse |
getPresence(AddressRequest parameters)
Returns the presence associated with an Address
|
GetStateResponse |
getState(AddressRequest parameters)
Returns the address state of the specified address
|
GetTerminalsResponse |
getTerminals(AddressRequest parameters)
Returns the terminals with which this address is associated
|
GetTerminalStatusResponse |
getTerminalStatus(AddressRequest parameters)
Returns the status of the terminal associated with the specified address
|
GetUriResponse |
getUri(AddressRequest parameters)
Returns the uri associated with the specified address
|
GetVersionResponse |
getVersion(GetVersionRequest parameters) |
IsForwardedResponse |
isForwarded(AddressRequest parameters)
Determines if the specified address is forwarded or not
|
IsMessageWaitingResponse |
isMessageWaiting(AddressRequest parameters)
Determines if there is a message waiting on the specified address
|
ContactResponse |
originate(AddressOriginateRequest parameters)
Attempts to create a contact between the specifed address and the specified destination
|
void |
presenceSubscribe(PresenceSubscribeRequest parameters)
Request presence subscription for the specified address
|
void |
presenceUnsubscribe(AddressRequest parameters)
Allows an application to unsubscribe for presence for a specific address.
|
void |
sendInstantMessage(InstantMessageRequest parameters) |
void |
setDoNotDisturb(SetDoNotDisturbRequest parameters)
Sets the do-no-disturb attribute of the address
|
void |
setForwarding(SetForwardingRequest parameters)
Sets the forwarding characteristics for the address specified
|
void |
setMessageWaiting(SetMessageWaitingRequest parameters)
Sets the message-waiting indicator for the address specified.
|
public IsForwardedResponse isForwarded(AddressRequest parameters) throws SessionNotCreatedException, IsForwardedException
Operation Summary:
Returns true if the specified address is forwarded
Sample Usage:
SOAP Request/Response:
Sample Request
Sample Response
isForwarded
in interface com.nortel.soa.oi.cct.addressservice.AddressService
parameters
- the AddressRequest
containing the address informationIsForwardedResponse
SessionNotCreatedException
IsForwardedException
public IsMessageWaitingResponse isMessageWaiting(AddressRequest parameters) throws IsMessageWaitingException, SessionNotCreatedException
Operation Summary:
Returns true if there is a message waiting on the address
Sample Usage:
SOAP Request/Response:
Sample Request
Sample Response
isMessageWaiting
in interface com.nortel.soa.oi.cct.addressservice.AddressService
parameters
- the AddressRequest
containing the address informationIsMessageWaitingResponse
contains value true if there is a message waiting, otherwise falseIsMessageWaitingException
SessionNotCreatedException
public GetConnectionsResponse getConnections(AddressRequest parameters) throws SessionNotCreatedException, GetConnectionsException
Operation Summary:
Returns a list of connections that are currently on the address
Sample Usage:
SOAP Request/Response:
Sample Request
Sample Response
getConnections
in interface com.nortel.soa.oi.cct.addressservice.AddressService
parameters
- the AddressRequest
containing the address informationGetConnectionsResponse
contains the list of connectionsSessionNotCreatedException
GetConnectionsException
public GetAddressCapabilitiesResponse getCapabilities(AddressRequest parameters) throws GetCapabilitiesException, SessionNotCreatedException
Operation Summary:
Returns the address capabilities. Address capabilities include
Sample Usage:
SOAP Request/Response:
Sample Request
Sample Response
getCapabilities
in interface com.nortel.soa.oi.cct.addressservice.AddressService
parameters
- the AddressRequest
contains the address informationGetAddressCapabilitiesResponse
contains the address capabilitiesGetCapabilitiesException
SessionNotCreatedException
public GetDoNotDisturbResponse getDoNotDisturb(AddressRequest parameters) throws GetDoNotDisturbException, SessionNotCreatedException
Operation Summary:
Returns True if do-not-disturb feature is activated, false if it is deactivated.
Sample Usage:
SOAP Request/Response:
Sample Request
Sample Response
getDoNotDisturb
in interface com.nortel.soa.oi.cct.addressservice.AddressService
parameters
- the AddressRequest
containing the address informationGetDoNotDisturbResponse
contains a boolean value representing the address's DoNotDisturb settingGetDoNotDisturbException
SessionNotCreatedException
public GetTerminalStatusResponse getTerminalStatus(AddressRequest parameters) throws GetTerminalStatusException, SessionNotCreatedException
Operation Summary:
Returns the status of the terminal associated with the specified address
Sample Usage:
SOAP Request/Response:
Sample Request
Sample Response
getTerminalStatus
in interface com.nortel.soa.oi.cct.addressservice.AddressService
parameters
- the AddressRequest
containing the address informationGetTerminalStatusResponse
contains a string representation of the terminals statusGetTerminalStatusException
SessionNotCreatedException
public void cancelForwarding(AddressRequest parameters) throws CancelForwardingException, SessionNotCreatedException
Operation Summary:
Cancels any forwarding on the specified address
Sample Usage:
SOAP Request/Response:
Sample Request
cancelForwarding
in interface com.nortel.soa.oi.cct.addressservice.AddressService
parameters
- the AddressRequest
containing the address informationCancelForwardingException
SessionNotCreatedException
public GetForwardingResponse getForwarding(AddressRequest parameters) throws GetForwardingException, SessionNotCreatedException
Operation Summary:
Returns the forwarding characteristics for the specified address
Sample Usage:
SOAP Request/Response:
Sample Request
Sample Response
getForwarding
in interface com.nortel.soa.oi.cct.addressservice.AddressService
parameters
- the AddressRequest
containing the address informationGetForwardingResponse
contains a list of Fowarding objects which detail the forwarding characteristics of the addressGetForwardingException
SessionNotCreatedException
public GetMessageWaitingResponse getMessageWaiting(AddressRequest parameters) throws GetMessageWaitingException, SessionNotCreatedException
Operation Summary:
Returns a boolean value indicating if there is a message waiting and
the number of messages that are waiting.
Sample Usage:
SOAP Request/Response:
Sample Request
Sample Response
getMessageWaiting
in interface com.nortel.soa.oi.cct.addressservice.AddressService
parameters
- the AddressRequest
containing the address informationGetMessageWaitingResponse
Contains a MessageWaiting object which wraps a boolean value for messageWaitingGetMessageWaitingException
SessionNotCreatedException
public GetPresenceResponse getPresence(AddressRequest parameters) throws GetPresenceException, SessionNotCreatedException
Operation Summary:
Returns the presence associated with an Address
Sample Usage:
SOAP Request/Response:
Sample Request
Sample Response
getPresence
in interface com.nortel.soa.oi.cct.addressservice.AddressService
parameters
- the AddressRequest
containing the address informationGetPresenceResponse
theGetPresenceException
SessionNotCreatedException
public GetTerminalsResponse getTerminals(AddressRequest parameters) throws GetTerminalsException, SessionNotCreatedException
Operation Summary:
Returns the terminals with which this address is associated
Sample Usage:
SOAP Request/Response:
Sample Request
Sample Response
getTerminals
in interface com.nortel.soa.oi.cct.addressservice.AddressService
parameters
- the AddressRequest
containing the address informationGetTerminalsResponse
Contains the list of terminalsGetTerminalsException
SessionNotCreatedException
public GetUriResponse getUri(AddressRequest parameters) throws SessionNotCreatedException, GetUriException
Operation Summary:
Returns the uri associated with the specified address
Sample Usage:
SOAP Request/Response:
Sample Request
Sample Response
getUri
in interface com.nortel.soa.oi.cct.addressservice.AddressService
parameters
- the AddressRequest
containing the address informationGetUriResponse
contains the uri informationSessionNotCreatedException
GetUriException
public void presenceSubscribe(PresenceSubscribeRequest parameters) throws SessionNotCreatedException, PresenceSubscribeException
Operation Summary:
Request presence subscription for the specified address
Sample Usage:
SOAP Request/Response:
Sample Request
presenceSubscribe
in interface com.nortel.soa.oi.cct.addressservice.AddressService
parameters
- the PresenceSubscribeRequest
containing the address information and the desired duration of the presence subscriptionSessionNotCreatedException
PresenceSubscribeException
public void presenceUnsubscribe(AddressRequest parameters) throws SessionNotCreatedException, PresenceUnsubscribeException
Operation Summary:
Allows an application to unsubscribe for presence for a specific address.
Sample Usage:
SOAP Request/Response:
Sample Request
presenceUnsubscribe
in interface com.nortel.soa.oi.cct.addressservice.AddressService
parameters
- the AddressRequest
containing the address informationSessionNotCreatedException
PresenceUnsubscribeException
public void setDoNotDisturb(SetDoNotDisturbRequest parameters) throws SetDoNotDisturbException, SessionNotCreatedException
Operation Summary:
Sets the do-no-disturb attribute of the address to the value specified
Sample Usage:
SOAP Request/Response:
Sample Request
setDoNotDisturb
in interface com.nortel.soa.oi.cct.addressservice.AddressService
parameters
- the SetDoNotDisturbRequest
containing the address information and the required do-not-disturb balueSetDoNotDisturbException
SessionNotCreatedException
public void setForwarding(SetForwardingRequest parameters) throws SetForwardingException, SessionNotCreatedException
Operation Summary:
This method tells the system how incoming telephone calls to a specific address should be forwarded
It sets the forwarding characteristics for this Address.
This forwarding request supplants all previous forwarding instructions if it succeeds,
otherwise the forwarding state at the time of the command remains unchanged.
This method takes a list of Forwarding
objects.
Each object describes a different forwarding.
This method waits until all forwarding instructions have been set,
or until an error occurs and an exception is thrown.
SOAP Request/Response:
Sample Request
setForwarding
in interface com.nortel.soa.oi.cct.addressservice.AddressService
parameters
- the SetForwardingRequest
containing the address and forwarding informationSetForwardingException
SessionNotCreatedException
public void setMessageWaiting(SetMessageWaitingRequest parameters) throws SessionNotCreatedException, SetMessageWaitingException
Operation Summary:
Activates or deactivates the message-waiting indicator for the address specified.
If 'enable' is true, message-waiting is activated if not already activated.
If 'enable' is false, message-waiting is deactivated if not already deactivated.
Sample Usage:
SOAP Request/Response:
Sample Request
setMessageWaiting
in interface com.nortel.soa.oi.cct.addressservice.AddressService
parameters
- the SetMessageWaitingRequest
containing the address information and the messageWaiting details (true/false)SessionNotCreatedException
SetMessageWaitingException
public GetStateResponse getState(AddressRequest parameters) throws GetStateException, SessionNotCreatedException
Operation Summary:
Returns the address state of the specified address. The address state can be
Sample Usage:
SOAP Request/Response:
Sample Request
Sample Response
getState
in interface com.nortel.soa.oi.cct.addressservice.AddressService
parameters
- the AddressRequest
containing the address informationGetStateResponse
contains the address state informationGetStateException
SessionNotCreatedException
public ContactResponse originate(AddressOriginateRequest parameters) throws OriginateException, SessionNotCreatedException
Operation Summary:
Attempts to create a contact between the specifed address and the specified destination
Sample Usage:
SOAP Request/Response:
Sample Request
Sample Response
originate
in interface com.nortel.soa.oi.cct.addressservice.AddressService
parameters
- the AddressOriginateRequest
containing the address informationContactResponse
contains the contact createdOriginateException
SessionNotCreatedException
public ConnectionResponse getConnection(ConnectionRequest parameters) throws GetConnectionException, SessionNotCreatedException
getConnection
in interface com.nortel.soa.oi.cct.addressservice.AddressService
GetConnectionException
SessionNotCreatedException
public GetVersionResponse getVersion(GetVersionRequest parameters) throws SessionNotCreatedException, GetVersionException
getVersion
in interface com.nortel.soa.oi.cct.addressservice.AddressService
SessionNotCreatedException
GetVersionException
public void sendInstantMessage(InstantMessageRequest parameters) throws SessionNotCreatedException, SendInstantMessageException
sendInstantMessage
in interface com.nortel.soa.oi.cct.addressservice.AddressService
SessionNotCreatedException
SendInstantMessageException
Copyright © 2010 All Rights Reserved.