Package com.microstrategy.web.app.tasks

Class BeanTaskInfo

  • public class BeanTaskInfo
extends java.lang.Object
    This class contains information about the bean task: its name, its file, its fully qualified base class.
    Since:
    MicroStrategy Web 8.1.0

    • Constructor Summary

      Constructors 
      Constructor Description
      BeanTaskInfo()
      Creates a new BeanTaskInfo object.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String getFilePath()
      Returns the File path associated with this object.
      java.lang.String getTaskFQCN()
      Returns the fully qualified class name to use as the base class for this task.
      java.lang.String getTaskID()
      Returns the ID of the task to use for this file.
      WebPrivilegesExpression getTaskPrivileges()  
      boolean isAdminTask()
      Returns whether this task is an administrative task.
      boolean isTask()
      Returns whether this file represents a bean task configuration file.
      void setFilePath​(java.lang.String filepath)
      Sets the File name associated with this object.
      void setIsAdminTask​(boolean isAdminTask)
      Sets whether this task is an administrative task.
      void setIsTask​(boolean isTask)
      Sets whether this file represents a bean task configuration file.
      void setTaskFQCN​(java.lang.String fqcn)
      Sets the fully qualified class name to use as the base class for this task.
      void setTaskID​(java.lang.String taskID)
      Sets the ID of the task to use for this file.
      void setTaskPrivileges​(java.lang.String privilegesString)  

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • BeanTaskInfo

        public BeanTaskInfo()
        Creates a new BeanTaskInfo object.

    • Method Detail

      • getTaskID

        public java.lang.String getTaskID()
        Returns the ID of the task to use for this file.
        Returns:
        The ID of the task to use for this file.

      • setTaskID

        public void setTaskID​(java.lang.String taskID)
        Sets the ID of the task to use for this file.
        Parameters:
        taskID - The ID of the task to use for this file.

      • isTask

        public boolean isTask()
        Returns whether this file represents a bean task configuration file.
        Returns:
        Whether this file represents a bean task configuration file.

      • setIsTask

        public void setIsTask​(boolean isTask)
        Sets whether this file represents a bean task configuration file.
        Parameters:
        isTask - Whether this file represents a bean task configuration file.

      • getTaskFQCN

        public java.lang.String getTaskFQCN()
        Returns the fully qualified class name to use as the base class for this task.
        Returns:
        The fully qualified class name to use as the base class for this task.

      • setTaskFQCN

        public void setTaskFQCN​(java.lang.String fqcn)
        Sets the fully qualified class name to use as the base class for this task.
        Parameters:
        fqcn - The fully qualified class name to use as the base class for this task.

      • getFilePath

        public java.lang.String getFilePath()
        Returns the File path associated with this object.
        Returns:
        The File path associated with this object.

      • setFilePath

        public void setFilePath​(java.lang.String filepath)
        Sets the File name associated with this object.
        Parameters:
        filepath - The file path associated with this object. This path is either relative or absolute if this file exist in customization folder only

      • isAdminTask

        public boolean isAdminTask()
        Returns whether this task is an administrative task.
        Returns:
        Whether this task is an administrative task.

      • setIsAdminTask

        public void setIsAdminTask​(boolean isAdminTask)
        Sets whether this task is an administrative task.
        Parameters:
        isAdminTask - Whether this task is an administrative task.

      • setTaskPrivileges

        public void setTaskPrivileges​(java.lang.String privilegesString)