ModelEntity

All Superinterfaces:

PrimitiveModelEntity

All Known Subinterfaces:

AbstractModel, AbstractSelection, AppFeature, AppFeatureList, BatchFeature, BatchFeatureList, BatchList, BEMFeature, BEMFeatureList, CapeOpen, CapeOpenFeature, CapeOpenFeatureList, Coeff, CoeffFeature, CoeffFeatureList, CoeffList, CommonFeature, CommonList, ComponentCommonList, ComponentCoordsysList, ComponentCplList, ComponentExprList, ComponentExtraDimList, ComponentFunctionFeatureList, ComponentGeomList, ComponentMaterialList, ComponentMeshList, ComponentMultiphysicsCouplingList, ComponentPairList, ComponentPhysicsList, ComponentProbeFeatureList, ComponentPropFeatureList, ComponentSelectionList, ComponentViewList, Constr, ConstrFeature, ConstrFeatureList, ConstrList, Coordsys, CoordsysList, Cpl, CplList, CumulativeSelection, DatasetFeature, DatasetFeatureList, Element, ElementSet, ElementSetList, ElemFeature, ElemFeatureList, ElemList, EvaluationFeature, EvaluationFeatureList, EvaluationGroupFeature, EvaluationGroupFeatureList, Event, EventList, ExportFeature, ExportFeatureList, Expr, ExpressionBase, ExpressionEntity, ExprList, ExtraDimFeature, ExtraDimList, FeatureInfo, FeatureInfoList, Field, FieldList, FileResource, FileResourceList, FormFeature, FormFeatureList, Frame, FrameFeature, FrameFeatureList, FrameList, FunctionFeature, FunctionFeatureList, GenericModelEntityList<T>, GeomContainer, GeomDefeature, GeomExport, GeomFeature, GeomFeatureList, GeomInfo, GeomInfoBase, GeomList, GeomMeasure, GeomMeasureFinal, GeomMeshFeature, GeomObject, GeomObjectGroupSelection, GeomObjectList, GeomObjectSelection, GeomObjectSelectionFeature, GeomObjectSelectionFeatureList, GeomProblemFeature, GeomProblemFeatureList, GeomSequence, GeomSubsequence, GeomSubsequenceCallFeature, Group, GroupList, HideDraw, HideDrawList, HideGeom, HideGeomList, HideMesh, HideMeshList, History, Information, InformationList, Init, InitList, IntRule, IntRuleFeature, IntRuleFeatureList, IntRuleList, LocalGeomObjectSelection, LocalSelection, Material, MaterialList, MaterialModel, MaterialModelList, MeshData, MeshExport, MeshFeature, MeshFeatureList, MeshList, MeshNative, MeshProblemFeature, MeshProblemFeatureList, MeshSelection, MeshSequence, MeshStatistics, MethodCallFeature, MethodCallFeatureList, Model, ModelEntityImage, ModelEntityList<T>, ModelNode, ModelNodeList, ModelParam, ModelParamGroup, ModelParamGroupCase, ModelParamGroupCaseList, ModelParamGroupList, MultigridLevel, MultigridLevelList, MultiphysicsCoupling, MultiphysicsCouplingList, NodeGroup, NodeGroupList, NumericalBaseFeature, NumericalFeature, NumericalFeatureList, Ode, OdeList, OptFeature, OptFeatureList, OptSequence, Pair, PairList, ParamBase, ParameterEntity, Physics, PhysicsFeature, PhysicsFeatureList, PhysicsField, PhysicsFieldList, PhysicsList, PhysicsProp, PhysicsPropList, ProbeFeature, ProbeFeatureList, PropFeature, PropFeatureList<T>, ReducedModel, ReducedModelBase, ReducedModelList, ReportFeature, ReportFeatureList, ResultBaseFeature, ResultFeature, ResultFeatureList, ResultParam, ResultProblemFeature, ResultProblemFeatureList, Results, SavePointData, SavePointDataList, SavePointGeom, SavePointGeomList, SavePointHideGeom, SavePointHideGeomList, SavePointSelection, SavePointSelectionList, SavePointView, SavePointViewList, Selection, SelectionEntity, SelectionFeature, SelectionList, Shape, ShapeFeature, ShapeFeatureList, ShapeList, SolutionInfo, SolverFeature, SolverFeatureList, SolverProblemFeature, SolverProblemFeatureList, SolverSequence, SolverSequenceList, Study, StudyFeature, StudyFeatureList, StudyList, TableBaseFeature, TableFeature, TableFeatureList, Unit, UnitList, UnitSystem, UnitSystemList, View, ViewBase, ViewFeature, ViewFeatureList, ViewList, Weak, WeakList, WorkPlaneFeature, XDLocalSelection
```
public interface ModelEntity
extends PrimitiveModelEntity
```
Base interface for model object entities.

Method Summary

All Methods Instance Methods Abstract Methods Deprecated Methods
Modifier and Type	Method and Description
`ModelEntity`	`active(boolean flag)` Makes the entity active or inactive.
`java.lang.String`	`author()` Returns the author of the entity.
`ModelEntity`	`author(java.lang.String name)` Sets the author of the entity.
`java.lang.String`	`comments()` Returns the comments of the entity.
`ModelEntity`	`comments(java.lang.String comment)` Sets the comments of the entity.
`java.lang.String`	`dateCreated()` Returns the creation date of the entity.
`java.lang.String`	`dateModified()` Returns the modification date of the model.
`java.lang.String`	`docMarker()` Returns the unique topic key for looking up help for this object using a remote documentation client.
`java.lang.String`	`docMarker(java.lang.String name)` Returns the unique topic key for looking up help for this object using a remote documentation client.
`java.lang.String`	`help()` Returns a URL to an HTML document with help text for a child of this entity.
`java.lang.String`	`help(java.lang.String name)` Returns a URL to an HTML document with help text for a child of this entity.
`java.lang.String`	`icon()` Returns the icon used in the Model Builder for this entity.
`boolean`	`isactive()` Deprecated. Use `isActive()` instead.
`boolean`	`isActive()` Returns `true` if the entity is active.
`java.lang.String`	`label()` Returns the label of the entity.
`ModelEntity`	`label(java.lang.String label)` Sets the label of the entity.
`java.lang.String`	`lastModifiedBy()` Returns the last user to modify the model.
`java.lang.String`	`model()` Returns the model component node tag of the entity.
`ModelEntity`	`model(java.lang.String compTag)` Sets the model component node of the entity.
`java.lang.String`	`name()` Deprecated. Use `label()` instead.
`ModelEntity`	`name(java.lang.String arg0)` Deprecated. Use `label(String)` instead.
`ModelEntity`	`resetAuthor(java.lang.String name)` Sets the author of the entity and all its children.
`java.lang.String`	`scope()` Return the scope of the entity.
`java.lang.String`	`tag()` Returns the tag of the entity.
`ModelEntity`	`tag(java.lang.String tag)` Assigns a new tag to the entity.
`long`	`timeCreated()` Returns the creation time of the entity as the number of milliseconds since January 1, 1970, 00:00:00 GMT.
`long`	`timeModified()` Returns the modification time of the entity as the number of milliseconds since January 1, 1970, 00:00:00 GMT.
`java.lang.String`	`version()` Returns the version of the entity.
`ModelEntity`	`version(java.lang.String version)` Sets the version of the entity.

Methods inherited from interface com.comsol.model.PrimitiveModelEntity
getContainer, getDisplayString

- Method Detail
  - active
```
ModelEntity active(boolean flag)
```
    Makes the entity active or inactive.
    
    Parameters:
    
    flag - true: make active; false: make inactive.
    
    Returns:
    
    Model entity.
  - author
```
java.lang.String author()
```
    Returns the author of the entity.
    
    Returns:
    
    Model entity author.
  - author
```
ModelEntity author(java.lang.String name)
```
    Sets the author of the entity.
    
    Parameters:
    
    name - Name of author.
    
    Returns:
    
    Model entity.
  - comments
```
java.lang.String comments()
```
    Returns the comments of the entity.
    
    Returns:
    
    Comments.
  - comments
```
ModelEntity comments(java.lang.String comment)
```
    Sets the comments of the entity.
    
    Parameters:
    
    comment - New comments.
    
    Returns:
    
    Model entity.
  - dateCreated
```
java.lang.String dateCreated()
```
    Returns the creation date of the entity.
    
    Returns:
    
    Creation date.
  - dateModified
```
java.lang.String dateModified()
```
    Returns the modification date of the model.
    
    Returns:
    
    Modification date.
  - docMarker
```
java.lang.String docMarker()
```
    Returns the unique topic key for looking up help for this object using a remote documentation client.
    
    Returns:
    
    A documentation topic key.
  - docMarker
```
java.lang.String docMarker(java.lang.String name)
```
    Returns the unique topic key for looking up help for this object using a remote documentation client.
    
    Parameters:
    
    name - The child's type name.
    
    Returns:
    
    A documentation topic key.
  - help
```
java.lang.String help()
```
    Returns a URL to an HTML document with help text for a child of this entity.
    
    Returns:
    
    A documentation URL string.
  - help
```
java.lang.String help(java.lang.String name)
```
    Returns a URL to an HTML document with help text for a child of this entity.
    
    Parameters:
    
    name - The child's type name.
    
    Returns:
    
    A documentation URL string.
  - icon
```
java.lang.String icon()
```
    Returns the icon used in the Model Builder for this entity. If the entity has no icon, null is returned. The return value is the name of the icon file in the folder data/images in the COMSOL installation folder.
    
    Returns:
    
    The icon or null.
  - isActive
```
boolean isActive()
```
    Returns true if the entity is active.
    
    Returns:
    
    true if active.
  - isactive
```
@Deprecated
boolean isactive()
```
    Deprecated. Use isActive() instead.
  - label
```
java.lang.String label()
```
    Returns the label of the entity.
    
    Returns:
    
    The label of the entity.
  - label
```
ModelEntity label(java.lang.String label)
```
    Sets the label of the entity.
    
    Parameters:
    
    label - Label for the entity.
    
    Returns:
    
    Model entity.
  - lastModifiedBy
```
java.lang.String lastModifiedBy()
```
    Returns the last user to modify the model.
    
    Returns:
    
    Last author of model.
  - model
```
java.lang.String model()
```
    Returns the model component node tag of the entity.
    
    Returns:
    
    Model component node tag.
  - model
```
ModelEntity model(java.lang.String compTag)
```
    Sets the model component node of the entity.
    
    Parameters:
    
    compTag - Model component node tag.
    
    Returns:
    
    Model node entity.
  - name
```
@Deprecated
java.lang.String name()
```
    Deprecated. Use label() instead.
  - name
```
@Deprecated
ModelEntity name(java.lang.String arg0)
```
    Deprecated. Use label(String) instead.
  - resetAuthor
```
ModelEntity resetAuthor(java.lang.String name)
```
    Sets the author of the entity and all its children.
    
    Parameters:
    
    name - Author name.
    
    Returns:
    
    Model entity.
  - scope
```
java.lang.String scope()
```
    Return the scope of the entity.
    
    Returns:
    
    Scope of entity.
  - tag
```
java.lang.String tag()
```
    Returns the tag of the entity.
    
    Returns:
    
    The tag of the entity.
  - tag
```
ModelEntity tag(java.lang.String tag)
```
    Assigns a new tag to the entity.
    
    Parameters:
    
    tag - The old tag of the entity.
    
    Returns:
    
    The new re-tagged entity.
  - timeCreated
```
long timeCreated()
```
    Returns the creation time of the entity as the number of milliseconds since January 1, 1970, 00:00:00 GMT. For a human readable format use dateCreated().
    
    Returns:
    
    Creation time.
  - timeModified
```
long timeModified()
```
    Returns the modification time of the entity as the number of milliseconds since January 1, 1970, 00:00:00 GMT. For a human readable format use dateModified().
    
    Returns:
    
    Creation time.
  - version
```
java.lang.String version()
```
    Returns the version of the entity.
    
    Returns:
    
    Version.
  - version
```
ModelEntity version(java.lang.String version)
```
    Sets the version of the entity.
    
    Parameters:
    
    version - Version.
    
    Returns:
    
    Model entity.

Interface ModelEntity

Method Summary

Methods inherited from interface com.comsol.model.PrimitiveModelEntity

Method Detail

active

author

author

comments

comments

dateCreated

dateModified

docMarker

docMarker

help

help

icon

isActive

isactive

label

label

lastModifiedBy

model

model

name

name

resetAuthor

scope

tag

tag

timeCreated

timeModified

version

version