Package uk.num.numlib.api
Interface NumAPIContext
-
- All Known Implementing Classes:
NumAPIContextBase
public interface NumAPIContextThe context state for a given module and NUM ID combination
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description UserVariable[]getRequiredUserVariables()Get the user variables.booleanisPopulatorQueryRequired()voidsetLocation(NumAPICallbacks.Location location)voidsetPopulatorQueryRequired(boolean populatorQueryRequired)voidsetRequiredUserVariables(UserVariable[] userVariables)Update the required user variables with values obtained from the client.
-
-
-
Method Detail
-
getRequiredUserVariables
UserVariable[] getRequiredUserVariables()
Get the user variables.- Returns:
- UserVariable[]
-
setRequiredUserVariables
void setRequiredUserVariables(UserVariable[] userVariables)
Update the required user variables with values obtained from the client.- Parameters:
userVariables- The UserVariable array with the value fields populated.
-
setLocation
void setLocation(NumAPICallbacks.Location location)
-
isPopulatorQueryRequired
boolean isPopulatorQueryRequired()
- Returns:
- true if the library should query the Populator
-
setPopulatorQueryRequired
void setPopulatorQueryRequired(boolean populatorQueryRequired)
- Parameters:
populatorQueryRequired- true if the library should query the Populator
-
-