Interface IMetadataResolver

Inherited Members

ICacheProvider.CacheTimeoutMinutes

ICacheProvider.ClearCache()

ICacheProvider.TimeoutChanged

ICacheProvider.CreateCache<K, V>()

ICacheProvider.UnregisterCache<K, V>(IDictionary<K, V>)

IEntityResolver.Invalidate(EntityType, int)

IEntityResolver.Invalidate(EntityType, Guid)

IEntityResolver.Resolvers

IEntityResolver.OriginId

Namespace: Estrelica.Archer.Utility

Assembly: Estrelica.Interfaces.dll

Syntax

[StayPublic]
[DoNotObfuscateType]
public interface IMetadataResolver : ICacheProvider, IEntityResolver

Properties

AllApplications

Returns all available Applications in the target Archer instance.

Declaration

IEnumerable<IArcherApplication> AllApplications { get; }

Property Value

IEnumerable<IArcherApplication>

AllLevels

Returns all available Levels for all available Modules in the target Archer instance.

Declaration

IEnumerable<IArcherLevel> AllLevels { get; }

Property Value

IEnumerable<IArcherLevel>

AllModuleOwners

Returns all module owners for all available Modules in the target Archer instance, if extensions are available, otherwise returns an empty set.

Declaration

IEnumerable<IModuleOwner> AllModuleOwners { get; }

Property Value

IEnumerable<IModuleOwner>

Remarks

Requires extensions

AllQuestionnaires

Returns all available Questionnaires in the target Archer instance.

Declaration

IEnumerable<IArcherQuestionnaire> AllQuestionnaires { get; }

Property Value

IEnumerable<IArcherQuestionnaire>

AllSolutions

Returns all available Solutions in the target Archer instance, if extensions are available, otherwise returns an empty set.

Declaration

IEnumerable<IArcherSolution> AllSolutions { get; }

Property Value

IEnumerable<IArcherSolution>

Remarks

Requires extensions

Methods

AllEncounteredFields(bool)

Returns all fields that have been encountered by the resolver.

Declaration

IEnumerable<IArcherField> AllEncounteredFields(bool forceDiscovery = false)

Parameters

bool forceDiscovery If true, the resolver will iterate through all modules/levels in order to discover all of their fields before returning. If false, only those fields which have already been discovered by virtue of earlier calls will be returned.

Returns

IEnumerable<IArcherField>

AllEncounteredSubforms(bool)

If extensions are available, returns all subforms available in the target Archer instance. If not, any subforms that have already been discovered by virtue of having encountered any ISubformField fields during earlier calls will be returned.

Declaration

IEnumerable<IArcherSubForm> AllEncounteredSubforms(bool forceDiscovery = false)

Parameters

bool forceDiscovery If true, all subforms will be discovered before returning by iterating through all available ISubformField fields. If false, only those subforms that have already been discovered will be returned. This parameter is irrelevant if extensions are available, as in that case the subforms can be identified directly without the need for ISubformField discovery.

Returns

IEnumerable<IArcherSubForm>

Remarks

Does not require extensions, but is optimized if they are available.

AllIds(EntityType)

Returns all available integer Ids for the given EntityType if extensions are available, otherwise returns an empty set.

Declaration

IEnumerable<int> AllIds(EntityType entityType)

Parameters

EntityType entityType The Archer EntityType to retrieve

Returns

IEnumerable<int>

Remarks

Requires extensions

AllModules(bool)

Returns the union of all Applications, Questionnaires, and discovered Subforms in the target Archer instance.

Declaration

IEnumerable<IArcherModule> AllModules(bool forceSubformDiscovery = false)

Parameters

bool forceSubformDiscovery If true, all subforms will be discovered before returning by iterating through all available ISubformField fields. If false, only those subforms that have already been discovered will be returned. This parameter is irrelevant if extensions are available, as in that case the subforms can be identified directly without the need for ISubformField discovery.

Returns

IEnumerable<IArcherModule>

Remarks

Does not require extensions, but is optimized if they are available.

ApplicationByAlias(string, bool)

Returns the Application having the specified alias in the target Archer instance.

Declaration

IArcherApplication ApplicationByAlias(string applicationAlias, bool throwExceptionIfInvalid = true)

Parameters

string applicationAlias

bool throwExceptionIfInvalid If true, an exception will be raised if the alias cannot be resolved to an Application. If false, an unresolveable alias will return null.

Returns

IArcherApplication

ApplicationByGuid(Guid, bool)

Returns the Application having the specified GUID in the target Archer instance.

Declaration

IArcherApplication ApplicationByGuid(Guid applicationGuid, bool throwExceptionIfInvalid = true)

Parameters

Guid applicationGuid The Guid of the Application to be retrieved

bool throwExceptionIfInvalid If true, an exception will be raised if the Guid cannot be resolved to an Application. If false, an unresolveable Guid will return null.

Returns

IArcherApplication

ApplicationById(int, bool)

Returns the Application having the specified integer Id in the target Archer instance.

Declaration

IArcherApplication ApplicationById(int applicationId, bool throwExceptionIfInvalid = true)

Parameters

int applicationId The integer Id of the Application to be retrieved

bool throwExceptionIfInvalid If true, an exception will be raised if the Id cannot be resolved to an Application. If false, an unresolveable Id will return null.

Returns

IArcherApplication

ApplicationByName(string, bool)

Returns the Application having the specified name in the target Archer instance.

Declaration

IArcherApplication ApplicationByName(string applicationName, bool throwExceptionIfInvalid = true)

Parameters

string applicationName The name of the Application to be retrieved

bool throwExceptionIfInvalid If true, an exception will be raised if the name cannot be resolved to an Application. If false, an unresolveable name will return null.

Returns

IArcherApplication

CreateValuesListValue(IArcherValuesList, string)

Declaration

IArcherValuesListValue CreateValuesListValue(IArcherValuesList valuesList, string newValueName)

Parameters

IArcherValuesList valuesList

string newValueName

Returns

IArcherValuesListValue

CreateValuesListValue(int, string)

Declaration

IArcherValuesListValue CreateValuesListValue(int valuesListId, string newValueName)

Parameters

int valuesListId

string newValueName

Returns

IArcherValuesListValue

DeleteValuesListValue(IArcherValuesListValue)

Declaration

bool DeleteValuesListValue(IArcherValuesListValue valueToDelete)

Parameters

IArcherValuesListValue valueToDelete

Returns

bool

DeleteValuesListValue(int, string, bool)

Declaration

bool DeleteValuesListValue(int valuesListId, string valueName, bool ignoreCase = true)

Parameters

int valuesListId

string valueName

bool ignoreCase

Returns

bool

FieldById(int, bool)

Returns the Field having the specified integer Id in the target Archer instance.

Declaration

IArcherField FieldById(int fieldId, bool throwExceptionIfInvalid = true)

Parameters

int fieldId The integer Id of the Field to be retrieved

bool throwExceptionIfInvalid If true, an exception will be raised if the Id cannot be resolved to a Field. If false, an unresolveable Id will return null.

Returns

IArcherField

FieldsByIds(IEnumerable<int>, bool)

Returns a collection of Fields having the specified integer Ids in the target Archer instance.

Declaration

IEnumerable<IArcherField> FieldsByIds(IEnumerable<int> fieldIds, bool throwExceptionIfInvalid = true)

Parameters

IEnumerable<int> fieldIds A collection of integer Ids of the Fields to be returned

bool throwExceptionIfInvalid If true, an exception will be raised if any of the Ids cannot be resolved to a Field. If false, any unresolveable Ids will be represented in the returned result by nulls.

Returns

IEnumerable<IArcherField>

FieldsByLevel(IArcherLevel)

Returns all available Fields for the specified Level in the target Archer instance.

Declaration

IEnumerable<IArcherField> FieldsByLevel(IArcherLevel level)

Parameters

IArcherLevel level

Returns

IEnumerable<IArcherField>

FieldsByLevelId(int, bool)

Returns all available Fields for the Level having the specified integer Id in the target Archer instance.

Declaration

IEnumerable<IArcherField> FieldsByLevelId(int levelId, bool throwExceptionIfInvalid = true)

Parameters

int levelId The integer Id of the Fields' Level

bool throwExceptionIfInvalid If true, an exception will be raised if the Id cannot be resolved to a Level. If false, an unresolveable Id will return an empty set.

Returns

IEnumerable<IArcherField>

FieldsByModule(IArcherModule)

Returns all available Fields for all Levels of the specified Module in the target Archer instance.

Declaration

IEnumerable<IArcherField> FieldsByModule(IArcherModule module)

Parameters

IArcherModule module

Returns

IEnumerable<IArcherField>

FieldsByModuleId(int, bool)

Returns all available Fields for all Levels of the Module having the specified integer Id in the target Archer instance.

Declaration

IEnumerable<IArcherField> FieldsByModuleId(int moduleId, bool throwExceptionIfInvalid = true)

Parameters

int moduleId The integer Id of the Fields' Module

bool throwExceptionIfInvalid If true, an exception will be raised if the Id cannot be resolved to a Module. If false, an unresolveable Id will return an empty set.

Returns

IEnumerable<IArcherField>

FilterCriteriaById(int)

Declaration

IDictionary<string, dynamic> FilterCriteriaById(int filterCriteriaId)

Parameters

int filterCriteriaId

Returns

IDictionary<string, dynamic>

GuidToId(EntityType, Guid, bool)

Declaration

int GuidToId(EntityType entityType, Guid guid, bool throwExceptionIfInvalid = true)

Parameters

EntityType entityType

Guid guid

bool throwExceptionIfInvalid

Returns

int

IdToGuid(EntityType, int, bool)

Declaration

Guid IdToGuid(EntityType entityType, int id, bool throwExceptionIfInvalid = true)

Parameters

EntityType entityType

int id

bool throwExceptionIfInvalid

Returns

Guid

LevelByFieldId(int, bool)

Declaration

IArcherLevel LevelByFieldId(int fieldId, bool throwExceptionIfInvalid = true)

Parameters

int fieldId

bool throwExceptionIfInvalid

Returns

IArcherLevel

LevelByGuid(Guid, bool)

Declaration

IArcherLevel LevelByGuid(Guid levelGuid, bool throwExceptionIfInvalid = true)

Parameters

Guid levelGuid

bool throwExceptionIfInvalid

Returns

IArcherLevel

LevelById(int, bool)

Declaration

IArcherLevel LevelById(int levelId, bool throwExceptionIfInvalid = true)

Parameters

int levelId

bool throwExceptionIfInvalid

Returns

IArcherLevel

LevelFiltersByLevelId(int)

Declaration

IEnumerable<ILevelFilter> LevelFiltersByLevelId(int levelId)

Parameters

int levelId

Returns

IEnumerable<ILevelFilter>

LevelsByModule(IArcherModule)

Declaration

IEnumerable<IArcherLevel> LevelsByModule(IArcherModule module)

Parameters

IArcherModule module

Returns

IEnumerable<IArcherLevel>

LevelsByModuleAlias(string, ModuleType, bool)

Declaration

IEnumerable<IArcherLevel> LevelsByModuleAlias(string moduleAlias, ModuleType moduleType = ModuleType.Undefined, bool throwExceptionIfInvalid = true)

Parameters

string moduleAlias

ModuleType moduleType

bool throwExceptionIfInvalid

Returns

IEnumerable<IArcherLevel>

LevelsByModuleGuid(Guid, ModuleType, bool)

Declaration

IEnumerable<IArcherLevel> LevelsByModuleGuid(Guid moduleGuid, ModuleType moduleType = ModuleType.Undefined, bool throwExceptionIfInvalid = true)

Parameters

Guid moduleGuid

ModuleType moduleType

bool throwExceptionIfInvalid

Returns

IEnumerable<IArcherLevel>

LevelsByModuleId(int, bool)

Declaration

IEnumerable<IArcherLevel> LevelsByModuleId(int moduleId, bool throwExceptionIfInvalid = true)

Parameters

int moduleId

bool throwExceptionIfInvalid

Returns

IEnumerable<IArcherLevel>

LevelsByModuleName(string, ModuleType, bool)

Declaration

IEnumerable<IArcherLevel> LevelsByModuleName(string moduleName, ModuleType moduleType = ModuleType.Undefined, bool throwExceptionIfInvalid = true)

Parameters

string moduleName

ModuleType moduleType

bool throwExceptionIfInvalid

Returns

IEnumerable<IArcherLevel>

ModuleByAlias(string, ModuleType, bool)

Declaration

IArcherModule ModuleByAlias(string moduleAlias, ModuleType moduleType = ModuleType.Undefined, bool throwExceptionIfInvalid = true)

Parameters

string moduleAlias

ModuleType moduleType

bool throwExceptionIfInvalid

Returns

IArcherModule

ModuleByGuid(Guid, ModuleType, bool)

Declaration

IArcherModule ModuleByGuid(Guid moduleGuid, ModuleType moduleType = ModuleType.Undefined, bool throwExceptionIfInvalid = true)

Parameters

Guid moduleGuid

ModuleType moduleType

bool throwExceptionIfInvalid

Returns

IArcherModule

ModuleById(int, bool)

Declaration

IArcherModule ModuleById(int moduleId, bool throwExceptionIfInvalid = true)

Parameters

int moduleId

bool throwExceptionIfInvalid

Returns

IArcherModule

ModuleByName(string, ModuleType, bool)

Declaration

IArcherModule ModuleByName(string moduleName, ModuleType moduleType = ModuleType.Undefined, bool throwExceptionIfInvalid = true)

Parameters

string moduleName

ModuleType moduleType

bool throwExceptionIfInvalid

Returns

IArcherModule

ModuleOwnersByModuleId(int)

Declaration

IEnumerable<IModuleOwner> ModuleOwnersByModuleId(int moduleId)

Parameters

int moduleId

Returns

IEnumerable<IModuleOwner>

ModulesBySolution(IArcherSolution)

Declaration

IEnumerable<IArcherModule> ModulesBySolution(IArcherSolution solution)

Parameters

IArcherSolution solution

Returns

IEnumerable<IArcherModule>

ModulesBySolutionId(int)

Declaration

IEnumerable<IArcherModule> ModulesBySolutionId(int solutionId)

Parameters

int solutionId

Returns

IEnumerable<IArcherModule>

QuestionnaireByAlias(string, bool)

Declaration

IArcherQuestionnaire QuestionnaireByAlias(string questionnaireAlias, bool throwExceptionIfInvalid = true)

Parameters

string questionnaireAlias

bool throwExceptionIfInvalid

Returns

IArcherQuestionnaire

QuestionnaireByGuid(Guid, bool)

Declaration

IArcherQuestionnaire QuestionnaireByGuid(Guid questionnaireGuid, bool throwExceptionIfInvalid = true)

Parameters

Guid questionnaireGuid

bool throwExceptionIfInvalid

Returns

IArcherQuestionnaire

QuestionnaireById(int, bool)

Declaration

IArcherQuestionnaire QuestionnaireById(int questionnaireId, bool throwExceptionIfInvalid = true)

Parameters

int questionnaireId

bool throwExceptionIfInvalid

Returns

IArcherQuestionnaire

QuestionnaireByName(string, bool)

Declaration

IArcherQuestionnaire QuestionnaireByName(string questionnaireName, bool throwExceptionIfInvalid = true)

Parameters

string questionnaireName

bool throwExceptionIfInvalid

Returns

IArcherQuestionnaire

QuestionnaireRulesByLevelId(int)

Declaration

IEnumerable<IQuestionnaireRule> QuestionnaireRulesByLevelId(int levelId)

Parameters

int levelId

Returns

IEnumerable<IQuestionnaireRule>

SolutionByAlias(string, bool)

Returns a Solution having the given alias, if extensions are available

Declaration

IArcherSolution SolutionByAlias(string solutionAlias, bool throwExceptionIfInvalid = true)

Parameters

string solutionAlias The alias of the Solution to be retrieved

bool throwExceptionIfInvalid If true, an exception will be raised if the alias cannot be resolved to a Solution. If false, an unresolveable alias will return null

Returns

IArcherSolution

Remarks

Requires extensions

SolutionByGuid(Guid, bool)

Returns a Solution having the given GUID identifier, if extensions are available

Declaration

IArcherSolution SolutionByGuid(Guid solutionGuid, bool throwExceptionIfInvalid = true)

Parameters

Guid solutionGuid The GUID of the Solution to be retrieved

bool throwExceptionIfInvalid If true, an exception will be raised if the GUID cannot be resolved to a Solution. If false, an unresolveable GUID will return null

Returns

IArcherSolution

Remarks

Requires extensions

SolutionById(int, bool)

Returns a Solution having the given integer Id, if extensions are available

Declaration

IArcherSolution SolutionById(int solutionId, bool throwExceptionIfInvalid = true)

Parameters

int solutionId The integer Id of the Solution to be retrieved

bool throwExceptionIfInvalid If true, an exception will be raised if the Id cannot be resolved to a Solution. If false, an unresolveable Id will return null

Returns

IArcherSolution

Remarks

Requires extensions

SolutionByName(string, bool)

Returns a Solution having the given name, if extensions are available

Declaration

IArcherSolution SolutionByName(string solutionName, bool throwExceptionIfInvalid = true)

Parameters

string solutionName

bool throwExceptionIfInvalid If true, an exception will be raised if the name cannot be resolved to a Solution. If false, an unresolveable name will return null

Returns

IArcherSolution

Remarks

Requires extensions

SolutionsByModule(IArcherModule)

Declaration

IEnumerable<IArcherSolution> SolutionsByModule(IArcherModule module)

Parameters

IArcherModule module

Returns

IEnumerable<IArcherSolution>

SolutionsByModuleId(int)

Declaration

IEnumerable<IArcherSolution> SolutionsByModuleId(int moduleId)

Parameters

int moduleId

Returns

IEnumerable<IArcherSolution>

SubformByAlias(string, bool, bool)

Declaration

IArcherSubForm SubformByAlias(string subformAlias, bool forceDiscovery = false, bool throwExceptionIfInvalid = true)

Parameters

string subformAlias

bool forceDiscovery

bool throwExceptionIfInvalid

Returns

IArcherSubForm

SubformByGuid(Guid, bool, bool)

Declaration

IArcherSubForm SubformByGuid(Guid subformGuid, bool forceDiscovery = false, bool throwExceptionIfInvalid = true)

Parameters

Guid subformGuid

bool forceDiscovery

bool throwExceptionIfInvalid

Returns

IArcherSubForm

SubformById(int, bool)

Declaration

IArcherSubForm SubformById(int subformId, bool throwExceptionIfInvalid = true)

Parameters

int subformId

bool throwExceptionIfInvalid

Returns

IArcherSubForm

SubformByName(string, bool, bool)

Declaration

IArcherSubForm SubformByName(string subformName, bool forceDiscovery = false, bool throwExceptionIfInvalid = true)

Parameters

string subformName

bool forceDiscovery

bool throwExceptionIfInvalid

Returns

IArcherSubForm

ValuesListByField(IArcherField)

Declaration

IArcherValuesList ValuesListByField(IArcherField field)

Parameters

IArcherField field

Returns

IArcherValuesList

ValuesListByFieldId(int, bool)

Declaration

IArcherValuesList ValuesListByFieldId(int fieldId, bool throwExceptionIfInvalid = true)

Parameters

int fieldId

bool throwExceptionIfInvalid

Returns

IArcherValuesList

ValuesListById(int)

Declaration

IArcherValuesList ValuesListById(int valuesListId)

Parameters

int valuesListId

Returns

IArcherValuesList

ValuesListValuesByValuesListId(int)

Declaration

IEnumerable<IArcherValuesListValue> ValuesListValuesByValuesListId(int valuesListId)

Parameters

int valuesListId

Returns

IEnumerable<IArcherValuesListValue>

Events

ValuesListChanged

Declaration

event ValuesListChangeEvent ValuesListChanged

Event Type

ValuesListChangeEvent

Extension Methods

EnumHelper.In<TEnum>(TEnum, params TEnum[])

IEnumerableExtensions.ToEnumerable<T>(T)

StringExtensions.AssertNotNull<T>(T, string)

TypeExtensions.WithDispose<T, V>(T, Func<T, V>)

EnumHelper.CastNullable<TEnum>(object)

TypeExtensions.ConvertTo<V>(object)

TypeExtensions.TryConvert<V>(object, out V)