Package de.xima.fc.mdl.enums

Enum EAccessProperty

  • All Implemented Interfaces:
    IAccessProperty, INamedUiElement, Serializable, Comparable<EAccessProperty>
    public enum EAccessProperty
extends Enum<EAccessProperty>
implements IAccessProperty
    An access property describes the permissions a formcycle user is granted. For each new session, a boolean value (true [=GRANT ACCESS] or false [=DENY ACCESS]) is assigned to each property. This value may come m either the user's current Rolle, the current license of the system; or it may be set by the system.

    Some access properties (called role properties) are configurable for each Rolle, this is indicated by isConfigurable().

    Each property has also got a default, this is used when the current value could not be determined in another way. For example, when a new version is released, new access properties might have been added: for these the default is used. Note however, that

    • the sadmin is unaffected by role properties, that
    • the defaults of the client administrator are true, except for system settings, and that
    • an access property must be assigned the value false if the parent access property is assigned the value false.
    Author:
    XIMA MEDIA GmbH

    • Method Detail

      • values

        public static EAccessProperty[] values()
        Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows: 
        for (EAccessProperty c : EAccessProperty.values())
    System.out.println(c);
        Returns:
        an array containing the constants of this enum type, in the order they are declared

      • valueOf

        public static EAccessProperty valueOf​(String name)
        Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
        Parameters:
        name - the name of the enum constant to be returned.
        Returns:
        the enum constant with the specified name
        Throws:
        IllegalArgumentException - if this enum type has no constant with the specified name
        NullPointerException - if the argument is null

      • getParent

        public EAccessProperty getParent()
        Returns:
        The parent of this access property. When a user is not granted the parent access property, they are not granted any child properties either. May be null, in which case this is a top-level property.

      • getDisplayName

        public String getDisplayName​(Locale l)
        The display name of this element in the given locale.
        Specified by:
        getDisplayName in interface INamedUiElement
        Parameters:
        l - The locale to get the display name for.
        Returns:
        The display name of this element in the given locale.

      • isConfigurable

        public boolean isConfigurable()
        Returns:
        Whether this access property is configurable separately for each Rolle. If false, the property is set by the license or the system etc.

      • isSysPermission

        public boolean isSysPermission()
        Returns:
        Whether this access property is a system permission. If true, the property is set a system permission and not intended for client roles.

      • getDefaultValue

        public boolean getDefaultValue()
        Description copied from interface: IAccessProperty
        The default value of this access property if it is not already set on the user role. Also this value will be used to define the initial status in the user role UI.
        Specified by:
        getDefaultValue in interface IAccessProperty
        Returns:
        The default value of this access property, in case no value could be determined otherwise. This is used eg. during a system update to set the defaults for Rolle properties for new properties that were not present in the previous version.

      • getNestingDepth

        public int getNestingDepth()
        Returns:
        The nesting depth of this access, ie. the number of getParent().

      • getChildren

        public List<EAccessProperty> getChildren()
        Description copied from interface: IAccessProperty
        A collection of child-properties specify parts of the main property. Also the children will be displayed in a second column in the UI.
        Specified by:
        getChildren in interface IAccessProperty
        Returns:
        A list of all child properties, ie. those that have this property set as their parent.

      • getChildrenRecursive

        public List<EAccessProperty> getChildrenRecursive()
        Returns:
        A list of all children, grand-children, grand-grand-children etc. of this access property.

      • isAuthorized

        public boolean isAuthorized​(ILicenseAccess licenseAccess)
        Checks whether this access property is authorized for the given license. If this property has parent properties, all of them must be authorized with the given license for this property to be authorized.
        Parameters:
        licenseAccess - The license access to check against.
        Returns:
        true if the access property is authorized, false otherwise.

      • isLicenseDefaultAccess

        @Deprecated
public boolean isLicenseDefaultAccess()
        Deprecated.