AraneaServices.java

/*
 Copyright 2006 - 2010 Under Dusken

 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.
 You may obtain a copy of the License at

 http://www.apache.org/licenses/LICENSE-2.0

 Unless required by applicable law or agreed to in writing, software
 distributed under the License is distributed on an "AS IS" BASIS,
 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 See the License for the specific language governing permissions and
 limitations under the License.
 */
package no.dusken.aranea.plugin;

import no.dusken.aranea.service.*;
import no.dusken.common.dao.GenericDao;
import no.dusken.common.service.MailService;
import org.kantega.jexmec.Services;
import org.kantega.jexmec.store.PluginStoreProvider;

/**
 * @author Marvin B. Lillehaug <lillehau@underdusken.no>
 * This interface contains one method for each service available to plugin writers.
 */
public interface AraneaServices extends Services{

    /**
     * Provides access to persistent state so the plugin can store configuration
     * etc.
     * @return the PluginStoreProvider
     */
    PluginStoreProvider getPluginStoreProvider();

    /**
     * Provides access to the generic dao that can handle <T extends AraneaObject>
     * @return the {@link GenericDao} dao
     */
    GenericDao getGenericDao();

    /**
     * Provides access to the generic service that can handle Page
     * @return the {@link no.dusken.aranea.service.PageService} service
     */
    PageService getPageService();

    /**
     * Provides access to the generic service that can handle Image
     * @return the {@link no.dusken.aranea.service.ImageService} service
     */
    ImageService getImageService();

    /**
     * Provides access to the generic service that can handle Mail
     * @return the {@link no.dusken.common.service.MailService} service
     */
    MailService getMailService();

    /**
     * Provides access to the generic service that can handle PageRelation
     * @return the {@link no.dusken.aranea.service.PageRelationService} service
     */
    PageRelationService getPageRelationService();

    /**
     * Provides access to the generic service that can handle Person
     * @return the {@link no.dusken.aranea.service.PersonService} service
     */
    PersonService getPersonService();

    /**
     * Provides access to the generic service that can handle Role
     * @return the {@link no.dusken.aranea.service.RoleService} service
     */
    RoleService getRoleService();

    /**
     * Provides access to the generic service that can handle Section
     * @return the {@link no.dusken.aranea.service.SectionService} service
     */
    SectionService getSectionService();

    /**
     * Provides access to the generic service that can handle Tag
     * @return the {@link no.dusken.aranea.service.TagService} service
     */
    TagService getTagService();

     /**
     * Provides access to the generic service that can handle Issue
     * @return the {@link no.dusken.aranea.service.IssueService} service
     */
    IssueService getIssueService();

     /**
     * Provides access to the generic service that can handle Tag
     * @return the {@link no.dusken.aranea.service.ArticleService} service
     */
    ArticleService getArticleService();

    /**
     * Provides access to the generic service that can store images
     * @return the {@link no.dusken.aranea.service.StoreImageService} service
     */
    StoreImageService getStoreImageService();

    /**
     * Provides access to a implementation of the UserDetailsManager
     * @return the {@link no.dusken.aranea.service.LoginDetailsService} service
     */
    LoginDetailsService getLoginDetailsService();

    /**
     * Provides access to a implementation of the SectionPageService
     * @return the {@link no.dusken.aranea.service.SectionPageService} service
     */
    SectionPageService getSectionPageService();

}