
sculptormetamodel.Reference Maven / Gradle / Ivy
/**
*/
package sculptormetamodel;
/**
*
* A representation of the model object 'Reference'.
*
*
*
* The following features are supported:
*
* - {@link sculptormetamodel.Reference#isMany Many}
* - {@link sculptormetamodel.Reference#getCollectionType Collection Type}
* - {@link sculptormetamodel.Reference#getOpposite Opposite}
* - {@link sculptormetamodel.Reference#getTo To}
* - {@link sculptormetamodel.Reference#getCascade Cascade}
* - {@link sculptormetamodel.Reference#getOrderBy Order By}
* - {@link sculptormetamodel.Reference#getVisibility Visibility}
* - {@link sculptormetamodel.Reference#isChangeable Changeable}
* - {@link sculptormetamodel.Reference#getFrom From}
* - {@link sculptormetamodel.Reference#isRequired Required}
* - {@link sculptormetamodel.Reference#getFetch Fetch}
* - {@link sculptormetamodel.Reference#isCache Cache}
* - {@link sculptormetamodel.Reference#isNaturalKey Natural Key}
* - {@link sculptormetamodel.Reference#isInverse Inverse}
* - {@link sculptormetamodel.Reference#isNullable Nullable}
* - {@link sculptormetamodel.Reference#getDatabaseColumn Database Column}
* - {@link sculptormetamodel.Reference#getValidate Validate}
* - {@link sculptormetamodel.Reference#isTransient Transient}
* - {@link sculptormetamodel.Reference#getDatabaseJoinTable Database Join Table}
* - {@link sculptormetamodel.Reference#getDatabaseJoinColumn Database Join Column}
*
*
*
* @see sculptormetamodel.SculptormetamodelPackage#getReference()
* @model
* @generated
*/
public interface Reference extends NamedElement
{
/**
* Returns the value of the 'Many' attribute.
*
*
* If the meaning of the 'Many' attribute isn't clear,
* there really should be more of a description here...
*
*
* @return the value of the 'Many' attribute.
* @see #setMany(boolean)
* @see sculptormetamodel.SculptormetamodelPackage#getReference_Many()
* @model
* @generated
*/
boolean isMany();
/**
* Sets the value of the '{@link sculptormetamodel.Reference#isMany Many}' attribute.
*
*
* @param value the new value of the 'Many' attribute.
* @see #isMany()
* @generated
*/
void setMany(boolean value);
/**
* Returns the value of the 'Collection Type' attribute.
*
*
* If the meaning of the 'Collection Type' attribute isn't clear,
* there really should be more of a description here...
*
*
* @return the value of the 'Collection Type' attribute.
* @see #setCollectionType(String)
* @see sculptormetamodel.SculptormetamodelPackage#getReference_CollectionType()
* @model
* @generated
*/
String getCollectionType();
/**
* Sets the value of the '{@link sculptormetamodel.Reference#getCollectionType Collection Type}' attribute.
*
*
* @param value the new value of the 'Collection Type' attribute.
* @see #getCollectionType()
* @generated
*/
void setCollectionType(String value);
/**
* Returns the value of the 'Opposite' reference.
*
*
* If the meaning of the 'Opposite' reference isn't clear,
* there really should be more of a description here...
*
*
* @return the value of the 'Opposite' reference.
* @see #setOpposite(Reference)
* @see sculptormetamodel.SculptormetamodelPackage#getReference_Opposite()
* @model
* @generated
*/
Reference getOpposite();
/**
* Sets the value of the '{@link sculptormetamodel.Reference#getOpposite Opposite}' reference.
*
*
* @param value the new value of the 'Opposite' reference.
* @see #getOpposite()
* @generated
*/
void setOpposite(Reference value);
/**
* Returns the value of the 'To' reference.
*
*
* If the meaning of the 'To' reference isn't clear,
* there really should be more of a description here...
*
*
* @return the value of the 'To' reference.
* @see #setTo(DomainObject)
* @see sculptormetamodel.SculptormetamodelPackage#getReference_To()
* @model required="true"
* @generated
*/
DomainObject getTo();
/**
* Sets the value of the '{@link sculptormetamodel.Reference#getTo To}' reference.
*
*
* @param value the new value of the 'To' reference.
* @see #getTo()
* @generated
*/
void setTo(DomainObject value);
/**
* Returns the value of the 'Cascade' attribute.
*
*
* If the meaning of the 'Cascade' attribute isn't clear,
* there really should be more of a description here...
*
*
* @return the value of the 'Cascade' attribute.
* @see #setCascade(String)
* @see sculptormetamodel.SculptormetamodelPackage#getReference_Cascade()
* @model
* @generated
*/
String getCascade();
/**
* Sets the value of the '{@link sculptormetamodel.Reference#getCascade Cascade}' attribute.
*
*
* @param value the new value of the 'Cascade' attribute.
* @see #getCascade()
* @generated
*/
void setCascade(String value);
/**
* Returns the value of the 'Order By' attribute.
*
*
* If the meaning of the 'Order By' attribute isn't clear,
* there really should be more of a description here...
*
*
* @return the value of the 'Order By' attribute.
* @see #setOrderBy(String)
* @see sculptormetamodel.SculptormetamodelPackage#getReference_OrderBy()
* @model
* @generated
*/
String getOrderBy();
/**
* Sets the value of the '{@link sculptormetamodel.Reference#getOrderBy Order By}' attribute.
*
*
* @param value the new value of the 'Order By' attribute.
* @see #getOrderBy()
* @generated
*/
void setOrderBy(String value);
/**
* Returns the value of the 'Visibility' attribute.
*
*
* If the meaning of the 'Visibility' attribute isn't clear,
* there really should be more of a description here...
*
*
* @return the value of the 'Visibility' attribute.
* @see #setVisibility(String)
* @see sculptormetamodel.SculptormetamodelPackage#getReference_Visibility()
* @model
* @generated
*/
String getVisibility();
/**
* Sets the value of the '{@link sculptormetamodel.Reference#getVisibility Visibility}' attribute.
*
*
* @param value the new value of the 'Visibility' attribute.
* @see #getVisibility()
* @generated
*/
void setVisibility(String value);
/**
* Returns the value of the 'Changeable' attribute.
* The default value is "true"
.
*
*
* If the meaning of the 'Changeable' attribute isn't clear,
* there really should be more of a description here...
*
*
* @return the value of the 'Changeable' attribute.
* @see #setChangeable(boolean)
* @see sculptormetamodel.SculptormetamodelPackage#getReference_Changeable()
* @model default="true"
* @generated
*/
boolean isChangeable();
/**
* Sets the value of the '{@link sculptormetamodel.Reference#isChangeable Changeable}' attribute.
*
*
* @param value the new value of the 'Changeable' attribute.
* @see #isChangeable()
* @generated
*/
void setChangeable(boolean value);
/**
* Returns the value of the 'From' container reference.
* It is bidirectional and its opposite is '{@link sculptormetamodel.DomainObject#getReferences References}'.
*
*
* If the meaning of the 'From' container reference isn't clear,
* there really should be more of a description here...
*
*
* @return the value of the 'From' container reference.
* @see #setFrom(DomainObject)
* @see sculptormetamodel.SculptormetamodelPackage#getReference_From()
* @see sculptormetamodel.DomainObject#getReferences
* @model opposite="references" transient="false"
* @generated
*/
DomainObject getFrom();
/**
* Sets the value of the '{@link sculptormetamodel.Reference#getFrom From}' container reference.
*
*
* @param value the new value of the 'From' container reference.
* @see #getFrom()
* @generated
*/
void setFrom(DomainObject value);
/**
* Returns the value of the 'Required' attribute.
*
*
* If the meaning of the 'Required' attribute isn't clear,
* there really should be more of a description here...
*
*
* @return the value of the 'Required' attribute.
* @see #setRequired(boolean)
* @see sculptormetamodel.SculptormetamodelPackage#getReference_Required()
* @model
* @generated
*/
boolean isRequired();
/**
* Sets the value of the '{@link sculptormetamodel.Reference#isRequired Required}' attribute.
*
*
* @param value the new value of the 'Required' attribute.
* @see #isRequired()
* @generated
*/
void setRequired(boolean value);
/**
* Returns the value of the 'Fetch' attribute.
*
*
* If the meaning of the 'Fetch' attribute isn't clear,
* there really should be more of a description here...
*
*
* @return the value of the 'Fetch' attribute.
* @see #setFetch(String)
* @see sculptormetamodel.SculptormetamodelPackage#getReference_Fetch()
* @model
* @generated
*/
String getFetch();
/**
* Sets the value of the '{@link sculptormetamodel.Reference#getFetch Fetch}' attribute.
*
*
* @param value the new value of the 'Fetch' attribute.
* @see #getFetch()
* @generated
*/
void setFetch(String value);
/**
* Returns the value of the 'Cache' attribute.
*
*
* If the meaning of the 'Cache' attribute isn't clear,
* there really should be more of a description here...
*
*
* @return the value of the 'Cache' attribute.
* @see #setCache(boolean)
* @see sculptormetamodel.SculptormetamodelPackage#getReference_Cache()
* @model
* @generated
*/
boolean isCache();
/**
* Sets the value of the '{@link sculptormetamodel.Reference#isCache Cache}' attribute.
*
*
* @param value the new value of the 'Cache' attribute.
* @see #isCache()
* @generated
*/
void setCache(boolean value);
/**
* Returns the value of the 'Natural Key' attribute.
*
*
* If the meaning of the 'Natural Key' attribute isn't clear,
* there really should be more of a description here...
*
*
* @return the value of the 'Natural Key' attribute.
* @see #setNaturalKey(boolean)
* @see sculptormetamodel.SculptormetamodelPackage#getReference_NaturalKey()
* @model
* @generated
*/
boolean isNaturalKey();
/**
* Sets the value of the '{@link sculptormetamodel.Reference#isNaturalKey Natural Key}' attribute.
*
*
* @param value the new value of the 'Natural Key' attribute.
* @see #isNaturalKey()
* @generated
*/
void setNaturalKey(boolean value);
/**
* Returns the value of the 'Inverse' attribute.
*
*
* If the meaning of the 'Inverse' attribute isn't clear,
* there really should be more of a description here...
*
*
* @return the value of the 'Inverse' attribute.
* @see #setInverse(boolean)
* @see sculptormetamodel.SculptormetamodelPackage#getReference_Inverse()
* @model
* @generated
*/
boolean isInverse();
/**
* Sets the value of the '{@link sculptormetamodel.Reference#isInverse Inverse}' attribute.
*
*
* @param value the new value of the 'Inverse' attribute.
* @see #isInverse()
* @generated
*/
void setInverse(boolean value);
/**
* Returns the value of the 'Nullable' attribute.
*
*
* If the meaning of the 'Nullable' attribute isn't clear,
* there really should be more of a description here...
*
*
* @return the value of the 'Nullable' attribute.
* @see #setNullable(boolean)
* @see sculptormetamodel.SculptormetamodelPackage#getReference_Nullable()
* @model
* @generated
*/
boolean isNullable();
/**
* Sets the value of the '{@link sculptormetamodel.Reference#isNullable Nullable}' attribute.
*
*
* @param value the new value of the 'Nullable' attribute.
* @see #isNullable()
* @generated
*/
void setNullable(boolean value);
/**
* Returns the value of the 'Database Column' attribute.
*
*
* If the meaning of the 'Database Column' attribute isn't clear,
* there really should be more of a description here...
*
*
* @return the value of the 'Database Column' attribute.
* @see #setDatabaseColumn(String)
* @see sculptormetamodel.SculptormetamodelPackage#getReference_DatabaseColumn()
* @model
* @generated
*/
String getDatabaseColumn();
/**
* Sets the value of the '{@link sculptormetamodel.Reference#getDatabaseColumn Database Column}' attribute.
*
*
* @param value the new value of the 'Database Column' attribute.
* @see #getDatabaseColumn()
* @generated
*/
void setDatabaseColumn(String value);
/**
* Returns the value of the 'Validate' attribute.
*
*
* If the meaning of the 'Validate' attribute isn't clear,
* there really should be more of a description here...
*
*
* @return the value of the 'Validate' attribute.
* @see #setValidate(String)
* @see sculptormetamodel.SculptormetamodelPackage#getReference_Validate()
* @model
* @generated
*/
String getValidate();
/**
* Sets the value of the '{@link sculptormetamodel.Reference#getValidate Validate}' attribute.
*
*
* @param value the new value of the 'Validate' attribute.
* @see #getValidate()
* @generated
*/
void setValidate(String value);
/**
* Returns the value of the 'Transient' attribute.
*
*
* If the meaning of the 'Transient' attribute isn't clear,
* there really should be more of a description here...
*
*
* @return the value of the 'Transient' attribute.
* @see #setTransient(boolean)
* @see sculptormetamodel.SculptormetamodelPackage#getReference_Transient()
* @model
* @generated
*/
boolean isTransient();
/**
* Sets the value of the '{@link sculptormetamodel.Reference#isTransient Transient}' attribute.
*
*
* @param value the new value of the 'Transient' attribute.
* @see #isTransient()
* @generated
*/
void setTransient(boolean value);
/**
* Returns the value of the 'Database Join Table' attribute.
*
*
* If the meaning of the 'Database Join Table' attribute isn't clear,
* there really should be more of a description here...
*
*
* @return the value of the 'Database Join Table' attribute.
* @see #setDatabaseJoinTable(String)
* @see sculptormetamodel.SculptormetamodelPackage#getReference_DatabaseJoinTable()
* @model
* @generated
*/
String getDatabaseJoinTable();
/**
* Sets the value of the '{@link sculptormetamodel.Reference#getDatabaseJoinTable Database Join Table}' attribute.
*
*
* @param value the new value of the 'Database Join Table' attribute.
* @see #getDatabaseJoinTable()
* @generated
*/
void setDatabaseJoinTable(String value);
/**
* Returns the value of the 'Database Join Column' attribute.
*
*
* If the meaning of the 'Database Join Column' attribute isn't clear,
* there really should be more of a description here...
*
*
* @return the value of the 'Database Join Column' attribute.
* @see #setDatabaseJoinColumn(String)
* @see sculptormetamodel.SculptormetamodelPackage#getReference_DatabaseJoinColumn()
* @model
* @generated
*/
String getDatabaseJoinColumn();
/**
* Sets the value of the '{@link sculptormetamodel.Reference#getDatabaseJoinColumn Database Join Column}' attribute.
*
*
* @param value the new value of the 'Database Join Column' attribute.
* @see #getDatabaseJoinColumn()
* @generated
*/
void setDatabaseJoinColumn(String value);
} // Reference