Interface SAPAbapProgramParameter

    • Method Detail

      • getPosition

        Long getPosition()
        Get the value for Position. (Position.) 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.
      • getKind

        SAPAbapProgramParameterKind getKind()
        Get the value for Kind. (Kind of parameter.) 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.
      • getLength

        Long getLength()
        Get the value for Length. (Length.) 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.
      • getType

        String getType()
        Get the value for Type. (Data type.) 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.
      • getSapType

        SAPAbapProgramParameterType getSapType()
        Get the value for SapType. (SAP data type.) 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.
      • getDefaultValue

        String getDefaultValue()
        Get the value for DefaultValue. (Low value of the parameter)
        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.
      • isProtected

        boolean isProtected()
        Get the value for Protected. (Indicates if this is a protected parameter.)
        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.
      • isHidden

        boolean isHidden()
        Get the value for Hidden. (Indicates if this is a hidden parameter.)
        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.
      • isRequired

        boolean isRequired()
        Get the value for Required. (Indicates if this is a mandatory parameter.)
        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.
      • getGroupId

        String getGroupId()
        Get the value for GroupId. (Group id of the parameter)
        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.
      • getDbField

        String getDbField()
        Get the value for DbField. (Database reference for the parameter)
        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.
      • setPosition

        void setPosition​(Long newPosition)
        Set the value for Position. (Position.) This value is mandatory.
        Parameters:
        newPosition - the new value for Position. If this is null, then the object cannot be persisted.
        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.
      • setKind

        void setKind​(SAPAbapProgramParameterKind newKind)
        Set the value for Kind. (Kind of parameter.) This value is mandatory.
        Parameters:
        newKind - the new value for Kind. If this is null, then the object cannot be persisted.
        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.
      • setLength

        void setLength​(Long newLength)
        Set the value for Length. (Length.) This value is mandatory.
        Parameters:
        newLength - the new value for Length. If this is null, then the object cannot be persisted.
        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.
      • setType

        void setType​(String newType)
        Set the value for Type. (Data type.) This value is mandatory.
        Parameters:
        newType - the new value for Type. If this is null, then the object cannot be persisted.
        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.
      • setSapType

        void setSapType​(SAPAbapProgramParameterType newSapType)
        Set the value for SapType. (SAP data type.) This value is mandatory.
        Parameters:
        newSapType - the new value for SapType. If this is null, then the object cannot be persisted.
        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.
      • setDefaultValue

        void setDefaultValue​(String newDefaultValue)
        Set the value for DefaultValue. (Low value of the parameter) This value is optional.
        Parameters:
        newDefaultValue - the new value for DefaultValue.
        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.
      • setProtected

        void setProtected​(boolean newProtected)
        Set the value for Protected. (Indicates if this is a protected parameter.)
        Parameters:
        newProtected - the new value for Protected.
        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.
      • setHidden

        void setHidden​(boolean newHidden)
        Set the value for Hidden. (Indicates if this is a hidden parameter.)
        Parameters:
        newHidden - the new value for Hidden.
        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.
      • setRequired

        void setRequired​(boolean newRequired)
        Set the value for Required. (Indicates if this is a mandatory parameter.)
        Parameters:
        newRequired - the new value for Required.
        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.
      • setGroupId

        void setGroupId​(String newGroupId)
        Set the value for GroupId. (Group id of the parameter) This value is optional.
        Parameters:
        newGroupId - the new value for GroupId.
        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.
      • setDbField

        void setDbField​(String newDbField)
        Set the value for DbField. (Database reference for the parameter) This value is optional.
        Parameters:
        newDbField - the new value for DbField.
        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.
      • getSAPAbapProgram

        SAPAbapProgram getSAPAbapProgram()
        Get the SAPAbapProgram.
        Returns:
        SAPAbapProgram
        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.