Class AccessControlHandle

All Implemented Interfaces:
org.eclipse.birt.report.model.elements.interfaces.IAccessControlModel, org.eclipse.birt.report.model.elements.interfaces.IDesignElementModel
Direct Known Subclasses:
ValueAccessControlHandle

@Deprecated public class AccessControlHandle extends ContentElementHandle implements org.eclipse.birt.report.model.elements.interfaces.IAccessControlModel
Deprecated.
Describes the privilege to access resources. Members are

user name
The user name of the privilege.
role
what behavior a user can perform
permission
"allow" or "disallow" the specified behavior to the user
  • Constructor Details

    • AccessControlHandle

      public AccessControlHandle(org.eclipse.birt.report.model.core.Module module, org.eclipse.birt.report.model.core.DesignElement element)
      Deprecated.
      Constructs a autotext handle with the given design and the element. The application generally does not create handles directly. Instead, it uses one of the navigation methods available on other element handles.
      Parameters:
      module - the module
      element - the model representation of the element
  • Method Details

    • addRole

      public void addRole(String role) throws SemanticException
      Deprecated.
      Adds the given role to the list.
      Parameters:
      role - the role
      Throws:
      SemanticException
    • addUserName

      public void addUserName(String userName) throws SemanticException
      Deprecated.
      Adds the given user name to the list.
      Parameters:
      userName - the user name
      Throws:
      SemanticException
    • getPermission

      public String getPermission()
      Deprecated.
      Returns whether the user can perform the role. The return value is one of following:
      • DesignChoiceConstants.ACCESS_PERMISSION_ALLOW
      • DesignChoiceConstants.ACCESS_PERMISSION_DISALLOW
      Returns:
      the permission to perform the role
    • removeRole

      public void removeRole(String role) throws SemanticException
      Deprecated.
      Removes the given role from the list.
      Parameters:
      role - the role to remove
      Throws:
      SemanticException
    • removeUserName

      public void removeUserName(String userName) throws SemanticException
      Deprecated.
      Removes the given user name from the list.
      Parameters:
      userName - the user name to remove
      Throws:
      SemanticException
    • setPermission

      public void setPermission(String permission) throws SemanticException
      Deprecated.
      Sets the permission. The input parameter should be one of following:
      • DesignChoiceConstants.ACCESS_PERMISSION_ALLOW
      • DesignChoiceConstants.ACCESS_PERMISSION_DISALLOW
      Parameters:
      permission - the permission to perform the role
      Throws:
      SemanticException