com.phloc.masterdata.telephone.ITelephoneNumber Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of phloc-masterdata Show documentation

Library with support for certain re-ocurring standard business objects

There is a newer version: 3.7.6

/**
 * Copyright (C) 2006-2014 phloc systems
 * http://www.phloc.com
 * office[at]phloc[dot]com
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *         http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package com.phloc.masterdata.telephone;

import javax.annotation.Nonnull;

import com.phloc.commons.ICloneable;
import com.phloc.commons.state.EChange;

/**
 * Base interface for a telephone number.
 * 
 * @author Philip Helger
 */
public interface ITelephoneNumber extends IReadonlyTelephoneNumber, ICloneable 
{
  /**
   * @param eType
   *        The semantic type of this telephone number.
   * @return {@link EChange}
   */
  @Nonnull
  EChange setType (ETelephoneType eType);

  /**
   * @param sCountryCode
   *        The country where the number resides.
   * @return {@link EChange}
   */
  @Nonnull
  EChange setCountryCode (String sCountryCode);

  /**
   * @param sAreaCode
   *        The area code for the phone number. This is country dependent.
   * @return {@link EChange}
   */
  @Nonnull
  EChange setAreaCode (String sAreaCode);

  /**
   * @param sLine
   *        The main telephone number within an area code.
   * @return {@link EChange}
   */
  @Nonnull
  EChange setLine (String sLine);

  /**
   * @param sDirectDial
   *        The direct dial for a further specification of a line. Is optional
   *        and may be null.
   * @return {@link EChange}
   */
  @Nonnull
  EChange setDirectDial (String sDirectDial);
}