Class SchemaManager<TSchemaManagerSchema>
Base class of schema manager.
Inheritance
Implements
Inherited Members
Namespace: Terrasoft.Core
Assembly: Terrasoft.Core.dll
Syntax
public abstract class SchemaManager<TSchemaManagerSchema> : Manager<ISchemaManagerItem<TSchemaManagerSchema>, TSchemaManagerSchema>, IManager<ISchemaManagerItem<TSchemaManagerSchema>, TSchemaManagerSchema>, IInternalSchemaManager, ISchemaManager, IManager, ISourceCodeSchemaManager where TSchemaManagerSchema : Schema, ISchemaManagerSchema<TSchemaManagerSchema>, IManagerItemInstance, ICloneable
Type Parameters
Name | Description |
---|---|
TSchemaManagerSchema | Class, inherits from Schema, implements interface ISchemaManagerSchema<TSchemaManagerSchema>, IManagerItemInstance, System.ICloneable. |
Constructors
SchemaManager()
Initializes a new SchemaManager<TSchemaManagerSchema> instance.
Declaration
protected SchemaManager()
Fields
DifferencePackagePrefix
Declaration
protected const string DifferencePackagePrefix = "MetaData.Schema."
Field Value
Type | Description |
---|---|
System.String |
Properties
AppConnection
System connection.
Declaration
public virtual AppConnection AppConnection { get; }
Property Value
Type | Description |
---|---|
AppConnection |
CanUseUserProperties
Declaration
protected virtual bool CanUseUserProperties { get; }
Property Value
Type | Description |
---|---|
System.Boolean |
CompileDependencies
Declaration
public IEnumerable<string> CompileDependencies { get; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.IEnumerable<System.String> |
DefSchema
The base schema.
Declaration
public virtual TSchemaManagerSchema DefSchema { get; }
Property Value
Type | Description |
---|---|
TSchemaManagerSchema |
IsInItemAdded
Determines whether the ItemAdded event is initialized.
Declaration
public bool IsInItemAdded { get; }
Property Value
Type | Description |
---|---|
System.Boolean |
IsInItemAdding
Determines whether the handling of the ItemAdding event is performed.
Declaration
public bool IsInItemAdding { get; }
Property Value
Type | Description |
---|---|
System.Boolean |
IsInItemRemoved
Determines whether the ItemRemoved event is initialized.
Declaration
public bool IsInItemRemoved { get; }
Property Value
Type | Description |
---|---|
System.Boolean |
IsInItemRemoving
Determines whether the handling of the ItemRemoving event is performed.
Declaration
public bool IsInItemRemoving { get; }
Property Value
Type | Description |
---|---|
System.Boolean |
IsInItemSaved
Determines whether the handling of the ItemSaved event is performed.
Declaration
public bool IsInItemSaved { get; }
Property Value
Type | Description |
---|---|
System.Boolean |
IsInItemSaving
Determines whether the handling of the ItemSaving event is performed.
Declaration
public bool IsInItemSaving { get; }
Property Value
Type | Description |
---|---|
System.Boolean |
IsItemsInitialized
Declaration
protected bool IsItemsInitialized { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
IsResolveAssemblyFromStandalonePackage
Declaration
protected virtual bool IsResolveAssemblyFromStandalonePackage { get; }
Property Value
Type | Description |
---|---|
System.Boolean |
ItemCaption
The caption for the schema manager item.
Declaration
public abstract string ItemCaption { get; }
Property Value
Type | Description |
---|---|
System.String |
ItemName
Name of the schema manager item.
Declaration
public string ItemName { get; }
Property Value
Type | Description |
---|---|
System.String |
Items
Declaration
protected override ManagerItemCollection<ISchemaManagerItem<TSchemaManagerSchema>> Items { get; set; }
Property Value
Type | Description |
---|---|
ManagerItemCollection<ISchemaManagerItem<TSchemaManagerSchema>> |
Overrides
ItemTypeName
Gets the name of the item type.
Declaration
protected abstract string ItemTypeName { get; }
Property Value
Type | Description |
---|---|
System.String |
MetaDataInstances
Declaration
protected virtual Dictionary<Guid, Dictionary<Guid, TSchemaManagerSchema>> MetaDataInstances { get; set; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.Dictionary<System.Guid, System.Collections.Generic.Dictionary<System.Guid, TSchemaManagerSchema>> |
MetaItems
Declaration
protected ManagerItemCollection<ISchemaManagerItem<TSchemaManagerSchema>> MetaItems { get; set; }
Property Value
Type | Description |
---|---|
ManagerItemCollection<ISchemaManagerItem<TSchemaManagerSchema>> |
Namespace
Namespace.
Declaration
public string Namespace { get; set; }
Property Value
Type | Description |
---|---|
System.String |
ProcessSchemaManager
Process schema manager.
Declaration
public ProcessSchemaManager ProcessSchemaManager { get; }
Property Value
Type | Description |
---|---|
ProcessSchemaManager |
ResourceManagerName
The name of the resource manager.
Declaration
public abstract string ResourceManagerName { get; }
Property Value
Type | Description |
---|---|
System.String |
SchemaManagerItems
Declaration
protected SchemaManagerItemCollection<TSchemaManagerSchema> SchemaManagerItems { get; set; }
Property Value
Type | Description |
---|---|
SchemaManagerItemCollection<TSchemaManagerSchema> |
SchemaManagerProvider
The provider of the schema manager.
Declaration
public SchemaManagerProvider SchemaManagerProvider { get; }
Property Value
Type | Description |
---|---|
SchemaManagerProvider |
SupportsProfiles
Determines whether the schema manager supports the profiles.
Declaration
[Obsolete("7.14.4 | Property is not in use and will be removed in upcoming builds")]
public bool SupportsProfiles { get; }
Property Value
Type | Description |
---|---|
System.Boolean |
SysSchemaUserPropertyRightsOperations
List of operations to access for modify SysSchemaUserProperty.
Declaration
protected virtual string[] SysSchemaUserPropertyRightsOperations { get; }
Property Value
Type | Description |
---|---|
System.String[] |
SystemUserConnection
Declaration
[Obsolete("7.15.3 | Property is not in use and will be removed in upcoming releases. Use SystemUserConnectionInject instead.")]
protected UserConnection SystemUserConnection { get; set; }
Property Value
Type | Description |
---|---|
UserConnection |
Workspace
Declaration
protected SysWorkspace Workspace { get; }
Property Value
Type | Description |
---|---|
SysWorkspace |
Methods
ActualizeItemDescriptor(ISchemaManagerItem)
Typed interface of the item of the schema manager.
Declaration
public virtual void ActualizeItemDescriptor(ISchemaManagerItem item)
Parameters
Type | Name | Description |
---|---|---|
ISchemaManagerItem | item | Manager item in which the descriptor needs to be updated. |
ActualizeSchemaDifferencePackage(JsonDataDifferencePackage)
Declaration
protected virtual void ActualizeSchemaDifferencePackage(JsonDataDifferencePackage differencePackage)
Parameters
Type | Name | Description |
---|---|---|
JsonDataDifferencePackage | differencePackage |
ActualizeSchemaMetaData(EntityCollection)
Actualizes the schema meta data.
Declaration
protected virtual Stream ActualizeSchemaMetaData(EntityCollection schemas)
Parameters
Type | Name | Description |
---|---|---|
EntityCollection | schemas | The schemas. |
Returns
Type | Description |
---|---|
System.IO.Stream | The actualized metadata. |
Exceptions
Type | Condition |
---|---|
InstanceActivationException | Error, while parsing the schema metadata. |
AddCoreSchema(Guid, String)
Adds the system schema with the specified identifier and name to the schema manager.
Declaration
public ISchemaManagerItem AddCoreSchema(Guid uid, string name)
Parameters
Type | Name | Description |
---|---|---|
System.Guid | uid | Identifier of the system schema that is being added. |
System.String | name | Name of the system schema that is being added. |
Returns
Type | Description |
---|---|
ISchemaManagerItem | The manager item that contains the system schema that was added. |
Remarks
Method is overloaded.
AddCoreSchema(Guid, String, Guid, Guid[])
Adds the system schema with the specified identifier and name to the schema manager and indicates the parent schema and a list of the schemas which the system schema being added references.
Declaration
public ISchemaManagerItem AddCoreSchema(Guid uid, string name, Guid parentSchemaUId, params Guid[] referenceSchemaUIds)
Parameters
Type | Name | Description |
---|---|---|
System.Guid | uid | Identifier of the system schema that is being added. |
System.String | name | Name of the system schema that is being added. |
System.Guid | parentSchemaUId | Identifier of the parent schema. |
System.Guid[] | referenceSchemaUIds | A list of the identifiers of the schemas that the schema being added references. |
Returns
Type | Description |
---|---|
ISchemaManagerItem | The manager item that contains the system schema that was added. |
Remarks
Method is overloaded.
AddEmptyDefaultEventsProcess(ProcessBasedSchema)
Declaration
protected void AddEmptyDefaultEventsProcess(ProcessBasedSchema ownerSchema)
Parameters
Type | Name | Description |
---|---|---|
ProcessBasedSchema | ownerSchema |
AddMetaDataInstanceToCache(Guid, Guid, Nullable<Guid>, TSchemaManagerSchema)
Declaration
protected bool AddMetaDataInstanceToCache(Guid packageId, Guid schemaUId, Guid? excludeSchemaUId, TSchemaManagerSchema metaDataInstance)
Parameters
Type | Name | Description |
---|---|---|
System.Guid | packageId | |
System.Guid | schemaUId | |
System.Nullable<System.Guid> | excludeSchemaUId | |
TSchemaManagerSchema | metaDataInstance |
Returns
Type | Description |
---|---|
System.Boolean |
AddSchema(Guid, String, LocalizableString, LocalizableString, Guid)
Adds the schema with the specified parameters to the schema manager.
Declaration
public ISchemaManagerItem AddSchema(Guid uid, string name, LocalizableString caption, LocalizableString description, Guid parentUId)
Parameters
Type | Name | Description |
---|---|---|
System.Guid | uid | Schema identifier. |
System.String | name | Name of the schema. |
LocalizableString | caption | Schema caption. |
LocalizableString | description | Description of the schema. |
System.Guid | parentUId | Identifier of the parent schema. |
Returns
Type | Description |
---|---|
ISchemaManagerItem | The manager item that contains the added schema with the specified parameters. |
Remarks
Method is overloaded.
AddSchemaParentUIdItem(JsonDataDifferencePackage, Guid)
Declaration
protected virtual void AddSchemaParentUIdItem(JsonDataDifferencePackage package, Guid parentSchemaUId)
Parameters
Type | Name | Description |
---|---|---|
JsonDataDifferencePackage | package | |
System.Guid | parentSchemaUId |
CanEditSchema(UserConnection, Guid)
Declaration
public bool CanEditSchema(UserConnection userConnection, Guid schemaUId)
Parameters
Type | Name | Description |
---|---|---|
UserConnection | userConnection | |
System.Guid | schemaUId |
Returns
Type | Description |
---|---|
System.Boolean |
CheckOperationUserRights(UserConnection)
Checks whether the current user can modify the manager elements.
Declaration
protected virtual bool CheckOperationUserRights(UserConnection userConnection)
Parameters
Type | Name | Description |
---|---|---|
UserConnection | userConnection | The user connection. |
Returns
Type | Description |
---|---|
System.Boolean |
|
CheckUserPropertyRights(UserConnection)
Check access for SysSchemaUserProperty operations.
Declaration
public void CheckUserPropertyRights(UserConnection userConnection)
Parameters
Type | Name | Description |
---|---|---|
UserConnection | userConnection | User connection. |
Clear()
Removes all items from manager items collection.
Declaration
public override void Clear()
Overrides
ClearItems(Object, EventArgs)
Declaration
protected override void ClearItems(object sender, EventArgs eventArgs)
Parameters
Type | Name | Description |
---|---|---|
System.Object | sender | |
System.EventArgs | eventArgs |
Overrides
CreateDesignSchema(UserConnection, Guid, Guid, Boolean)
Declaration
public virtual ISchemaManagerItem<TSchemaManagerSchema> CreateDesignSchema(UserConnection userConnection, Guid parentSchemaUId, Guid packageUId, bool extendParent)
Parameters
Type | Name | Description |
---|---|---|
UserConnection | userConnection | |
System.Guid | parentSchemaUId | |
System.Guid | packageUId | |
System.Boolean | extendParent |
Returns
Type | Description |
---|---|
ISchemaManagerItem<TSchemaManagerSchema> |
CreateItem()
Declaration
protected virtual ISchemaManagerItem<TSchemaManagerSchema> CreateItem()
Returns
Type | Description |
---|---|
ISchemaManagerItem<TSchemaManagerSchema> |
CreateItemCollection()
Declaration
protected override IManagerItemCollection<IManagerItem> CreateItemCollection()
Returns
Type | Description |
---|---|
IManagerItemCollection<IManagerItem> |
Overrides
CreateRuntimeSchemaFromMetaData(Guid, UserConnection)
Declaration
protected virtual TSchemaManagerSchema CreateRuntimeSchemaFromMetaData(Guid schemaUId, UserConnection userConnection)
Parameters
Type | Name | Description |
---|---|---|
System.Guid | schemaUId | |
UserConnection | userConnection |
Returns
Type | Description |
---|---|
TSchemaManagerSchema |
CreateRuntimeSchemaFromMetaData(Guid, UserConnection, Boolean)
Create schema from metadata with complete hierarchy.
Declaration
protected virtual TSchemaManagerSchema CreateRuntimeSchemaFromMetaData(Guid schemaUId, UserConnection userConnection, bool initResources)
Parameters
Type | Name | Description |
---|---|---|
System.Guid | schemaUId | Identifier of schema |
UserConnection | userConnection | User connection. |
System.Boolean | initResources | Returns true if use resources. Otherwise returns false. |
Returns
Type | Description |
---|---|
TSchemaManagerSchema | Schema with complete hierarchy of elements. |
Exceptions
Type | Condition |
---|---|
Terrasoft.Core.SchemaManager.Exception.CannotCreateSchemaByExtendSchemaUId | Exception if |
CreateSchema(String, TSchemaManagerSchema, UserConnection, Guid, Boolean)
Creates a new schema with the specified name and parent schema and indicates that the schema is added to the list of designed schemas.
Declaration
public ISchemaManagerItem<TSchemaManagerSchema> CreateSchema(string name, TSchemaManagerSchema baseSchema, UserConnection userConnection, Guid uid, bool addToDesignItems)
Parameters
Type | Name | Description |
---|---|---|
System.String | name | Name of the schema. |
TSchemaManagerSchema | baseSchema | Instance of the parent schema. |
UserConnection | userConnection | User connection. |
System.Guid | uid | Schema identifier. |
System.Boolean | addToDesignItems | Indicates that the schema is added to the list of designed schemas. |
Returns
Type | Description |
---|---|
ISchemaManagerItem<TSchemaManagerSchema> | The manager item that contains the schema that was created. |
Remarks
Method is overloaded.
CreateSchema(UserConnection)
Creates a new schema.
Declaration
public ISchemaManagerItem<TSchemaManagerSchema> CreateSchema(UserConnection userConnection)
Parameters
Type | Name | Description |
---|---|---|
UserConnection | userConnection | User connection. |
Returns
Type | Description |
---|---|
ISchemaManagerItem<TSchemaManagerSchema> | The manager item that contains the schema that was created. |
Remarks
Method is overloaded.
CreateSchema(UserConnection, Guid, Boolean)
Creates a new schema with the specified identifier and indicates that the schema is added to the list of designed schemas.
Declaration
public ISchemaManagerItem<TSchemaManagerSchema> CreateSchema(UserConnection userConnection, Guid uid, bool addToDesignItems)
Parameters
Type | Name | Description |
---|---|---|
UserConnection | userConnection | User connection. |
System.Guid | uid | Schema identifier. |
System.Boolean | addToDesignItems | Indicates that the schema is added to the list of designed schemas. |
Returns
Type | Description |
---|---|
ISchemaManagerItem<TSchemaManagerSchema> | The manager item that contains the schema that was created. |
Remarks
Method is overloaded.
CreateSchemaInstance(ISchemaManagerItem, Assembly)
Creates the schema instance.
Declaration
protected virtual TSchemaManagerSchema CreateSchemaInstance(ISchemaManagerItem schemaManagerItem, Assembly assembly)
Parameters
Type | Name | Description |
---|---|---|
ISchemaManagerItem | schemaManagerItem | The schema manager item. |
System.Reflection.Assembly | assembly | Assembly contains instance type. |
Returns
Type | Description |
---|---|
TSchemaManagerSchema | Created instance. |
CreateSchemaItem(Guid, String, TSchemaManagerSchema, Boolean, UserConnection)
Declaration
protected ISchemaManagerItem<TSchemaManagerSchema> CreateSchemaItem(Guid packageUId, string name, TSchemaManagerSchema parentSchema, bool extendParent, UserConnection userConnection)
Parameters
Type | Name | Description |
---|---|---|
System.Guid | packageUId | |
System.String | name | |
TSchemaManagerSchema | parentSchema | |
System.Boolean | extendParent | |
UserConnection | userConnection |
Returns
Type | Description |
---|---|
ISchemaManagerItem<TSchemaManagerSchema> |
DeleteSchemaSource(Guid)
Delte schema source codes from database.
Declaration
public void DeleteSchemaSource(Guid schemaId)
Parameters
Type | Name | Description |
---|---|---|
System.Guid | schemaId | Schema identifier. |
DeriveSchemaManagerItem(UserConnection, EntityCollection)
Declaration
protected virtual ISchemaManagerItem<TSchemaManagerSchema> DeriveSchemaManagerItem(UserConnection userConnection, EntityCollection orderedSchemas)
Parameters
Type | Name | Description |
---|---|---|
UserConnection | userConnection | |
EntityCollection | orderedSchemas |
Returns
Type | Description |
---|---|
ISchemaManagerItem<TSchemaManagerSchema> |
DeserializeSchemaManagerItem(Stream, UserConnection)
Declaration
protected ISchemaManagerItem<TSchemaManagerSchema> DeserializeSchemaManagerItem(Stream metaData, UserConnection userConnection)
Parameters
Type | Name | Description |
---|---|---|
System.IO.Stream | metaData | |
UserConnection | userConnection |
Returns
Type | Description |
---|---|
ISchemaManagerItem<TSchemaManagerSchema> |
DesignItem(UserConnection, Guid)
Returns the instance of the development time element.
Declaration
public virtual ISchemaManagerItem DesignItem(UserConnection userConnection, Guid uid)
Parameters
Type | Name | Description |
---|---|---|
UserConnection | userConnection | User connection. |
System.Guid | uid | Schema identifier. |
Returns
Type | Description |
---|---|
ISchemaManagerItem | The instance of the development time element. |
DesignItemInCustomPackage(UserConnection, Guid)
Declaration
public ISchemaManagerItem DesignItemInCustomPackage(UserConnection userConnection, Guid uid)
Parameters
Type | Name | Description |
---|---|---|
UserConnection | userConnection | |
System.Guid | uid |
Returns
Type | Description |
---|---|
ISchemaManagerItem |
DesignSchema(UserConnection, Guid)
Declaration
public ISchemaManagerItem DesignSchema(UserConnection userConnection, Guid realUId)
Parameters
Type | Name | Description |
---|---|---|
UserConnection | userConnection | |
System.Guid | realUId |
Returns
Type | Description |
---|---|
ISchemaManagerItem |
DoItemAdded(Object, SchemaManagerItemAfterAddEventArgs)
Declaration
protected void DoItemAdded(object sender, SchemaManagerItemAfterAddEventArgs e)
Parameters
Type | Name | Description |
---|---|---|
System.Object | sender | |
SchemaManagerItemAfterAddEventArgs | e |
DoItemAdding(Object, SchemaManagerItemBeforeAddEventArgs)
Declaration
protected void DoItemAdding(object sender, SchemaManagerItemBeforeAddEventArgs e)
Parameters
Type | Name | Description |
---|---|---|
System.Object | sender | |
SchemaManagerItemBeforeAddEventArgs | e |
DoItemRemoved(Object, SchemaManagerItemAfterRemoveEventArgs)
Declaration
protected void DoItemRemoved(object sender, SchemaManagerItemAfterRemoveEventArgs e)
Parameters
Type | Name | Description |
---|---|---|
System.Object | sender | |
SchemaManagerItemAfterRemoveEventArgs | e |
DoItemRemoving(Object, SchemaManagerItemBeforeRemoveEventArgs)
Declaration
protected void DoItemRemoving(object sender, SchemaManagerItemBeforeRemoveEventArgs e)
Parameters
Type | Name | Description |
---|---|---|
System.Object | sender | |
SchemaManagerItemBeforeRemoveEventArgs | e |
DropInstances()
Deletes instances of all schemas of the manager.
Declaration
public void DropInstances()
FillSourceCollection(Collection<ISchemaManagerItem>, Guid)
Loads the source code of the specified schema to the passed-in collection.
Declaration
public void FillSourceCollection(Collection<ISchemaManagerItem> compileCollection, Guid uid)
Parameters
Type | Name | Description |
---|---|---|
System.Collections.ObjectModel.Collection<ISchemaManagerItem> | compileCollection | The collection to which the source code of the schema is loaded. |
System.Guid | uid | Identifier of the schema whose source code is loaded. |
Remarks
Method is overloaded.
FillSourceCollection(Collection<ISchemaManagerItem>, ISchemaManagerItem)
Loads code of schema to target collection.
Declaration
public void FillSourceCollection(Collection<ISchemaManagerItem> compileCollection, ISchemaManagerItem item)
Parameters
Type | Name | Description |
---|---|---|
System.Collections.ObjectModel.Collection<ISchemaManagerItem> | compileCollection | Collection, to which loads code of schema. |
ISchemaManagerItem | item | Item of manager, which contains schema with code. |
FindDesignInstance(UserConnection, Guid)
Searches an instance of edited schema with unique identifier.
Declaration
public virtual TSchemaManagerSchema FindDesignInstance(UserConnection userConnection, Guid uid)
Parameters
Type | Name | Description |
---|---|---|
UserConnection | userConnection | User connection. |
System.Guid | uid | Unique identifier of edited schema instance. |
Returns
Type | Description |
---|---|
TSchemaManagerSchema | Instance of edited schema with uid |
FindDesignItem(UserConnection, Guid)
Searches for the designed item with the specified identifier.
Declaration
public virtual ISchemaManagerItem FindDesignItem(UserConnection userConnection, Guid uid)
Parameters
Type | Name | Description |
---|---|---|
UserConnection | userConnection | User connection. |
System.Guid | uid | Identifier of the schema to get. |
Returns
Type | Description |
---|---|
ISchemaManagerItem | The designed item with the |
FindInstanceFromMetaDataByPackageUId(Guid, Guid, UserConnection)
Finds item with given UId with changes in elements hierarchy for package.
Declaration
public virtual TSchemaManagerSchema FindInstanceFromMetaDataByPackageUId(Guid schemaUId, Guid packageUId, UserConnection userConnection)
Parameters
Type | Name | Description |
---|---|---|
System.Guid | schemaUId | Schema UId. |
System.Guid | packageUId | Package UId. |
UserConnection | userConnection | User connection. |
Returns
Type | Description |
---|---|
TSchemaManagerSchema |
FindRuntimeInstanceByName(String)
Returns instance of manager item by name. If not found - get instance from metadata.
Declaration
public TSchemaManagerSchema FindRuntimeInstanceByName(string name)
Parameters
Type | Name | Description |
---|---|---|
System.String | name | Unique identifier of searched manager item. |
Returns
Type | Description |
---|---|
TSchemaManagerSchema | Instance of manager item with name |
FindRuntimeInstanceByUId(Guid)
Returns instance of manager item by unique identifier. If not found - get instance from metadata.
Declaration
public TSchemaManagerSchema FindRuntimeInstanceByUId(Guid uid)
Parameters
Type | Name | Description |
---|---|---|
System.Guid | uid | Unique identifier of searched manager item. |
Returns
Type | Description |
---|---|
TSchemaManagerSchema | Instance of manager item with unique identifier |
FindRuntimeInstanceFromMetadata(Guid)
Returns an instance of the manager's item with the given UId.
Declaration
public TSchemaManagerSchema FindRuntimeInstanceFromMetadata(Guid schemaUId)
Parameters
Type | Name | Description |
---|---|---|
System.Guid | schemaUId | The schema unique identifier. |
Returns
Type | Description |
---|---|
TSchemaManagerSchema | AAn instance of the manager's item with specified |
ForceGetCustomPackageUId(UserConnection)
Declaration
protected virtual Guid ForceGetCustomPackageUId(UserConnection userConnection)
Parameters
Type | Name | Description |
---|---|---|
UserConnection | userConnection |
Returns
Type | Description |
---|---|
System.Guid |
GenerateItemUniqueCaption(String)
Generates the unique header of the manager item, using the specified prefix.
Declaration
public string GenerateItemUniqueCaption(string prefix)
Parameters
Type | Name | Description |
---|---|---|
System.String | prefix | The prefix. |
Returns
Type | Description |
---|---|
System.String | The unique header of the manager item with the |
GenerateItemUniqueName(String)
Generates the unique name of the manager item, using the specified prefix.
Declaration
public string GenerateItemUniqueName(string prefix)
Parameters
Type | Name | Description |
---|---|---|
System.String | prefix | Prefix. |
Returns
Type | Description |
---|---|
System.String | The unique name of the manager item with the |
GenerateReferenceSchemaSources(IEnumerable<Guid>, UserConnection)
Declaration
protected virtual void GenerateReferenceSchemaSources(IEnumerable<Guid> referenceSchemaUIds, UserConnection userConnection)
Parameters
Type | Name | Description |
---|---|---|
System.Collections.Generic.IEnumerable<System.Guid> | referenceSchemaUIds | |
UserConnection | userConnection |
GenerateSchemaSources(TSchemaManagerSchema, Guid, UserConnection)
Declaration
protected virtual bool GenerateSchemaSources(TSchemaManagerSchema schema, Guid schemaId, UserConnection userConnection)
Parameters
Type | Name | Description |
---|---|---|
TSchemaManagerSchema | schema | |
System.Guid | schemaId | |
UserConnection | userConnection |
Returns
Type | Description |
---|---|
System.Boolean |
GenerateSchemaSources(Guid, ISchemaManagerItem, UserConnection)
Declaration
public void GenerateSchemaSources(Guid sysSchemaId, ISchemaManagerItem schemaManagerItem, UserConnection userConnection)
Parameters
Type | Name | Description |
---|---|---|
System.Guid | sysSchemaId | |
ISchemaManagerItem | schemaManagerItem | |
UserConnection | userConnection |
GetAllParents(ISchemaManagerItem<TSchemaManagerSchema>)
Gets the parent schemas for the given one. For each parent schema returns only instance of ISchemaManagerItem<TSchemaManagerSchema> containing lowest extension of this schema.
Declaration
public IEnumerable<ISchemaManagerItem<TSchemaManagerSchema>> GetAllParents(ISchemaManagerItem<TSchemaManagerSchema> schemaManagerItem)
Parameters
Type | Name | Description |
---|---|---|
ISchemaManagerItem<TSchemaManagerSchema> | schemaManagerItem | The schema manager item. |
Returns
Type | Description |
---|---|
System.Collections.Generic.IEnumerable<ISchemaManagerItem<TSchemaManagerSchema>> | The collection of schemas, which are parent for the given one. |
GetDataReaderAsGuid(IDataReader, Int32)
Declaration
[Obsolete("7.14.4 | Method is not in use and will be removed in upcoming builds")]
protected static Guid GetDataReaderAsGuid(IDataReader dataReader, int index)
Parameters
Type | Name | Description |
---|---|---|
System.Data.IDataReader | dataReader | |
System.Int32 | index |
Returns
Type | Description |
---|---|
System.Guid |
GetDefSchemaUId()
Gets the identifier of the schema from which all base schemas of the schema manager derive.
Declaration
public Guid GetDefSchemaUId()
Returns
Type | Description |
---|---|
System.Guid | The identifier of the schema from which all base schemas of the schema manager derive. |
GetDesignedItemFolderIdFromSessionData(UserConnection, Guid)
Gets the identifier of the catalog which contains the designed item schema with the specified identifier from the session data.
Declaration
public Guid GetDesignedItemFolderIdFromSessionData(UserConnection userConnection, Guid designedItemId)
Parameters
Type | Name | Description |
---|---|---|
UserConnection | userConnection | User connection. |
System.Guid | designedItemId | Identifier of the item that contains the designed schema. |
Returns
Type | Description |
---|---|
System.Guid | Identifier of the catalog that contains the |
GetDesignedItemIdFromSessionData(UserConnection, Guid)
Declaration
public Guid GetDesignedItemIdFromSessionData(UserConnection userConnection, Guid uid)
Parameters
Type | Name | Description |
---|---|---|
UserConnection | userConnection | |
System.Guid | uid |
Returns
Type | Description |
---|---|
System.Guid |
GetDesignedItemPackageUIdFromSessionData(UserConnection, Guid)
Declaration
public Guid GetDesignedItemPackageUIdFromSessionData(UserConnection userConnection, Guid uid)
Parameters
Type | Name | Description |
---|---|---|
UserConnection | userConnection | |
System.Guid | uid |
Returns
Type | Description |
---|---|
System.Guid |
GetDesignInstance(UserConnection, Guid)
Gets the instance of the designed schema with the specified identifier. If no such schema is found, an exception is thrown.
Declaration
public virtual TSchemaManagerSchema GetDesignInstance(UserConnection userConnection, Guid uid)
Parameters
Type | Name | Description |
---|---|---|
UserConnection | userConnection | User connection. |
System.Guid | uid | Identifier of the instance of the designed schema. |
Returns
Type | Description |
---|---|
TSchemaManagerSchema | The instance of the designed schema with the |
Exceptions
Type | Condition |
---|---|
ItemNotFoundException | If the designed schema instance with the |
GetDesignItem(UserConnection, Guid)
Gets the designed item with the specified identifier. If no such item is found, an exception is thrown.
Declaration
public ISchemaManagerItem GetDesignItem(UserConnection userConnection, Guid uid)
Parameters
Type | Name | Description |
---|---|---|
UserConnection | userConnection | User connection. |
System.Guid | uid | The identifier of the returned item. |
Returns
Type | Description |
---|---|
ISchemaManagerItem | The designed item with the |
Exceptions
Type | Condition |
---|---|
ItemNotFoundException | If the designed item with the |
GetFullItemHierarchy(Guid)
Gets the hierarchy of the schema manager items for the specified unique identifier.
Declaration
protected Collection<ISchemaManagerItem<TSchemaManagerSchema>> GetFullItemHierarchy(Guid realUId)
Parameters
Type | Name | Description |
---|---|---|
System.Guid | realUId | Unique identifier of the item from which the hierarchy is built. |
Returns
Type | Description |
---|---|
System.Collections.ObjectModel.Collection<ISchemaManagerItem<TSchemaManagerSchema>> | The hierarchy of the schema manager items for the specified unique identifier. |
GetGeneratedItemPrefix(String)
Declaration
protected virtual string GetGeneratedItemPrefix(string name)
Parameters
Type | Name | Description |
---|---|---|
System.String | name |
Returns
Type | Description |
---|---|
System.String |
GetGenerator(UserConnection)
Returns the source code generator for the manager schemas.
Declaration
public abstract SchemaCodeGenerator<TSchemaManagerSchema> GetGenerator(UserConnection userConnection)
Parameters
Type | Name | Description |
---|---|---|
UserConnection | userConnection | The user connection. |
Returns
Type | Description |
---|---|
SchemaCodeGenerator<TSchemaManagerSchema> | The source code generator. |
GetHash()
Returns the hash for this item.
Declaration
public virtual string GetHash()
Returns
Type | Description |
---|---|
System.String |
GetItemFromMetaData(Guid, UserConnection, Nullable<Guid>)
Gets the manager item that contains the schema with the specified identifier, using the specified user connection.
Declaration
public virtual ISchemaManagerItem<TSchemaManagerSchema> GetItemFromMetaData(Guid schemaUId, UserConnection userConnection, Guid? workspaceId = default(Guid? ))
Parameters
Type | Name | Description |
---|---|---|
System.Guid | schemaUId | Schema identifier. |
UserConnection | userConnection | User connection. |
System.Nullable<System.Guid> | workspaceId | Unique identifier of the workspace. |
Returns
Type | Description |
---|---|
ISchemaManagerItem<TSchemaManagerSchema> | The manager item that contains the schema with the |
GetItemIdByUId(Guid)
Declaration
public Guid GetItemIdByUId(Guid itemUId)
Parameters
Type | Name | Description |
---|---|---|
System.Guid | itemUId |
Returns
Type | Description |
---|---|
System.Guid |
GetItemReferenceSchemaUIds(Guid, UserConnection)
Declaration
protected virtual IEnumerable<Guid> GetItemReferenceSchemaUIds(Guid schemaId, UserConnection userConnection)
Parameters
Type | Name | Description |
---|---|---|
System.Guid | schemaId | |
UserConnection | userConnection |
Returns
Type | Description |
---|---|
System.Collections.Generic.IEnumerable<System.Guid> |
GetItems()
Returns elements of current manager elements.
Declaration
public override IEnumerable<ISchemaManagerItem<TSchemaManagerSchema>> GetItems()
Returns
Type | Description |
---|---|
System.Collections.Generic.IEnumerable<ISchemaManagerItem<TSchemaManagerSchema>> | Items of current manager. |
Overrides
GetMetaDataSerializer(UserConnection)
Gets a serializer of the schemas of the manager.
Declaration
public virtual IMetaDataSerializer GetMetaDataSerializer(UserConnection userConnection)
Parameters
Type | Name | Description |
---|---|---|
UserConnection | userConnection | User connection. |
Returns
Type | Description |
---|---|
IMetaDataSerializer | The serializer of the schemas of the manager. |
GetPackageItems(IEnumerable<Guid>)
Returns schemas those are located in one of specified packages or extend schemas which have at least one another extension in one of specified packages.
Declaration
public virtual IEnumerable<ISchemaManagerItem<TSchemaManagerSchema>> GetPackageItems(IEnumerable<Guid> packageUIds)
Parameters
Type | Name | Description |
---|---|---|
System.Collections.Generic.IEnumerable<System.Guid> | packageUIds | UIds of packages, containing schemas. |
Returns
Type | Description |
---|---|
System.Collections.Generic.IEnumerable<ISchemaManagerItem<TSchemaManagerSchema>> | Instance of System.Collections.Generic.IEnumerable<T> with enumeration of schemas. |
GetParentSchemaLocalizableValues(TSchemaManagerSchema)
Gets the parent schema localizable values.
Declaration
protected virtual LocalizableValueCollection GetParentSchemaLocalizableValues(TSchemaManagerSchema schema)
Parameters
Type | Name | Description |
---|---|---|
TSchemaManagerSchema | schema | The schema. |
Returns
Type | Description |
---|---|
LocalizableValueCollection | The localizable data. |
GetParentSchemaUIds(UserConnection, Guid, String, Guid, Boolean)
Gets the parent schema's unique identifiers for the given one.
Declaration
public virtual Guid[] GetParentSchemaUIds(UserConnection userConnection, Guid schemaUId, string schemaName, Guid packageUId, bool usePackageHierarchy)
Parameters
Type | Name | Description |
---|---|---|
UserConnection | userConnection | The user connection. |
System.Guid | schemaUId | The schema unique identifier. |
System.String | schemaName | Filter by schema name. |
System.Guid | packageUId | The package unique identifier. |
System.Boolean | usePackageHierarchy |
|
Returns
Type | Description |
---|---|
System.Guid[] | The collection of schema's unique identifiers, which are parent for the given one. |
GetProcessSchemaGenerator(UserConnection)
Returns process schema generator instance.
Declaration
public virtual ProcessSchemaGenerator GetProcessSchemaGenerator(UserConnection userConnection)
Parameters
Type | Name | Description |
---|---|---|
UserConnection | userConnection | User connection. |
Returns
Type | Description |
---|---|
ProcessSchemaGenerator | Process schema generator. |
GetReadableSchemaMetaData(Guid, UserConnection)
Gets the metadata of the schema with the specified identifier in a readable format.
Declaration
public Stream GetReadableSchemaMetaData(Guid schemaUId, UserConnection userConnection)
Parameters
Type | Name | Description |
---|---|---|
System.Guid | schemaUId | The identifier of the schema whose metadata is to be obtained. |
UserConnection | userConnection | User connection. |
Returns
Type | Description |
---|---|
System.IO.Stream | The stream that contains the metadata of the schema with the |
GetReadableSchemaMetaData(MetaSchema, UserConnection)
Gets the metadata of the specified schema in a readable format.
Declaration
public Stream GetReadableSchemaMetaData(MetaSchema schema, UserConnection userConnection)
Parameters
Type | Name | Description |
---|---|---|
MetaSchema | schema | The schema whose metadata is to be obtained. |
UserConnection | userConnection | User connection. |
Returns
Type | Description |
---|---|
System.IO.Stream | The stream that contains the metadata of the |
GetReadableSchemaMetaData(MetaSchema, UserConnection, Boolean)
Gets the metadata of the specified schema in a format that is easy to read.
Declaration
public Stream GetReadableSchemaMetaData(MetaSchema schema, UserConnection userConnection, bool toLowerCamelCase)
Parameters
Type | Name | Description |
---|---|---|
MetaSchema | schema | The schema whose metadata is to be retrieved. |
UserConnection | userConnection | User connection. |
System.Boolean | toLowerCamelCase | A characteristic of the generation of property names in the style of LowerCamelCase. |
Returns
Type | Description |
---|---|
System.IO.Stream | A thread containing schema metadata |
GetReadableSchemaMetaDataText(Guid, UserConnection)
Gets metadata string with target identifier in a format that is easy to read.
Declaration
public string GetReadableSchemaMetaDataText(Guid schemaUId, UserConnection userConnection)
Parameters
Type | Name | Description |
---|---|---|
System.Guid | schemaUId | Identifier of schema. |
UserConnection | userConnection | User connection. |
Returns
Type | Description |
---|---|
System.String | Schema metadata with target identifier |
GetReadableSchemaMetaDataText(MetaSchema, UserConnection, Boolean, Boolean)
Gets the metadata text of the specified schema in a format that is easy to read.
Declaration
public string GetReadableSchemaMetaDataText(MetaSchema schema, UserConnection userConnection, bool toLowerCamelCase, bool formatJson)
Parameters
Type | Name | Description |
---|---|---|
MetaSchema | schema | The schema whose metadata is to be retrieved. |
UserConnection | userConnection | User connection. |
System.Boolean | toLowerCamelCase | A characteristic of the generation of property names in the style of LowerCamelCase. |
System.Boolean | formatJson | A characteristic of the generation of property names in the style of indent formatted json. |
Returns
Type | Description |
---|---|
System.String | A thread containing schema metadata |
GetResourcesFromData(String)
Declaration
protected Dictionary<string, string> GetResourcesFromData(string data)
Parameters
Type | Name | Description |
---|---|---|
System.String | data |
Returns
Type | Description |
---|---|
System.Collections.Generic.Dictionary<System.String, System.String> |
GetRuntimeInstanceFromMetadata(Guid)
Returns an instance of the manager's item with the given UId.
Declaration
public TSchemaManagerSchema GetRuntimeInstanceFromMetadata(Guid schemaUId)
Parameters
Type | Name | Description |
---|---|---|
System.Guid | schemaUId | The schema unique identifier. |
Returns
Type | Description |
---|---|
TSchemaManagerSchema | An instance of the manager's item with specified |
GetSchemaDesignItem(UserConnection, Guid)
Gets the typed designed item with the specified identifier.
Declaration
public ISchemaManagerItem<TSchemaManagerSchema> GetSchemaDesignItem(UserConnection userConnection, Guid uid)
Parameters
Type | Name | Description |
---|---|---|
UserConnection | userConnection | User connection. |
System.Guid | uid | Schema identifier. |
Returns
Type | Description |
---|---|
ISchemaManagerItem<TSchemaManagerSchema> | The typed designed item with the |
GetSchemaHierarchy(Guid)
Declaration
public Collection<Guid> GetSchemaHierarchy(Guid schemaUId)
Parameters
Type | Name | Description |
---|---|---|
System.Guid | schemaUId |
Returns
Type | Description |
---|---|
System.Collections.ObjectModel.Collection<System.Guid> |
GetSchemaHierarchyByName(String)
Declaration
public virtual Collection<Guid> GetSchemaHierarchyByName(string schemaName)
Parameters
Type | Name | Description |
---|---|---|
System.String | schemaName |
Returns
Type | Description |
---|---|
System.Collections.ObjectModel.Collection<System.Guid> |
GetSchemaIdBySchemaUId(Guid, Guid)
Declaration
protected Guid GetSchemaIdBySchemaUId(Guid schemaUId, Guid workspaceId)
Parameters
Type | Name | Description |
---|---|---|
System.Guid | schemaUId | |
System.Guid | workspaceId |
Returns
Type | Description |
---|---|
System.Guid |
GetSchemaMetaData(Guid, UserConnection)
Gets metadata with target identifier.
Declaration
public Stream GetSchemaMetaData(Guid schemaUId, UserConnection userConnection)
Parameters
Type | Name | Description |
---|---|---|
System.Guid | schemaUId | Identifier of schema. |
UserConnection | userConnection | Users connection. |
Returns
Type | Description |
---|---|
System.IO.Stream | Stream with metadata of schema with target id |
GetSchemaMetaDataDifferencePackage(Guid, UserConnection)
Gets the difference package for the schema with the specified identifier and its parent schema.
Declaration
public Stream GetSchemaMetaDataDifferencePackage(Guid schemaUId, UserConnection userConnection)
Parameters
Type | Name | Description |
---|---|---|
System.Guid | schemaUId | The identifier of the schema for which the difference package to get. |
UserConnection | userConnection | User connection. |
Returns
Type | Description |
---|---|
System.IO.Stream | The stream containing the difference package for the base schema and the schema with the |
GetSchemaMetaDataText(Guid, UserConnection)
Gets metadata string with target identifier.
Declaration
public string GetSchemaMetaDataText(Guid schemaUId, UserConnection userConnection)
Parameters
Type | Name | Description |
---|---|---|
System.Guid | schemaUId | Identifier of schema. |
UserConnection | userConnection | Users connection. |
Returns
Type | Description |
---|---|
System.String | Metadata string of schema with target id |
GetSchemaResources(TSchemaManagerSchema)
Declaration
protected Dictionary<string, LocalizableValueCollection> GetSchemaResources(TSchemaManagerSchema schema)
Parameters
Type | Name | Description |
---|---|---|
TSchemaManagerSchema | schema |
Returns
Type | Description |
---|---|
System.Collections.Generic.Dictionary<System.String, LocalizableValueCollection> |
GetSchemaResourcesForSave(ISchemaManagerItem<TSchemaManagerSchema>)
Declaration
protected virtual Dictionary<string, LocalizableValueCollection> GetSchemaResourcesForSave(ISchemaManagerItem<TSchemaManagerSchema> designItem)
Parameters
Type | Name | Description |
---|---|---|
ISchemaManagerItem<TSchemaManagerSchema> | designItem |
Returns
Type | Description |
---|---|
System.Collections.Generic.Dictionary<System.String, LocalizableValueCollection> |
GetSchemasMetaData(IEnumerable<Guid>, UserConnection)
Declaration
protected Dictionary<Guid, byte[]> GetSchemasMetaData(IEnumerable<Guid> schemaUIds, UserConnection userConnection)
Parameters
Type | Name | Description |
---|---|---|
System.Collections.Generic.IEnumerable<System.Guid> | schemaUIds | |
UserConnection | userConnection |
Returns
Type | Description |
---|---|
System.Collections.Generic.Dictionary<System.Guid, System.Byte[]> |
GetSchemaSource(Guid, UserConnection)
Gets the source code of the schema with the specified identifier.
Declaration
public virtual Stream GetSchemaSource(Guid schemaUId, UserConnection userConnection)
Parameters
Type | Name | Description |
---|---|---|
System.Guid | schemaUId | Identifier of the schema whose source code to get. |
UserConnection | userConnection | User connection. |
Returns
Type | Description |
---|---|
System.IO.Stream | The stream containing the source code of the schema with the |
GetSchemaSources(TSchemaManagerSchema, Guid, UserConnection)
Gets the schema sources.
Declaration
protected virtual EntityCollection GetSchemaSources(TSchemaManagerSchema schema, Guid schemaId, UserConnection userConnection)
Parameters
Type | Name | Description |
---|---|---|
TSchemaManagerSchema | schema | The schema. |
System.Guid | schemaId | The schema identifier. |
UserConnection | userConnection | The user connection. |
Returns
Type | Description |
---|---|
EntityCollection | The schema sources. |
GetSchemaSources(Guid, Guid, UserConnection, out String)
Gets the collection of objects that contain the source code of the schema with the specified identifier.
Declaration
public EntityCollection GetSchemaSources(Guid schemaUId, Guid schemaId, UserConnection userConnection, out string errorMessage)
Parameters
Type | Name | Description |
---|---|---|
System.Guid | schemaUId | Identifier of the schema whose source code to get. |
System.Guid | schemaId | The identifier of the record in the SysSchema table. |
UserConnection | userConnection | User connection. |
System.String | errorMessage | The error message when getting the source code of the schema. |
Returns
Type | Description |
---|---|
EntityCollection | Collection of entities with the source code of the schema with the |
GetTextFromStream(Stream, Boolean)
Declaration
protected string GetTextFromStream(Stream source, bool isJsonFormat)
Parameters
Type | Name | Description |
---|---|---|
System.IO.Stream | source | |
System.Boolean | isJsonFormat |
Returns
Type | Description |
---|---|
System.String |
Initialize(SchemaManagerProvider, SchemaManagerProviderConfigurationElement)
Creates the manager of schema, using specified provider and information from configuration file.
Declaration
public virtual void Initialize(SchemaManagerProvider provider, SchemaManagerProviderConfigurationElement configuration)
Parameters
Type | Name | Description |
---|---|---|
SchemaManagerProvider | provider | Provider of schema manager. |
SchemaManagerProviderConfigurationElement | configuration | Information from configuration file. |
InitializeDefSchema()
Initializes the default schema.
Declaration
protected abstract TSchemaManagerSchema InitializeDefSchema()
Returns
Type | Description |
---|---|
TSchemaManagerSchema | The default schema. |
InitializeInstance(ISchemaManagerItem<TSchemaManagerSchema>)
Declaration
protected override TSchemaManagerSchema InitializeInstance(ISchemaManagerItem<TSchemaManagerSchema> item)
Parameters
Type | Name | Description |
---|---|---|
ISchemaManagerItem<TSchemaManagerSchema> | item |
Returns
Type | Description |
---|---|
TSchemaManagerSchema |
Overrides
InitializeItem(Guid)
Initializes the manager item with the specified identifier.
Declaration
public virtual bool InitializeItem(Guid itemUId)
Parameters
Type | Name | Description |
---|---|---|
System.Guid | itemUId | Identifier of the manager item to initialize. |
Returns
Type | Description |
---|---|
System.Boolean |
|
Exceptions
Type | Condition |
---|---|
ArgumentEmptyException | If the empty value is passed as the |
InitializeItems()
Declaration
protected virtual bool InitializeItems()
Returns
Type | Description |
---|---|
System.Boolean |
InitializeItems(IEnumerable<Guid>)
Declaration
protected virtual bool InitializeItems(IEnumerable<Guid> itemUIds)
Parameters
Type | Name | Description |
---|---|---|
System.Collections.Generic.IEnumerable<System.Guid> | itemUIds |
Returns
Type | Description |
---|---|
System.Boolean |
InitializeItems(Guid)
Declaration
protected virtual bool InitializeItems(Guid itemUId)
Parameters
Type | Name | Description |
---|---|---|
System.Guid | itemUId |
Returns
Type | Description |
---|---|
System.Boolean |
InitializeItemsCaption(IEnumerable<Guid>)
Declaration
protected virtual void InitializeItemsCaption(IEnumerable<Guid> itemUIds)
Parameters
Type | Name | Description |
---|---|---|
System.Collections.Generic.IEnumerable<System.Guid> | itemUIds |
InitializeItemsCaption(Guid)
Declaration
protected virtual void InitializeItemsCaption(Guid itemUId)
Parameters
Type | Name | Description |
---|---|---|
System.Guid | itemUId |
InitializeSafeInstance(ISchemaManagerItem<TSchemaManagerSchema>)
Declaration
protected override TSchemaManagerSchema InitializeSafeInstance(ISchemaManagerItem<TSchemaManagerSchema> item)
Parameters
Type | Name | Description |
---|---|---|
ISchemaManagerItem<TSchemaManagerSchema> | item |
Returns
Type | Description |
---|---|
TSchemaManagerSchema |
Overrides
InitializeSafeSchema(ISchemaManagerItem, Assembly)
Creates the schema instance for the type specified in the passed-in manager item. If the schema type is not found in the assembly, null
is returned.
Declaration
public virtual IManagerItemInstance InitializeSafeSchema(ISchemaManagerItem schemaManagerItem, Assembly assembly)
Parameters
Type | Name | Description |
---|---|---|
ISchemaManagerItem | schemaManagerItem | The manager item where the schema is to be initialized. |
System.Reflection.Assembly | assembly | An assembly that contains the type of the schema that is being created. |
Returns
Type | Description |
---|---|
IManagerItemInstance | The initialized schema instance or |
InitializeSchema(ISchemaManagerItem, Assembly)
Creates the schema instance for the type specified in the passed-in manager item. If the type of the schema of the manager item is not found, an exception is thrown.
Declaration
public virtual IManagerItemInstance InitializeSchema(ISchemaManagerItem schemaManagerItem, Assembly assembly)
Parameters
Type | Name | Description |
---|---|---|
ISchemaManagerItem | schemaManagerItem | The manager item where the schema is to be initialized. |
System.Reflection.Assembly | assembly | An assembly that contains the type of the schema that is being created. |
Returns
Type | Description |
---|---|
IManagerItemInstance | The initialized instance of the schema. |
InitializeSchemaExtraProperties(TSchemaManagerSchema, ISchemaManagerItem)
Declaration
protected void InitializeSchemaExtraProperties(TSchemaManagerSchema schemaManagerItemSchema, ISchemaManagerItem schemaManagerItem)
Parameters
Type | Name | Description |
---|---|---|
TSchemaManagerSchema | schemaManagerItemSchema | |
ISchemaManagerItem | schemaManagerItem |
InitializeSchemaProperties(TSchemaManagerSchema, ISchemaManagerItem)
Declaration
protected void InitializeSchemaProperties(TSchemaManagerSchema schemaManagerItemSchema, ISchemaManagerItem schemaManagerItem)
Parameters
Type | Name | Description |
---|---|---|
TSchemaManagerSchema | schemaManagerItemSchema | |
ISchemaManagerItem | schemaManagerItem |
InitializeSchemaUserProperties(TSchemaManagerSchema, ISchemaManagerItem)
Initializes schema user properties from manager item.
Declaration
protected void InitializeSchemaUserProperties(TSchemaManagerSchema schemaManagerItemSchema, ISchemaManagerItem schemaManagerItem)
Parameters
Type | Name | Description |
---|---|---|
TSchemaManagerSchema | schemaManagerItemSchema | Schema. |
ISchemaManagerItem | schemaManagerItem | Manager item. |
InitializeUserPropertiesForAllItems(Guid)
Declaration
protected virtual void InitializeUserPropertiesForAllItems(Guid workspaceId)
Parameters
Type | Name | Description |
---|---|---|
System.Guid | workspaceId |
InitializeUserPropertiesForItem(ISchemaManagerItem)
Declaration
protected virtual void InitializeUserPropertiesForItem(ISchemaManagerItem managerItem)
Parameters
Type | Name | Description |
---|---|---|
ISchemaManagerItem | managerItem |
InternalCreateSchema(Guid, Guid, Guid, String, TSchemaManagerSchema, Boolean)
Declaration
protected TSchemaManagerSchema InternalCreateSchema(Guid schemaId, Guid schemaUId, Guid realUId, string schemaName, TSchemaManagerSchema baseSchema, bool fromMetaData = false)
Parameters
Type | Name | Description |
---|---|---|
System.Guid | schemaId | |
System.Guid | schemaUId | |
System.Guid | realUId | |
System.String | schemaName | |
TSchemaManagerSchema | baseSchema | |
System.Boolean | fromMetaData |
Returns
Type | Description |
---|---|
TSchemaManagerSchema |
InternalCreateSchema(String, TSchemaManagerSchema, UserConnection, Boolean)
Declaration
protected ISchemaManagerItem<TSchemaManagerSchema> InternalCreateSchema(string name, TSchemaManagerSchema baseSchema, UserConnection userConnection, bool fromMetaData = false)
Parameters
Type | Name | Description |
---|---|---|
System.String | name | |
TSchemaManagerSchema | baseSchema | |
UserConnection | userConnection | |
System.Boolean | fromMetaData |
Returns
Type | Description |
---|---|
ISchemaManagerItem<TSchemaManagerSchema> |
InternalCreateSchema(String, TSchemaManagerSchema, UserConnection, Guid, Boolean)
Internally creates new manager item.
Declaration
protected virtual ISchemaManagerItem<TSchemaManagerSchema> InternalCreateSchema(string name, TSchemaManagerSchema baseSchema, UserConnection userConnection, Guid uid, bool fromMetaData = false)
Parameters
Type | Name | Description |
---|---|---|
System.String | name | The item name. |
TSchemaManagerSchema | baseSchema | The base schema. |
UserConnection | userConnection | The user connection. |
System.Guid | uid | The unique identifier. |
System.Boolean | fromMetaData |
|
Returns
Type | Description |
---|---|
ISchemaManagerItem<TSchemaManagerSchema> | The new manager item. |
InternalCreateSchema(String, ISchemaManagerItem, UserConnection, Boolean)
Declaration
protected ISchemaManagerItem InternalCreateSchema(string name, ISchemaManagerItem baseSchema, UserConnection userConnection, bool fromMetaData)
Parameters
Type | Name | Description |
---|---|---|
System.String | name | |
ISchemaManagerItem | baseSchema | |
UserConnection | userConnection | |
System.Boolean | fromMetaData |
Returns
Type | Description |
---|---|
ISchemaManagerItem |
InternalDesignSchema(UserConnection, Guid)
Declaration
protected ISchemaManagerItem<TSchemaManagerSchema> InternalDesignSchema(UserConnection userConnection, Guid realUId)
Parameters
Type | Name | Description |
---|---|---|
UserConnection | userConnection | |
System.Guid | realUId |
Returns
Type | Description |
---|---|
ISchemaManagerItem<TSchemaManagerSchema> |
InternalSaveSchema(ISchemaManagerItem<TSchemaManagerSchema>, Guid, Boolean, UserConnection, Boolean)
Declaration
protected virtual bool InternalSaveSchema(ISchemaManagerItem<TSchemaManagerSchema> designItem, Guid packageUId, bool removeDesignItem, UserConnection userConnection, bool generateBundles)
Parameters
Type | Name | Description |
---|---|---|
ISchemaManagerItem<TSchemaManagerSchema> | designItem | |
System.Guid | packageUId | |
System.Boolean | removeDesignItem | |
UserConnection | userConnection | |
System.Boolean | generateBundles |
Returns
Type | Description |
---|---|
System.Boolean |
InternalSaveSchema(ISchemaManagerItem<TSchemaManagerSchema>, Guid, Boolean, UserConnection, Boolean, Boolean)
Declaration
protected virtual bool InternalSaveSchema(ISchemaManagerItem<TSchemaManagerSchema> designItem, Guid packageUId, bool removeDesignItem, UserConnection userConnection, bool generateBundles, bool validateNamePrefixes)
Parameters
Type | Name | Description |
---|---|---|
ISchemaManagerItem<TSchemaManagerSchema> | designItem | |
System.Guid | packageUId | |
System.Boolean | removeDesignItem | |
UserConnection | userConnection | |
System.Boolean | generateBundles | |
System.Boolean | validateNamePrefixes |
Returns
Type | Description |
---|---|
System.Boolean |
InternalSaveSchema(ISchemaManagerItem<TSchemaManagerSchema>, Guid, Boolean, UserConnection, Boolean, Boolean, Boolean)
Declaration
protected virtual bool InternalSaveSchema(ISchemaManagerItem<TSchemaManagerSchema> designItem, Guid packageUId, bool removeDesignItem, UserConnection userConnection, bool generateBundles, bool validateNamePrefixes, bool lockSchemaInSourceControlStorage)
Parameters
Type | Name | Description |
---|---|---|
ISchemaManagerItem<TSchemaManagerSchema> | designItem | |
System.Guid | packageUId | |
System.Boolean | removeDesignItem | |
UserConnection | userConnection | |
System.Boolean | generateBundles | |
System.Boolean | validateNamePrefixes | |
System.Boolean | lockSchemaInSourceControlStorage |
Returns
Type | Description |
---|---|
System.Boolean |
InternalSaveSchema(ISchemaManagerItem<TSchemaManagerSchema>, Guid, Boolean, UserConnection, Boolean, Boolean, Boolean, Boolean)
Declaration
protected virtual bool InternalSaveSchema(ISchemaManagerItem<TSchemaManagerSchema> designItem, Guid packageUId, bool removeDesignItem, UserConnection userConnection, bool generateBundles, bool validateNamePrefixes, bool lockSchemaInSourceControlStorage, bool useFullHierarchy)
Parameters
Type | Name | Description |
---|---|---|
ISchemaManagerItem<TSchemaManagerSchema> | designItem | |
System.Guid | packageUId | |
System.Boolean | removeDesignItem | |
UserConnection | userConnection | |
System.Boolean | generateBundles | |
System.Boolean | validateNamePrefixes | |
System.Boolean | lockSchemaInSourceControlStorage | |
System.Boolean | useFullHierarchy |
Returns
Type | Description |
---|---|
System.Boolean |
InternalSaveSchemaInDB(ISchemaManagerItem<TSchemaManagerSchema>, Guid, Boolean, UserConnection, Boolean, Boolean)
Declaration
protected virtual bool InternalSaveSchemaInDB(ISchemaManagerItem<TSchemaManagerSchema> designItem, Guid packageUId, bool removeDesignItem, UserConnection userConnection, bool validateNamePrefixes, bool lockSchemaInSourceControlStorage = false)
Parameters
Type | Name | Description |
---|---|---|
ISchemaManagerItem<TSchemaManagerSchema> | designItem | |
System.Guid | packageUId | |
System.Boolean | removeDesignItem | |
UserConnection | userConnection | |
System.Boolean | validateNamePrefixes | |
System.Boolean | lockSchemaInSourceControlStorage |
Returns
Type | Description |
---|---|
System.Boolean |
InternalSaveSchemaInDB(ISchemaManagerItem<TSchemaManagerSchema>, Guid, Boolean, UserConnection, Boolean, Boolean, Boolean)
Declaration
protected virtual bool InternalSaveSchemaInDB(ISchemaManagerItem<TSchemaManagerSchema> designItem, Guid packageUId, bool removeDesignItem, UserConnection userConnection, bool validateNamePrefixes, bool lockSchemaInSourceControlStorage, bool useFullHierarchy)
Parameters
Type | Name | Description |
---|---|---|
ISchemaManagerItem<TSchemaManagerSchema> | designItem | |
System.Guid | packageUId | |
System.Boolean | removeDesignItem | |
UserConnection | userConnection | |
System.Boolean | validateNamePrefixes | |
System.Boolean | lockSchemaInSourceControlStorage | |
System.Boolean | useFullHierarchy |
Returns
Type | Description |
---|---|
System.Boolean |
IsInheritedFrom(Guid, Guid)
Returns flag that indicates if schema is inherited from specified parent schema.
Declaration
public bool IsInheritedFrom(Guid uId, Guid parentUId)
Parameters
Type | Name | Description |
---|---|---|
System.Guid | uId | Schema identifier. |
System.Guid | parentUId | Parent schema identifier. |
Returns
Type | Description |
---|---|
System.Boolean |
LoadLocalizableValues(TSchemaManagerSchema)
Declaration
protected virtual void LoadLocalizableValues(TSchemaManagerSchema schemaManagerItemSchema)
Parameters
Type | Name | Description |
---|---|---|
TSchemaManagerSchema | schemaManagerItemSchema |
LoadManagerResources(SchemaResourceManager, Dictionary<String, String>)
Declaration
protected void LoadManagerResources(SchemaResourceManager manager, Dictionary<string, string> resources)
Parameters
Type | Name | Description |
---|---|---|
SchemaResourceManager | manager | |
System.Collections.Generic.Dictionary<System.String, System.String> | resources |
ModifyMetaDataProperty(JsonDataDifferencePackage, TSchemaManagerSchema)
Declaration
protected virtual void ModifyMetaDataProperty(JsonDataDifferencePackage package, TSchemaManagerSchema schema)
Parameters
Type | Name | Description |
---|---|---|
JsonDataDifferencePackage | package | |
TSchemaManagerSchema | schema |
ModifyMetaDataProperty(JsonDataDifferencePackage, TSchemaManagerSchema, Boolean)
Declaration
protected virtual void ModifyMetaDataProperty(JsonDataDifferencePackage package, TSchemaManagerSchema schema, bool useFullHierarchy)
Parameters
Type | Name | Description |
---|---|---|
JsonDataDifferencePackage | package | |
TSchemaManagerSchema | schema | |
System.Boolean | useFullHierarchy |
MoveSchema(Guid, Guid)
Declaration
public void MoveSchema(Guid schemaUId, Guid targetPackageUId)
Parameters
Type | Name | Description |
---|---|---|
System.Guid | schemaUId | |
System.Guid | targetPackageUId |
MoveSchemas(IEnumerable<Guid>, Guid)
Declaration
public void MoveSchemas(IEnumerable<Guid> schemaUIds, Guid targetPackageUId)
Parameters
Type | Name | Description |
---|---|---|
System.Collections.Generic.IEnumerable<System.Guid> | schemaUIds | |
System.Guid | targetPackageUId |
OnItemAdded(SchemaManagerItemAfterAddEventArgs)
Event handler used after adding a new schema.
Declaration
protected virtual void OnItemAdded(SchemaManagerItemAfterAddEventArgs e)
Parameters
Type | Name | Description |
---|---|---|
SchemaManagerItemAfterAddEventArgs | e | Arguments of the event that occurs after adding a new schema. |
OnItemAdding(SchemaManagerItemBeforeAddEventArgs)
Event handler used before adding a new schema.
Declaration
protected virtual void OnItemAdding(SchemaManagerItemBeforeAddEventArgs e)
Parameters
Type | Name | Description |
---|---|---|
SchemaManagerItemBeforeAddEventArgs | e | Arguments of the event that occurs before adding a new schema. |
OnItemRemoved(SchemaManagerItemAfterRemoveEventArgs)
Event handler used after deleting a schema.
Declaration
protected virtual void OnItemRemoved(SchemaManagerItemAfterRemoveEventArgs e)
Parameters
Type | Name | Description |
---|---|---|
SchemaManagerItemAfterRemoveEventArgs | e | Arguments of the event that occurs after deleting a schema. |
OnItemRemoving(SchemaManagerItemBeforeRemoveEventArgs)
Event handler used before deleting a schema.
Declaration
protected virtual void OnItemRemoving(SchemaManagerItemBeforeRemoveEventArgs e)
Parameters
Type | Name | Description |
---|---|---|
SchemaManagerItemBeforeRemoveEventArgs | e | Arguments of the event that occurs before deleting a schema. |
OnItemSaved(SchemaManagerItemAfterSaveEventArgs)
Event handler used after saving a schema.
Declaration
protected virtual void OnItemSaved(SchemaManagerItemAfterSaveEventArgs e)
Parameters
Type | Name | Description |
---|---|---|
SchemaManagerItemAfterSaveEventArgs | e | Arguments of the event that occurs after saving a schema. |
OnItemSaving(SchemaManagerItemBeforeSaveEventArgs)
Event handler used before saving a schema.
Declaration
protected virtual void OnItemSaving(SchemaManagerItemBeforeSaveEventArgs e)
Parameters
Type | Name | Description |
---|---|---|
SchemaManagerItemBeforeSaveEventArgs | e | Arguments of the event that occurs before saving a schema. |
RefreshItems()
Declaration
public void RefreshItems()
RefreshItems(IEnumerable<Guid>)
Declaration
public void RefreshItems(IEnumerable<Guid> itemUIds)
Parameters
Type | Name | Description |
---|---|---|
System.Collections.Generic.IEnumerable<System.Guid> | itemUIds |
ReInitializeRuntimeSchemaResourceManager(String, String)
Declaration
protected void ReInitializeRuntimeSchemaResourceManager(string resourceManagerName, string schemaName)
Parameters
Type | Name | Description |
---|---|---|
System.String | resourceManagerName | |
System.String | schemaName |
ReInitializeSchemaLocalizableValues(UserConnection, ISchemaManagerItem<TSchemaManagerSchema>, HierarchySchemaInfo)
Declaration
protected virtual void ReInitializeSchemaLocalizableValues(UserConnection userConnection, ISchemaManagerItem<TSchemaManagerSchema> schemaItem, HierarchySchemaInfo hierarchySchemaInfo)
Parameters
Type | Name | Description |
---|---|---|
UserConnection | userConnection | |
ISchemaManagerItem<TSchemaManagerSchema> | schemaItem | |
HierarchySchemaInfo | hierarchySchemaInfo |
ReleaseResourcesManagers(Guid, UserConnection)
Declaration
protected void ReleaseResourcesManagers(Guid schemaId, UserConnection userConnection)
Parameters
Type | Name | Description |
---|---|---|
System.Guid | schemaId | |
UserConnection | userConnection |
RemoveDesignedItemFromSessionData(ISchemaManagerItem)
Deletes the specified designed item from the session data.
Declaration
public void RemoveDesignedItemFromSessionData(ISchemaManagerItem designItem)
Parameters
Type | Name | Description |
---|---|---|
ISchemaManagerItem | designItem | The designed manager item to delete. |
RemoveDesignedItemFromSessionData(UserConnection, Guid)
Deletes the designed item with the specified identifier from the session data.
Declaration
public void RemoveDesignedItemFromSessionData(UserConnection userConnection, Guid uid)
Parameters
Type | Name | Description |
---|---|---|
UserConnection | userConnection | User connection. |
System.Guid | uid | The identifier of the designed item. |
Remarks
Method is overloaded.
RemoveDesignedItemIdFromSessionData(UserConnection, Guid)
Declaration
public void RemoveDesignedItemIdFromSessionData(UserConnection userConnection, Guid uid)
Parameters
Type | Name | Description |
---|---|---|
UserConnection | userConnection | |
System.Guid | uid |
RemoveDesignedItemPackageUIdFromSessionData(UserConnection, Guid)
Declaration
public void RemoveDesignedItemPackageUIdFromSessionData(UserConnection userConnection, Guid uid)
Parameters
Type | Name | Description |
---|---|---|
UserConnection | userConnection | |
System.Guid | uid |
RemoveItem(ISchemaManagerItem<TSchemaManagerSchema>, UserConnection)
Declaration
protected void RemoveItem(ISchemaManagerItem<TSchemaManagerSchema> item, UserConnection userConnection)
Parameters
Type | Name | Description |
---|---|---|
ISchemaManagerItem<TSchemaManagerSchema> | item | |
UserConnection | userConnection |
RemoveItemByName(Guid, String, UserConnection)
Declaration
public void RemoveItemByName(Guid packageUId, string name, UserConnection userConnection)
Parameters
Type | Name | Description |
---|---|---|
System.Guid | packageUId | |
System.String | name | |
UserConnection | userConnection |
RemoveItemByUId(Guid, UserConnection)
Removes item with given UId from manager items collection.
Declaration
public void RemoveItemByUId(Guid uid, UserConnection userConnection)
Parameters
Type | Name | Description |
---|---|---|
System.Guid | uid | Item UId. |
UserConnection | userConnection | User connection. |
RemoveSchema(Guid, UserConnection)
Removes schema from database by the identifier supplied.
Declaration
public virtual Guid RemoveSchema(Guid schemaId, UserConnection userConnection)
Parameters
Type | Name | Description |
---|---|---|
System.Guid | schemaId | Identifier of the schema to remove. |
UserConnection | userConnection | User connection. |
Returns
Type | Description |
---|---|
System.Guid | Deleted record identifier from the SysSchemaInSolution. |
Exceptions
Type | Condition |
---|---|
System.Security.SecurityException | Throws if the user does not have the rights to remove the schema. |
RemoveSchemaFromMetaDataCache(ISchemaManagerItem<TSchemaManagerSchema>)
Removes the schema from meta data cache.
Declaration
protected void RemoveSchemaFromMetaDataCache(ISchemaManagerItem<TSchemaManagerSchema> designItem)
Parameters
Type | Name | Description |
---|---|---|
ISchemaManagerItem<TSchemaManagerSchema> | designItem | The design item. |
SaveDesignedDataToSession(UserConnection, ISchemaManagerItem<TSchemaManagerSchema>, Guid)
Declaration
protected void SaveDesignedDataToSession(UserConnection userConnection, ISchemaManagerItem<TSchemaManagerSchema> managerItem, Guid packageUId)
Parameters
Type | Name | Description |
---|---|---|
UserConnection | userConnection | |
ISchemaManagerItem<TSchemaManagerSchema> | managerItem | |
System.Guid | packageUId |
SaveDesignedItemAdditionalData(UserConnection, ISchemaManagerItem, Guid)
Declaration
protected virtual void SaveDesignedItemAdditionalData(UserConnection userConnection, ISchemaManagerItem managerItem, Guid customPackageUId)
Parameters
Type | Name | Description |
---|---|---|
UserConnection | userConnection | |
ISchemaManagerItem | managerItem | |
System.Guid | customPackageUId |
SaveDesignedItemFolderIdInSessionData(UserConnection, Guid, Guid)
Saves the passed-in identifier of the catalog which contains the designed item schema with the specified identifier to the session data.
Declaration
public void SaveDesignedItemFolderIdInSessionData(UserConnection userConnection, Guid designedItemId, Guid designedItemFolderId)
Parameters
Type | Name | Description |
---|---|---|
UserConnection | userConnection | User connection. |
System.Guid | designedItemId | The identifier of the designed item. |
System.Guid | designedItemFolderId | Identifier of the catalog that contains the designed item schema with the |
SaveDesignedItemIdInSessionData(UserConnection, Guid, Guid)
Declaration
public void SaveDesignedItemIdInSessionData(UserConnection userConnection, Guid uid, Guid designedItemId)
Parameters
Type | Name | Description |
---|---|---|
UserConnection | userConnection | |
System.Guid | uid | |
System.Guid | designedItemId |
SaveDesignedItemInSessionData(ISchemaManagerItem)
Serializes and saves the instance of the specified designed schema to the session data.
Declaration
public void SaveDesignedItemInSessionData(ISchemaManagerItem designItem)
Parameters
Type | Name | Description |
---|---|---|
ISchemaManagerItem | designItem | The manager item that contains the designed schema whose instance is saved in the session data. |
Remarks
Method is overloaded.
SaveDesignedItemInSessionData(ISchemaManagerItem<TSchemaManagerSchema>)
Serializes the instance of the specified typed schema that is being designed and saves it to the session data.
Declaration
public void SaveDesignedItemInSessionData(ISchemaManagerItem<TSchemaManagerSchema> designItem)
Parameters
Type | Name | Description |
---|---|---|
ISchemaManagerItem<TSchemaManagerSchema> | designItem | The manager item that contains the typed designed schema whose instance is saved in the session data. |
Remarks
Method is overloaded.
SaveDesignedItemInSessionData(UserConnection, MetaSchema, Guid)
Serializes the instance of the designed schema with the specified identifier and saves it to the session data.
Declaration
public void SaveDesignedItemInSessionData(UserConnection userConnection, MetaSchema designedItem, Guid designedItemId)
Parameters
Type | Name | Description |
---|---|---|
UserConnection | userConnection | User connection. |
MetaSchema | designedItem | An instance of the designed manager item. |
System.Guid | designedItemId | Identifier of the designed schema to save. |
SaveDesignedItemPackageUIdInSessionData(UserConnection, Guid, Guid)
Declaration
public void SaveDesignedItemPackageUIdInSessionData(UserConnection userConnection, Guid uid, Guid packageUId)
Parameters
Type | Name | Description |
---|---|---|
UserConnection | userConnection | |
System.Guid | uid | |
System.Guid | packageUId |
SaveExtraProperties(ISchemaManagerItem<TSchemaManagerSchema>, Guid)
Declaration
protected virtual void SaveExtraProperties(ISchemaManagerItem<TSchemaManagerSchema> item, Guid sysSchemaId)
Parameters
Type | Name | Description |
---|---|---|
ISchemaManagerItem<TSchemaManagerSchema> | item | |
System.Guid | sysSchemaId |
SaveItem(SysSchema, ISchemaManagerItem<TSchemaManagerSchema>)
Declaration
protected virtual void SaveItem(SysSchema schema, ISchemaManagerItem<TSchemaManagerSchema> item)
Parameters
Type | Name | Description |
---|---|---|
SysSchema | schema | |
ISchemaManagerItem<TSchemaManagerSchema> | item |
SaveMetaData(TSchemaManagerSchema, SysSchema, UserConnection)
Declaration
protected virtual string SaveMetaData(TSchemaManagerSchema schema, SysSchema sysSchema, UserConnection userConnection)
Parameters
Type | Name | Description |
---|---|---|
TSchemaManagerSchema | schema | |
SysSchema | sysSchema | |
UserConnection | userConnection |
Returns
Type | Description |
---|---|
System.String |
SaveMetaData(MemoryStream, SysSchema, ISchemaManagerItem)
Declaration
protected virtual void SaveMetaData(MemoryStream metaData, SysSchema sysSchema, ISchemaManagerItem item)
Parameters
Type | Name | Description |
---|---|---|
System.IO.MemoryStream | metaData | |
SysSchema | sysSchema | |
ISchemaManagerItem | item |
SaveMetaDataDifferencePackage(TSchemaManagerSchema, SysSchema, String, UserConnection, Boolean)
Saves the metadata difference package.
Declaration
protected virtual void SaveMetaDataDifferencePackage(TSchemaManagerSchema schema, SysSchema sysSchema, string schemaMetaData, UserConnection userConnection, bool isNew)
Parameters
Type | Name | Description |
---|---|---|
TSchemaManagerSchema | schema | The schema. |
SysSchema | sysSchema | The schema entity. |
System.String | schemaMetaData | The schema metadata. |
UserConnection | userConnection | The user connection. |
System.Boolean | isNew |
|
SaveMetaDataDifferencePackage(TSchemaManagerSchema, SysSchema, String, UserConnection, Boolean, Boolean)
Declaration
protected virtual void SaveMetaDataDifferencePackage(TSchemaManagerSchema schema, SysSchema sysSchema, string schemaMetaData, UserConnection userConnection, bool isNew, bool useFullHierarchy)
Parameters
Type | Name | Description |
---|---|---|
TSchemaManagerSchema | schema | |
SysSchema | sysSchema | |
System.String | schemaMetaData | |
UserConnection | userConnection | |
System.Boolean | isNew | |
System.Boolean | useFullHierarchy |
SaveSchema(Guid, Boolean, UserConnection, Boolean, Boolean)
Saves schema.
Declaration
public bool SaveSchema(Guid uid, bool removeDesignItem, UserConnection userConnection, bool generateBundles = true, bool lockSchemaInSourceControlStorage = false)
Parameters
Type | Name | Description |
---|---|---|
System.Guid | uid | Specified designed schema UId. |
System.Boolean | removeDesignItem | Determines if the schema should be deleted from designed schemas collection in manager after save. |
UserConnection | userConnection | Specified instance of UserConnection. |
System.Boolean | generateBundles | Determines if schema bundles should be generated after save. |
System.Boolean | lockSchemaInSourceControlStorage | Determines if schema bundles should be generated after save. |
Returns
Type | Description |
---|---|
System.Boolean |
|
Remarks
The method is overloaded.
Exceptions
Type | Condition |
---|---|
System.Security.SecurityException | If user have no rights to modify schema. |
SaveSchema(Guid, UserConnection, Boolean, Boolean)
Saves schema.
Declaration
public bool SaveSchema(Guid uid, UserConnection userConnection, bool generateBundles = true, bool lockSchemaInSourceControlStorage = false)
Parameters
Type | Name | Description |
---|---|---|
System.Guid | uid | Specified designed schema UId. |
UserConnection | userConnection | Specified instance of UserConnection. |
System.Boolean | generateBundles | Determines if schema bundles should be generated after save. |
System.Boolean | lockSchemaInSourceControlStorage | Determines if schema bundles should be generated after save. |
Returns
Type | Description |
---|---|
System.Boolean |
|
Remarks
The method is overloaded.
The method calls method SaveSchema(Guid, Boolean, UserConnection, Boolean, Boolean), with second
argument value - false
.
SaveSchema(ISchemaManagerItem<TSchemaManagerSchema>, UserConnection, Boolean, Boolean, Boolean)
Saves schema.
Declaration
public bool SaveSchema(ISchemaManagerItem<TSchemaManagerSchema> designItem, UserConnection userConnection, bool generateBundles = true, bool lockSchemaInSourceControlStorage = false, bool useFullHierarchy = false)
Parameters
Type | Name | Description |
---|---|---|
ISchemaManagerItem<TSchemaManagerSchema> | designItem | Specified instance of ISchemaManagerItem<TSchemaManagerSchema>. |
UserConnection | userConnection | Specified instance of UserConnection. |
System.Boolean | generateBundles | Determines if schema bundles should be generated after save. |
System.Boolean | lockSchemaInSourceControlStorage | Determines if schema should be locked in source control storage. |
System.Boolean | useFullHierarchy | Determines if full schema hierarchy should be used to save metadata. |
Returns
Type | Description |
---|---|
System.Boolean |
|
Exceptions
Type | Condition |
---|---|
System.Security.SecurityException | If user have no rights to modify schema. |
SaveSchemaContent(ISchemaManagerItem<TSchemaManagerSchema>)
Declaration
protected virtual void SaveSchemaContent(ISchemaManagerItem<TSchemaManagerSchema> item)
Parameters
Type | Name | Description |
---|---|---|
ISchemaManagerItem<TSchemaManagerSchema> | item |
SaveSchemaInCustomPackage(Guid, Boolean, UserConnection, Boolean)
Saves schema in custom package.
Declaration
public bool SaveSchemaInCustomPackage(Guid uid, bool removeDesignItem, UserConnection userConnection, bool generateBundles = true)
Parameters
Type | Name | Description |
---|---|---|
System.Guid | uid | Specified designed schema UId. |
System.Boolean | removeDesignItem | Determines if the schema should be deleted from designed schemas collection in manager after save. |
UserConnection | userConnection | Specified instance of UserConnection. |
System.Boolean | generateBundles | Determines if schema bundles should be generated after save. |
Returns
Type | Description |
---|---|
System.Boolean |
|
Remarks
The method is overloaded.
SaveSchemaInCustomPackage(Guid, UserConnection, Boolean)
Saves schema in custom package.
Declaration
public bool SaveSchemaInCustomPackage(Guid uid, UserConnection userConnection, bool generateBundles = true)
Parameters
Type | Name | Description |
---|---|---|
System.Guid | uid | Specified designed schema UId. |
UserConnection | userConnection | Specified instance of UserConnection. |
System.Boolean | generateBundles | Determines if schema bundles should be generated after save. |
Returns
Type | Description |
---|---|
System.Boolean |
|
Remarks
The method is overloaded.
The method calls method SaveSchemaInCustomPackage(Guid, Boolean, UserConnection, Boolean),
with second argument value - false
.
SaveSchemaItem(ISchemaManagerItem<TSchemaManagerSchema>, Guid, Boolean, UserConnection, Boolean)
Declaration
protected virtual SchemaManagerItemInfo SaveSchemaItem(ISchemaManagerItem<TSchemaManagerSchema> item, Guid packageId, bool validateNamePrefixes, UserConnection userConnection = null, bool lockSchemaInSourceControlStorage = false)
Parameters
Type | Name | Description |
---|---|---|
ISchemaManagerItem<TSchemaManagerSchema> | item | |
System.Guid | packageId | |
System.Boolean | validateNamePrefixes | |
UserConnection | userConnection | |
System.Boolean | lockSchemaInSourceControlStorage |
Returns
Type | Description |
---|---|
SchemaManagerItemInfo |
SaveSchemaMetaData(TSchemaManagerSchema, Guid, UserConnection, Boolean)
Declaration
protected virtual void SaveSchemaMetaData(TSchemaManagerSchema schema, Guid schemaId, UserConnection userConnection, bool isNew)
Parameters
Type | Name | Description |
---|---|---|
TSchemaManagerSchema | schema | |
System.Guid | schemaId | |
UserConnection | userConnection | |
System.Boolean | isNew |
SaveSchemaMetaData(TSchemaManagerSchema, Guid, UserConnection, Boolean, Boolean)
Declaration
protected virtual void SaveSchemaMetaData(TSchemaManagerSchema schema, Guid schemaId, UserConnection userConnection, bool isNew, bool useFullHierarchy)
Parameters
Type | Name | Description |
---|---|---|
TSchemaManagerSchema | schema | |
System.Guid | schemaId | |
UserConnection | userConnection | |
System.Boolean | isNew | |
System.Boolean | useFullHierarchy |
SaveSchemaMetaData(ISchemaManagerItem, Guid, UserConnection)
Declaration
public void SaveSchemaMetaData(ISchemaManagerItem managerItem, Guid schemaId, UserConnection userConnection)
Parameters
Type | Name | Description |
---|---|---|
ISchemaManagerItem | managerItem | |
System.Guid | schemaId | |
UserConnection | userConnection |
SaveSchemaPackageDifference(UserConnection, PackageElementInfo, String)
Declaration
public void SaveSchemaPackageDifference(UserConnection userConnection, PackageElementInfo schemaInfo, string packageDifferenceValue)
Parameters
Type | Name | Description |
---|---|---|
UserConnection | userConnection | |
PackageElementInfo | schemaInfo | |
System.String | packageDifferenceValue |
SaveSchemaResourcesInDB(ISchemaManagerItem<TSchemaManagerSchema>, Dictionary<String, LocalizableValueCollection>, Guid, Guid, UserConnection)
Declaration
protected virtual bool SaveSchemaResourcesInDB(ISchemaManagerItem<TSchemaManagerSchema> designItem, Dictionary<string, LocalizableValueCollection> schemaResources, Guid sysSchemaId, Guid packageId, UserConnection userConnection)
Parameters
Type | Name | Description |
---|---|---|
ISchemaManagerItem<TSchemaManagerSchema> | designItem | |
System.Collections.Generic.Dictionary<System.String, LocalizableValueCollection> | schemaResources | |
System.Guid | sysSchemaId | |
System.Guid | packageId | |
UserConnection | userConnection |
Returns
Type | Description |
---|---|
System.Boolean |
SaveSchemaSources(EntityCollection)
Saves the source code from the passed-in collection.
Declaration
public virtual bool SaveSchemaSources(EntityCollection sources)
Parameters
Type | Name | Description |
---|---|---|
EntityCollection | sources | Collection of the source code to preserve. |
Returns
Type | Description |
---|---|
System.Boolean |
|
SelectCustomProperties(Select)
Declaration
protected virtual void SelectCustomProperties(Select select)
Parameters
Type | Name | Description |
---|---|---|
Select | select |
SetCustomProperties(SysSchema, TSchemaManagerSchema)
Declaration
protected virtual void SetCustomProperties(SysSchema schema, TSchemaManagerSchema item)
Parameters
Type | Name | Description |
---|---|---|
SysSchema | schema | |
TSchemaManagerSchema | item |
SetCustomProperties(ISchemaManagerItem<TSchemaManagerSchema>, TSchemaManagerSchema)
Declaration
protected virtual void SetCustomProperties(ISchemaManagerItem<TSchemaManagerSchema> item, TSchemaManagerSchema schema)
Parameters
Type | Name | Description |
---|---|---|
ISchemaManagerItem<TSchemaManagerSchema> | item | |
TSchemaManagerSchema | schema |
SetCustomProperties(ISchemaManagerItem<TSchemaManagerSchema>, IDataReader)
Declaration
protected virtual void SetCustomProperties(ISchemaManagerItem<TSchemaManagerSchema> item, IDataReader dr)
Parameters
Type | Name | Description |
---|---|---|
ISchemaManagerItem<TSchemaManagerSchema> | item | |
System.Data.IDataReader | dr |
SetMetaItemsCreatedInPackage(TSchemaManagerSchema, Guid)
Declaration
protected void SetMetaItemsCreatedInPackage(TSchemaManagerSchema instance, Guid packageId)
Parameters
Type | Name | Description |
---|---|---|
TSchemaManagerSchema | instance | |
System.Guid | packageId |
TryGenerateSchemaSources(Guid, ISchemaManagerItem, UserConnection)
Declaration
public bool TryGenerateSchemaSources(Guid sysSchemaId, ISchemaManagerItem schemaManagerItem, UserConnection userConnection)
Parameters
Type | Name | Description |
---|---|---|
System.Guid | sysSchemaId | |
ISchemaManagerItem | schemaManagerItem | |
UserConnection | userConnection |
Returns
Type | Description |
---|---|
System.Boolean |
TryGetMetaDataInstanceFromCache(Guid, Guid, out TSchemaManagerSchema, Nullable<Guid>)
Declaration
protected bool TryGetMetaDataInstanceFromCache(Guid packageId, Guid schemaUId, out TSchemaManagerSchema schema, Guid? excludeSchemaUId)
Parameters
Type | Name | Description |
---|---|---|
System.Guid | packageId | |
System.Guid | schemaUId | |
TSchemaManagerSchema | schema | |
System.Nullable<System.Guid> | excludeSchemaUId |
Returns
Type | Description |
---|---|
System.Boolean |
UpdatePackagePosition(UserConnection, ISchemaManagerItem, Guid)
Declaration
public virtual void UpdatePackagePosition(UserConnection userConnection, ISchemaManagerItem managerItem, Guid packageUId)
Parameters
Type | Name | Description |
---|---|---|
UserConnection | userConnection | |
ISchemaManagerItem | managerItem | |
System.Guid | packageUId |
UpdateResourceManager(UserConnection, String, String)
Declaration
protected void UpdateResourceManager(UserConnection userConnection, string resourceData, string schemaName)
Parameters
Type | Name | Description |
---|---|---|
UserConnection | userConnection | |
System.String | resourceData | |
System.String | schemaName |
Events
Changed
Declaration
public event EventHandler Changed
Event Type
Type | Description |
---|---|
System.EventHandler |
ItemAdded
Event that occurs after adding a new schema.
Declaration
public event EventHandler<SchemaManagerItemAfterAddEventArgs> ItemAdded
Event Type
Type | Description |
---|---|
System.EventHandler<SchemaManagerItemAfterAddEventArgs> |
ItemAdding
Event that occurs before adding a new schema.
Declaration
public event EventHandler<SchemaManagerItemBeforeAddEventArgs> ItemAdding
Event Type
Type | Description |
---|---|
System.EventHandler<SchemaManagerItemBeforeAddEventArgs> |
ItemRemoved
Event that occurs after deleting a schema.
Declaration
public event EventHandler<SchemaManagerItemAfterRemoveEventArgs> ItemRemoved
Event Type
Type | Description |
---|---|
System.EventHandler<SchemaManagerItemAfterRemoveEventArgs> |
ItemRemoving
Event that occurs before deleting a schema.
Declaration
public event EventHandler<SchemaManagerItemBeforeRemoveEventArgs> ItemRemoving
Event Type
Type | Description |
---|---|
System.EventHandler<SchemaManagerItemBeforeRemoveEventArgs> |
ItemSaved
Event that occurs after saving a schema.
Declaration
public event EventHandler<SchemaManagerItemAfterSaveEventArgs> ItemSaved
Event Type
Type | Description |
---|---|
System.EventHandler<SchemaManagerItemAfterSaveEventArgs> |
ItemSaving
Event that occurs before saving a schema.
Declaration
public event EventHandler<SchemaManagerItemBeforeSaveEventArgs> ItemSaving
Event Type
Type | Description |
---|---|
System.EventHandler<SchemaManagerItemBeforeSaveEventArgs> |
Explicit Interface Implementations
ISchemaManager.CreateDesignSchema(UserConnection, Guid, Guid, Boolean)
Declaration
ISchemaManagerItem ISchemaManager.CreateDesignSchema(UserConnection userConnection, Guid parentSchemaUId, Guid packageUId, bool extendParent)
Parameters
Type | Name | Description |
---|---|---|
UserConnection | userConnection | |
System.Guid | parentSchemaUId | |
System.Guid | packageUId | |
System.Boolean | extendParent |
Returns
Type | Description |
---|---|
ISchemaManagerItem |
ISchemaManager.CreateSchema(String, ISchemaManagerItem, UserConnection, Boolean)
Creates a new schema with the specified name and the parent schema, indicating that the schema is generated from the metadata.
Declaration
ISchemaManagerItem ISchemaManager.CreateSchema(string name, ISchemaManagerItem baseSchema, UserConnection userConnection, bool fromMetaData)
Parameters
Type | Name | Description |
---|---|---|
System.String | name | Name of the schema. |
ISchemaManagerItem | baseSchema | The manager item that contains the base schema. |
UserConnection | userConnection | User connection. |
System.Boolean | fromMetaData | Indicates that the schema is generated from the metadata. |
Returns
Type | Description |
---|---|
ISchemaManagerItem | The manager item that contains the schema that was created. |
Remarks
Method is overloaded.
ISchemaManager.CreateSchema(String, ISchemaManagerItem, UserConnection, Guid, Boolean)
Creates a new schema with the specified name and parent schema and indicates that the schema is added to the list of designed schemas.
Declaration
ISchemaManagerItem ISchemaManager.CreateSchema(string name, ISchemaManagerItem baseSchema, UserConnection userConnection, Guid uid, bool addToDesignItems)
Parameters
Type | Name | Description |
---|---|---|
System.String | name | Name of the schema. |
ISchemaManagerItem | baseSchema | The item that contains the parent schema. |
UserConnection | userConnection | User connection. |
System.Guid | uid | Schema identifier. |
System.Boolean | addToDesignItems | Indicates that the schema is added to the list of designed schemas. |
Returns
Type | Description |
---|---|
ISchemaManagerItem | The manager item that contains the schema that was created. |
Remarks
Method is overloaded.
ISchemaManager.GetItemFromMetaData(Guid, Guid, UserConnection)
Declaration
ISchemaManagerItem ISchemaManager.GetItemFromMetaData(Guid sysSchemaUId, Guid sysPackageUId, UserConnection userConnection)
Parameters
Type | Name | Description |
---|---|---|
System.Guid | sysSchemaUId | |
System.Guid | sysPackageUId | |
UserConnection | userConnection |
Returns
Type | Description |
---|---|
ISchemaManagerItem |
ISchemaManager.GetItemFromMetaData(Guid, UserConnection)
Declaration
ISchemaManagerItem ISchemaManager.GetItemFromMetaData(Guid sysSchemaUId, UserConnection userConnection)
Parameters
Type | Name | Description |
---|---|---|
System.Guid | sysSchemaUId | |
UserConnection | userConnection |
Returns
Type | Description |
---|---|
ISchemaManagerItem |
ISchemaManager.SetProvider(SchemaManagerProvider)
Declaration
void ISchemaManager.SetProvider(SchemaManagerProvider schemaManagerProvider)
Parameters
Type | Name | Description |
---|---|---|
SchemaManagerProvider | schemaManagerProvider |