net.anotheria.anosite.access.AnoSiteAccessAPI Maven / Gradle / Ivy
package net.anotheria.anosite.access;
import net.anotheria.anoplass.api.API;
/**
* {@link API} for validate current user access to requested Page, Box, Action, Wizard, etc.
*
* @author Alexandr Bolbat
*/
public interface AnoSiteAccessAPI extends API {
/**
* Validate access for given page. If access operation not configured for given page this validation return true.
*
* @param pageId
* - given page it
* @return true if have access or false
* @throws AnoSiteAccessAPIException
*/
boolean isAllowedForPage(String pageId) throws AnoSiteAccessAPIException;
/**
* Validate access for given box. If access operation not configured for given box this validation return true.
*
* @param boxId
* - given box it
* @return true if have access or false
* @throws AnoSiteAccessAPIException
*/
boolean isAllowedForBox(String boxId) throws AnoSiteAccessAPIException;
/**
* Validate access for given navigation item. If access operation not configured for given navigation item this validation return true.
*
* @param naviItemId
* - given navigation item it
* @return true if have access or false
* @throws AnoSiteAccessAPIException
*/
boolean isAllowedForNaviItem(String naviItemId) throws AnoSiteAccessAPIException;
/**
* Validate access for given action. If access operation not configured for given action this validation return true.
*
* @param actionId
* - given action it
* @return true if have access or false
* @throws AnoSiteAccessAPIException
*/
boolean isAllowedForAction(String actionId) throws AnoSiteAccessAPIException;
/**
* Validate access for given wizard. If access operation not configured for given wizard this validation return true.
*
* @param wizardId
* - given wizard it
* @return true if have access or false
* @throws AnoSiteAccessAPIException
*/
boolean isAllowedForWizard(String wizardId) throws AnoSiteAccessAPIException;
}