Interface PublishedWebService

    • Method Detail

      • getWSURL

        String getWSURL()
        Get the value for WSURL. (The URL that the WebService is published on. e.g. http://192.169.7.5:7777. Defaults to the hostname:port where the WebService was published if not set.)
        Returns:
        the field
        Throws:
        com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.
      • getWSDL_URL

        String getWSDL_URL()
        Get the value for WSDL_URL. (The URL that the WSDL is published on. Calculated from the WSURL)
        Returns:
        the field
        Throws:
        com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.
      • isAddJobNote

        boolean isAddJobNote()
        Get the value for AddJobNote. (Whether to add a JobNote on submit.)
        Returns:
        the field
        Throws:
        com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.
      • isEnabled

        boolean isEnabled()
        Get the value for Enabled. (Whether this webservice is currently enabled or not.)
        Returns:
        the field
        Throws:
        com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.
      • getBranchedLLPVersion

        Long getBranchedLLPVersion()
        Get the value for BranchedLLPVersion. (LLP version from which this object was created.) This value is mandatory, and therefore will not be null if this object has been retrieved from the database.
        Returns:
        the field
        Throws:
        com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.
      • setWSURL

        void setWSURL​(String newWSURL)
        Set the value for WSURL. (The URL that the WebService is published on. e.g. http://192.169.7.5:7777. Defaults to the hostname:port where the WebService was published if not set.) This value is optional.
        Parameters:
        newWSURL - the new value for WSURL.
        Throws:
        com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.
      • setAddJobNote

        void setAddJobNote​(boolean newAddJobNote)
        Set the value for AddJobNote. (Whether to add a JobNote on submit.)
        Parameters:
        newAddJobNote - the new value for AddJobNote.
        Throws:
        com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.
      • setEnabled

        void setEnabled​(boolean newEnabled)
        Set the value for Enabled. (Whether this webservice is currently enabled or not.)
        Parameters:
        newEnabled - the new value for Enabled.
        Throws:
        com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.
      • getJobDefinition

        JobDefinition getJobDefinition()
        Get the JobDefinition.
        Returns:
        JobDefinition
        Throws:
        com.redwood.scheduler.api.exception.ObjectDeletedException - If this method is called when the object has been marked for deletion.
        com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException - If this method is called when the object has been removed from it's session.