Package de.mid.innovator.srv2api.icw2im

Interface IMSequence

All Superinterfaces:

ADAccessAble, ADClientAble, ADFindAble, ADHistoryAble, ADLockAble, ADM2AttrModifyAble, ADOptionAble, ADReferenceAble, ADVersionAble, ELClassifier, ELContainerAble, ELContAsgnAble, ELDeleteAble, ELElement, ELNamedElement, ELNamespaceAble, ELNamespaceAsgnAble, ELObject, ELPackageAble, ELRedefAble, ELType, ELTypedElement, ELUUIDAble, ELValueContainerAble, IMClassifier, IMDataType, IMSemanticDataType, MECommentAble, MEConstraintAble, MEModelElement, MENamedElement, MENamespaceAsgnAble, MEPackageAble, MEStereotypeAble, METermAble, MMAttachmentAble, MMCommentContainerAble, MMLabelAble, MMLabelTextAttachmentAble, MMStereotypeAble, MMTextAble

public interface IMSequence
extends IMSemanticDataType

Subclass of IMSemanticDataType with automatic unique value.

See Also:

• IMSequenceHelper

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static enum	IMSequence.VAttr

Method Summary

Modifier and Type	Method	Description
String	getCache()	Specify the cache value the sequence preallocates and keeps in memory for faster access.
boolean	getCycleOption()	If true, it indicates that the sequence continues to generate values after reaching either its maximum or minimum value.
IMSemanticDataType	getForeignKeyType()	Returns the IMSemanticDataType used in a referencing foreign key for this IMSequence in the primary key.
K_IMSEQUENCE	getGenerationType()	It indicates if this sequence will be generated always or by default.
String	getIncrement()	Specify the interval between sequence numbers.
String	getMaximum()	Specify the maximum value the sequence can generate.
String	getMinimum()	Specify the minimum value the sequence can generate.
boolean	getOrderOption()	If true, the sequence guarantees that sequence numbers are generated in order of request.
String	getStartValue()	Specify the first sequence number to be generated.
void	setCache(String value)	Set the value of Attribut Cache.
void	setCycleOption(boolean value)	Set the value of Attribut CycleOption.
void	setForeignKeyType(IMSemanticDataType value)	Set the value of Foreign Key ForeignKeyType.
void	setGenerationType(K_IMSEQUENCE value)	Set the value of Attribut GenerationType.
void	setIncrement(String value)	Set the value of Attribut Increment.
void	setMaximum(String value)	Set the value of Attribut Maximum.
void	setMinimum(String value)	Set the value of Attribut Minimum.
void	setOrderOption(boolean value)	Set the value of Attribut OrderOption.
void	setStartValue(String value)	Set the value of Attribut StartValue.

Methods inherited from interface de.mid.innovator.srv2api.icw2meta.ADAccessAble

getAccessRole, getReadRole, hasAccess, setAccessRole, setReadRole

Methods inherited from interface de.mid.innovator.srv2api.icw2meta.ADClientAble

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

Methods inherited from interface de.mid.innovator.srv2api.icw2meta.ADHistoryAble

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

Methods inherited from interface de.mid.innovator.srv2api.icw2meta.ADLockAble

getLock, getLockableCache, getLockLogin, getLockName, hasClutch, hasLock, hasNoLock, hasOthLock, hasOwnLock, isLockable, lock, unlock

Methods inherited from interface de.mid.innovator.srv2api.icw2meta.ADM2AttrModifyAble

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

Methods inherited from interface de.mid.innovator.srv2api.icw2meta.ADOptionAble

getOwnedOption, modifyOptionDlg

Methods inherited from interface de.mid.innovator.srv2api.icw2meta.ADReferenceAble

getReferenceContainer, setReferenceContainer

Methods inherited from interface de.mid.innovator.srv2api.icw2meta.ADVersionAble

getVersionFile, getVersionList, getVersionListWithoutOpenInfo

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

getAssociation, getAssociation, getAssociationEndFirstTypedBySelf, getAssociationEndFirstTypedBySelf, getAssociationEndNavigableTypedBySelf, getAssociationEndNavigableTypedBySelf, getAssociationEndNavigableTypedBySelfOrGeneralTransitive, getAssociationEndNavigableTypedBySelfOrGeneralTransitive, getAssociationEndTypedBySelf, getAssociationEndTypedBySelf, getAssociationEndTypedBySelfOrGeneralTransitive, getAssociationEndTypedBySelfOrGeneralTransitive, getAssociationNavigableFrom, getAssociationNavigableFrom, getAssociationOfSelfOrGeneralTransitive, getAssociationOfSelfOrGeneralTransitive, getAssociationTypedBySelf, getAssociationTypedBySelf, getClassifierViewGroup, getEffectiveRedefinerOfAssocEnd, getEffectiveRedefinerOfAssocEnd, getEffectiveSubsetterOfAssocEnd, getEffectiveSubsetterOfAssocEnd, getGeneralDirect, getGeneralDirect, getGeneralGeneralizationSet, getGeneralGeneralizationSet, getGeneralization, getGeneralTransitive, getGeneralTransitive, getItemDefinition, getOwnedAndInheritedMember, getOwnedAndInheritedMember, getPropertyNavigableFrom, getPropertyNavigableFrom, getPropertyNavigableFromSelfOrGeneralTransitive, getPropertyNavigableFromSelfOrGeneralTransitive, getSelfAndGeneralTransitive, getSelfAndGeneralTransitive, getSelfAndSpecificTransitive, getSelfAndSpecificTransitive, getSelfAndSpecificTransitiveNotAbstract, getSelfAndSpecificTransitiveNotAbstract, getSpecialization, getSpecificDirect, getSpecificDirect, getSpecificGeneralization, getSpecificGeneralizationSet, getSpecificGeneralizationSet, getSpecificTransitive, getSpecificTransitive, getSpecificTransitiveNotAbstract, getSpecificTransitiveNotAbstract, getSpecificTransitiveNotAbstractRange, getSpecificTransitiveNotAbstractRange, getSpecificTransitiveNotAbstractTypesOfEffectiveSubsetterOfAssocEnd, getSpecificTransitiveNotAbstractTypesOfEffectiveSubsetterOfAssocEnd, getSpecificTransitiveNotAbstractTypesOfEffectiveSubsetterOfAssocEndIntersectedByInverseAssocEnd, getSpecificTransitiveNotAbstractTypesOfEffectiveSubsetterOfAssocEndIntersectedByInverseAssocEnd, getTypedCLStructureEntry, getTypedMaskField, getTypesOfEffectiveSubsetterOfAssocEnd, getTypesOfEffectiveSubsetterOfAssocEnd, getViewTransitive, getViewTransitive, isAbstract, isRoot, isSpecificTransitive, setAbstract

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

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

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

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

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, getNotificationElement, getQualifiedNamespaceName, getRelshipBinDir, getRelshipBinDir, getRelshipBinDirTarget, getUnitToLock, getValSpecElement, isContainedInProfile, isUnresolved, lockUnit, setUnresolved, unlockUnit

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

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

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

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

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

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

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.ELPackageAble

getElementImportingNamespace, getElementImportingNamespace, getImportedPackageAble, getOwningPackage

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

getRedefined, getRedefining, isLeaf, isRedefined, isRedefining, setLeaf, setRedefined

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

getRaisingAsException, getTypedElement, getTypedElementNotAssocEnd, getTypedElementNotAssocEnd, isTypeReuseable

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

getModifyTypedElementDeclaration, getType, getTypedElementCnstr, getTypeKind, getValSpecOfTypedElement, getValSpecOfTypedElementWithPattern, getValSpecOfTypedElementWithPattern, isBitmapAble, isColorAble, modifyTypedElementDeclaration, setType

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

getHyperlinkReferenceAble, getInnoRef, getNotToTranslateAttribute, getTranslatedValue, getUUID, setUUID

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

getValueReUseAble, setValueReUseAble

Methods inherited from interface de.mid.innovator.srv2api.icw2im.IMClassifier

getAllAssignedConstraint, getAllAssignedConstraint, getDirectlyCheckConstraintAssign, getForeignKeyReferencingOwnedUniqueKey, getForeignKeyReferencingOwnedUniqueKey, getImplementation, getOwnedFeature, getOwnedGeneralizationSet, getOwnedIMConstraint, getOwnedIMTrigger, getOwnedKey, getOwnedProperty, getPrimaryKey, getUniqueKeyReferencedByDefault, setImplementation

Methods inherited from interface de.mid.innovator.srv2api.icw2im.IMDataType

getTypedIMProperty

Methods inherited from interface de.mid.innovator.srv2api.icw2im.IMSemanticDataType

getConcreteFirstMasterParameter, getConcreteSecondMasterParameter, getOwnedDBCheckConstraint, getOwnedERConstraint, getOwnedTypeDefinition, getPrimaryKeySequence, getSameTypedSemanticDataTypes, getSameTypedSemanticDataTypes, getTypeClassName, getTypedBySemanticAttribute, getTypedBySemanticColumn, getTypedBySemanticProperty, getTypingDataTypeDefinition, getTypingTSType, merge, setConcreteFirstMasterParameter, setConcreteSecondMasterParameter, setTypingTSType, typeMapping

Methods inherited from interface de.mid.innovator.srv2api.icw2model.MECommentAble

getAssignedComment, getAssignedComment, getCommentAssign

Methods inherited from interface de.mid.innovator.srv2api.icw2model.MEConstraintAble

getAssignedConstraint, getAssignedConstraint, getConstraintAssign

Methods inherited from interface de.mid.innovator.srv2api.icw2model.MEModelElement

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

Methods inherited from interface de.mid.innovator.srv2api.icw2model.MENamedElement

getMappingSourceElement, getMappingSourceElement, getMESupplierDependency, getMESupplierMappingDependency

Methods inherited from interface de.mid.innovator.srv2api.icw2model.MENamespaceAsgnAble

getMENamespace, getSignatureMessage

Methods inherited from interface de.mid.innovator.srv2api.icw2model.MEPackageAble

getComponent, getManifest

Methods inherited from interface de.mid.innovator.srv2api.icw2model.MEStereotypeAble

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

Methods inherited from interface de.mid.innovator.srv2api.icw2model.METermAble

getTerm, setTerm

Methods inherited from interface de.mid.innovator.srv2api.icw2meta.MMAttachmentAble

getAssignedAttachment, getAttachmentAssign, getDefaultAttachment, getOwnedAttachment, setDefaultAttachment

Methods inherited from interface de.mid.innovator.srv2api.icw2meta.MMCommentContainerAble

getOutgoingConceptRealization, getOwnedComment, getRealizedConcept, getRealizedConcept, replaceRealizedConcepts, setRealizedConcept

Methods inherited from interface de.mid.innovator.srv2api.icw2meta.MMLabelAble

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

Methods inherited from interface de.mid.innovator.srv2api.icw2meta.MMStereotypeAble

assignStereotypeDlg, cloneElement, completelySynchronizeOthers, completelySynchronizeThis, getAttrCnstrEffective, getCreateTemplate, getDisplayType, 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, setStereotype, setStereotypePropertyInfo, setStereotypeTSOptionInfo, setSyncedStereotypeAble

Methods inherited from interface de.mid.innovator.srv2api.icw2meta.MMTextAble

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

Method Details

getGenerationType

K_IMSEQUENCE getGenerationType()
                        throws InoNetException,
SrvErrorException

It indicates if this sequence will be generated always or by default.

Throws:

InoNetException

SrvErrorException

setGenerationType

void setGenerationType(K_IMSEQUENCE value)
                throws InoNetException,
SrvErrorException

Set the value of Attribut GenerationType.

Parameters:

value - The value to be set.

Throws:

InoNetException

SrvErrorException

getStartValue

String getStartValue()
              throws InoNetException,
SrvErrorException

Specify the first sequence number to be generated. Use this clause to start an ascending sequence at a value greater than its minimum or to start a descending sequence at a value less than its maximum. For ascending sequences, the default value is the minimum value of the sequence. For descending sequences, the default value is the maximum value of the sequence. Usually it is an integer value, but if empty, the sequence uses the system default.

Throws:

InoNetException

SrvErrorException

setStartValue

void setStartValue(String value)
            throws InoNetException,
SrvErrorException

Set the value of Attribut StartValue.

Parameters:

value - The value to be set.

Throws:

InoNetException

SrvErrorException

getIncrement

String getIncrement()
             throws InoNetException,
SrvErrorException

Specify the interval between sequence numbers. This integer value can be any positive or negative integer, but it cannot be 0. The absolute of this value must be less than the difference of maximum and minimum. If this value is negative, then the sequence descends. If the value is positive, then the sequence ascends. Usually it is an integer value, but if empty, the sequence uses the system default.

Throws:

InoNetException

SrvErrorException

setIncrement

void setIncrement(String value)
           throws InoNetException,
SrvErrorException

Set the value of Attribut Increment.

Parameters:

value - The value to be set.

Throws:

InoNetException

SrvErrorException

getMinimum

String getMinimum()
           throws InoNetException,
SrvErrorException

Specify the minimum value the sequence can generate. Usually an integer, but if empty, the sequence uses the system default.

Throws:

InoNetException

SrvErrorException

setMinimum

void setMinimum(String value)
         throws InoNetException,
SrvErrorException

Set the value of Attribut Minimum.

Parameters:

value - The value to be set.

Throws:

InoNetException

SrvErrorException

getMaximum

String getMaximum()
           throws InoNetException,
SrvErrorException

Specify the maximum value the sequence can generate. Usually an integer, but if empty, the sequence uses the system default.

Throws:

InoNetException

SrvErrorException

setMaximum

void setMaximum(String value)
         throws InoNetException,
SrvErrorException

Set the value of Attribut Maximum.

Parameters:

value - The value to be set.

Throws:

InoNetException

SrvErrorException

getCycleOption

boolean getCycleOption()
                throws InoNetException,
SrvErrorException

If true, it indicates that the sequence continues to generate values after reaching either its maximum or minimum value. After an ascending sequence reaches its maximum value, it generates its minimum value. After a descending sequence reaches its minimum, it generates its maximum value.

Throws:

InoNetException

SrvErrorException

setCycleOption

void setCycleOption(boolean value)
             throws InoNetException,
SrvErrorException

Set the value of Attribut CycleOption.

Parameters:

value - The value to be set.

Throws:

InoNetException

SrvErrorException

getOrderOption

boolean getOrderOption()
                throws InoNetException,
SrvErrorException

If true, the sequence guarantees that sequence numbers are generated in order of request. This clause is useful if you are using the sequence numbers as timestamps. Guaranteeing order is usually not important for sequences used to generate primary keys.

Throws:

InoNetException

SrvErrorException

setOrderOption

void setOrderOption(boolean value)
             throws InoNetException,
SrvErrorException

Set the value of Attribut OrderOption.

Parameters:

value - The value to be set.

Throws:

InoNetException

SrvErrorException

getCache

String getCache()
         throws InoNetException,
SrvErrorException

Specify the cache value the sequence preallocates and keeps in memory for faster access. Usually an integer, but if empty, the sequence uses no cache.

Throws:

InoNetException

SrvErrorException

setCache

void setCache(String value)
       throws InoNetException,
SrvErrorException

Set the value of Attribut Cache.

Parameters:

value - The value to be set.

Throws:

InoNetException

SrvErrorException

getForeignKeyType

IMSemanticDataType getForeignKeyType()
                              throws InoNetException,
SrvErrorException

Returns the IMSemanticDataType used in a referencing foreign key for this IMSequence in the primary key.

Throws:

InoNetException

SrvErrorException

setForeignKeyType

void setForeignKeyType(IMSemanticDataType value)
                throws InoNetException,
SrvErrorException

Set the value of Foreign Key ForeignKeyType.

Parameters:

value - The value to be set.

Throws:

InoNetException

SrvErrorException