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

 1/*
 2 * JBoss, Home of Professional Open Source
 3 * Copyright 2011, Red Hat, Inc. and/or its affiliates, and individual
 4 * contributors as indicated by the @authors tag. All rights reserved.
 5 * See the copyright.txt in the distribution for a full listing
 6 * of individual contributors.
 7 * 
 8 * This copyrighted material is made available to anyone wishing to use,
 9 * modify, copy, or redistribute it subject to the terms and conditions
10 * of the GNU General Public License, v. 2.0.
11 * 
12 * This program 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 * General Public License for more details.
16 * 
17 * You should have received a copy of the GNU General Public License,
18 * v. 2.0 along with this distribution; if not, write to the Free 
19 * Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
20 * MA 02110-1301, USA.
21 */
22package org.mobicents.protocols.ss7.map.api.primitives;
23
24import java.io.Serializable;
25
26/**
27 * AlertingPattern ::= OCTET STRING (SIZE (1) )
28 *		-- This type is used to represent Alerting Pattern
29 *		-- bits 8765 : 0000 (unused)
30 *		-- bits 43 : type of Pattern
31 *		-- 				00 level
32 *		-- 				01 category
33 *		-- 				10 category
34 * 		-- 				all other values are reserved.
35 *		-- bits 21 : type of alerting
36 *	alertingLevel-0 AlertingPattern ::= '00000000'B
37 *	alertingLevel-1 AlertingPattern ::= '00000001'B
38 *	alertingLevel-2 AlertingPattern ::= '00000010'B
39 *		-- all other values of Alerting level are reserved
40 *		-- Alerting Levels are defined in GSM 02.07
41 *	alertingCategory-1 AlertingPattern ::= '00000100'B
42 *	alertingCategory-2 AlertingPattern ::= '00000101'B
43 *	alertingCategory-3 AlertingPattern ::= '00000110'B
44 *	alertingCategory-4 AlertingPattern ::= '00000111'B
45 *	alertingCategory-5 AlertingPattern ::= '00001000'B
46 *		-- all other values of Alerting Category are reserved
47 *		-- Alerting categories are defined in GSM 02.07
48 * 
49 * @author amit bhayani
50 * @author sergey vetyutnev
51 *
52 */
53public interface AlertingPattern extends Serializable {
54
55	public byte[] getData();
56
57	public AlertingLevel getAlertingLevel();
58
59	public AlertingCategory getAlertingCategory();
60
61}