public interface EnvService
Modifier and Type | Method and Description |
---|---|
EnvDesc[] |
getAllEnv()
Retrieve the list of all AMX Environments in the enterprise.
|
EnvTreeDesc[] |
getAllEnvDescs(FilterDesc filter)
Retrieve a hierarchical list of all AMX Environments for display in a tree widget.
|
PlatformDesc[] |
getEnabledHostsForNodeCreation(EntityIdentifier envid)
Returns hosts which have node creation permission and are currently enabled for an environment
|
EnvTreeDesc[] |
getSpecifiedEnvDescs(FilterDesc filter,
EntityIdentifier[] envIds)
Similar to
getAllEnvDescs(FilterDesc) , but this operation takes an input of specific environments to return data for. |
EnvDesc[] getAllEnv() throws AdminException
AdminException
EnvTreeDesc[] getAllEnvDescs(FilterDesc filter) throws AdminException
filter
- specifies types of data that should be suppressed. The flags in FilterDesc should be set to false, if the data
is needed, or true if the data is not needed. The FilterDesc thus acts as exclusion criteria. When a flag is set to true,
the corresponding data element will be null.AdminException
EnvTreeDesc[] getSpecifiedEnvDescs(FilterDesc filter, EntityIdentifier[] envIds) throws AdminException
getAllEnvDescs(FilterDesc)
, but this operation takes an input of specific environments to return data for.filter
- specifies types of data that should be suppressed. The flags in FilterDesc should be set to false, if the data
is needed, or true if the data is not needed. The FilterDesc thus acts as exclusion criteria. When a flag is set to true,
the corresponding data element will be null.envIds
- specific environment identifiers for which data is to be returnedAdminException
PlatformDesc[] getEnabledHostsForNodeCreation(EntityIdentifier envid) throws AdminException
envid
- AdminException