blob: 2cd140a02482762d053394c2a3e8a470737993fa [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.AD;
import org.eclipse.mdht.uml.hl7.datatypes.CE;
import org.eclipse.mdht.uml.hl7.datatypes.CS;
import org.eclipse.mdht.uml.hl7.datatypes.II;
import org.eclipse.mdht.uml.hl7.datatypes.ON;
import org.eclipse.mdht.uml.hl7.datatypes.TEL;
import org.eclipse.mdht.uml.hl7.rim.Entity;
import org.eclipse.mdht.uml.hl7.vocab.EntityClassOrganization;
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>Organization</b></em>'.
* <!-- end-user-doc -->
*
* <p>
* The following features are supported:
* </p>
* <ul>
* <li>{@link org.eclipse.mdht.uml.cda.Organization#getRealmCodes <em>Realm Code</em>}</li>
* <li>{@link org.eclipse.mdht.uml.cda.Organization#getTypeId <em>Type Id</em>}</li>
* <li>{@link org.eclipse.mdht.uml.cda.Organization#getTemplateIds <em>Template Id</em>}</li>
* <li>{@link org.eclipse.mdht.uml.cda.Organization#getIds <em>Id</em>}</li>
* <li>{@link org.eclipse.mdht.uml.cda.Organization#getNames <em>Name</em>}</li>
* <li>{@link org.eclipse.mdht.uml.cda.Organization#getTelecoms <em>Telecom</em>}</li>
* <li>{@link org.eclipse.mdht.uml.cda.Organization#getAddrs <em>Addr</em>}</li>
* <li>{@link org.eclipse.mdht.uml.cda.Organization#getStandardIndustryClassCode <em>Standard Industry Class Code</em>}</li>
* <li>{@link org.eclipse.mdht.uml.cda.Organization#getAsOrganizationPartOf <em>As Organization Part Of</em>}</li>
* <li>{@link org.eclipse.mdht.uml.cda.Organization#getNullFlavor <em>Null Flavor</em>}</li>
* <li>{@link org.eclipse.mdht.uml.cda.Organization#getClassCode <em>Class Code</em>}</li>
* <li>{@link org.eclipse.mdht.uml.cda.Organization#getDeterminerCode <em>Determiner Code</em>}</li>
* </ul>
*
* @see org.eclipse.mdht.uml.cda.CDAPackage#getOrganization()
* @model
* @generated
*/
public interface Organization 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#getOrganization_RealmCode()
* @model containment="true" ordered="false"
* extendedMetaData="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#getOrganization_TypeId()
* @model containment="true" ordered="false"
* extendedMetaData="namespace='##targetNamespace' kind='element'"
* @generated
*/
InfrastructureRootTypeId getTypeId();
/**
* Sets the value of the '{@link org.eclipse.mdht.uml.cda.Organization#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#getOrganization_TemplateId()
* @model containment="true" ordered="false"
* extendedMetaData="namespace='##targetNamespace' kind='element'"
* @generated
*/
EList<II> getTemplateIds();
/**
* Returns the value of the '<em><b>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>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>Id</em>' containment reference list.
* @see org.eclipse.mdht.uml.cda.CDAPackage#getOrganization_Id()
* @model containment="true" ordered="false"
* extendedMetaData="namespace='##targetNamespace' kind='element'"
* @generated
*/
EList<II> getIds();
/**
* 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.ON}.
* <!-- 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#getOrganization_Name()
* @model containment="true" ordered="false"
* extendedMetaData="namespace='##targetNamespace' kind='element'"
* @generated
*/
EList<ON> getNames();
/**
* Returns the value of the '<em><b>Telecom</b></em>' containment reference list.
* The list contents are of type {@link org.eclipse.mdht.uml.hl7.datatypes.TEL}.
* <!-- begin-user-doc -->
* <p>
* If the meaning of the '<em>Telecom</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>Telecom</em>' containment reference list.
* @see org.eclipse.mdht.uml.cda.CDAPackage#getOrganization_Telecom()
* @model containment="true" ordered="false"
* extendedMetaData="namespace='##targetNamespace' kind='element'"
* @generated
*/
EList<TEL> getTelecoms();
/**
* Returns the value of the '<em><b>Addr</b></em>' containment reference list.
* The list contents are of type {@link org.eclipse.mdht.uml.hl7.datatypes.AD}.
* <!-- begin-user-doc -->
* <p>
* If the meaning of the '<em>Addr</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>Addr</em>' containment reference list.
* @see org.eclipse.mdht.uml.cda.CDAPackage#getOrganization_Addr()
* @model containment="true" ordered="false"
* extendedMetaData="namespace='##targetNamespace' kind='element'"
* @generated
*/
EList<AD> getAddrs();
/**
* Returns the value of the '<em><b>Standard Industry Class Code</b></em>' containment reference.
* <!-- begin-user-doc -->
* <p>
* If the meaning of the '<em>Standard Industry Class 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>Standard Industry Class Code</em>' containment reference.
* @see #setStandardIndustryClassCode(CE)
* @see org.eclipse.mdht.uml.cda.CDAPackage#getOrganization_StandardIndustryClassCode()
* @model containment="true" ordered="false"
* extendedMetaData="namespace='##targetNamespace' kind='element'"
* @generated
*/
CE getStandardIndustryClassCode();
/**
* Sets the value of the '{@link org.eclipse.mdht.uml.cda.Organization#getStandardIndustryClassCode <em>Standard Industry Class Code</em>}' containment reference.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @param value the new value of the '<em>Standard Industry Class Code</em>' containment reference.
* @see #getStandardIndustryClassCode()
* @generated
*/
void setStandardIndustryClassCode(CE value);
/**
* Returns the value of the '<em><b>As Organization Part Of</b></em>' containment reference.
* <!-- begin-user-doc -->
* <p>
* If the meaning of the '<em>As Organization Part Of</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>As Organization Part Of</em>' containment reference.
* @see #setAsOrganizationPartOf(OrganizationPartOf)
* @see org.eclipse.mdht.uml.cda.CDAPackage#getOrganization_AsOrganizationPartOf()
* @model containment="true" ordered="false"
* extendedMetaData="namespace='##targetNamespace' kind='element'"
* @generated
*/
OrganizationPartOf getAsOrganizationPartOf();
/**
* Sets the value of the '{@link org.eclipse.mdht.uml.cda.Organization#getAsOrganizationPartOf <em>As Organization Part Of</em>}' containment reference.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @param value the new value of the '<em>As Organization Part Of</em>' containment reference.
* @see #getAsOrganizationPartOf()
* @generated
*/
void setAsOrganizationPartOf(OrganizationPartOf 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#getOrganization_NullFlavor()
* @model unsettable="true" ordered="false"
* @generated
*/
NullFlavor getNullFlavor();
/**
* Sets the value of the '{@link org.eclipse.mdht.uml.cda.Organization#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.Organization#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.Organization#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>"ORG"</code>.
* The literals are from the enumeration {@link org.eclipse.mdht.uml.hl7.vocab.EntityClassOrganization}.
* <!-- 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.EntityClassOrganization
* @see #isSetClassCode()
* @see #unsetClassCode()
* @see #setClassCode(EntityClassOrganization)
* @see org.eclipse.mdht.uml.cda.CDAPackage#getOrganization_ClassCode()
* @model default="ORG" unsettable="true" ordered="false"
* @generated
*/
EntityClassOrganization getClassCode();
/**
* Sets the value of the '{@link org.eclipse.mdht.uml.cda.Organization#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.EntityClassOrganization
* @see #isSetClassCode()
* @see #unsetClassCode()
* @see #getClassCode()
* @generated
*/
void setClassCode(EntityClassOrganization value);
/**
* Unsets the value of the '{@link org.eclipse.mdht.uml.cda.Organization#getClassCode <em>Class Code</em>}' attribute.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @see #isSetClassCode()
* @see #getClassCode()
* @see #setClassCode(EntityClassOrganization)
* @generated
*/
void unsetClassCode();
/**
* Returns whether the value of the '{@link org.eclipse.mdht.uml.cda.Organization#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(EntityClassOrganization)
* @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#getOrganization_DeterminerCode()
* @model default="INSTANCE" unsettable="true" ordered="false"
* @generated
*/
EntityDeterminer getDeterminerCode();
/**
* Sets the value of the '{@link org.eclipse.mdht.uml.cda.Organization#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.Organization#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.Organization#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.isClassCodeDefined() implies self.classCode=vocab::EntityClassOrganization::ORG'"
* @generated
*/
boolean validateClassCode(DiagnosticChain diagnostics, Map<Object, Object> context);
/**
* <!-- 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);
} // Organization