org.plasma.sdo.profile.SDOKey Maven / Gradle / Ivy

Go to download
//==============================================================================
//                                                                         
// This software artifact was generated using Plasma                       
// provisioning tools. Do not modify.                                      
//                                                                         
//==============================================================================
package org.plasma.sdo.profile;


import fUML.Syntax.Classes.Kernel.*;
import org.modeldriven.fuml.repository.ext.Stereotype;
import org.plasma.sdo.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.
* 
* @author Plasma-Team
* @version 2.0.1
*/
public class SDOKey extends Stereotype
    implements Key
{

    public static final String BASE__PROPERTY = "base_Property";
    /**
    * Specifies the type of key
    */
    public static final String TYPE = "type";
    /**
    * Used to associate one or more properties within a class under a single grouping or category.
    */
    public static final String GROUP = "group";
    /**
    * An identifier which denotes the ordering of the property witin a key. Not an indicator related to key structure. See KeyStructure
    */
    public static final String SEQUENCE = "sequence";
    /**
    * Whether a key is automatically generated and maintained
    */
    public static final String AUTO = "auto";
    /**
    * Indicates the key arrangement or organization
    */
    public static final String STRUCTURE = "structure";
    /**
    * 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.
    */
    public static final String SUPPLIER = "supplier";

    private Property base_Property;
    /**
    * Specifies the type of key
    */
    private KeyType type;
    /**
    * Used to associate one or more properties within a class under a single grouping or category.
    */
    private String group;
    /**
    * An identifier which denotes the ordering of the property witin a key. Not an indicator related to key structure. See KeyStructure
    */
    private Integer sequence;
    /**
    * Whether a key is automatically generated and maintained
    */
    private Boolean auto;
    /**
    * Indicates the key arrangement or organization
    */
    private KeyStructure structure;
    /**
    * 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.
    */
    private NamedElement supplier;


    public Property getBase_Property() {
        return this.base_Property;
    }

    public void setBase_Property(Property value) {
        this.base_Property = value;
    }

    public KeyType getType() {
        return this.type;
    }

    public void setType(KeyType value) {
        this.type = value;
    }

    public String getGroup() {
        return this.group;
    }

    public void setGroup(String value) {
        this.group = value;
    }

    public Integer getSequence() {
        return this.sequence;
    }

    public void setSequence(Integer value) {
        this.sequence = value;
    }

    public Boolean getAuto() {
        return this.auto;
    }

    public void setAuto(Boolean value) {
        this.auto = value;
    }

    public KeyStructure getStructure() {
        return this.structure;
    }

    public void setStructure(KeyStructure value) {
        this.structure = value;
    }

    public NamedElement getSupplier() {
        return this.supplier;
    }

    public void setSupplier(NamedElement value) {
        this.supplier = value;
    }
}