Interface SAPMassActivityParameter

    • Method Detail

      • getRollname

        String getRollname()
        Get the value for Rollname. (Rollname)
        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

        SAPMassActivityParameterType getType()
        Get the value for Type. (Parameter 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.
      • 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.
      • getDatatype

        String getDatatype()
        Get the value for Datatype. (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.
      • 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.
      • isMandatory

        boolean isMandatory()
        Get the value for Mandatory. (Whether this field is mandatory)
        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.
      • getFieldName

        String getFieldName()
        Get the value for FieldName. ("Field name")
        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.
      • getStructureName

        String getStructureName()
        Get the value for StructureName. (Structure) 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.
      • setRollname

        void setRollname​(String newRollname)
        Set the value for Rollname. (Rollname) This value is optional.
        Parameters:
        newRollname - the new value for Rollname.
        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​(SAPMassActivityParameterType newType)
        Set the value for Type. (Parameter 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.
      • 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.
      • setDatatype

        void setDatatype​(String newDatatype)
        Set the value for Datatype. (Data type) This value is mandatory.
        Parameters:
        newDatatype - the new value for Datatype. 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.
      • setMandatory

        void setMandatory​(boolean newMandatory)
        Set the value for Mandatory. (Whether this field is mandatory)
        Parameters:
        newMandatory - the new value for Mandatory.
        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.
      • setFieldName

        void setFieldName​(String newFieldName)
        Set the value for FieldName. ("Field name") This value is optional.
        Parameters:
        newFieldName - the new value for FieldName.
        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.
      • setStructureName

        void setStructureName​(String newStructureName)
        Set the value for StructureName. (Structure) This value is mandatory.
        Parameters:
        newStructureName - the new value for StructureName. 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.
      • getSAPMassActivityStructure

        SAPMassActivityStructure getSAPMassActivityStructure()
        Get the SAPMassActivityStructure.
        Returns:
        SAPMassActivityStructure
        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.
      • getParentSAPMassActivityParameter

        SAPMassActivityParameter getParentSAPMassActivityParameter()
        Get the ParentSAPMassActivityParameter.
        Returns:
        ParentSAPMassActivityParameter
        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.
      • setParentSAPMassActivityParameter

        void setParentSAPMassActivityParameter​(SAPMassActivityParameter newParentSAPMassActivityParameter)
        Set the value for ParentSAPMassActivityParameter. This value is optional.
        Parameters:
        newParentSAPMassActivityParameter - is the object to set ParentSAPMassActivityParameter to. Parent-child relationship for Mass Activity parameters.