org.osbot.rs07.api.ai.activity

Interface ActivityProvider

public interface ActivityProvider

Interface to notify the compiler the inheriting class supports activities

Method Summary

Modifier and Type	Method and Description
default ActivityConfiguration	getActivityConfigurationByArgument(java.lang.String argument) Attempts to get the first activity configuration using getActivityConfigurations() where the argument equals the provided argument.
ActivityConfiguration[]	getActivityConfigurations() Returns the possible activity configurations that can be provided
default ActivityPreparation	getActivityPreparation(java.lang.String configurationArgument, Requirement[] requirements) Gets the preparations to start or complete the activity configuration

Method Detail

getActivityConfigurations

ActivityConfiguration[] getActivityConfigurations()

Returns the possible activity configurations that can be provided

Returns:

The possible activity configurations that can be provided

getActivityPreparation

default ActivityPreparation getActivityPreparation(java.lang.String configurationArgument,
                                                   Requirement[] requirements)

Gets the preparations to start or complete the activity configuration

Parameters:

configurationArgument - The activity configuration argument to get the preparations for

requirements - The requirements that are needed to be obtained from the configuration

Returns:

The preparations to start or complete the activity configuration

getActivityConfigurationByArgument

default ActivityConfiguration getActivityConfigurationByArgument(java.lang.String argument)

Attempts to get the first activity configuration using getActivityConfigurations() where the argument equals the provided argument. When no configuration matches, null will be returned.

Parameters:

argument - The argument of the configuration to get

Returns:

The first activity configuration where the argument equals the provided argument