com.phloc.masterdata.person.IReadonlyPerson 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.person;

import java.io.Serializable;

import javax.annotation.Nonnull;
import javax.annotation.Nullable;

import org.joda.time.LocalDate;

import com.phloc.commons.id.IHasID;
import com.phloc.masterdata.address.IReadonlyAddress;
import com.phloc.masterdata.email.IReadonlyExtendedEmailAddress;
import com.phloc.masterdata.telephone.IReadonlyTelephoneNumber;

public interface IReadonlyPerson extends IHasID , Serializable
{
  /**
   * @return The gender of the person. May be null.
   */
  @Nullable
  EGender getGender ();

  /**
   * @return The name of the person. May not be null.
   */
  @Nonnull
  IReadonlyPersonName getName ();

  /**
   * @return The optional birthday of the person.
   */
  @Nullable
  LocalDate getBirthday ();

  /**
   * @return An optional telephone number.
   */
  @Nullable
  IReadonlyTelephoneNumber getTelephoneNumber ();

  /**
   * @return An optional email address for this person.
   */
  @Nullable
  IReadonlyExtendedEmailAddress getEmailAddress ();

  /**
   * @return An optional real address for this person.
   */
  @Nullable
  IReadonlyAddress getAddress ();
}