org.openxma.dsl.dom.model.Entity Maven / Gradle / Ivy

Go to download
/**
 * 
 * 
 *
 * $Id: Entity.java 10224 2013-01-04 15:48:48Z dschwarz $
 */
package org.openxma.dsl.dom.model;

import java.util.Collection;

import org.eclipse.emf.common.util.EList;
import org.openxma.dsl.core.model.ConditionsBlock;

/**
 *  A representation of the model object '
 * Entity'. 
 *
 * 
 * The following features are supported:
 * 

 *   {@link org.openxma.dsl.dom.model.Entity#getSuperType Super Type}
 *   {@link org.openxma.dsl.dom.model.Entity#getAttributeGroups Attribute Groups}
 *   {@link org.openxma.dsl.dom.model.Entity#getConditionsBlock Conditions Block}
 *   {@link org.openxma.dsl.dom.model.Entity#getRepository Repository}
 *   {@link org.openxma.dsl.dom.model.Entity#getKey Key}
 *   {@link org.openxma.dsl.dom.model.Entity#getSortOrders Sort Orders}
 *   {@link org.openxma.dsl.dom.model.Entity#getIdentifier Identifier}
 *   {@link org.openxma.dsl.dom.model.Entity#getVersion Version}
 *   {@link org.openxma.dsl.dom.model.Entity#getRequiredReferences Required References}
 *   {@link org.openxma.dsl.dom.model.Entity#getRequiredAttributes Required Attributes}
 * 
 * 
 *
 * @see org.openxma.dsl.dom.DomPackage#getEntity()
 * @model
 * @generated
 */
public interface Entity extends ComplexType, Dependant {
	/**
	 * Returns the value of the 'Super Type' reference. 
	 * 
	 * If the meaning of the 'Super Type' reference isn't clear, there
	 * really should be more of a description here...
	 * 
	 * 
	 * 
	 * @return the value of the 'Super Type' reference.
	 * @see #setSuperType(Entity)
	 * @see org.openxma.dsl.dom.DomPackage#getEntity_SuperType()
	 * @model
	 * @generated
	 */
	Entity getSuperType();

	/**
	 * Sets the value of the '{@link org.openxma.dsl.dom.model.Entity#getSuperType Super Type}' reference.
	 *  
	 * @param value the new value of the 'Super Type' reference.
	 * @see #getSuperType()
	 * @generated
	 */
	void setSuperType(Entity value);

	/**
	 * Returns the value of the 'Attribute Groups' containment reference list.
	 * The list contents are of type {@link org.openxma.dsl.dom.model.AttributeGroup}.
	 * 
	 * 
	 * If the meaning of the 'Attribute Groups' containment reference list isn't clear,
	 * there really should be more of a description here...
	 * 
	 * 
	 * @return the value of the 'Attribute Groups' containment reference list.
	 * @see org.openxma.dsl.dom.DomPackage#getEntity_AttributeGroups()
	 * @model containment="true"
	 * @generated
	 */
	EList getAttributeGroups();

	/**
	 * Returns the value of the 'Conditions Block' containment reference.
	 * 
	 * 
	 * If the meaning of the 'Conditions Block' containment reference
	 * isn't clear, there really should be more of a description here...
	 * 
	 * 
	 * @return the value of the 'Conditions Block' containment reference.
	 * @see #setConditionsBlock(ConditionsBlock)
	 * @see org.openxma.dsl.dom.DomPackage#getEntity_ConditionsBlock()
	 * @model containment="true"
	 * @generated
	 */
	ConditionsBlock getConditionsBlock();

	/**
	 * Sets the value of the '{@link org.openxma.dsl.dom.model.Entity#getConditionsBlock Conditions Block}' containment reference.
	 *  
	 * @param value the new value of the 'Conditions Block' containment reference.
	 * @see #getConditionsBlock()
	 * @generated
	 */
	void setConditionsBlock(ConditionsBlock value);

	/**
	 * Returns the value of the 'Repository' reference.
	 * 
	 * 
	 * If the meaning of the 'Repository' reference isn't clear,
	 * there really should be more of a description here...
	 * 
	 * 
	 * @return the value of the 'Repository' reference.
	 * @see org.openxma.dsl.dom.DomPackage#getEntity_Repository()
	 * @model resolveProxies="false" transient="true" changeable="false" volatile="true" derived="true"
	 * @generated
	 */
	Dao getRepository();

	/**
	 * Returns the value of the 'Key' reference.
	 * 
	 * 
	 * If the meaning of the 'Key' containment reference isn't clear,
	 * there really should be more of a description here...
	 * 
	 * 
	 * @return the value of the 'Key' reference.
	 * @see org.openxma.dsl.dom.DomPackage#getEntity_Key()
	 * @model resolveProxies="false" transient="true" changeable="false" volatile="true" derived="true"
	 * @generated
	 */
	AttributeGroup getKey();

	/**
	 * Returns the value of the 'Sort Orders' reference list.
	 * The list contents are of type {@link org.openxma.dsl.dom.model.AttributeGroup}.
	 * 
	 * 
	 * If the meaning of the 'Sort Orders' containment reference list
	 * isn't clear, there really should be more of a description here...
	 * 
	 * 
	 * @return the value of the 'Sort Orders' reference list.
	 * @see org.openxma.dsl.dom.DomPackage#getEntity_SortOrders()
	 * @model resolveProxies="false" transient="true" changeable="false" volatile="true" derived="true"
	 * @generated
	 */
	EList getSortOrders();

	/**
	 * Returns the value of the 'Identifier' reference. 
	 * 
	 * If the meaning of the 'Identifier' reference isn't clear, there
	 * really should be more of a description here...
	 * 
	 * 
	 * 
	 * @return the value of the 'Identifier' reference.
	 * @see org.openxma.dsl.dom.DomPackage#getEntity_Identifier()
	 * @model resolveProxies="false" transient="true" changeable="false"
	 *        volatile="true" derived="true"
	 * @generated
	 */
	Attribute getIdentifier();

	/**
	 * Returns the value of the 'Version' reference. 
	 * 
	 * If the meaning of the 'Version' reference isn't clear, there
	 * really should be more of a description here...
	 * 
	 * 
	 * 
	 * @return the value of the 'Version' reference.
	 * @see org.openxma.dsl.dom.DomPackage#getEntity_Version()
	 * @model resolveProxies="false" transient="true" changeable="false"
	 *        volatile="true" derived="true"
	 * @generated
	 */
	Attribute getVersion();

	/**
	 * Returns the value of the 'Required References' reference list.
	 * The list contents are of type {@link org.openxma.dsl.dom.model.Attribute}.
	 * 
	 * 
	 * If the meaning of the 'Required References' reference list isn't clear,
	 * there really should be more of a description here...
	 * 
	 * 
	 * @return the value of the 'Required References' reference list.
	 * @see org.openxma.dsl.dom.DomPackage#getEntity_RequiredReferences()
	 * @model resolveProxies="false" transient="true" changeable="false" volatile="true" derived="true"
	 * @generated
	 */
	EList getRequiredReferences();

	/**
	 * Returns the value of the 'Required Attributes' reference list.
	 * The list contents are of type {@link org.openxma.dsl.dom.model.Attribute}.
	 * 
	 * 
	 * If the meaning of the 'Required Attributes' reference list isn't clear,
	 * there really should be more of a description here...
	 * 
	 * 
	 * @return the value of the 'Required Attributes' reference list.
	 * @see org.openxma.dsl.dom.DomPackage#getEntity_RequiredAttributes()
	 * @model resolveProxies="false" transient="true" changeable="false" volatile="true" derived="true"
	 * @generated
	 */
	EList getRequiredAttributes();

	/**
	 * @generated NOT
	 */
	void setDas(Dao das);


	/**
	 * Returns a collection of the self-contained copies of each attribute.
	 * 
	 * @return
	 * @generated NOT
	 */
	Collection copyAttributes();

	/**
	 * @param name
	 *            the name of the attribute to match
	 * @return the attribute matching the given name
	 * @generated NOT
	 */
	Attribute getAttributeByName(String name);

	/**
	 * @generated NOT
	 */
	DataView getDefaultDataView();

	/**
	 * @return the name of the default created DataView for the
	 *         given entity
	 * @generated NOT
	 */
	String getDefaultDataViewName();
	
	/**
	 * @generated NOT
	 */
	EList getResolvedAttributeList() ;

} // Entity