Package org.xwiki.contrib.moccacalendar.importJob

Class ImportJobRequest

  • All Implemented Interfaces:
    Serializable, org.xwiki.job.Request
    @Unstable
public class ImportJobRequest
extends org.xwiki.job.AbstractRequest
    Represents a request to start a import job.
    Since:
    2.14
    Version:
    $Id$
    See Also:
    Serialized Form

    • Field Summary

      • Fields inherited from interface org.xwiki.job.Request

        PROPERTY_CONTEXT, PROPERTY_INTERACTIVE, PROPERTY_REMOTE

    • Constructor Summary

      Constructors 
      Constructor Description
      ImportJobRequest()
      Default constructor.
      ImportJobRequest​(List<String> requestId, byte[] file, String parentRef, org.xwiki.model.reference.DocumentReference userReference)
      Creates a specific request for the ical file import job.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      byte[] getFile()
      Get the content of the given file.
      String getParentRef()
      Get the reference to the parent calendar.
      org.xwiki.model.reference.DocumentReference getUserReference()
      Get the reference to the user who requested the import.

      • Methods inherited from class org.xwiki.job.AbstractRequest

        containsProperty, equals, getContext, getId, getProperties, getProperty, getProperty, getPropertyNames, hashCode, isInteractive, isRemote, isStatusLogIsolated, isStatusSerialized, isVerbose, removeProperty, setContext, setId, setId, setId, setInteractive, setProperty, setRemote, setStatusLogIsolated, setStatusSerialized, setVerbose

    • Constructor Detail

      • ImportJobRequest

        public ImportJobRequest()
        Default constructor.

      • ImportJobRequest

        public ImportJobRequest​(List<String> requestId,
                        byte[] file,
                        String parentRef,
                        org.xwiki.model.reference.DocumentReference userReference)
        Creates a specific request for the ical file import job.
        Parameters:
        requestId - the ID of the request.
        file - the file to be processed.
        parentRef - the reference to the parent calendar.
        userReference - the user who requests the job.

    • Method Detail

      • getFile

        public byte[] getFile()
        Get the content of the given file.
        Returns:
        the content of the file as a Byte array.

      • getParentRef

        public String getParentRef()
        Get the reference to the parent calendar.
        Returns:
        the reference to the parent calendar.

      • getUserReference

        public org.xwiki.model.reference.DocumentReference getUserReference()
        Get the reference to the user who requested the import.
        Returns:
        the reference to the user.