|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface ClassMetaModel
Method Summary | |
---|---|
QCriteria<?> |
createCriteria()
EXPERIMENTAL If this is a persistent class, this should create a base QCriteria instance to do queries on this class. |
PropertyMetaModel<?> |
findProperty(java.lang.String name)
Returns a property reference to the specified property by following the dotted path starting at this class. |
PropertyMetaModel<?> |
findSimpleProperty(java.lang.String name)
Returns the named property on this class. |
java.lang.Class<?> |
getActualClass()
FIXME Questionable nullity |
BundleRef |
getClassBundle()
Returns the message bundle for translations related to this class. |
java.lang.Class<? extends IComboDataSet<?>> |
getComboDataSet()
If this class is the UP in a relation this specifies that it must be shown as a COMBOBOX containing choices. |
java.util.List<DisplayPropertyMetaModel> |
getComboDisplayProperties()
If this object is shown in a combobox it needs to show the following properties as the display value. |
java.lang.Class<? extends ILabelStringRenderer<?>> |
getComboLabelRenderer()
When this relation-property is presented as a single field this can contain a class to render that field as a string. |
java.lang.Class<? extends INodeContentRenderer<?>> |
getComboNodeRenderer()
When set, the entire content of a combobox's OPTION tag can be generated by this content renderer. |
java.lang.String |
getComponentTypeHint()
When present this gives a hint to the component factories to help with choosing a proper component to select a single record of this type. |
SortableType |
getDefaultSortDirection()
When a getDefaultSortProperty() is defined, this defines the sort order to use
initially. |
java.lang.String |
getDefaultSortProperty()
Contains the name of the property to use for sorting initially. |
java.lang.String |
getDomainLabel(java.util.Locale loc,
java.lang.Object value)
For a Domain type (Enum, Boolean) this returns a label for a given domain value, or null if no label is defined. |
java.lang.Object[] |
getDomainValues()
If this class is an Enum or represents some enumerated value, this returns the possible value objects. |
java.util.List<SearchPropertyMetaModel> |
getKeyWordSearchProperties()
Returns the SORTED list of key word search properties defined on this class. |
java.util.List<DisplayPropertyMetaModel> |
getLookupSelectedProperties()
When this class is to be selected as a parent in an UP relation using an InputLookup control this describes the properties to use to display the currently selected record in the edit page. |
java.lang.Class<? extends INodeContentRenderer<?>> |
getLookupSelectedRenderer()
When this class is to be selected as a parent in an UP relation using an InputLookup control this describes the renderer to use to display the currently selected record in the edit page. |
PropertyMetaModel<?> |
getPrimaryKey()
Returns the property containing the primary key for this object, if one can be found. |
java.util.List<PropertyMetaModel<?>> |
getProperties()
|
java.util.List<SearchPropertyMetaModel> |
getSearchProperties()
Returns the SORTED list of search properties defined on this class. |
java.util.List<DisplayPropertyMetaModel> |
getTableDisplayProperties()
If this object is shown in a Table it needs to show the following properties there. |
java.lang.String |
getTableName()
If this is a persistent class that is directly mapped onto some table, this might return the table name. |
java.lang.String |
getUserEntityName()
Return a user-presentable entity name (singular) for this class. |
java.lang.String |
getUserEntityNamePlural()
Returns the name of this entity in user terms; the returned name is plural. |
boolean |
isPersistentClass()
|
Method Detail |
---|
@Nonnull java.lang.Class<?> getActualClass()
@Nullable BundleRef getClassBundle()
@Nonnull java.util.List<PropertyMetaModel<?>> getProperties()
@Nullable PropertyMetaModel<?> findSimpleProperty(java.lang.String name)
name
-
@Nullable PropertyMetaModel<?> findProperty(java.lang.String name)
name
-
boolean isPersistentClass()
@Nullable java.lang.String getTableName()
@Nullable PropertyMetaModel<?> getPrimaryKey()
@Nullable java.lang.Object[] getDomainValues()
@Nullable java.lang.String getDomainLabel(java.util.Locale loc, java.lang.Object value)
loc
- value
-
@Nonnull java.lang.String getUserEntityName()
@Nullable java.lang.String getUserEntityNamePlural()
@Nullable java.lang.Class<? extends IComboDataSet<?>> getComboDataSet()
@Nullable java.lang.Class<? extends ILabelStringRenderer<?>> getComboLabelRenderer()
@Nullable java.lang.Class<? extends INodeContentRenderer<?>> getComboNodeRenderer()
getComboDisplayProperties()
,
getComboLabelRenderer()
properties are ignored.
@Nonnull java.util.List<DisplayPropertyMetaModel> getComboDisplayProperties()
@Nonnull java.util.List<DisplayPropertyMetaModel> getTableDisplayProperties()
LookupInput
search.
@Nonnull java.util.List<SearchPropertyMetaModel> getSearchProperties()
LookupInput
and LookupForm
. The value gets set from either the MetaSearch
or
the MetaSearch
annotations.
@Nonnull java.util.List<SearchPropertyMetaModel> getKeyWordSearchProperties()
LookupInput
to define the "search-as-I-type" functionality.
The value gets set from either the MetaSearch
or the MetaSearch
annotations.
@Nullable java.lang.String getDefaultSortProperty()
@Nonnull SortableType getDefaultSortDirection()
getDefaultSortProperty()
is defined, this defines the sort order to use
initially.
@Nullable java.lang.String getComponentTypeHint()
@Nullable java.lang.Class<? extends INodeContentRenderer<?>> getLookupSelectedRenderer()
getLookupSelectedProperties()
.
@Nonnull java.util.List<DisplayPropertyMetaModel> getLookupSelectedProperties()
@Nonnull QCriteria<?> createCriteria() throws java.lang.Exception
Needs evaluation.
java.lang.Exception
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |