Package com.microstrategy.web.objects

Interface WebProjectManipulator

  • public interface WebProjectManipulator
    The WebProjectManipulator interface represents the behavior of an object that can change properties of a project within a Cluster. An object of this type obtained from a WebClusterMembership object will affect a project on all servers within the membership cluster. And object of this type obtained from a WebClusterMember object will only affect the project for that specific member.
    Since:
    MicroStrategy Web 9.0.0

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      void applyChanges​(WebProjectInstance project)
      Applies all changes to the project specified by project.
      void setAction​(int action)
      Sets the action to be applied to the project.
      void setMaxWait​(int maxWaitSeconds)
      Sets the maximum amount of time, in seconds, the API will wait Currently, only supported for Loading project especially when project is offline pending.
      void setStatus​(int status)
      Sets the status to be used when the change is applied

    • Method Detail

      • setStatus

        void setStatus​(int status)
        Sets the status to be used when the change is applied
        Parameters:
        status - Status of the project. Value must be from EnumDSSXMLProjectStatus.

      • setMaxWait

        void setMaxWait​(int maxWaitSeconds)
        Sets the maximum amount of time, in seconds, the API will wait Currently, only supported for Loading project especially when project is offline pending. It would wait for project status to change to offline and then load the project. This can be used to provide an upper bound on synchronous execution time. the command will be blocked for given timeout duration until the project status is changed (and thus has performance impact)
        Parameters:
        maxWaitSeconds - timeout in seconds