Package com.xpn.xwiki.job

Class JobRequestContext

  • All Implemented Interfaces:
    Serializable
    @Deprecated
public class JobRequestContext
extends Object
implements Serializable
    Deprecated.
    since 10.9RC1, use ContextStore instead
    Contains various information about the context which asked for a job execution.
    Since:
    8.3RC1
    Version:
    $Id: 0994e650a84c3e5cee3bbabb457a19e940db005e $
    See Also:
    Serialized Form

    • Constructor Detail

      • JobRequestContext

        public JobRequestContext()
        Deprecated.
        Default constructor.

      • JobRequestContext

        public JobRequestContext​(XWikiContext xcontext)
        Deprecated.
        Parameters:
        xcontext - the XWiki context to extract informations from

    • Method Detail

      • set

        public static void set​(org.xwiki.job.AbstractRequest request,
                       XWikiContext xcontext)
        Deprecated.
        Register part of the XWikiContext in the job request.
        Parameters:
        request - the job request
        xcontext - the XWiki context
        Since:
        8.4RC1

      • isWikiIdSet

        public boolean isWikiIdSet()
        Deprecated.
        Returns:
        true if the identifier of the wiki has been set

      • getWikiId

        public String getWikiId()
        Deprecated.
        Returns:
        the identifier of the wiki

      • setWikiId

        public void setWikiId​(String wikiId)
        Deprecated.
        Parameters:
        wikiId - the identifier of the wiki

      • isUserReferenceSet

        public boolean isUserReferenceSet()
        Deprecated.
        Returns:
        true if the reference of the user has been set

      • getUserReference

        public DocumentReference getUserReference()
        Deprecated.
        Returns:
        the reference of the user

      • setUserReference

        public void setUserReference​(DocumentReference userReference)
        Deprecated.
        Parameters:
        userReference - the reference of the user

      • isDocumentSet

        public boolean isDocumentSet()
        Deprecated.
        Returns:
        true of the current document has been set

      • setDocumentReference

        public void setDocumentReference​(DocumentReference documentReference)
        Deprecated.
        Parameters:
        documentReference - the reference of the current document
        Since:
        9.7

      • getDocumentReference

        public DocumentReference getDocumentReference()
        Deprecated.
        Returns:
        the reference of the current document
        Since:
        9.7

      • setDocument

        public void setDocument​(XWikiDocument document)
        Deprecated.
        Parameters:
        document - the current document

      • isSDocumentSet

        public boolean isSDocumentSet()
        Deprecated.
        Returns:
        true if the document holding the current author has been set

      • getDocument

        public XWikiDocument getDocument()
        Deprecated.
        Returns:
        the current document

      • setSDocumentReference

        public void setSDocumentReference​(DocumentReference sdocumentReference)
        Deprecated.
        Parameters:
        sdocumentReference - the reference of the document holding the current author
        Since:
        9.7

      • getSDocumentReference

        public DocumentReference getSDocumentReference()
        Deprecated.
        Returns:
        the reference of the document holding the current author
        Since:
        9.7

      • setSDocument

        public void setSDocument​(XWikiDocument sdocument)
        Deprecated.
        Parameters:
        sdocument - the document holding the current author

      • getSDocument

        public XWikiDocument getSDocument()
        Deprecated.
        Returns:
        the document holding the current author

      • isRequestSet

        public boolean isRequestSet()
        Deprecated.
        Returns:
        true if the request informations have been set
        Since:
        8.4RC1

      • setRequestUrl

        public void setRequestUrl​(URL requestURL)
        Deprecated.
        Parameters:
        requestURL - the request URL
        Since:
        8.4RC1

      • getRequestURL

        public URL getRequestURL()
        Deprecated.
        Returns:
        the request URL
        Since:
        8.4RC1

      • getRequestContextPath

        public String getRequestContextPath()
        Deprecated.
        Returns:
        the requestContextPath
        Since:
        10.11.1, 11.0

      • setRequestContextPath

        public void setRequestContextPath​(String requestContextPath)
        Deprecated.
        Parameters:
        requestContextPath - the requestContextPath to set
        Since:
        10.11.1, 11.0

      • setRequestParameters

        public void setRequestParameters​(Map<String,​String[]> requestParameters)
        Deprecated.
        Parameters:
        requestParameters - the parameters of the request
        Since:
        8.4RC1

      • getRequestParameters

        public Map<String,​String[]> getRequestParameters()
        Deprecated.
        Returns:
        the parameters of the request
        Since:
        8.4RC1