[Index]

input


Ask for input from the user.

The medium with which Oddjob asks for input will depend on how it's running. When running in Oddjob Explorer a GUI dialogue will be used. When running from the console, input from the console will be requested.


Property Summary

inputHandler The input handler to use.
name A name, can be any text.
properties Provide all the merged properties defined by this job.
requests A list of requests for input.
stop This flag is set by the stop method and should be examined by any Stoppable jobs in their processing loops.

Example Summary

Example 1 Request lots of input.

Property Detail

inputHandler

Configured ByELEMENT
AccessREAD_WRITE
RequiredNo. This will be set automatically by Oddjob.

The input handler to use.

name

Configured ByATTRIBUTE
AccessREAD_WRITE
RequiredNo.

A name, can be any text.

properties

AccessREAD_ONLY
RequiredRead Only.

Provide all the merged properties defined by this job.

requests

Configured ByELEMENT
AccessREAD_WRITE
RequiredNo, but there will be no values.

A list of requests for input.

stop

AccessREAD_ONLY
RequiredRead Only.

This flag is set by the stop method and should be examined by any Stoppable jobs in their processing loops.


Examples

Example 1

Request lots of input.

<oddjob>
    <job>
        <sequential>
            <jobs>
                <input>
                    <requests>
                        <input-file prompt="Install Directory" default="/home/oddjob/foo" property="config.install"/>
                        <input-text prompt="System" default="Development" property="config.system"/>
                        <input-text prompt="Username" property="config.username"/>
                        <input-password prompt="Password" property="config.password"/>
                        <input-confirm prompt="Agree To Licence" default="false" property="config.agree"/>
                    </requests>
                </input>
                <check value="${config.agree}" eq="true"/>
                <echo>Password for ${config.username} is ${config.password}</echo>
                <input>
                    <requests>
                        <input-message>Logging On to ${config.system} Now!</input-message>
                    </requests>
                </input>
            </jobs>
        </sequential>
    </job>
</oddjob>


(c) R Gordon Ltd 2005 - Present