Class ClassificationController
Controller for working with configurations and instance data classification assignments
Inheritance
Inherited Members
Namespace: Simplic.Framework.Extension
Assembly: Simplic.Framework.Extension.dll
Syntax
public class ClassificationController
Fields
| Improve this Doc View SourceTABLE_SUFFIX
Suffix of any classification configuration table
Declaration
public const string TABLE_SUFFIX = "_Classification_Configuration"
Field Value
Type | Description |
---|---|
System.String |
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 SourceSingleton
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 SourceAssignClassification(ClassificationItem)
Assign a classification to an instance data
Declaration
public void AssignClassification(ClassificationItem item)
Parameters
Type | Name | Description |
---|---|---|
ClassificationItem | item | Classification to assign |
Delete(ClassificationConfiguration)
Delete classification from the database
Declaration
public void Delete(ClassificationConfiguration configuration)
Parameters
Type | Name | Description |
---|---|---|
ClassificationConfiguration | configuration | Configuration of the classification |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
UnassignClassification(ClassificationItem)
Unassign a classification from an instance data
Declaration
public void UnassignClassification(ClassificationItem item)
Parameters
Type | Name | Description |
---|---|---|
ClassificationItem | item | Classification to unassign |