Interface UserPropertiesComposite

    • Method Detail

      • getPropertyNames

        java.util.Collection<java.lang.String> getPropertyNames()
                                                         throws RepositoryException
        Retrieves all first-level property names found on all user properties contained in the composite.
        Returns:
        An unordered collection of property names, or an empty collection if no property names were found.
        Throws:
        RepositoryException - If an error occurs accessing the user properties.
      • getPropertyNames

        java.util.Collection<java.lang.String> getPropertyNames​(java.lang.String relPath)
                                                         throws RepositoryException
        Retrieves all property names found at the given relativePath within all user properties contained within this composite.
        Parameters:
        relPath - The relative path of a user properties node/resource for which to retrieve property names.
        Returns:
        An unordered collection of property names, or an empty collection if no property names were found.
        Throws:
        RepositoryException - If an error occurs accessing the user properties.
      • getProperty

        <T> T getProperty​(java.lang.String relativePath,
                          T defaultValue,
                          java.lang.Class<T> type)
                   throws RepositoryException
        Same as getProperty(String). Additionally a default value and type can be specified.
        Type Parameters:
        T - specifies the expected format of the property
        Parameters:
        relativePath - The relative path of the property to retrieve.
        defaultValue - The default value to return if the property is not found.
        type - The expected type of the property value.
        Returns:
        The property value found at relativePath with the given type, or the defaultValue if the property is not found.
        Throws:
        RepositoryException - If an error occurs accessing the user properties.
      • getAuthorizableId

        java.lang.String getAuthorizableId()
        Returns the ID of the authorizable to which the user properties of this composite belong.
        Returns:
        A string representing the authorizable ID.