Select a site

IMPORTANT: This version of Sitefinity CMS is out of support and the respective product documentation is no longer maintained and can be outdated. Use the version selector to view a supported product version.

Locations module: Implement a manager class

After youLocations module: Implement a configuration class of the Locations module, you need to implement a manager class:

  1. In Visual Studio, expand the LocationsModule project and open the context menu of the the Data folder.
    Click Add » Class.
  2. Name the class file LocationsManager.cs and click Add.
  3. Open the file LocationsManager.cs.
  4. Add the following using statements:
    • using LocationsModule.Data.OpenAccess;
    • using LocationsModule.Model;
    • using LocationsModule.Configuration;
    • using Telerik.Sitefinity;
    • using Telerik.Sitefinity.Configuration;
    • using Telerik.Sitefinity.Data;
    • using Telerik.Sitefinity.GenericContent.Model;
    • using Telerik.Sitefinity.Model;
    • using Telerik.Sitefinity.Modules;
    • using Telerik.Sitefinity.Modules.GenericContent;
  5. Make the LocationsManager class inherit the ContentManagerBase<OpenAccessLocationsDataProvider> class and to implement the IContentLifecycleManager<LocationItem> interface:
    public class LocationsManager : ContentManagerBase<OpenAccessLocationsDataProvider>, IContentLifecycleManager<LocationItem>
    {
    }

  6. Create the following constructors in the class:

    public LocationsManager()
        : this(null)
    {
    }
     
    public LocationsManager(string providerName)
        : base(providerName)
    {
    }
     
    public LocationsManager(string providerName, string transactionName)
        : base(providerName, transactionName)
    {
    }

  7. Create the following static methods:

    public static LocationsManager GetManager() { return ManagerBase<OpenAccessLocationsDataProvider>.GetManager<LocationsManager>(); }
     
    public static LocationsManager GetManager(string providerName) { return ManagerBase<OpenAccessLocationsDataProvider>.GetManager<LocationsManager>(providerName); }
     
    public static LocationsManager GetManager(string providerName, string transactionName) { return ManagerBase<OpenAccessLocationsDataProvider>.GetManager<LocationsManager>(providerName, transactionName); }

  8. Wire up the manager class to the data provider class by creating the following methods:

    public LocationItem CreateLocation()
    {
        return this.Provider.CreateLocation();
    }
     
    public LocationItem CreateLocation(Guid id)
    {
        return this.Provider.CreateLocation(id);
    }
     
    public LocationItem GetLocation(Guid id)
    {
        return this.Provider.GetLocation(id);
    }
     
    public IQueryable<LocationItem> GetLocations()
    {
        return this.Provider.GetLocations();
    }
     
    public void DeleteLocation(LocationItem location)
    {
        this.Provider.DeleteLocation(location);
    }
     
    public void DeleteLocation(Guid id)
    {
        this.Provider.DeleteLocation(this.Provider.GetLocation(id));
    }

  9. Implement the abstract methods of the ContentManagerBase class in the following way:

    public override IQueryable<TItem> GetItems<TItem>()
    {
        if (typeof(LocationItem).IsAssignableFrom(typeof(TItem)))
            return this.GetLocations() as IQueryable<TItem>;
        if (typeof(TItem) == typeof(UrlData) || typeof(TItem) == typeof(LocationItemUrlData))
            return this.GetUrls<LocationItemUrlData>() as IQueryable<TItem>;
        throw new NotSupportedException();
    }
     
    protected override GetDefaultProvider DefaultProviderDelegate
    {
        get { return () => Config.Get<LocationsModuleConfig>().DefaultProvider; }
    }
     
    public override string ModuleName
    {
        get { return LocationsModule.ModuleName; }
    }
     
    protected override ConfigElementDictionary<string, DataProviderSettings> ProvidersSettings
    {
        get { return Config.Get<LocationsModuleConfig>().Providers; }
    }


    NOTE: You will implement the ModuleName constant in the module class later in this tutorial. For more information, see Locations module: Implement the module class.

  10. Implement the members required by the IContentLifecycleManager interface.

    Although the Locations module does not support content lifecycle, the implementation of the interface is mandatory for the manager class. Following is the default implementation of the members:

    public LocationItem CheckIn(LocationItem item)
    {
        throw new NotImplementedException();
    }
     
    public LocationItem CheckOut(LocationItem item)
    {
        throw new NotImplementedException();
    }
     
    public void Copy(LocationItem source, LocationItem destination)
    {
        throw new NotImplementedException();
    }
     
    public LocationItem Edit(LocationItem item)
    {
        throw new NotImplementedException();
    }
     
    public Guid GetCheckedOutBy(LocationItem item)
    {
        throw new NotImplementedException();
    }
     
    public LocationItem GetLive(LocationItem cnt)
    {
        throw new NotImplementedException();
    }
     
    public LocationItem GetMaster(LocationItem cnt)
    {
        throw new NotImplementedException();
    }
     
    public LocationItem GetTemp(LocationItem cnt)
    {
        throw new NotImplementedException();
    }
     
    public bool IsCheckedOut(LocationItem item)
    {
        throw new NotImplementedException();
    }
     
    public bool IsCheckedOutBy(LocationItem item, Guid userId)
    {
        throw new NotImplementedException();
    }
     
    public LocationItem Publish(LocationItem item)
    {
        throw new NotImplementedException();
    }
     
    public LocationItem Schedule(LocationItem item, DateTime publicationDate, DateTime? expirationDate)
    {
        throw new NotImplementedException();
    }
     
    public LocationItem Unpublish(LocationItem item)
    {
        throw new NotImplementedException();
    }
     
    public Content CheckIn(Content item)
    {
        throw new NotImplementedException();
    }
     
    public Content CheckOut(Content item)
    {
        throw new NotImplementedException();
    }
     
    public void Copy(Content source, Content destination)
    {
        throw new NotImplementedException();
    }
     
    public Content Edit(Content item)
    {
        throw new NotImplementedException();
    }
     
    public Guid GetCheckedOutBy(Content item)
    {
        throw new NotImplementedException();
    }
     
    public Content GetLive(Content cnt)
    {
        throw new NotImplementedException();
    }
     
    public Content GetMaster(Content cnt)
    {
        throw new NotImplementedException();
    }
     
    public Content GetTemp(Content cnt)
    {
        throw new NotImplementedException();
    }
     
    public bool IsCheckedOut(Content item)
    {
        throw new NotImplementedException();
    }
     
    public bool IsCheckedOutBy(Content item, Guid userId)
    {
        throw new NotImplementedException();
    }
     
    public Content Publish(Content item)
    {
        throw new NotImplementedException();
    }
     
    public Content Schedule(Content item, DateTime publicationDate, DateTime? expirationDate)
    {
        throw new NotImplementedException();
    }
     
    public Content Unpublish(Content item)
    {
        throw new NotImplementedException();
    }

Back To Top