/*
 * Copyright (C) 2005-2006 Kouji Sugisawa. All rights reserved.
 */

package jp.sourceforge.livez.vodafone;

import jp.sourceforge.livez.UserId;

/**
 * ボーダフォンライブの UID (ユーザID) 情報のインターフェースです。
 * 
 * @author 杉澤 浩二
 */
public interface UID extends UserId {

	/**
	 * UID の生値を返します。
	 * 
	 * @return UID
	 */
	public String getValue();

	/**
	 * UID 通知状況を返します。
	 * 
	 * @return UID 通知が無効な場合は <code>true</code> を、それ以外の場合は <code>false</code> を返します。
	 */
	public boolean isDisabled();

	/**
	 * UID がC型端末のものであるかどうかを返します。
	 * 
	 * @return UID がC型端末のものである場合は <code>true</code> を、それ以外の場合は <code>false</code> を返します。
	 */
	public boolean isCtype();

	/**
	 * UIDの先頭1バイトのエリアコードを返します。
	 * 不明な場合は <code>0</code> を返します。
	 * <table border="1">
	 * <tr align="center"><th>エリア</th><th>P型/W型/3GC型</th><th>C型</th></tr>
	 * <tr align="center"><td align="left">関東･甲信</td><td>a</td><td>1</td></tr>
	 * <tr align="center"><td align="left">東海</td><td>b</td><td>2</td></tr>
	 * <tr align="center"><td align="left">関西</td><td>c</td><td>3</td></tr>
	 * <tr align="center"><td align="left">中国</td><td>d</td><td>4</td></tr>
	 * <tr align="center"><td align="left">四国</td><td>e</td><td>5</td></tr>
	 * <tr align="center"><td align="left">九州･沖縄</td><td>f</td><td>6</td></tr>
	 * <tr align="center"><td align="left">東北･新潟</td><td>g</td><td>7</td></tr>
	 * <tr align="center"><td align="left">北海道</td><td>h</td><td>8</td></tr>
	 * <tr align="center"><td align="left">北陸</td><td>i</td><td>9</td></tr>
	 * </table>
	 * 
	 * @return エリアコード
	 */
	public char getRegion();

	/**
	 * ユーザIDを返します。
	 * 不明な場合は <code>null</code> を返します。
	 * ユーザIDは UID の生値からエリアコード(先頭1バイト)を除いた値です。
	 * 
	 * @return ユーザID
	 */
	public String getUserId();

}
