de.bensoft.acis.core.environment

Interface SystemEnvironment

All Known Subinterfaces:

Environment

public interface SystemEnvironment

Represents a globally available unified interface for Actions. It supports spoken, written and visual output functions.

Method Summary

Modifier and Type	Method and Description
void	addOutput(java.lang.String output) Adds written and spoken output.
void	addSpokenOutput(java.lang.String output) Adds speech output.
void	addWrittenOutput(java.lang.String output) Add written output.
boolean	canRequestInput() Returns whether input can be requested.
boolean	canSpeak() Returns whether speech output is available.
SystemProperties	getSystemProperties() Returns a SystemProperties Object containing some system properties.
UserInfo	getUserInfo() Returns a UserInfo Object which contains information about the user.
VisualOutput	getVisualOutput() Returns the VisualOutput Object if available.
boolean	hasVisualOutput() Returns whether there is visual output available.
java.lang.String	requestInput(java.lang.String message) Requests input from the user and returns the result.

Method Detail

getSystemProperties

SystemProperties getSystemProperties()

Returns a SystemProperties Object containing some system properties.

Returns:

The SystemProperties Object.

getUserInfo

UserInfo getUserInfo()

Returns a UserInfo Object which contains information about the user.

Returns:

The UserInfo Object.

canSpeak

boolean canSpeak()

Returns whether speech output is available.

Returns:

true if available, else false.

addOutput

void addOutput(java.lang.String output)

Adds written and spoken output. Note: There should not be multiple calls of this function sequentially because of there may be a unexpected behavior. The output should be wrapped and this function called once at a time.

Parameters:

output - The output.

addWrittenOutput

void addWrittenOutput(java.lang.String output)

Add written output.

Parameters:

output - The output.

addSpokenOutput

void addSpokenOutput(java.lang.String output)

Adds speech output. Note: There should not be multiple calls of this function sequentially because of there may be a unexpected behavior. The output should be wrapped and this function called once at a time.

Parameters:

output - The speech output.

canRequestInput

boolean canRequestInput()

Returns whether input can be requested.

Returns:

true if yes, else false.

requestInput

java.lang.String requestInput(java.lang.String message)
                       throws java.lang.UnsupportedOperationException

Requests input from the user and returns the result.

Parameters:

message - A message to prompt the request.

Returns:

The input from the user or null when an error occurred.

Throws:

java.lang.UnsupportedOperationException - When requesting input is not supported.

hasVisualOutput

boolean hasVisualOutput()

Returns whether there is visual output available.

Returns:

true if available, else false.

getVisualOutput

VisualOutput getVisualOutput()
                      throws java.lang.UnsupportedOperationException

Returns the VisualOutput Object if available.

Returns:

The VisualOutput Object.

Throws:

java.lang.UnsupportedOperationException - When VisualOutput is not available.