MMTextValue (Java API)

Overview

Package

Class

Use

Help

SDK Help DE EN

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

de.mid.innovator.srv2api.icw2meta
Interface MMTextValue

All Superinterfaces:: ELContainerAble, ELContAsgnAble, ELDeleteAble, ELElement, ELObject

public interface MMTextValue
extends ELContainerAble, ELContAsgnAble
extends ELContainerAble, ELContAsgnAble

Represents an existing text.

Nested Class Summary
`static class`	`MMTextValue.VAttr`

Method Summary
`String`	`getFlowDocumentValue()` The formatted value of the connected text.
`String`	`getFlowExpandedValue()` Returns the formatted value where all fill-ins are expanded.
`String`	`getName()` Returns the name of the text.
`String`	`getStringValue()` The string value of the connected text.
`MMText`	`getText()` Text of the value.
`MMTextAble`	`getTextAble()` The element that owns this text value.
`String`	`getTextExpandedValue()` Returns the text value where all fill-ins are expanded.
`String`	`getTextStringValue(MMText refObj, String pattern)` Returns the displayed text value of the current object given by argument pattern or `argument refObj`.
`void`	`setFlowDocumentValue(String value)` Set the value of Attribut FlowDocumentValue.
`void`	`setStringValue(String value)` Set the value of Attribut StringValue.
`void`	`setTextStringValue(String value)` Set the value of Info TextStringValue.

Methods inherited from interface de.mid.innovator.srv2api.icw2elem.ELContainerAble
getCheckSetNotToLocalizeAttribute, getClientDependency, getNotToLocalizeAttribute, getOwnedElement, getOwnedElementTransitiveDown, getOwnedElementTransitiveDown, getOwnedElementTransitiveDownAndUnresolved, getOwnedElementTransitiveDownAndUnresolved, getOwnedLocalizedValue, getOwnedOrReferencedElementTransitiveDown, getOwnedOrReferencedElementTransitiveDown, getOwnedRelshipBinDirWithTarget, getOwnedRelshipBinDirWithTarget, getRedirectedModelContainer, getRelshipBinDirSource, getSelfAndOwnedElementTransitiveDown, getSelfAndOwnedElementTransitiveDown, getSortedContents, resetNotToLocalizeAttribute, setNotToLocalizeAttribute, sortContents

Methods inherited from interface de.mid.innovator.srv2api.icw2elem.ELContainerAble

getCheckSetNotToLocalizeAttribute, getClientDependency, getNotToLocalizeAttribute, getOwnedElement, getOwnedElementTransitiveDown, getOwnedElementTransitiveDown, getOwnedElementTransitiveDownAndUnresolved, getOwnedElementTransitiveDownAndUnresolved, getOwnedLocalizedValue, getOwnedOrReferencedElementTransitiveDown, getOwnedOrReferencedElementTransitiveDown, getOwnedRelshipBinDirWithTarget, getOwnedRelshipBinDirWithTarget, getRedirectedModelContainer, getRelshipBinDirSource, getSelfAndOwnedElementTransitiveDown, getSelfAndOwnedElementTransitiveDown, getSortedContents, resetNotToLocalizeAttribute, setNotToLocalizeAttribute, sortContents

Methods inherited from interface de.mid.innovator.srv2api.icw2elem.ELDeleteAble
`delete`

Methods inherited from interface de.mid.innovator.srv2api.icw2elem.ELElement
`duplicateElement, getAssignAbleToVattr, getAssignAbleToVattr, getClientId, getCreateTemplateOfInstance, getDisplayBitmap, getDisplayColor, getDisplayFont, getDisplayLine, getDisplayName, getDisplayNameShort, getDisplayNSName, getElementCache, getElementMappingInformation, getQualifiedNamespaceName, getRelshipBinDir, getRelshipBinDir, getRelshipBinDirTarget, getUnitToLock, getValSpecElement, isContainedInProfile, isUnresolved, lockUnit, setUnresolved, unlockUnit`

Methods inherited from interface de.mid.innovator.srv2api.icw2elem.ELElement

duplicateElement, getAssignAbleToVattr, getAssignAbleToVattr, getClientId, getCreateTemplateOfInstance, getDisplayBitmap, getDisplayColor, getDisplayFont, getDisplayLine, getDisplayName, getDisplayNameShort, getDisplayNSName, getElementCache, getElementMappingInformation, getQualifiedNamespaceName, getRelshipBinDir, getRelshipBinDir, getRelshipBinDirTarget, getUnitToLock, getValSpecElement, isContainedInProfile, isUnresolved, lockUnit, setUnresolved, unlockUnit

Methods inherited from interface de.mid.innovator.srv2api.icw2elem.ELObject
`getId, getLongId, getMetaClass, getMetaName, getOclClass, getSrvCon, hasRead`

Methods inherited from interface de.mid.innovator.srv2api.icw2elem.ELContAsgnAble
`getAsgnKind, getContSortOrder, getFirstOwnerWhichIsConformTo, getOwner, getOwnerTransitive, getOwnerTransitive, getSelfAndOwnerTransitive, getSelfAndOwnerTransitive, getVersionRoot, isTransitiveChildOf, setAsgnKind, setContSortOrder, setOwner`

Method Detail

getFlowDocumentValue

String getFlowDocumentValue()
                            throws InoNetException,
                                   SrvErrorException

The formatted value of the connected text.

Throws:: InoNetException; SrvErrorException

getFlowExpandedValue

String getFlowExpandedValue()
                            throws InoNetException,
                                   SrvErrorException

Returns the formatted value where all fill-ins are expanded.

Throws:: InoNetException; SrvErrorException

getName

String getName()
               throws InoNetException,
                      SrvErrorException

Returns the name of the text.

Throws:: InoNetException; SrvErrorException

getStringValue

String getStringValue()
                      throws InoNetException,
                             SrvErrorException

The string value of the connected text.

Throws:: InoNetException; SrvErrorException

getText

MMText getText()
               throws InoNetException,
                      SrvErrorException

Text of the value.

Throws:: InoNetException; SrvErrorException

getTextAble

MMTextAble getTextAble()
                       throws InoNetException,
                              SrvErrorException

The element that owns this text value.

Throws:: InoNetException; SrvErrorException

getTextExpandedValue

String getTextExpandedValue()
                            throws InoNetException,
                                   SrvErrorException

Returns the text value where all fill-ins are expanded.

Throws:: InoNetException; SrvErrorException

getTextStringValue

String getTextStringValue(MMText refObj,
                          String pattern)
                          throws InoNetException,
                                 SrvErrorException

Returns the displayed text value of the current object given by argument pattern or argument refObj.

Parameters:: refObj - A further instance of type MMText which is used to control the behaviour of the method. (see description above) This parameter is optional. (Its value can be given as null.); pattern - A string pattern. This parameter is optional. (Its value can be given as null.)
Throws:: InoNetException; SrvErrorException

setFlowDocumentValue

void setFlowDocumentValue(String value)
                          throws InoNetException,
                                 SrvErrorException

Set the value of Attribut FlowDocumentValue.

Parameters:: value - The value to be set.
Throws:: InoNetException; SrvErrorException

setStringValue

void setStringValue(String value)
                    throws InoNetException,
                           SrvErrorException

Set the value of Attribut StringValue.

Parameters:: value - The value to be set.
Throws:: InoNetException; SrvErrorException

setTextStringValue

void setTextStringValue(String value)
                        throws InoNetException,
                               SrvErrorException

Set the value of Info TextStringValue.

Parameters:: value - The value to be set.
Throws:: InoNetException; SrvErrorException