SmartStoreNET/src/Libraries/SmartStore.Services/Localization/ILanguageService.cs at 3.x · snailspeed/SmartStoreNET · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
using System.Collections.Generic;
using SmartStore.Core.Domain.Localization;

namespace SmartStore.Services.Localization
{
    /// <summary>
    /// Language service interface
    /// </summary>
    public partial interface ILanguageService
    {
        /// <summary>
        /// Deletes a language
        /// </summary>
        /// <param name="language">Language</param>
        void DeleteLanguage(Language language);

        /// <summary>
        /// Gets all languages
        /// </summary>
        /// <param name="showHidden">A value indicating whether to show hidden records</param>
		/// <param name="storeId">Load records allows only in specified store; pass 0 to load all records</param>
        /// <returns>Language collection</returns>
		IList<Language> GetAllLanguages(bool showHidden = false, int storeId = 0);

        /// <summary>
        /// Gets languages count
        /// </summary>
        /// <param name="showHidden">A value indicating whether to consider hidden records</param>
        /// <returns>The count of Languages</returns>
        int GetLanguagesCount(bool showHidden = false);

        /// <summary>
        /// Gets a language
        /// </summary>
        /// <param name="languageId">Language identifier</param>
        /// <returns>Language</returns>
        Language GetLanguageById(int languageId);

        /// <summary>
        /// Gets a language by culture code (e.g.: en-US)
        /// </summary>
        /// <param name="culture">Culture code</param>
        /// <returns>Language</returns>
        Language GetLanguageByCulture(string culture);

        /// <summary>
        /// Gets a language by it's unique seo code (e.g.: en)
        /// </summary>
        /// <param name="seoCode">SEO code</param>
        /// <returns>Language</returns>
        Language GetLanguageBySeoCode(string seoCode);

        /// <summary>
        /// Inserts a language
        /// </summary>
        /// <param name="language">Language</param>
        void InsertLanguage(Language language);

        /// <summary>
        /// Updates a language
        /// </summary>
        /// <param name="language">Language</param>
        void UpdateLanguage(Language language);

		/// <summary>
		/// Determines whether a language is active/published
		/// </summary>
		/// <param name="seoCode">The SEO code of the language to check</param>
		/// <param name="storeId">The store id</param>
		/// <returns><c>true</c> when the language is published, <c>false</c> otherwise</returns>
		bool IsPublishedLanguage(string seoCode, int storeId = 0);

		/// <summary>
		/// Determines whether a language is active/published
		/// </summary>
		/// <param name="languageId">The id of the language to check</param>
		/// <param name="storeId">The store id</param>
		/// <returns><c>true</c> when the language is published, <c>false</c> otherwise</returns>
		bool IsPublishedLanguage(int languageId, int storeId = 0);

		/// <summary>
		/// Gets the seo code of the default (first) active language
		/// </summary>
		/// <param name="storeId">The store id</param>
		/// <returns>The seo code</returns>
		string GetDefaultLanguageSeoCode(int storeId = 0);

		/// <summary>
		/// Gets the id of the default (first) active language
		/// </summary>
		/// <param name="storeId">The store id</param>
		/// <returns>The language id</returns>
		int GetDefaultLanguageId(int storeId = 0);
    }
}