/protocols/ss7/map/map-api/src/main/java/org/mobicents/protocols/ss7/map/api/service/lsm/LCSCodeword.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.service.lsm;
24
25import java.io.Serializable;
26
27import org.mobicents.protocols.ss7.map.api.primitives.USSDString;
28
29/**
30 * LCSCodeword ::= SEQUENCE {
31 *   dataCodingScheme [0] USSD-DataCodingScheme,
32 *   lcsCodewordString [1] LCSCodewordString,
33 *   ...}
34 * 
35 * @author amit bhayani
36 *
37 */
38public interface LCSCodeword extends Serializable {
39	
40	/**
41	 * USSD-DataCodingScheme ::= OCTET STRING (SIZE (1))
42	 *		-- The structure of the USSD-DataCodingScheme is defined by
43	 *		-- the Cell Broadcast Data Coding Scheme as described in
44	 *		-- TS 3GPP TS 23.038 [25]
45	 *
46	 * @return
47	 */
48	public byte getDataCodingScheme();
49	
50	/**
51	 * LCSCodewordString ::= USSD-String (SIZE (1..maxLCSCodewordStringLength))
52	 * 
53	 * maxLCSCodewordStringLength INTEGER ::= 20
54	 * 
55	 * @return
56	 */
57	public USSDString getLCSCodewordString();
58}