/******************************************************************************* | |
* 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.II; | |
import org.eclipse.mdht.uml.hl7.rim.Act; | |
import org.eclipse.mdht.uml.hl7.vocab.ActClass; | |
import org.eclipse.mdht.uml.hl7.vocab.ActMood; | |
import org.eclipse.mdht.uml.hl7.vocab.NullFlavor; | |
/** | |
* <!-- begin-user-doc --> | |
* A representation of the model object '<em><b>Consent</b></em>'. | |
* <!-- end-user-doc --> | |
* | |
* <p> | |
* The following features are supported: | |
* </p> | |
* <ul> | |
* <li>{@link org.eclipse.mdht.uml.cda.Consent#getRealmCodes <em>Realm Code</em>}</li> | |
* <li>{@link org.eclipse.mdht.uml.cda.Consent#getTypeId <em>Type Id</em>}</li> | |
* <li>{@link org.eclipse.mdht.uml.cda.Consent#getTemplateIds <em>Template Id</em>}</li> | |
* <li>{@link org.eclipse.mdht.uml.cda.Consent#getIds <em>Id</em>}</li> | |
* <li>{@link org.eclipse.mdht.uml.cda.Consent#getCode <em>Code</em>}</li> | |
* <li>{@link org.eclipse.mdht.uml.cda.Consent#getStatusCode <em>Status Code</em>}</li> | |
* <li>{@link org.eclipse.mdht.uml.cda.Consent#getNullFlavor <em>Null Flavor</em>}</li> | |
* <li>{@link org.eclipse.mdht.uml.cda.Consent#getClassCode <em>Class Code</em>}</li> | |
* <li>{@link org.eclipse.mdht.uml.cda.Consent#getMoodCode <em>Mood Code</em>}</li> | |
* </ul> | |
* | |
* @see org.eclipse.mdht.uml.cda.CDAPackage#getConsent() | |
* @model | |
* @generated | |
*/ | |
public interface Consent extends Act { | |
/** | |
* 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#getConsent_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#getConsent_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.Consent#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#getConsent_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#getConsent_Id() | |
* @model containment="true" ordered="false" | |
* extendedMetaData="namespace='##targetNamespace' kind='element'" | |
* @generated | |
*/ | |
EList<II> getIds(); | |
/** | |
* 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#getConsent_Code() | |
* @model containment="true" ordered="false" | |
* extendedMetaData="namespace='##targetNamespace' kind='element'" | |
* @generated | |
*/ | |
CE getCode(); | |
/** | |
* Sets the value of the '{@link org.eclipse.mdht.uml.cda.Consent#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>Status Code</b></em>' containment reference. | |
* <!-- begin-user-doc --> | |
* <p> | |
* If the meaning of the '<em>Status 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>Status Code</em>' containment reference. | |
* @see #setStatusCode(CS) | |
* @see org.eclipse.mdht.uml.cda.CDAPackage#getConsent_StatusCode() | |
* @model containment="true" required="true" ordered="false" | |
* extendedMetaData="namespace='##targetNamespace' kind='element'" | |
* @generated | |
*/ | |
CS getStatusCode(); | |
/** | |
* Sets the value of the '{@link org.eclipse.mdht.uml.cda.Consent#getStatusCode <em>Status Code</em>}' containment reference. | |
* <!-- begin-user-doc --> | |
* <!-- end-user-doc --> | |
* @param value the new value of the '<em>Status Code</em>' containment reference. | |
* @see #getStatusCode() | |
* @generated | |
*/ | |
void setStatusCode(CS 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#getConsent_NullFlavor() | |
* @model unsettable="true" ordered="false" | |
* @generated | |
*/ | |
NullFlavor getNullFlavor(); | |
/** | |
* Sets the value of the '{@link org.eclipse.mdht.uml.cda.Consent#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.Consent#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.Consent#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>"CONS"</code>. | |
* The literals are from the enumeration {@link org.eclipse.mdht.uml.hl7.vocab.ActClass}. | |
* <!-- 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.ActClass | |
* @see #isSetClassCode() | |
* @see #unsetClassCode() | |
* @see #setClassCode(ActClass) | |
* @see org.eclipse.mdht.uml.cda.CDAPackage#getConsent_ClassCode() | |
* @model default="CONS" unsettable="true" ordered="false" | |
* @generated | |
*/ | |
ActClass getClassCode(); | |
/** | |
* Sets the value of the '{@link org.eclipse.mdht.uml.cda.Consent#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.ActClass | |
* @see #isSetClassCode() | |
* @see #unsetClassCode() | |
* @see #getClassCode() | |
* @generated | |
*/ | |
void setClassCode(ActClass value); | |
/** | |
* Unsets the value of the '{@link org.eclipse.mdht.uml.cda.Consent#getClassCode <em>Class Code</em>}' attribute. | |
* <!-- begin-user-doc --> | |
* <!-- end-user-doc --> | |
* @see #isSetClassCode() | |
* @see #getClassCode() | |
* @see #setClassCode(ActClass) | |
* @generated | |
*/ | |
void unsetClassCode(); | |
/** | |
* Returns whether the value of the '{@link org.eclipse.mdht.uml.cda.Consent#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(ActClass) | |
* @generated | |
*/ | |
boolean isSetClassCode(); | |
/** | |
* Returns the value of the '<em><b>Mood Code</b></em>' attribute. | |
* The default value is <code>"EVN"</code>. | |
* The literals are from the enumeration {@link org.eclipse.mdht.uml.hl7.vocab.ActMood}. | |
* <!-- begin-user-doc --> | |
* <p> | |
* If the meaning of the '<em>Mood 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>Mood Code</em>' attribute. | |
* @see org.eclipse.mdht.uml.hl7.vocab.ActMood | |
* @see #isSetMoodCode() | |
* @see #unsetMoodCode() | |
* @see #setMoodCode(ActMood) | |
* @see org.eclipse.mdht.uml.cda.CDAPackage#getConsent_MoodCode() | |
* @model default="EVN" unsettable="true" ordered="false" | |
* @generated | |
*/ | |
ActMood getMoodCode(); | |
/** | |
* Sets the value of the '{@link org.eclipse.mdht.uml.cda.Consent#getMoodCode <em>Mood Code</em>}' attribute. | |
* <!-- begin-user-doc --> | |
* <!-- end-user-doc --> | |
* @param value the new value of the '<em>Mood Code</em>' attribute. | |
* @see org.eclipse.mdht.uml.hl7.vocab.ActMood | |
* @see #isSetMoodCode() | |
* @see #unsetMoodCode() | |
* @see #getMoodCode() | |
* @generated | |
*/ | |
void setMoodCode(ActMood value); | |
/** | |
* Unsets the value of the '{@link org.eclipse.mdht.uml.cda.Consent#getMoodCode <em>Mood Code</em>}' attribute. | |
* <!-- begin-user-doc --> | |
* <!-- end-user-doc --> | |
* @see #isSetMoodCode() | |
* @see #getMoodCode() | |
* @see #setMoodCode(ActMood) | |
* @generated | |
*/ | |
void unsetMoodCode(); | |
/** | |
* Returns whether the value of the '{@link org.eclipse.mdht.uml.cda.Consent#getMoodCode <em>Mood Code</em>}' attribute is set. | |
* <!-- begin-user-doc --> | |
* <!-- end-user-doc --> | |
* @return whether the value of the '<em>Mood Code</em>' attribute is set. | |
* @see #unsetMoodCode() | |
* @see #getMoodCode() | |
* @see #setMoodCode(ActMood) | |
* @generated | |
*/ | |
boolean isSetMoodCode(); | |
/** | |
* <!-- 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::ActClass::CONS'" | |
* @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.isMoodCodeDefined() implies self.moodCode=vocab::ActMood::EVN'" | |
* @generated | |
*/ | |
boolean validateMoodCode(DiagnosticChain diagnostics, Map<Object, Object> context); | |
} // Consent |