Package com.microstrategy.web.objects

Interface WebAssociatedSchedules

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      void clearObjectAssociatedSchedules()
      clear the associated schedule for a report or a RWD, the object will inherit its parent's schedule
      void clearProjectAssociatedSchedules()
      clear the associated schedule
      void disableList()
      disable the associated schedule for a report or a RWD, the object will become unschedulable
      boolean isNewlyCreated()
      get the Newly-Created flag
      boolean isNonSchedulable()
      get the Non-Schedulable flag
      void populate()
      get the associated schedule from IServer
      void populate​(boolean inherited)
      get the associated schedule from IServer
      void populateObject()
      get the associated schedule from IServer for object
      void saveObjectAssociatedSchedules()
      save the associated schedule to IServer
      void saveProjectAssociatedSchedules()
      save the associated schedule to IServer
      void setMessageId​(java.lang.String msgId)
      set the message id related to
      void setNewlyCreated​(boolean newlyCreated)
      set the Newly-Created flag
      void setNonSchedulable​(boolean nonSchedulable)
      set the Non-Schedulable flag
      void setObject​(ResultSetBean rsb)
      set the report/document bean related to
      void setObject​(WebObjectInfo wrsi)
      set the report/document object related to
      void setObjectId​(java.lang.String objId)
      set the report/document object id related to
      void setObjectType​(int objType)
      set the report/document object type related to

      • Methods inherited from interface java.util.Collection

        parallelStream, removeIf, stream, toArray

      • Methods inherited from interface java.lang.Iterable

        forEach

      • Methods inherited from interface java.util.List

        add, add, addAll, addAll, clear, contains, containsAll, equals, get, hashCode, indexOf, isEmpty, iterator, lastIndexOf, listIterator, listIterator, remove, remove, removeAll, replaceAll, retainAll, set, size, sort, spliterator, subList, toArray, toArray

    • Method Detail

      • populate

        void populate​(boolean inherited)
       throws WebObjectsException
        get the associated schedule from IServer
        Parameters:
        inherited - boolean states whether inherit the parents schedules
        Throws:
        WebObjectsException

      • clearObjectAssociatedSchedules

        void clearObjectAssociatedSchedules()
                             throws WebObjectsException
        clear the associated schedule for a report or a RWD, the object will inherit its parent's schedule
        Parameters:
        objId - the id for the object
        objType - the type of the object
        msesageId - Message ID corresponding to object the associated schedule to be saved.
        Throws:
        WebObjectsException

      • disableList

        void disableList()
          throws WebObjectsException
        disable the associated schedule for a report or a RWD, the object will become unschedulable
        Parameters:
        objId - the id for the object
        objType - the type of the object
        msesageId - Message ID corresponding to object the associated schedule to be saved.
        Throws:
        WebObjectsException

      • saveObjectAssociatedSchedules

        void saveObjectAssociatedSchedules()
                            throws WebObjectsException
        save the associated schedule to IServer
        Parameters:
        msesageId - Message ID corresponding to object the associated schedule to be saved.
        Throws:
        WebObjectsException

      • populateObject

        void populateObject()
             throws WebObjectsException
        get the associated schedule from IServer for object
        Parameters:
        objId - the id for the object
        objType - the type of the object
        msesageId - Message ID corresponding to object the associated schedule to be saved.
        Throws:
        WebObjectsException

      • setNonSchedulable

        void setNonSchedulable​(boolean nonSchedulable)
        set the Non-Schedulable flag
        Parameters:
        nonSchedulable - the flag indicates non-schedulable

      • setNewlyCreated

        void setNewlyCreated​(boolean newlyCreated)
        set the Newly-Created flag
        Parameters:
        newlyCreated - the flag indicates whether a report/document is never been saved.

      • isNewlyCreated

        boolean isNewlyCreated()
        get the Newly-Created flag
        Returns:
        the flag indicates whether a report/document is never been saved.

      • isNonSchedulable

        boolean isNonSchedulable()
        get the Non-Schedulable flag
        Returns:
        the flag indicates non-schedulable

      • setObject

        void setObject​(WebObjectInfo wrsi)
        set the report/document object related to

      • setObject

        void setObject​(ResultSetBean rsb)
        set the report/document bean related to

      • setObjectId

        void setObjectId​(java.lang.String objId)
        set the report/document object id related to

      • setObjectType

        void setObjectType​(int objType)
        set the report/document object type related to

      • setMessageId

        void setMessageId​(java.lang.String msgId)
        set the message id related to