IPluginAccessProperties (FORMCYCLE: BOM 7.0.3 API)

All Superinterfaces:

IFCPlugin, INamedUiElement, INameProviding, ITransferable, Serializable
```
public interface IPluginAccessProperties
extends IFCPlugin
```
A plugin for adding custom IPluginAccessPropertys to the FORMCYCLE backend. An access property may be used, for example, to control whether a user is granted access to a portal page, see IPluginPortal.

Author:

XIMA MEDIA GmbH

Field Summary
- Fields inherited from interface de.xima.fc.plugin.interfaces.IFCPlugin
  CONFIG_FILENAME
- Fields inherited from interface de.xima.fc.interfaces.INamedUiElement
  ATTR_DISPLAY_NAME
- Fields inherited from interface de.xima.fc.entities.interfaces.INameProviding
  ATTR_NAME, COL_NAME

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`Collection<IPluginAccessProperty>`	`getProperties(IPluginAccessPropertiesParams params)`	Returns the access properties to be added to FORMCYCLE.
`String`	`getPropertiesGroupName(Locale locale)`	Getter for the heading of the group (fieldset) for the `IPluginAccessProperty`s in the user role UI.

Methods inherited from interface de.xima.fc.plugin.interfaces.IFCPlugin
getDescription, getDescription, getDisplayName, getName, initialize, initPlugin, install, shutdown, shutdown, uninstall

- Method Detail
  - getPropertiesGroupName
```
String getPropertiesGroupName(Locale locale)
```
    Getter for the heading of the group (fieldset) for the IPluginAccessPropertys in the user role UI.
    
    Parameters:
    
    locale - the current Locale of the backend UI
    
    Returns:
    
    String the heading
  - getProperties
```
Collection<IPluginAccessProperty> getProperties(IPluginAccessPropertiesParams params)
```
    Returns the access properties to be added to FORMCYCLE. Please note that an access property may have children. Child access properties are shown in a submenu when the parent access property is enabled. This method must return only the top-level (parent) access properties.
    
    Parameters:
    
    params - IPluginAccessPropertiesParams The parameters this plugin may make use of.
    
    Returns:
    
    A Collection of top-level (parent) IPluginAccessPropertys to add to FORMCYCLE.