/protocols/ss7/m3ua/api/src/main/java/org/mobicents/protocols/ss7/m3ua/parameter/UserCause.java

http://mobicents.googlecode.com/ · Java · 79 lines · 5 code · 5 blank · 69 comment · 0 complexity · 9cec87e012369d5b1d67f998c6c7f365 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. package org.mobicents.protocols.ss7.m3ua.parameter;
  23. /**
  24. * The Unavailability Cause and MTP3-User Identity fields, associated with the
  25. * Affected PC in the Affected Point Code parameter
  26. *
  27. * @author amit bhayani
  28. *
  29. */
  30. public interface UserCause extends Parameter {
  31. /**
  32. * <p>
  33. * The Unavailability Cause parameter provides the reason for the
  34. * unavailability of the MTP3-User. The valid values for the Unavailability
  35. * Cause parameter are
  36. * </p>
  37. * <p>
  38. * <ul>
  39. * <li>0 Unknown</li>
  40. * <li>1 Unequipped Remote User</li>
  41. * <li>2 Inaccessible Remote User</li>
  42. * </ul>
  43. * </p>
  44. *
  45. * @return
  46. */
  47. public int getCause();
  48. /**
  49. * <p>
  50. * The MTP3-User Identity describes the specific MTP3-User that is
  51. * unavailable (e.g., ISUP, SCCP, etc.). Some of the valid values for the
  52. * MTP3-User Identity are
  53. * </p>
  54. * <p>
  55. * <ul>
  56. * <li>0 to 2 Reserved</li>
  57. * <li>3 SCCP</li>
  58. * <li>4 TUP</li>
  59. * <li>5 ISUP</li>
  60. * <li>6 to 8 Reserved</li>
  61. * <li>9 Broadband ISUP</li>
  62. * <li>10 Satellite ISUP</li>
  63. * <li>11 Reserved</li>
  64. * <li>12 AAL type 2 Signalling</li>
  65. * <li>13 Bearer Independent Call Control (BICC)</li>
  66. * <li>14 Gateway Control Protocol</li>
  67. * <li>15 Reserved</li>
  68. * </ul>
  69. * </p>
  70. *
  71. * @return
  72. */
  73. public int getUser();
  74. }