Package com.mendix.systemwideinterfaces.core.meta

Interface IMetaObjectAccess

public interface IMetaObjectAccess
Represents the access rules apply to an entity (Mendix object).

  • Method Summary

    Modifier and Type
    Method
    Description
    List<String>
    getAllowedUserRoles()
    Returns the user roles that are allowed by this access rule.
    UUID
    getId()
    Returns the unique identifier of this access rule.
    Set<UUID>
    getIdsOfSameXPathConstraints()
    Returns a list of other access rules with the same XPath constraints.
    Set<String>
    getReadAccessMembers()
    Returns the names of the attributes and/or associations that are considered readable by this access rule.
    Set<String>
    getWriteAccessMembers()
    Returns the names of the attributes and/or associations that are writeable writable by this access rule.
    String
    getXpathConstraint()
    Returns the XPath constraint that constrains this access rule to the sub-set of matching objects.
    boolean
    isAllowCreate()
    Returns whether this access rule allows creating new object for an entity.
    boolean
    isAllowDelete()
    Returns whether this access rules allows deleting existing objects for an entity.
    boolean
    providesReadAccess(String memberName)
    Returns whether this access rule considers the attribute or association with the specified name readable.
    boolean
    providesWriteAccess(String memberName)
    Returns whether this access rule considers the attribute or association with the specified name writable.

  • Method Details

    • getId

      UUID getId()
      Returns the unique identifier of this access rule.
      Returns:
      the unique identifier

    • isAllowCreate

      boolean isAllowCreate()
      Returns whether this access rule allows creating new object for an entity.
      Returns:
      true if creation is allowed, false otherwise

    • isAllowDelete

      boolean isAllowDelete()
      Returns whether this access rules allows deleting existing objects for an entity.
      Returns:
      true if deletion is allowed, false otherwise

    • getXpathConstraint

      String getXpathConstraint()
      Returns the XPath constraint that constrains this access rule to the sub-set of matching objects.
      Returns:
      the XPath constraint

    • getAllowedUserRoles

      List<String> getAllowedUserRoles()
      Returns the user roles that are allowed by this access rule.
      Returns:
      the allowed user roles

    • getReadAccessMembers

      Set<String> getReadAccessMembers()
      Returns the names of the attributes and/or associations that are considered readable by this access rule.
      Returns:
      the names of the readable members

    • getWriteAccessMembers

      Set<String> getWriteAccessMembers()
      Returns the names of the attributes and/or associations that are writeable writable by this access rule.
      Returns:
      the names of the writable members

    • providesReadAccess

      boolean providesReadAccess(String memberName)
      Returns whether this access rule considers the attribute or association with the specified name readable.
      Parameters:
      memberName - the name of the attribute or association to check
      Returns:
      true if the member is readable, false otherwise

    • providesWriteAccess

      boolean providesWriteAccess(String memberName)
      Returns whether this access rule considers the attribute or association with the specified name writable.
      Parameters:
      memberName - the name of the attribute or association to check
      Returns:
      true if the member is writable, false otherwise

    • getIdsOfSameXPathConstraints

      Set<UUID> getIdsOfSameXPathConstraints()
      Returns a list of other access rules with the same XPath constraints. Only for internal use.
      Returns:
      the identifiers of the other access rules