blob: d46b667b263c0cf99ce170410e5179c97bad7389 [file] [log] [blame]
/*******************************************************************************
* Copyright (c) 2009, 2011 IBM Corporation and others.
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License v1.0
* which accompanies this distribution, and is available at
* http://www.eclipse.org/legal/epl-v10.html
*
* Contributors:
* IBM Corporation - initial API and implementation
*******************************************************************************/
package org.eclipse.mdht.uml.cda;
import java.util.Map;
import org.eclipse.emf.common.util.DiagnosticChain;
import org.eclipse.emf.common.util.EList;
import org.eclipse.mdht.uml.hl7.datatypes.CE;
import org.eclipse.mdht.uml.hl7.datatypes.CS;
import org.eclipse.mdht.uml.hl7.datatypes.ED;
import org.eclipse.mdht.uml.hl7.datatypes.II;
import org.eclipse.mdht.uml.hl7.datatypes.PN;
import org.eclipse.mdht.uml.hl7.datatypes.PQ;
import org.eclipse.mdht.uml.hl7.datatypes.TS;
import org.eclipse.mdht.uml.hl7.rim.Entity;
import org.eclipse.mdht.uml.hl7.vocab.EntityClassRoot;
import org.eclipse.mdht.uml.hl7.vocab.EntityDeterminer;
import org.eclipse.mdht.uml.hl7.vocab.NullFlavor;
/**
* <!-- begin-user-doc -->
* A representation of the model object '<em><b>Playing Entity</b></em>'.
* <!-- end-user-doc -->
*
* <p>
* The following features are supported:
* </p>
* <ul>
* <li>{@link org.eclipse.mdht.uml.cda.PlayingEntity#getRealmCodes <em>Realm Code</em>}</li>
* <li>{@link org.eclipse.mdht.uml.cda.PlayingEntity#getTypeId <em>Type Id</em>}</li>
* <li>{@link org.eclipse.mdht.uml.cda.PlayingEntity#getTemplateIds <em>Template Id</em>}</li>
* <li>{@link org.eclipse.mdht.uml.cda.PlayingEntity#getCode <em>Code</em>}</li>
* <li>{@link org.eclipse.mdht.uml.cda.PlayingEntity#getQuantities <em>Quantity</em>}</li>
* <li>{@link org.eclipse.mdht.uml.cda.PlayingEntity#getNames <em>Name</em>}</li>
* <li>{@link org.eclipse.mdht.uml.cda.PlayingEntity#getSDTCBirthTime <em>SDTC Birth Time</em>}</li>
* <li>{@link org.eclipse.mdht.uml.cda.PlayingEntity#getDesc <em>Desc</em>}</li>
* <li>{@link org.eclipse.mdht.uml.cda.PlayingEntity#getNullFlavor <em>Null Flavor</em>}</li>
* <li>{@link org.eclipse.mdht.uml.cda.PlayingEntity#getClassCode <em>Class Code</em>}</li>
* <li>{@link org.eclipse.mdht.uml.cda.PlayingEntity#getDeterminerCode <em>Determiner Code</em>}</li>
* </ul>
*
* @see org.eclipse.mdht.uml.cda.CDAPackage#getPlayingEntity()
* @model
* @generated
*/
public interface PlayingEntity extends Entity {
/**
* Returns the value of the '<em><b>Realm Code</b></em>' containment reference list.
* The list contents are of type {@link org.eclipse.mdht.uml.hl7.datatypes.CS}.
* <!-- begin-user-doc -->
* <p>
* If the meaning of the '<em>Realm Code</em>' containment reference list isn't clear,
* there really should be more of a description here...
* </p>
* <!-- end-user-doc -->
* @return the value of the '<em>Realm Code</em>' containment reference list.
* @see org.eclipse.mdht.uml.cda.CDAPackage#getPlayingEntity_RealmCode()
* @model containment="true" ordered="false"
* extendedMetaData="name='realmCode' namespace='##targetNamespace' kind='element'"
* @generated
*/
EList<CS> getRealmCodes();
/**
* Returns the value of the '<em><b>Type Id</b></em>' containment reference.
* <!-- begin-user-doc -->
* <p>
* If the meaning of the '<em>Type Id</em>' containment reference isn't clear,
* there really should be more of a description here...
* </p>
* <!-- end-user-doc -->
* @return the value of the '<em>Type Id</em>' containment reference.
* @see #setTypeId(InfrastructureRootTypeId)
* @see org.eclipse.mdht.uml.cda.CDAPackage#getPlayingEntity_TypeId()
* @model containment="true" ordered="false"
* extendedMetaData="name='typeId' namespace='##targetNamespace' kind='element'"
* @generated
*/
InfrastructureRootTypeId getTypeId();
/**
* Sets the value of the '{@link org.eclipse.mdht.uml.cda.PlayingEntity#getTypeId <em>Type Id</em>}' containment reference.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @param value the new value of the '<em>Type Id</em>' containment reference.
* @see #getTypeId()
* @generated
*/
void setTypeId(InfrastructureRootTypeId value);
/**
* Returns the value of the '<em><b>Template Id</b></em>' containment reference list.
* The list contents are of type {@link org.eclipse.mdht.uml.hl7.datatypes.II}.
* <!-- begin-user-doc -->
* <p>
* If the meaning of the '<em>Template Id</em>' containment reference list isn't clear,
* there really should be more of a description here...
* </p>
* <!-- end-user-doc -->
* @return the value of the '<em>Template Id</em>' containment reference list.
* @see org.eclipse.mdht.uml.cda.CDAPackage#getPlayingEntity_TemplateId()
* @model containment="true" ordered="false"
* extendedMetaData="name='templateId' namespace='##targetNamespace' kind='element'"
* @generated
*/
EList<II> getTemplateIds();
/**
* Returns the value of the '<em><b>Code</b></em>' containment reference.
* <!-- begin-user-doc -->
* <p>
* If the meaning of the '<em>Code</em>' containment reference isn't clear,
* there really should be more of a description here...
* </p>
* <!-- end-user-doc -->
* @return the value of the '<em>Code</em>' containment reference.
* @see #setCode(CE)
* @see org.eclipse.mdht.uml.cda.CDAPackage#getPlayingEntity_Code()
* @model containment="true" ordered="false"
* extendedMetaData="name='code' namespace='##targetNamespace' kind='element'"
* @generated
*/
CE getCode();
/**
* Sets the value of the '{@link org.eclipse.mdht.uml.cda.PlayingEntity#getCode <em>Code</em>}' containment reference.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @param value the new value of the '<em>Code</em>' containment reference.
* @see #getCode()
* @generated
*/
void setCode(CE value);
/**
* Returns the value of the '<em><b>Quantity</b></em>' containment reference list.
* The list contents are of type {@link org.eclipse.mdht.uml.hl7.datatypes.PQ}.
* <!-- begin-user-doc -->
* <p>
* If the meaning of the '<em>Quantity</em>' containment reference list isn't clear,
* there really should be more of a description here...
* </p>
* <!-- end-user-doc -->
* @return the value of the '<em>Quantity</em>' containment reference list.
* @see org.eclipse.mdht.uml.cda.CDAPackage#getPlayingEntity_Quantity()
* @model containment="true" ordered="false"
* extendedMetaData="name='quantity' namespace='##targetNamespace' kind='element'"
* @generated
*/
EList<PQ> getQuantities();
/**
* Returns the value of the '<em><b>Name</b></em>' containment reference list.
* The list contents are of type {@link org.eclipse.mdht.uml.hl7.datatypes.PN}.
* <!-- begin-user-doc -->
* <p>
* If the meaning of the '<em>Name</em>' containment reference list isn't clear,
* there really should be more of a description here...
* </p>
* <!-- end-user-doc -->
* @return the value of the '<em>Name</em>' containment reference list.
* @see org.eclipse.mdht.uml.cda.CDAPackage#getPlayingEntity_Name()
* @model containment="true" ordered="false"
* extendedMetaData="name='name' namespace='##targetNamespace' kind='element'"
* @generated
*/
EList<PN> getNames();
/**
* Returns the value of the '<em><b>SDTC Birth Time</b></em>' containment reference.
* <!-- begin-user-doc -->
* <p>
* If the meaning of the '<em>SDTC Birth Time</em>' containment reference isn't clear,
* there really should be more of a description here...
* </p>
* <!-- end-user-doc -->
* @return the value of the '<em>SDTC Birth Time</em>' containment reference.
* @see #setSDTCBirthTime(TS)
* @see org.eclipse.mdht.uml.cda.CDAPackage#getPlayingEntity_SDTCBirthTime()
* @model containment="true" ordered="false"
* extendedMetaData="name='birthTime' namespace='urn:hl7-org:sdtc' kind='element'"
* @generated
*/
TS getSDTCBirthTime();
/**
* Sets the value of the '{@link org.eclipse.mdht.uml.cda.PlayingEntity#getSDTCBirthTime <em>SDTC Birth Time</em>}' containment reference.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @param value the new value of the '<em>SDTC Birth Time</em>' containment reference.
* @see #getSDTCBirthTime()
* @generated
*/
void setSDTCBirthTime(TS value);
/**
* Returns the value of the '<em><b>Desc</b></em>' containment reference.
* <!-- begin-user-doc -->
* <p>
* If the meaning of the '<em>Desc</em>' containment reference isn't clear,
* there really should be more of a description here...
* </p>
* <!-- end-user-doc -->
* @return the value of the '<em>Desc</em>' containment reference.
* @see #setDesc(ED)
* @see org.eclipse.mdht.uml.cda.CDAPackage#getPlayingEntity_Desc()
* @model containment="true" ordered="false"
* extendedMetaData="name='desc' namespace='##targetNamespace' kind='element'"
* @generated
*/
ED getDesc();
/**
* Sets the value of the '{@link org.eclipse.mdht.uml.cda.PlayingEntity#getDesc <em>Desc</em>}' containment reference.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @param value the new value of the '<em>Desc</em>' containment reference.
* @see #getDesc()
* @generated
*/
void setDesc(ED value);
/**
* Returns the value of the '<em><b>Null Flavor</b></em>' attribute.
* The literals are from the enumeration {@link org.eclipse.mdht.uml.hl7.vocab.NullFlavor}.
* <!-- begin-user-doc -->
* <p>
* If the meaning of the '<em>Null Flavor</em>' attribute isn't clear,
* there really should be more of a description here...
* </p>
* <!-- end-user-doc -->
* @return the value of the '<em>Null Flavor</em>' attribute.
* @see org.eclipse.mdht.uml.hl7.vocab.NullFlavor
* @see #isSetNullFlavor()
* @see #unsetNullFlavor()
* @see #setNullFlavor(NullFlavor)
* @see org.eclipse.mdht.uml.cda.CDAPackage#getPlayingEntity_NullFlavor()
* @model unsettable="true" ordered="false"
* extendedMetaData="name='nullFlavor' kind='attribute'"
* @generated
*/
NullFlavor getNullFlavor();
/**
* Sets the value of the '{@link org.eclipse.mdht.uml.cda.PlayingEntity#getNullFlavor <em>Null Flavor</em>}' attribute.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @param value the new value of the '<em>Null Flavor</em>' attribute.
* @see org.eclipse.mdht.uml.hl7.vocab.NullFlavor
* @see #isSetNullFlavor()
* @see #unsetNullFlavor()
* @see #getNullFlavor()
* @generated
*/
void setNullFlavor(NullFlavor value);
/**
* Unsets the value of the '{@link org.eclipse.mdht.uml.cda.PlayingEntity#getNullFlavor <em>Null Flavor</em>}' attribute.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @see #isSetNullFlavor()
* @see #getNullFlavor()
* @see #setNullFlavor(NullFlavor)
* @generated
*/
void unsetNullFlavor();
/**
* Returns whether the value of the '{@link org.eclipse.mdht.uml.cda.PlayingEntity#getNullFlavor <em>Null Flavor</em>}' attribute is set.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @return whether the value of the '<em>Null Flavor</em>' attribute is set.
* @see #unsetNullFlavor()
* @see #getNullFlavor()
* @see #setNullFlavor(NullFlavor)
* @generated
*/
boolean isSetNullFlavor();
/**
* Returns the value of the '<em><b>Class Code</b></em>' attribute.
* The default value is <code>"ENT"</code>.
* The literals are from the enumeration {@link org.eclipse.mdht.uml.hl7.vocab.EntityClassRoot}.
* <!-- begin-user-doc -->
* <p>
* If the meaning of the '<em>Class Code</em>' attribute isn't clear,
* there really should be more of a description here...
* </p>
* <!-- end-user-doc -->
* @return the value of the '<em>Class Code</em>' attribute.
* @see org.eclipse.mdht.uml.hl7.vocab.EntityClassRoot
* @see #isSetClassCode()
* @see #unsetClassCode()
* @see #setClassCode(EntityClassRoot)
* @see org.eclipse.mdht.uml.cda.CDAPackage#getPlayingEntity_ClassCode()
* @model default="ENT" unsettable="true" ordered="false"
* extendedMetaData="name='classCode' kind='attribute'"
* @generated
*/
EntityClassRoot getClassCode();
/**
* Sets the value of the '{@link org.eclipse.mdht.uml.cda.PlayingEntity#getClassCode <em>Class Code</em>}' attribute.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @param value the new value of the '<em>Class Code</em>' attribute.
* @see org.eclipse.mdht.uml.hl7.vocab.EntityClassRoot
* @see #isSetClassCode()
* @see #unsetClassCode()
* @see #getClassCode()
* @generated
*/
void setClassCode(EntityClassRoot value);
/**
* Unsets the value of the '{@link org.eclipse.mdht.uml.cda.PlayingEntity#getClassCode <em>Class Code</em>}' attribute.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @see #isSetClassCode()
* @see #getClassCode()
* @see #setClassCode(EntityClassRoot)
* @generated
*/
void unsetClassCode();
/**
* Returns whether the value of the '{@link org.eclipse.mdht.uml.cda.PlayingEntity#getClassCode <em>Class Code</em>}' attribute is set.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @return whether the value of the '<em>Class Code</em>' attribute is set.
* @see #unsetClassCode()
* @see #getClassCode()
* @see #setClassCode(EntityClassRoot)
* @generated
*/
boolean isSetClassCode();
/**
* Returns the value of the '<em><b>Determiner Code</b></em>' attribute.
* The default value is <code>"INSTANCE"</code>.
* The literals are from the enumeration {@link org.eclipse.mdht.uml.hl7.vocab.EntityDeterminer}.
* <!-- begin-user-doc -->
* <p>
* If the meaning of the '<em>Determiner Code</em>' attribute isn't clear,
* there really should be more of a description here...
* </p>
* <!-- end-user-doc -->
* @return the value of the '<em>Determiner Code</em>' attribute.
* @see org.eclipse.mdht.uml.hl7.vocab.EntityDeterminer
* @see #isSetDeterminerCode()
* @see #unsetDeterminerCode()
* @see #setDeterminerCode(EntityDeterminer)
* @see org.eclipse.mdht.uml.cda.CDAPackage#getPlayingEntity_DeterminerCode()
* @model default="INSTANCE" unsettable="true" ordered="false"
* extendedMetaData="name='determinerCode' kind='attribute'"
* @generated
*/
EntityDeterminer getDeterminerCode();
/**
* Sets the value of the '{@link org.eclipse.mdht.uml.cda.PlayingEntity#getDeterminerCode <em>Determiner Code</em>}' attribute.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @param value the new value of the '<em>Determiner Code</em>' attribute.
* @see org.eclipse.mdht.uml.hl7.vocab.EntityDeterminer
* @see #isSetDeterminerCode()
* @see #unsetDeterminerCode()
* @see #getDeterminerCode()
* @generated
*/
void setDeterminerCode(EntityDeterminer value);
/**
* Unsets the value of the '{@link org.eclipse.mdht.uml.cda.PlayingEntity#getDeterminerCode <em>Determiner Code</em>}' attribute.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @see #isSetDeterminerCode()
* @see #getDeterminerCode()
* @see #setDeterminerCode(EntityDeterminer)
* @generated
*/
void unsetDeterminerCode();
/**
* Returns whether the value of the '{@link org.eclipse.mdht.uml.cda.PlayingEntity#getDeterminerCode <em>Determiner Code</em>}' attribute is set.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @return whether the value of the '<em>Determiner Code</em>' attribute is set.
* @see #unsetDeterminerCode()
* @see #getDeterminerCode()
* @see #setDeterminerCode(EntityDeterminer)
* @generated
*/
boolean isSetDeterminerCode();
/**
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* <!-- begin-model-doc -->
* @param diagnostics The chain of diagnostics to which problems are to be appended.
* @param context The cache of context-specific information.
* <!-- end-model-doc -->
* @model annotation="http://www.eclipse.org/uml2/1.1.0/GenModel body='self.isDeterminerCodeDefined() implies self.determinerCode=vocab::EntityDeterminer::INSTANCE'"
* @generated
*/
boolean validateDeterminerCode(DiagnosticChain diagnostics, Map<Object, Object> context);
} // PlayingEntity