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()Modules can have required user variables that must be supplied before the NUM record csn be retrieved.voidsetLocation(NumAPICallbacks.Location location)voidsetRequiredUserVariables(UserVariable[] userVariables)Update the required user variables with values obtained from the client.
-
-
-
Method Detail
-
getRequiredUserVariables
UserVariable[] getRequiredUserVariables()
Modules can have required user variables that must be supplied before the NUM record csn be retrieved.- Returns:
- An array of objects.
-
setRequiredUserVariables
void setRequiredUserVariables(UserVariable[] userVariables) throws NumUserVariablesException
Update the required user variables with values obtained from the client.- Parameters:
userVariables- The RequiredUserVariable array with the value fields populated.- Throws:
NumUserVariablesException- on error
-
setLocation
void setLocation(NumAPICallbacks.Location location)
-
-