PageRenderTime 18ms CodeModel.GetById 12ms app.highlight 3ms RepoModel.GetById 1ms app.codeStats 0ms

/protocols/ss7/map/map-api/src/main/java/org/mobicents/protocols/ss7/map/api/service/supplementary/MAPDialogSupplementary.java

http://mobicents.googlecode.com/
Java | 132 lines | 22 code | 12 blank | 98 comment | 0 complexity | 6d6093b541e7e5c4140e3ed403223792 MD5 | raw file
  1/*
  2 * JBoss, Home of Professional Open Source
  3 * Copyright 2011, Red Hat, Inc. and individual contributors
  4 * by the @authors tag. See the copyright.txt in the distribution for a
  5 * full listing of individual contributors.
  6 *
  7 * This is free software; you can redistribute it and/or modify it
  8 * under the terms of the GNU Lesser General Public License as
  9 * published by the Free Software Foundation; either version 2.1 of
 10 * the License, or (at your option) any later version.
 11 *
 12 * This software is distributed in the hope that it will be useful,
 13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 15 * Lesser General Public License for more details.
 16 *
 17 * You should have received a copy of the GNU Lesser General Public
 18 * License along with this software; if not, write to the Free
 19 * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
 20 * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
 21 */
 22
 23package org.mobicents.protocols.ss7.map.api.service.supplementary;
 24
 25import org.mobicents.protocols.ss7.map.api.MAPDialog;
 26import org.mobicents.protocols.ss7.map.api.MAPException;
 27import org.mobicents.protocols.ss7.map.api.primitives.AlertingPattern;
 28import org.mobicents.protocols.ss7.map.api.primitives.ISDNAddressString;
 29import org.mobicents.protocols.ss7.map.api.primitives.USSDString;
 30
 31/**
 32 * 
 33 * @author amit bhayani
 34 * @author sergey vetyutnev
 35 * 
 36 */
 37public interface MAPDialogSupplementary extends MAPDialog {
 38
 39	/**
 40	 * Add's a new Process Unstructured SS Request as Component.
 41	 * 
 42	 * @param ussdDataCodingScheme
 43	 *            The Data Coding Scheme for this USSD String as defined in GSM
 44	 *            03.38
 45	 * @param ussdString
 46	 *            Ussd String
 47	 * @param alertingPatter
 48	 *            The optional alerting pattern. See {@link AlertingPattern}
 49	 * @param msisdn
 50	 *            The optional MSISDN in {@link ISDNAddressString} format.
 51	 * @return invokeId
 52	 * @throws MAPException
 53	 */
 54	public Long addProcessUnstructuredSSRequest(byte ussdDataCodingScheme, USSDString ussdString, AlertingPattern alertingPatter, ISDNAddressString msisdn)
 55			throws MAPException;
 56
 57	public Long addProcessUnstructuredSSRequest(int customInvokeTimeout, byte ussdDataCodingScheme, USSDString ussdString, AlertingPattern alertingPatter,
 58			ISDNAddressString msisdn) throws MAPException;
 59
 60	/**
 61	 * Add's a new ProcessUnstructured SS Response as Component.
 62	 * 
 63	 * @param invokeId
 64	 *            The original invoke ID retrieved from
 65	 *            {@link ProcessUnstructuredSSResponseIndication}
 66	 * @param ussdDataCodingScheme
 67	 *            The Data Coding Scheme for this USSD String as defined in GSM
 68	 *            03.38
 69	 * @param ussdString
 70	 *            Ussd String {@link USSDString}
 71	 * @throws MAPException
 72	 */
 73	public void addProcessUnstructuredSSResponse(long invokeId, byte ussdDataCodingScheme, USSDString ussdString) throws MAPException;
 74
 75	/**
 76	 * Add's a new Unstructured SS Request
 77	 * 
 78	 * @param ussdDataCodingScheme
 79	 *            The Data Coding Scheme for this USSD String as defined in GSM
 80	 *            03.38
 81	 * @param ussdString
 82	 *            Ussd String {@link USSDString}
 83	 * @param alertingPatter
 84	 *            The optional alerting pattern. See {@link AlertingPattern}
 85	 * @param msisdn
 86	 *            The optional MSISDN in {@link ISDNAddressString} format.
 87	 * @return invokeId
 88	 * @throws MAPException
 89	 */
 90	public Long addUnstructuredSSRequest(byte ussdDataCodingScheme, USSDString ussdString, AlertingPattern alertingPatter, ISDNAddressString msisdn)
 91			throws MAPException;
 92
 93	public Long addUnstructuredSSRequest(int customInvokeTimeout, byte ussdDataCodingScheme, USSDString ussdString, AlertingPattern alertingPatter,
 94			ISDNAddressString msisdn) throws MAPException;
 95
 96	/**
 97	 * Add's a new Unstructured SS Response
 98	 * 
 99	 * @param invokeId
100	 *            The original invoke ID retrieved from
101	 *            {@link UnstructuredSSResponseIndication}
102	 * @param ussdDataCodingScheme
103	 *            The Data Coding Scheme for this USSD String as defined in GSM
104	 *            03.38
105	 * @param ussdString
106	 *            Ussd String {@link USSDString}
107	 * @throws MAPException
108	 */
109	public void addUnstructuredSSResponse(long invokeId, byte ussdDataCodingScheme, USSDString ussdString) throws MAPException;
110
111	/**
112	 * Add's a new Unstructured SS Notify
113	 * 
114	 * @param ussdDataCodingScheme
115	 *            The Data Coding Scheme for this USSD String as defined in GSM
116	 *            03.38
117	 * @param ussdString
118	 *            Ussd String {@link USSDString}
119	 * @param alertingPatter
120	 *            The optional alerting pattern. See {@link AlertingPattern}
121	 * @param msisdn
122	 *            The optional MSISDN in {@link ISDNAddressString} format.
123	 * @return invokeId
124	 * @throws MAPException
125	 */
126	public Long addUnstructuredSSNotifyRequest(byte ussdDataCodingScheme, USSDString ussdString, AlertingPattern alertingPatter, ISDNAddressString msisdn)
127			throws MAPException;
128
129	public Long addUnstructuredSSNotifyRequest(int customInvokeTimeout, byte ussdDataCodingScheme, USSDString ussdString, AlertingPattern alertingPatter,
130			ISDNAddressString msisdn) throws MAPException;
131
132}