com.opengamma.strata.product.LegalEntity Maven / Gradle / Ivy
/*
* Copyright (C) 2018 - present by OpenGamma Inc. and the OpenGamma group of companies
*
* Please see distribution for license.
*/
package com.opengamma.strata.product;
import com.opengamma.strata.basics.ReferenceData;
import com.opengamma.strata.basics.location.Country;
/**
* A legal entity.
*
* A legal entity is one of the building blocks of finance, representing an organization.
* It is used to capture details for credit worthiness.
* The legal entity can be looked up in {@link ReferenceData} using the identifier.
*
* Implementations of this interface must be immutable beans.
*
* @see SimpleLegalEntity
*/
public interface LegalEntity {
/**
* Gets the legal entity identifier.
*
* This identifier uniquely identifies the legal entity within the system.
*
* @return the legal entity identifier
*/
public abstract LegalEntityId getLegalEntityId();
/**
* Gets the name of the legal entity.
*
* This is intended for humans.
*
* @return the name
*/
public abstract String getName();
/**
* Gets the country that the legal entity is based in.
*
* @return the country
*/
public abstract Country getCountry();
}