Skip navigation links

Oracle Communications Service Broker
Module MBean Java API Reference
Release 6.0

E26174-01


com.convergin.module.imocf.config
Interface AnnouncementInfoMBean


public interface AnnouncementInfoMBean

Inteface for AnnouncementInfoMBean

Author:
osnat NOTE: this code is autogenerated by createConfigMbeans.pl. Do not change it.

Method Summary
 int getAnnouncementCode()
          Specifies an announcement code (identifier) (value is integer)
 javax.management.ObjectName getAnnouncementInfoTable_REFSEP_()
          Returns the MBean parent get accessor to the parent mbean: AnnouncementInfoTable_REFSEP_
 java.lang.String getCallState()
          This parameter specifies the call state (the point in call) for which playing the announcement is relevant.
 java.lang.String getDeploymentName()
          return the Module instance name that this MBean configures
 java.lang.String getEnabled()
          Specifies whether or not the announcement is enabled
 java.lang.String getNetwork()
          This restriction indicates for which user locations the announcement is relevant.
 int getPriority()
          Specifies the priority of the announcement
 int getReasonFrom()
          This parameter specifies a (positive) lower limit of a range.
 int getReasonTo()
          This parameter specifies an (positive) upper limit of a range.
 java.lang.String getReasonType()
          The type of criteria for this announcement.
 java.lang.String getServiceSide()
          Specifies for which service side (orig, term or both) the announcement is relevant.
 int getThreshold()
          This parameter specifies the time (positive amount of seconds > 0) the announcement should be played before the call quota ends.
 void setAnnouncementCode(int param)
          Specifies an announcement code (identifier) (value is integer)
 void setCallState(java.lang.String param)
          This parameter specifies the call state (the point in call) for which playing the announcement is relevant.
 void setEnabled(java.lang.String param)
          Specifies whether or not the announcement is enabled
 void setNetwork(java.lang.String param)
          This restriction indicates for which user locations the announcement is relevant.
 void setPriority(int param)
          Specifies the priority of the announcement
 void setReasonFrom(int param)
          This parameter specifies a (positive) lower limit of a range.
 void setReasonTo(int param)
          This parameter specifies an (positive) upper limit of a range.
 void setReasonType(java.lang.String param)
          The type of criteria for this announcement.
 void setServiceSide(java.lang.String param)
          Specifies for which service side (orig, term or both) the announcement is relevant.
 void setThreshold(int param)
          This parameter specifies the time (positive amount of seconds > 0) the announcement should be played before the call quota ends.

 

Method Detail

getAnnouncementInfoTable_REFSEP_

javax.management.ObjectName getAnnouncementInfoTable_REFSEP_()
                                                             throws java.io.IOException
Returns the MBean parent get accessor to the parent mbean: AnnouncementInfoTable_REFSEP_
Parameters:
-
Returns:
ObjectName
Throws:
java.io.IOException

getEnabled

java.lang.String getEnabled()
                            throws java.io.IOException
Specifies whether or not the announcement is enabled
Parameters:
-
Returns:
String
Throws:
java.io.IOException

setEnabled

void setEnabled(java.lang.String param)
                throws java.io.IOException
Specifies whether or not the announcement is enabled
Parameters:
param -
Throws:
java.io.IOException

getReasonType

java.lang.String getReasonType()
                               throws java.io.IOException
The type of criteria for this announcement. It determines the meaning of the Lower/Upper Limit parameters.
Parameters:
-
Returns:
String
Throws:
java.io.IOException

setReasonType

void setReasonType(java.lang.String param)
                   throws java.io.IOException
The type of criteria for this announcement. It determines the meaning of the Lower/Upper Limit parameters.
Parameters:
param -
Throws:
java.io.IOException

getReasonFrom

int getReasonFrom()
                  throws java.io.IOException
This parameter specifies a (positive) lower limit of a range. The type of the range is determined by the Reason Type parameter. The announcement is played if the relevant attribute is in the specified range. (Note that a value of -1 is considered to be 'any value').
Parameters:
-
Returns:
int
Throws:
java.io.IOException

setReasonFrom

void setReasonFrom(int param)
                   throws java.io.IOException
This parameter specifies a (positive) lower limit of a range. The type of the range is determined by the Reason Type parameter. The announcement is played if the relevant attribute is in the specified range. (Note that a value of -1 is considered to be 'any value').
Parameters:
param -
Throws:
java.io.IOException

getReasonTo

int getReasonTo()
                throws java.io.IOException
This parameter specifies an (positive) upper limit of a range. The type of the range is determined by the Reason Type parameter. The announcement is played if the relevant attribute is in the specified range. (Note that a value of -1 is considered to be 'any value').
Parameters:
-
Returns:
int
Throws:
java.io.IOException

setReasonTo

void setReasonTo(int param)
                 throws java.io.IOException
This parameter specifies an (positive) upper limit of a range. The type of the range is determined by the Reason Type parameter. The announcement is played if the relevant attribute is in the specified range. (Note that a value of -1 is considered to be 'any value').
Parameters:
param -
Throws:
java.io.IOException

getNetwork

java.lang.String getNetwork()
                            throws java.io.IOException
This restriction indicates for which user locations the announcement is relevant. Possible values are: 'ANY', 'HOME_ZONE', 'HOME_NETWORK', 'ROAMING' or the ID of a specific MSC.
Parameters:
-
Returns:
String
Throws:
java.io.IOException

setNetwork

void setNetwork(java.lang.String param)
                throws java.io.IOException
This restriction indicates for which user locations the announcement is relevant. Possible values are: 'ANY', 'HOME_ZONE', 'HOME_NETWORK', 'ROAMING' or the ID of a specific MSC.
Parameters:
param -
Throws:
java.io.IOException

getServiceSide

java.lang.String getServiceSide()
                                throws java.io.IOException
Specifies for which service side (orig, term or both) the announcement is relevant.
Parameters:
-
Returns:
String
Throws:
java.io.IOException

setServiceSide

void setServiceSide(java.lang.String param)
                    throws java.io.IOException
Specifies for which service side (orig, term or both) the announcement is relevant.
Parameters:
param -
Throws:
java.io.IOException

getCallState

java.lang.String getCallState()
                              throws java.io.IOException
This parameter specifies the call state (the point in call) for which playing the announcement is relevant.
Parameters:
-
Returns:
String
Throws:
java.io.IOException

setCallState

void setCallState(java.lang.String param)
                  throws java.io.IOException
This parameter specifies the call state (the point in call) for which playing the announcement is relevant.
Parameters:
param -
Throws:
java.io.IOException

getPriority

int getPriority()
                throws java.io.IOException
Specifies the priority of the announcement
Parameters:
-
Returns:
int
Throws:
java.io.IOException

setPriority

void setPriority(int param)
                 throws java.io.IOException
Specifies the priority of the announcement
Parameters:
param -
Throws:
java.io.IOException

getAnnouncementCode

int getAnnouncementCode()
                        throws java.io.IOException
Specifies an announcement code (identifier) (value is integer)
Parameters:
-
Returns:
int
Throws:
java.io.IOException

setAnnouncementCode

void setAnnouncementCode(int param)
                         throws java.io.IOException
Specifies an announcement code (identifier) (value is integer)
Parameters:
param -
Throws:
java.io.IOException

getThreshold

int getThreshold()
                 throws java.io.IOException
This parameter specifies the time (positive amount of seconds > 0) the announcement should be played before the call quota ends. Note that threshold can exist in MIDCALL announcements only.
Parameters:
-
Returns:
int
Throws:
java.io.IOException

setThreshold

void setThreshold(int param)
                  throws java.io.IOException
This parameter specifies the time (positive amount of seconds > 0) the announcement should be played before the call quota ends. Note that threshold can exist in MIDCALL announcements only.
Parameters:
param -
Throws:
java.io.IOException

getDeploymentName

java.lang.String getDeploymentName()
return the Module instance name that this MBean configures
Returns:
String

Skip navigation links

Oracle Communications Service Broker
Module MBean Java API Reference
Release 6.0

E26174-01


Copyright © 2011, Oracle and/or its affiliates. All rights reserved.