Skip navigation links

com.oracle.sft.xcap.client.simservs.actions
Interface ForwardTo

All Superinterfaces:

Action, XcapElement, XcapResource

public interface ForwardTo

extends Action

Represent "forward-to" action which is communication diversion specific extensions to IETF common policy actions. Target is a mandatory element. An ForwardTo can be created by calling com.oracle.sft.xcap.client.policy.Actions.createAction(Class<A>).

Nested Class Summary

static class

ForwardTo.RevealURIOptionsType Reveal URI Options Type for "forward-to".

Method Summary

ForwardTo.RevealURIOptionsType	getRevealIdentityToCaller() Get value of reveal-identity-to-caller.
ForwardTo.RevealURIOptionsType	getRevealIdentityToTarget() Get value of reveal-identity-to-target.
ForwardTo.RevealURIOptionsType	getRevealServedUserIdentityToCaller() Get value of reveal-served-user-identity-to-caller.
String	getTarget() Get the target of action forward-to.
boolean	isNotifyCaller() Check whether is notify-caller.
boolean	isNotifyServedUser() Check whether is notify-served-user.
boolean	isNotifyServedUserOnOutboundCall() Check whether is notify-served-user-on-outbound-call.
void	setNotifyCaller(boolean notifyCaller) Set whether is notify-caller.
void	setNotifyServedUser(boolean notifyServedUser) Set whether is notify-served-user.
void	setNotifyServedUserOnOutboundCall(boolean notifyServedUserOnOutboundCall) Set whether is notify-served-user-on-outbound-call.
void	setRevealIdentityToCaller(ForwardTo.RevealURIOptionsType revealIdentityToCaller) Set value of reveal-identity-to-caller.
void	setRevealIdentityToTarget(ForwardTo.RevealURIOptionsType revealIdentityToTarget) Set value of reveal-identity-to-target.
void	setRevealServedUserIdentityToCaller(ForwardTo.RevealURIOptionsType revealServedUserIdentityToCaller) Set value of reveal-served-user-identity-to-caller Default value is RevealURIOptionsType.TRUE.
void	setTarget(String target) Set the target.

Methods inherited from interface com.oracle.sft.xcap.client.XcapElement

getDocument, getNamespace, getNodeSelector, getParent

Methods inherited from interface com.oracle.sft.xcap.client.XcapResource

getContent, getContentType, getUrl, setContent

Method Detail

getTarget

String getTarget()

Get the target of action forward-to.

Returns:

the target

setTarget

void setTarget(String target)

Set the target. Target is a mandatory element for action forward-to.

Parameters:

target - the target name

isNotifyCaller

boolean isNotifyCaller()

Check whether is notify-caller. Default value is true.

Returns:

true if is notify-caller, otherwise, false.

setNotifyCaller

void setNotifyCaller(boolean notifyCaller)

Set whether is notify-caller. Default value is true.

Parameters:

notifyCaller - flag which denotes whether notify caller

getRevealIdentityToCaller

ForwardTo.RevealURIOptionsType getRevealIdentityToCaller()

Get value of reveal-identity-to-caller. Default value is RevealURIOptionsType.TRUE.

Returns:

value of reveal-identity-to-caller.

setRevealIdentityToCaller

void setRevealIdentityToCaller(ForwardTo.RevealURIOptionsType revealIdentityToCaller)

Set value of reveal-identity-to-caller. Default value is RevealURIOptionsType.TRUE.

Parameters:

revealIdentityToCaller - flag which denotes whether reveal identity to caller.

getRevealServedUserIdentityToCaller

ForwardTo.RevealURIOptionsType getRevealServedUserIdentityToCaller()

Get value of reveal-served-user-identity-to-caller. Default value is RevealURIOptionsType.TRUE..

Returns:

value of reveal-served-user-identity-to-caller

setRevealServedUserIdentityToCaller

void setRevealServedUserIdentityToCaller(ForwardTo.RevealURIOptionsType revealServedUserIdentityToCaller)

Set value of reveal-served-user-identity-to-caller Default value is RevealURIOptionsType.TRUE.

Parameters:

revealServedUserIdentityToCaller - flag which denotes whether reveal served user identity to caller.

isNotifyServedUser

boolean isNotifyServedUser()

Check whether is notify-served-user. Default value is false.

Returns:

true if is notify-served-user, otherwise, false.

setNotifyServedUser

void setNotifyServedUser(boolean notifyServedUser)

Set whether is notify-served-user. Default value is false.

Parameters:

notifyServedUser - flag which denotes whether notify served user

isNotifyServedUserOnOutboundCall

boolean isNotifyServedUserOnOutboundCall()

Check whether is notify-served-user-on-outbound-call. Default value is false.

Returns:

true if is notify-served-user-on-outbound-call, otherwise, false

setNotifyServedUserOnOutboundCall

void setNotifyServedUserOnOutboundCall(boolean notifyServedUserOnOutboundCall)

Set whether is notify-served-user-on-outbound-call. Default value is false.

Parameters:

notifyServedUserOnOutboundCall - flag which denotes whether notify served user on outbound call.

getRevealIdentityToTarget

ForwardTo.RevealURIOptionsType getRevealIdentityToTarget()

Get value of reveal-identity-to-target. Default value is RevealURIOptionsType.TRUE.

Returns:

value of reveal-identity-to-target.

setRevealIdentityToTarget

void setRevealIdentityToTarget(ForwardTo.RevealURIOptionsType revealIdentityToTarget)

Set value of reveal-identity-to-target. Default value is RevealURIOptionsType.TRUE.

Parameters:

revealIdentityToTarget - flag which denotes whether reveal identity to target.

Skip navigation links