Interface IMViewFrom

All Superinterfaces:

ADClientAble, ADFindAble, ADHistoryAble, ADM2AttrModifyAble, ELContainerAble, ELContAsgnAble, ELDeleteAble, ELElement, ELMultiplicityAble, ELNamedElement, ELNamespaceAble, ELNamespaceAsgnAble, ELObject, ELUUIDAble, ELValueContainerAble, ELViewElement, ELViewGroup, ELViewGroupAble, IMViewElement, MECommentAble, MEModelElement, MENamedElement, MENamespaceAsgnAble, MEStereotypeAble, METermAble, MMAttachmentAble, MMCommentContainerAble, MMLabelAble, MMLabelTextAttachmentAble, MMStereotypeAble, MMTextAble

All Known Subinterfaces:

DBViewFrom, DBViewSubselectFrom, ERViewFrom, ERViewSubselectFrom, IMViewSubselectFrom

public interface IMViewFrom
extends MEStereotypeAble, MECommentAble, MENamespaceAsgnAble, ELViewGroup, IMViewElement, MMLabelTextAttachmentAble

This is a utility class for IMViewFrom that provides static methods for creation or other purposes.

Note:

The interface IMViewFrom describes an abstract ability of an object. Therefore no instances of this type can be found in the repository!

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static enum	IMViewFrom.VAttr

Method Summary

Modifier and Type	Method	Description
K_FROM_KIND	getFromKind()	Kind of this IMViewFrom.
K_JOIN_KIND	getJoinKind()	Kind of this Join.
IMKeyRelationship	getKeyRelationship()	The IMKeyRelationship used by this IMViewFrom.
<T extends IMProperty> List<T>	getPropertySetProperty(Class<T> returnType, K_CONTROL_OPTION... behaviourFlags)	List of all properties owned by the referenced IMClassifier of this IMViewFrom.
<T extends IMProperty> List<T>	getPropertySetProperty(Class<T> returnType, MMStereotype stereotype, K_CONTROL_OPTION... behaviourFlags)	The method calls getPropertySetProperty and filters its return values according to the given stereotype value.
String	getUdfParameterValues()	Values for input parameters in a call to a user-defined function as a comma-separated character string.
List<MEStereotypeAble>	maintain()	Runs all maintaining methods for this IMViewFrom in the following order: maintainJoinPartner(...) maintainJoinExpression(...)
void	maintainJoinExpression()	This maintaining method sets the join expression for the assigned IMKeyRelationship.
IMViewFrom	maintainJoinPartner()	If the previous IMViewFrom of this from clause is not referencing the correct partner of the assigned IMKeyRelationship an appropriate from clause will be created.
void	setFromKind(K_FROM_KIND value)	Set the value of Info FromKind.
void	setJoinKind(K_JOIN_KIND value)	Set the value of Attribut JoinKind.
void	setKeyRelationship(IMKeyRelationship value)	Set the value of Foreign Key KeyRelationship.
void	setUdfParameterValues(String value)	Set the value of Attribut UdfParameterValues.

Methods inherited from interface ADClientAble

getAnnotation, getEndAnalysisDia, getLogic, getLogic, getPresentationContext, getSection, getStartAnalysisDia

Methods inherited from interface ADHistoryAble

getCreateTime, getCreator, getHistory, getModifier, getModifyTime, modifyHistory, setHistory

Methods inherited from interface ADM2AttrModifyAble

getTabCell, getTabCellObjectList, getTabCreateTemplate, getTabCreateTemplateObjectList, getTabElement, getTabElementRelshipTypeList, getTabElementRowList, getTabElementRowTypeList, getTabRelshipList, getTabRowList, tabCellModify, tabCreateTemplate, tabElementModify

Methods inherited from interface ELContainerAble

getClientDependency, getOwnedElement, getOwnedElementTransitiveDown, getOwnedElementTransitiveDown, getOwnedElementTransitiveDownAndUnresolved, getOwnedElementTransitiveDownAndUnresolved, getOwnedOrReferencedElementTransitiveDown, getOwnedOrReferencedElementTransitiveDown, getOwnedRelshipBinDirWithTarget, getOwnedRelshipBinDirWithTarget, getRedirectedModelContainer, getRelshipBinDirSource, getSelfAndOwnedElementTransitiveDown, getSelfAndOwnedElementTransitiveDown, getSortedContents, sortContents

Methods inherited from interface ELContAsgnAble

getAsgnKind, getContSortOrder, getFirstOwnerWhichIsConformTo, getOwner, getOwnerTransitive, getOwnerTransitive, getSelfAndOwnerTransitive, getSelfAndOwnerTransitive, getVersionRoot, isTransitiveChildOf, setAsgnKind, setContSortOrder, setOwner

Methods inherited from interface ELDeleteAble

delete

Methods inherited from interface ELElement

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

Methods inherited from interface ELMultiplicityAble

getLower, getLowerBoundAsString, getLowerUpperVal, getUpper, getUpperBoundAsString, hasMultiplicity11, hasUpper1, isMany, isMultivalued, isOptional, isOrdered, isUnique, setLower, setMany, setOptional, setOrdered, setUnique, setUpper

Methods inherited from interface ELNamedElement

getName, getNameKind, getQualifiedDisplayName, getQualifiedName, getQualifiedTLName, getSupplierDependency, rename, setName, setNameKind

Methods inherited from interface ELNamespaceAble

getElementImport, getImportedElement, getImportedElement, getImportedPackage, getImportedPackage, getItemDefinition, getMember, getMember, getMemberByPattern, getMemberByPattern, getOwnedConstraint, getOwnedMember, getOwnedMemberByPath, getOwnedMemberByPattern, getOwnedMemberByPattern, getOwnedMemberTransitiveByPattern, getOwnedMemberTransitiveByPattern, getOwnedMemberTransitiveByPatternIgnoreCase, getOwnedMemberTransitiveByPatternIgnoreCase, getPackageImport

Methods inherited from interface ELNamespaceAsgnAble

getMnClassicTREFName, getNamespace, getNamespaceName, getPath, getSeparator, getVisibility, setUniqueName, setVisibility

Methods inherited from interface ELObject

getId, getLongId, getMetaClass, getMetaName, getOclClass, getSrvCon, hasRead

Methods inherited from interface ELUUIDAble

getHyperlinkReferenceAble, getInnoRef, getNotToTranslateAttribute, getTranslatedValue, getUUID, setUUID

Methods inherited from interface ELValueContainerAble

getValueReUseAble, setValueReUseAble

Methods inherited from interface ELViewElement

getConcreteExpression, getConcreteExpressionQuoted, getEnvironmentView, getExprFlowText, getExprInnoRefText, getExprText, getModifyViewExpressionFlow, getUsedFeature, modifyViewExpressionFlow, setConcreteExpression, setExprFlowText, setExprInnoRefText, setUsedFeature

Methods inherited from interface ELViewGroup

getOwningViewGroupAble, getViewGroupNavigAble, isHidden, setHidden, setViewGroupNavigAble

Methods inherited from interface ELViewGroupAble

getFeatureNotUsedByEntry, getFeatureNotUsedByEntry, getFeatureUsedByEntry, getFeatureUsedByEntry, getGroupType, getOwnedViewEntry, getOwnedViewGroup, getViewGroupClassifier, getXSDElemType, setGroupType, setViewGroupClassifier, setXSDElemType

Methods inherited from interface MECommentAble

getAssignedComment, getAssignedComment, getCommentAssign

Methods inherited from interface MEModelElement

buildProxyConnection, getActivityPartition, getConsider, getContentStereotypeByClass, getCreateTemplateByClass, getDataModel, getDataModelName, getElementColor, getFirstValidContentStereotype, getIgnore, getKnownTypeSystems, getMEModelName, getModelElement, getModelElement, getPresContext, getPresContext, getPresetMapping, getPRPresContent, setElementColor

Methods inherited from interface MENamedElement

getMappingSourceElement, getMappingSourceElement, getMESupplierDependency, getMESupplierMappingDependency

Methods inherited from interface MENamespaceAsgnAble

getSignatureMessage

Methods inherited from interface MEStereotypeAble

getClientMappingDependency, getDecisionMade, getDecisionOwned, getKnowledgeSourceOfOwner, getMappingTargetElement, getMappingTargetElement, getMEClientDependency, getProxyAsgProperty, getRepresentingArtifact, getRequirementOfStakeholder, getRequirementOfStakeholderOwner, isMapped, setMapped, setRequirementOfStakeholder

Methods inherited from interface METermAble

getTerm, setTerm

Methods inherited from interface MMAttachmentAble

getAssignedAttachment, getAttachmentAssign, getDefaultAttachment, getOwnedAttachment, setDefaultAttachment

Methods inherited from interface MMCommentContainerAble

getOutgoingConceptRealization, getOwnedComment, getRealizedConcept, getRealizedConcept, replaceRealizedConcepts, setRealizedConcept

Methods inherited from interface MMLabelAble

getLabel, getLabelBoolValue, getLabelColor, getLabelInfo, getLabelLongValue, getLabelNameValue, getLabelStringValue, getLabelValueByPattern, getLabelValueByPattern, getLabelValueList, getOwnedLabelValSpec, hasLabel, modifyLabelValuesByName, setLabelInfo

Methods inherited from interface MMStereotypeAble

assignStereotypeDlg, cloneElement, completelySynchronizeOthers, completelySynchronizeThis, getAttrCnstrEffective, getCreateTemplate, getDisplayType, getExtendingStereotype, getExtendingStereotypeNames, getOwnedFormat, getOwnedStereotypePropertyValSpec, getOwnedStereotypeTSOptionValSpec, getOwnedSyncedElement, getPropBoolValue, getPropLongValue, getPropStringValue, getPropValueList, getStereoPropValueByPattern, getStereoPropValueByPattern, getStereotype, getStereotypeName, getStereotypeProperty, getStereotypePropertyInfo, getStereotypePropertyNameValue, getStereotypeTSOption, getStereotypeTSOptionBoolValue, getStereotypeTSOptionInfo, getStereotypeTSOptionLongValue, getStereotypeTSOptionNameValue, getStereotypeTSOptionStringValue, getStereotypeTSOptionValueByPattern, getStereotypeTSOptionValueByPattern, getStereotypeTSOptionValueList, getSyncedElement, getSyncedStereotypeAble, getSyncedStereotypeAble, isCloneAbleElement, modifyStereotypePropertyValuesByName, modifyStereotypeTSOptionValuesByName, setExtendingStereotype, setStereotype, setStereotypePropertyInfo, setStereotypeTSOptionInfo, setSyncedStereotypeAble

Methods inherited from interface MMTextAble

getFlowExpandedValue, getModifyFlowDocuments, getModifyTextValues, getModifyTextValuesDlgInit, getOwnedTextValue, getOwnedTextValueByPattern, getText, getTextExpandedValue, getTextStringValue, getURIList, modifyFlowDocuments, modifyTextValuesDlg

Method Details

getJoinKind

K_JOIN_KIND getJoinKind()
                 throws InoNetException,
SrvErrorException

Kind of this Join.

Throws:

InoNetException

SrvErrorException

setJoinKind

void setJoinKind(K_JOIN_KIND value)
          throws InoNetException,
SrvErrorException

Set the value of Attribut JoinKind.

Parameters:

value - The value to be set.

Throws:

InoNetException

SrvErrorException

getUdfParameterValues

String getUdfParameterValues()
                      throws InoNetException,
SrvErrorException

Values for input parameters in a call to a user-defined function as a comma-separated character string.

Throws:

InoNetException

SrvErrorException

setUdfParameterValues

void setUdfParameterValues(String value)
                    throws InoNetException,
SrvErrorException

Set the value of Attribut UdfParameterValues.

Parameters:

value - The value to be set.

Throws:

InoNetException

SrvErrorException

getFromKind

K_FROM_KIND getFromKind()
                 throws InoNetException,
SrvErrorException

Kind of this IMViewFrom.

Throws:

InoNetException

SrvErrorException

setFromKind

void setFromKind(K_FROM_KIND value)
          throws InoNetException,
SrvErrorException

Set the value of Info FromKind.

Parameters:

value - The value to be set.

Throws:

InoNetException

SrvErrorException

getPropertySetProperty

<T extends IMProperty> List<T> getPropertySetProperty(Class<T> returnType,
 K_CONTROL_OPTION... behaviourFlags)
                                               throws InoNetException,
SrvErrorException

List of all properties owned by the referenced IMClassifier of this IMViewFrom.

Parameters:

returnType - Specifies the type of elements to be returned.

behaviourFlags - An optional list of enum values to control the behaviour of the command.

Throws:

InoNetException

SrvErrorException

Sorted:

the result may be sorted as the property in the referenced classifier.

getPropertySetProperty

<T extends IMProperty> List<T> getPropertySetProperty(Class<T> returnType,
 MMStereotype stereotype,
 K_CONTROL_OPTION... behaviourFlags)
                                               throws InoNetException,
SrvErrorException

The method calls getPropertySetProperty and filters its return values according to the given stereotype value.

Parameters:

returnType - Specifies the type of elements to be returned.

stereotype - The stereotype used to filter the result list

behaviourFlags - An optional list of enum values to control the behaviour of the command.

Throws:

InoNetException

SrvErrorException

maintain

List<MEStereotypeAble> maintain()
                         throws InoNetException,
SrvErrorException

Runs all maintaining methods for this IMViewFrom in the following order:
maintainJoinPartner(...) maintainJoinExpression(...)

Throws:

InoNetException

SrvErrorException

maintainJoinExpression

void maintainJoinExpression()
                     throws InoNetException,
SrvErrorException

This maintaining method sets the join expression for the assigned IMKeyRelationship.

Throws:

InoNetException

SrvErrorException

maintainJoinPartner

IMViewFrom maintainJoinPartner()
                        throws InoNetException,
SrvErrorException

If the previous IMViewFrom of this from clause is not referencing the correct partner of the assigned IMKeyRelationship an appropriate from clause will be created.

Throws:

InoNetException

SrvErrorException

getKeyRelationship

IMKeyRelationship getKeyRelationship()
                              throws InoNetException,
SrvErrorException

The IMKeyRelationship used by this IMViewFrom.

Throws:

InoNetException

SrvErrorException

setKeyRelationship

void setKeyRelationship(IMKeyRelationship value)
                 throws InoNetException,
SrvErrorException

Set the value of Foreign Key KeyRelationship.

Parameters:

value - The value to be set.

Throws:

InoNetException

SrvErrorException