/protocols/ss7/map/map-api/src/main/java/org/mobicents/protocols/ss7/map/api/primitives/USSDString.java

 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.primitives;
24
25import java.io.Serializable;
26import java.nio.charset.Charset;
27
28/**
29 * USSD-String ::= OCTET STRING (SIZE (1..maxUSSD-StringLength))
30 *     -- The structure of the contents of the USSD-String is dependent
31 *     -- on the USSD-DataCodingScheme as described in TS 3GPP TS 23.038 [25].
32 * 
33 * maxUSSD-StringLength INTEGER ::= 160
34 *
35 * 
36 * @author amit bhayani
37 * 
38 */
39public interface USSDString extends Serializable {
40
41	/**
42	 * Get the decoded USSD String
43	 * 
44	 * @return
45	 */
46	public String getString();
47
48	/**
49	 * Get the byte[] that represents encoded USSD String
50	 * 
51	 * @return
52	 */
53	public byte[] getEncodedString();
54
55	/**
56	 * Get the {@link java.nio.charset.Charset}
57	 * 
58	 * @return
59	 */
60	public Charset getCharset();
61
62
63}