SDOKey (Plasma Profile 1.3.3 API)

java.lang.Object
- org.modeldriven.fuml.FumlObject
- - fUML.Syntax.Classes.Kernel.Element
  - - fUML.Syntax.Classes.Kernel.NamedElement
    - - fUML.Syntax.Classes.Kernel.PackageableElement
      - fUML.Syntax.Classes.Kernel.Namespace
        
        fUML.Syntax.Classes.Kernel.Type
        
        fUML.Syntax.Classes.Kernel.Classifier
        
        fUML.Syntax.CommonBehaviors.BasicBehaviors.BehavioredClassifier
        
        fUML.Syntax.Classes.Kernel.Class_
        
        org.modeldriven.fuml.repository.ext.Stereotype
        
        org.plasma.sdo.profile.SDOKey

All Implemented Interfaces:

Key
```
public class SDOKey
extends org.modeldriven.fuml.repository.ext.Stereotype
implements Key
```
This stereotype tags or annotates a UML property as representing some type of key within a data store, data transfer or transient storage medium.

Version:

1.3.3

Author:

Plasma-Team

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`AUTO` Whether the key is created and assigned automatically
`static String`	`BASE__PROPERTY`
`static String`	`GROUP` The key set or constraint name
`static String`	`SEQUENCE` The position or ordering of a key within a group
`static String`	`STRUCTURE` Specifies the structure of key
`static String`	`SUPPLIER` Links a property element which supplies the actual data for the key where multiple possible targets exist.
`static String`	`TYPE` Specifies the type of key

Fields inherited from class fUML.Syntax.Classes.Kernel.Class_
isActive, isID, nestedClassifier, ownedAttribute, ownedOperation, ownedReception, superClass

Fields inherited from class fUML.Syntax.CommonBehaviors.BasicBehaviors.BehavioredClassifier
classifierBehavior, ownedBehavior

Fields inherited from class fUML.Syntax.Classes.Kernel.Classifier
attribute, feature, general, generalization, inheritedMember, isAbstract, isFinalSpecialization

Fields inherited from class fUML.Syntax.Classes.Kernel.Type
package_

Fields inherited from class fUML.Syntax.Classes.Kernel.Namespace
elementImport, importedMember, member, ownedMember, packageImport

Fields inherited from class fUML.Syntax.Classes.Kernel.NamedElement
name, namespace, qualifiedName, visibility

Fields inherited from class fUML.Syntax.Classes.Kernel.Element
ownedComment, ownedElement, owner

Constructor Summary

Constructors
Constructor and Description

SDOKey()

Constructors
Constructor and Description
`SDOKey()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Boolean`	`getAuto()`
`fUML.Syntax.Classes.Kernel.Property`	`getBase_Property()`
`String`	`getGroup()`
`Integer`	`getSequence()`
`KeyStructure`	`getStructure()`
`fUML.Syntax.Classes.Kernel.NamedElement`	`getSupplier()`
`KeyType`	`getType()`
`void`	`setAuto(Boolean value)`
`void`	`setBase_Property(fUML.Syntax.Classes.Kernel.Property value)`
`void`	`setGroup(String value)`
`void`	`setSequence(Integer value)`
`void`	`setStructure(KeyStructure value)`
`void`	`setSupplier(fUML.Syntax.Classes.Kernel.NamedElement value)`
`void`	`setType(KeyType value)`

Methods inherited from class fUML.Syntax.Classes.Kernel.Class_
addGeneralization, addNestedClassifier, addOwnedAttribute, addOwnedOperation, addOwnedReception, inherit, setIsActive

Methods inherited from class fUML.Syntax.CommonBehaviors.BasicBehaviors.BehavioredClassifier
addOwnedBehavior, setClassifierBehavior

Methods inherited from class fUML.Syntax.Classes.Kernel.Classifier
addAttribute, addFeature, hasVisibilityOf, inheritableMembers, setIsAbstract, setIsFinalSpecialization

Methods inherited from class fUML.Syntax.Classes.Kernel.Type
_setPackage

Methods inherited from class fUML.Syntax.Classes.Kernel.Namespace
addElementImport, addMember, addOwnedMember, addPackageImport

Methods inherited from class fUML.Syntax.Classes.Kernel.NamedElement
_setNamespace, setName, setVisibility

Methods inherited from class fUML.Syntax.Classes.Kernel.Element
addOwnedElement

Methods inherited from class org.modeldriven.fuml.FumlObject
getHref, getXmiId, getXmiNamespace, setHref, setXmiId, setXmiNamespace

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - TYPE
```
public static final String TYPE
```
    Specifies the type of key
    
    See Also:
    
    Constant Field Values
  - BASE__PROPERTY
```
public static final String BASE__PROPERTY
```
    See Also:
    
    Constant Field Values
  - SUPPLIER
```
public static final String SUPPLIER
```
    Links a property element which supplies the actual data for the key where multiple possible targets exist. Where a key property is a reference SDO property and the target entity has multiple primary keys, the supplier is used by services to disambiguate which target key actually supplies the data.
    
    See Also:
    
    Constant Field Values
  - GROUP
```
public static final String GROUP
```
    The key set or constraint name
    
    See Also:
    
    Constant Field Values
  - SEQUENCE
```
public static final String SEQUENCE
```
    The position or ordering of a key within a group
    
    See Also:
    
    Constant Field Values
  - AUTO
```
public static final String AUTO
```
    Whether the key is created and assigned automatically
    
    See Also:
    
    Constant Field Values
  - STRUCTURE
```
public static final String STRUCTURE
```
    Specifies the structure of key
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - SDOKey
```
public SDOKey()
```
- Method Detail
  - getType
```
public KeyType getType()
```
    Specified by:
    
    getType in interface Key
  - setType
```
public void setType(KeyType value)
```
    Specified by:
    
    setType in interface Key
  - getBase_Property
```
public fUML.Syntax.Classes.Kernel.Property getBase_Property()
```
    Specified by:
    
    getBase_Property in interface Key
  - setBase_Property
```
public void setBase_Property(fUML.Syntax.Classes.Kernel.Property value)
```
    Specified by:
    
    setBase_Property in interface Key
  - getSupplier
```
public fUML.Syntax.Classes.Kernel.NamedElement getSupplier()
```
    Specified by:
    
    getSupplier in interface Key
  - setSupplier
```
public void setSupplier(fUML.Syntax.Classes.Kernel.NamedElement value)
```
    Specified by:
    
    setSupplier in interface Key
  - getGroup
```
public String getGroup()
```
    Specified by:
    
    getGroup in interface Key
  - setGroup
```
public void setGroup(String value)
```
    Specified by:
    
    setGroup in interface Key
  - getSequence
```
public Integer getSequence()
```
    Specified by:
    
    getSequence in interface Key
  - setSequence
```
public void setSequence(Integer value)
```
    Specified by:
    
    setSequence in interface Key
  - getAuto
```
public Boolean getAuto()
```
    Specified by:
    
    getAuto in interface Key
  - setAuto
```
public void setAuto(Boolean value)
```
    Specified by:
    
    setAuto in interface Key
  - getStructure
```
public KeyStructure getStructure()
```
    Specified by:
    
    getStructure in interface Key
  - setStructure
```
public void setStructure(KeyStructure value)
```
    Specified by:
    
    setStructure in interface Key

Class SDOKey

Field Summary

Fields inherited from class fUML.Syntax.Classes.Kernel.Class_

Fields inherited from class fUML.Syntax.CommonBehaviors.BasicBehaviors.BehavioredClassifier

Fields inherited from class fUML.Syntax.Classes.Kernel.Classifier

Fields inherited from class fUML.Syntax.Classes.Kernel.Type

Fields inherited from class fUML.Syntax.Classes.Kernel.Namespace

Fields inherited from class fUML.Syntax.Classes.Kernel.NamedElement

Fields inherited from class fUML.Syntax.Classes.Kernel.Element

Constructor Summary

Method Summary

Methods inherited from class fUML.Syntax.Classes.Kernel.Class_

Methods inherited from class fUML.Syntax.CommonBehaviors.BasicBehaviors.BehavioredClassifier

Methods inherited from class fUML.Syntax.Classes.Kernel.Classifier

Methods inherited from class fUML.Syntax.Classes.Kernel.Type

Methods inherited from class fUML.Syntax.Classes.Kernel.Namespace

Methods inherited from class fUML.Syntax.Classes.Kernel.NamedElement

Methods inherited from class fUML.Syntax.Classes.Kernel.Element

Methods inherited from class org.modeldriven.fuml.FumlObject

Methods inherited from class java.lang.Object

Field Detail

TYPE

BASE__PROPERTY

SUPPLIER

GROUP

SEQUENCE

AUTO

STRUCTURE

Constructor Detail

SDOKey

Method Detail

getType

setType

getBase_Property

setBase_Property

getSupplier

setSupplier

getGroup

setGroup

getSequence

setSequence

getAuto

setAuto

getStructure

setStructure