public interface GlobalVariableFactory
Title: Service Event Fabric Runtime/p>
Description: Defines a factory working with Global Variable
objects.
Copyright: Copyright (c) 2013
Company: StreamScape Technologies
Modifier and Type | Method and Description |
---|---|
void |
addLiteralPool(java.lang.String poolName)
Adds an empty literal pool with the specified name.
|
void |
addVariable(java.lang.String qualifiedName)
Adds the specified variable with an empty value.
|
void |
addVariable(java.lang.String poolName,
java.lang.String variableName)
Adds the specified variable with an empty value to the specified literal pool.
|
boolean |
existsLiteralPool(java.lang.String poolName)
Checks if the specified literal pool exists.
|
boolean |
existsVariable(java.lang.String qualifiedName)
Checks if the specified variable exists.
|
boolean |
existsVariable(java.lang.String poolName,
java.lang.String variableName)
Checks if the specified variable exists in the specified literal pool.
|
GlobalVariableCollection |
getGlobalVariables()
Returns a collection containing all global variables.
|
java.util.List |
getLiteralPoolVariables(java.lang.String poolName)
Returns a sorted list of variables from the specified literal pool.
|
java.lang.String |
getVariable(java.lang.String qualifiedName)
Returns a value of the specified variable.
|
java.lang.String |
getVariable(java.lang.String poolName,
java.lang.String variableName)
Returns a value of the specified variable contained in the specified literal pool.
|
java.util.List |
listLiteralPools()
Returns a sorted list of literal pools.
|
java.util.List |
listLiteralPoolVariables(java.lang.String poolName)
Returns a sorted list of variable names from the specified literal pool.
|
void |
removeLiteralPool(java.lang.String poolName)
Removes a literal pool with the specified name.
|
void |
removeVariable(java.lang.String qualifiedName)
Removes the specified variable.
|
void |
removeVariable(java.lang.String poolName,
java.lang.String variableName)
Removes the specified variable from the specified literal pool.
|
void |
setVariable(java.lang.String qualifiedName,
java.lang.String value)
Sets the specified value to the specified variable.
|
void |
setVariable(java.lang.String poolName,
java.lang.String variableName,
java.lang.String value)
Sets the specified value to the specified variable contained in the specified literal pool.
|
GlobalVariableCollection getGlobalVariables()
void addLiteralPool(java.lang.String poolName) throws UnresolvedVariableException, GlobalVariableFactoryException
poolName
- the name of the pool to be added.UnresolvedVariableException
- if the pool name has invalid format or the pool already exists.GlobalVariableFactoryException
- if some error occurs in the Repository.void removeLiteralPool(java.lang.String poolName) throws UnresolvedVariableException, GlobalVariableFactoryException
poolName
- the name of the pool to be removed.UnresolvedVariableException
- if the pool name has invalid format or the pool already exists.GlobalVariableFactoryException
- if some error occurs in the Repository.boolean existsLiteralPool(java.lang.String poolName)
poolName
- the name of the pool.true
if the specified pool exists, false
otherwise.java.util.List listLiteralPools()
java.util.List listLiteralPoolVariables(java.lang.String poolName) throws UnresolvedVariableException
poolName
- the name of the pool.UnresolvedVariableException
- if the corresponding pool does not exist.java.util.List getLiteralPoolVariables(java.lang.String poolName) throws UnresolvedVariableException
poolName
- the name of the pool.UnresolvedVariableException
- if the corresponding pool does not exist.void addVariable(java.lang.String qualifiedName) throws UnresolvedVariableException, GlobalVariableFactoryException
qualifiedName
- the fully qualified name of the variable to be added.UnresolvedVariableException
- if the specified name has invalid format or the corresponding pool does not exist.GlobalVariableFactoryException
- if some error occurs in the Repository.void addVariable(java.lang.String poolName, java.lang.String variableName) throws UnresolvedVariableException, GlobalVariableFactoryException
poolName
- the name of the pool.variableName
- the name of the variable to be added.UnresolvedVariableException
- if any of these names has invalid format or the pool does not exist.GlobalVariableFactoryException
- if some error occurs in the Repository.void removeVariable(java.lang.String qualifiedName) throws UnresolvedVariableException, GlobalVariableFactoryException
qualifiedName
- the fully qualified name of a variable to be removed.UnresolvedVariableException
- if the specified name has invalid format or the corresponding pool does not exist.GlobalVariableFactoryException
- if some error occurs in the Repository.void removeVariable(java.lang.String poolName, java.lang.String variableName) throws UnresolvedVariableException, GlobalVariableFactoryException
poolName
- the name of the pool containing a variable.variableName
- the name of the variable to be removed.UnresolvedVariableException
- if any of these names has invalid format or the pool does not exist.GlobalVariableFactoryException
- if some error occurs in the Repository.void setVariable(java.lang.String qualifiedName, java.lang.String value) throws UnresolvedVariableException, GlobalVariableFactoryException
qualifiedName
- the fully qualified name of the variable.value
- the variable value to be set.UnresolvedVariableException
- if the specified name has invalid format or the corresponding pool does not exist.GlobalVariableFactoryException
- if some error occurs in the Repository.void setVariable(java.lang.String poolName, java.lang.String variableName, java.lang.String value) throws UnresolvedVariableException, GlobalVariableFactoryException
poolName
- the name of the pool containing the variable.variableName
- the name of the variable.value
- the variable value to be set.UnresolvedVariableException
- if the corresponding pool does not exist.GlobalVariableFactoryException
- if some error occurs in the Repository.boolean existsVariable(java.lang.String qualifiedName) throws UnresolvedVariableException
qualifiedName
- the fully qualified name of the variable.true
if the specified variable exists, false
otherwise.UnresolvedVariableException
- if the specified name has invalid format or the corresponding pool does not exist.boolean existsVariable(java.lang.String poolName, java.lang.String variableName) throws UnresolvedVariableException
poolName
- the name of the pool containing the variable.variableName
- the name of the variable.true
if the specified variable exists, false
otherwise.UnresolvedVariableException
- if the pool does not exist.java.lang.String getVariable(java.lang.String qualifiedName) throws UnresolvedVariableException
qualifiedName
- the fully qualified name of the variable.UnresolvedVariableException
- if the specified name has invalid format or the variable does not exist.java.lang.String getVariable(java.lang.String poolName, java.lang.String variableName) throws UnresolvedVariableException
poolName
- the name of the pool containing the variable.variableName
- the name of the variable.UnresolvedVariableException
- if the specified pool does not exist or the variable does not exist.Copyright © 2015-2024 StreamScape Technologies. All rights reserved.