Package com.microstrategy.web.objects

Interface WebProjectCreator

  • public interface WebProjectCreator
    Since:
    MicroStrategy Web 9.0.0

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      void createProject()
      Creates a new project on the IServer with the characteristics specified by this object.
      void createProject​(int flag)
      Creates a new project on the IServer with the characteristics specified by this object.
      java.lang.String getDescription()
      Returns the description to be used for the new project.
      java.lang.String getId()
      Gets the project ID for the newly created project.
      java.lang.String getName()
      Returns the name to be used for the new project.
      WebLocaleObjectInfo getPrimaryLocale()
      Returns the primary locale set for new project.
      java.lang.String getScriptPath()
      Returns the location of NEWPROJECT.PDS used to create the new project
      java.util.Set<WebLocaleObjectInfo> getSupportedLocales()
      Returns an editable Set of locales supported by the new project.
      void setCreateFlag​(int flag)
      Sets the project creation flags.
      void setDescription​(java.lang.String description)
      Sets the description to be used for the new project.
      void setName​(java.lang.String name)
      Sets the name to be used for the new project.
      void setPrimaryLocale​(WebLocaleObjectInfo primaryLocale)
      Sets the primary locale of the new project.
      void setScriptPath​(java.lang.String scriptPath)
      Sets the path to the location of the NEWPROJECT.PDS script.

    • Method Detail

      • setDescription

        void setDescription​(java.lang.String description)
             throws WebObjectsException
        Sets the description to be used for the new project.
        Parameters:
        description - String description of the new project
        Throws:
        WebObjectsException

      • setPrimaryLocale

        void setPrimaryLocale​(WebLocaleObjectInfo primaryLocale)
        Sets the primary locale of the new project. As the primary locale is only supported in MDI enabled metadata, ensure that the IServer is using an MDI enabled metadata before calling this method.
        Parameters:
        primaryLocale - WebLocaleObjectInfo to be used as primary locale for new project

      • setScriptPath

        void setScriptPath​(java.lang.String scriptPath)
        Sets the path to the location of the NEWPROJECT.PDS script.
        Parameters:
        scriptPath - String location of the script

      • getId

        java.lang.String getId()
        Gets the project ID for the newly created project.
        Returns:
        Project ID

      • getName

        java.lang.String getName()
        Returns the name to be used for the new project.
        Returns:
        String name of the new project

      • getDescription

        java.lang.String getDescription()
        Returns the description to be used for the new project.
        Returns:
        String description of the new project

      • getScriptPath

        java.lang.String getScriptPath()
        Returns the location of NEWPROJECT.PDS used to create the new project
        Returns:
        String containing the new location of NEWPROJECT.PDS

      • createProject

        void createProject​(int flag)
            throws WebObjectsException
        Creates a new project on the IServer with the characteristics specified by this object.
        Parameters:
        flag - The project creation flag.
        Throws:
        WebObjectsException

      • setCreateFlag

        void setCreateFlag​(int flag)
        Sets the project creation flags. This value should come from the bitwise or (|) of values from EnumDSSXMLCreateFlags.
        Parameters:
        flag - The project creation flag value.