Class RightsManagerRightsApi


  • public class RightsManagerRightsApi
    extends Api
    API for managing rights and inheritance.
    Since:
    1.1.2, 1.2M2
    Version:
    $Id: 932f82d0ca955da658412189293509a795f31a88 $
    • Field Detail

      • CONTEXT_LASTERRORCODE

        public static final String CONTEXT_LASTERRORCODE
        Field name of the last error code inserted in context.
        See Also:
        Constant Field Values
      • CONTEXT_LASTEXCEPTION

        public static final String CONTEXT_LASTEXCEPTION
        Field name of the last api exception inserted in context.
        See Also:
        Constant Field Values
      • LOGGER

        protected static final org.slf4j.Logger LOGGER
        The logging toolkit.
    • Constructor Detail

      • RightsManagerRightsApi

        public RightsManagerRightsApi​(XWikiContext context)
        Create an instance of RightsManageRightsApi.
        Parameters:
        context - the XWiki context.
    • Method Detail

      • getParentPreference

        public Document getParentPreference​(String spaceOrPage)
                                     throws XWikiException
        Get the document containing inherited rights of provided document.
        Parameters:
        spaceOrPage - the space of page where to get XWikiRights. If null get wiki rights.
        Returns:
        the document containing inherited rights of provided document.
        Throws:
        XWikiException - error when browsing rights preferences.