Search Results for

    Show / Hide Table of Contents

    Class ClassificationController

    Controller for working with configurations and instance data classification assignments

    Inheritance
    System.Object
    ClassificationController
    Inherited Members
    System.Object.ToString()
    System.Object.Equals(System.Object)
    System.Object.Equals(System.Object, System.Object)
    System.Object.ReferenceEquals(System.Object, System.Object)
    System.Object.GetHashCode()
    System.Object.GetType()
    System.Object.MemberwiseClone()
    Namespace: Simplic.Framework.Extension
    Assembly: Simplic.Framework.Extension.dll
    Syntax
    public class ClassificationController

    Fields

    | Improve this Doc View Source

    TABLE_SUFFIX

    Suffix of any classification configuration table

    Declaration
    public const string TABLE_SUFFIX = "_Classification_Configuration"
    Field Value
    Type Description
    System.String
    | Improve this Doc View Source

    TABLE_TUPLE_SUFFIX

    Suffix of any classification table which connects instancedata with classification configuration

    Declaration
    public const string TABLE_TUPLE_SUFFIX = "_Classification"
    Field Value
    Type Description
    System.String

    Properties

    | Improve this Doc View Source

    Singleton

    Singleton access to the controller. Instances of this class can currently not be created

    Declaration
    public static ClassificationController Singleton { get; }
    Property Value
    Type Description
    ClassificationController

    Methods

    | Improve this Doc View Source

    AssignClassification(ClassificationItem)

    Assign a classification to an instance data

    Declaration
    public void AssignClassification(ClassificationItem item)
    Parameters
    Type Name Description
    ClassificationItem item

    Classification to assign

    | Improve this Doc View Source

    Delete(ClassificationConfiguration)

    Delete classification from the database

    Declaration
    public void Delete(ClassificationConfiguration configuration)
    Parameters
    Type Name Description
    ClassificationConfiguration configuration

    Configuration of the classification

    | Improve this Doc View Source

    Get(Guid, Guid)

    Get a classification configuration from the database

    Declaration
    public ClassificationConfiguration Get(Guid id, Guid stackId)
    Parameters
    Type Name Description
    System.Guid id

    Unique id of the classification

    System.Guid stackId

    Unique id of the stack, to which the classification systems belongs

    Returns
    Type Description
    ClassificationConfiguration

    If a classification was found, an instance of ClassificationConfiguration, else null

    | Improve this Doc View Source

    GetAll(Guid)

    Return all classification configurations which belongs to a stackid

    Declaration
    public IList<ClassificationConfiguration> GetAll(Guid stackId)
    Parameters
    Type Name Description
    System.Guid stackId

    Unique stack-id

    Returns
    Type Description
    System.Collections.Generic.IList<ClassificationConfiguration>

    List of classification configurations

    | Improve this Doc View Source

    GetAssignedClassifications(Guid, Guid)

    Get a list of classifications, that are assigned to an instance data

    Declaration
    public IList<ClassificationItem> GetAssignedClassifications(Guid stackId, Guid instanceDataId)
    Parameters
    Type Name Description
    System.Guid stackId

    Unique stackguid

    System.Guid instanceDataId

    Unique instancedata guid

    Returns
    Type Description
    System.Collections.Generic.IList<ClassificationItem>

    List of assigned classifications

    | Improve this Doc View Source

    GetConfigurationTableName(Guid)

    Get the classification configuration table which belongs to a stack

    Declaration
    public string GetConfigurationTableName(Guid stackId)
    Parameters
    Type Name Description
    System.Guid stackId

    Unique stack id

    Returns
    Type Description
    System.String

    Table name

    | Improve this Doc View Source

    GetTupleTableName(Guid)

    Get the classification configuration table which belongs to a stack

    Declaration
    public string GetTupleTableName(Guid stackId)
    Parameters
    Type Name Description
    System.Guid stackId

    Unique stack id

    Returns
    Type Description
    System.String

    Table name

    | Improve this Doc View Source

    IsClassifiable(Guid)

    Returns true if a stack is classifiable

    Declaration
    public bool IsClassifiable(Guid stackId)
    Parameters
    Type Name Description
    System.Guid stackId

    Unique stack id

    Returns
    Type Description
    System.Boolean

    True if is classifiable

    | Improve this Doc View Source

    IsInUse(Guid, Guid)

    Returns true, if the classification is in use (has some data)

    Declaration
    public bool IsInUse(Guid id, Guid stackId)
    Parameters
    Type Name Description
    System.Guid id

    Classificaiton configuration id

    System.Guid stackId

    Unique stack id

    Returns
    Type Description
    System.Boolean

    True if is in use, else false

    | Improve this Doc View Source

    Save(ClassificationConfiguration)

    Create or update a classification configuration in the database

    Declaration
    public void Save(ClassificationConfiguration configuration)
    Parameters
    Type Name Description
    ClassificationConfiguration configuration

    Configuration instance, must not be null

    | Improve this Doc View Source

    UnassignAllClassification(Guid, Guid)

    Unassign all classification from instance data

    Declaration
    public void UnassignAllClassification(Guid stackId, Guid instanceDataId)
    Parameters
    Type Name Description
    System.Guid stackId

    Unique stackid

    System.Guid instanceDataId

    Instance data guid to unassign all classification from

    | Improve this Doc View Source

    UnassignClassification(ClassificationItem)

    Unassign a classification from an instance data

    Declaration
    public void UnassignClassification(ClassificationItem item)
    Parameters
    Type Name Description
    ClassificationItem item

    Classification to unassign

    • Improve this Doc
    • View Source
    In This Article
    Back to top Copyright © 2018 SIMPLIC GmbH
    Generated by DocFx