EASP API 7.6.0

net.juniper.smgt.ent.im
Interface Substitutions

All Known Subinterfaces:
Access, Enterprise, Folder, Retailer, Site, Subscriber, Subscription

public interface Substitutions

This interface is implemented by objects for which Substitutions can be defined or aquired via the service parameter aquisition path (see the SSC documentation for more detail re. the aquisition path). It has two purposes: the first is to provide views of the Substititutions aquired from this object and above this object in the aquisition path (via the getFixedVariables, getDefaultedVariables, and getFreeVariables methods); the second is to provide a means of manipulating the Substitutions defined in this object (via the remaining methods).

The free variables returned by the getFreeVariables method do not have values; they need to appear on the left side of some Substitution. The fixed and defaulted variables returned by the getFixedVariables and getDefaultedVariables methods are variables that are known to have values; they can be used on the right side of a Substitution.


Method Summary
 Substitution delSubstitution(String varName)
          Deletes the Substitution for the named variable.
 List getDefaultedVariables()
          Returns a List of Substitutions defining the defaulted variables, in the context of this object.
 List getFixedVariables()
          Returns a List of Substitutions defining the fixed variables, in the context of this object.
 List getFreeVariables()
          Returns a List of Substitutions defining the 'free' variables, in the context of this object.
 Substitution getSubstitution(String varName)
          Returns the Substitution for the named variable, or null if none exists.
 Iterator getSubstitutionVariableNames()
          Returns an iterator over the variables names for which a Substitution exists in this Substitutions object.
 boolean hasSubstitution(String varName)
          Returns true if there is a Substitution object defined in this Substitutions object for the named variable.
 Substitution putSubstitution(Substitution subst)
          Defines a Substitution for this object.
 

Method Detail

getFixedVariables

List getFixedVariables()
                       throws CommunicationException,
                              AccessControlException,
                              SubstitutionFormatException
Returns a List of Substitutions defining the fixed variables, in the context of this object. These are the variables that have at least one fixed Substitution in the aquisition path. If a fixed Substitution exists for a variable, the value bound to that variable is the value provided by the fixed Substitution, or, if it does not provide a value, by next most specific Substitution for that variable that does provide a value. If no such Substitution exists, the variable will not have any value. These variables that can be safely used in the right side of Substitutions for the object, since they have values.

Returns:
A List of Substitution objects.
Throws:
CommunicationException - Thrown if there is a problem communicating with the directory.
AccessControlException - Thrown if the currently bound Manager doesn't have access to all the Substitutions in the acquistion path
SubstitutionFormatException - thrown if the list of substitutions results in using variables with inconsistent types, for instance, variable x with [x:port, X:network] fails because x is used as both a port and a network type variable

getDefaultedVariables

List getDefaultedVariables()
                           throws CommunicationException,
                                  AccessControlException,
                                  SubstitutionFormatException
Returns a List of Substitutions defining the defaulted variables, in the context of this object. These are the variables that that have at least one Substitution in the aquisition path that defines a value, and no fixed Substitutions in the acquistion path. These variables that can be safely used in the right side of Substitutions for the object, since they have values.

Returns:
A List of Substitution objects.
Throws:
CommunicationException - Thrown if there is a problem communicating with the directory.
AccessControlException - Thrown if the currently bound Manager doesn't have access to all the Substitutions in the acquistion path.
SubstitutionFormatException - thrown if the list of substitutions results in using variables with inconsistent types, for instance, variable x with [x:port, X:network] fails because x is used as both a port and a network type variable

getFreeVariables

List getFreeVariables()
                      throws CommunicationException,
                             AccessControlException,
                             SubstitutionFormatException
Returns a List of Substitutions defining the 'free' variables, in the context of this object. These are the variables that that have at least one Substitution in the aquisition path, but have no substitutions that define a value. These variables must be given values in order to be used.

Returns:
A List of Substitution objects.
Throws:
CommunicationException - Thrown if there is a problem communicating with the directory.
AccessControlException - Thrown if the currently bound Manager doesn't have access to all the Substitutions in the acquistion path.
SubstitutionFormatException - thrown if the list of substitutions results in using variables with inconsistent types, for instance, variable x with [x:port, X:network] fails because x is used as both a port and a network type variable

hasSubstitution

boolean hasSubstitution(String varName)
                        throws AccessControlException,
                               CommunicationException
Returns true if there is a Substitution object defined in this Substitutions object for the named variable.

Parameters:
varName - The name of the variable.
Throws:
AccessControlException - Thrown if the currently bound Manager doesn't have permission to read Substitutions.
CommunicationException - Thrown if there is a problem communicating with the directory.

getSubstitutionVariableNames

Iterator getSubstitutionVariableNames()
                                      throws AccessControlException,
                                             CommunicationException
Returns an iterator over the variables names for which a Substitution exists in this Substitutions object.

Throws:
CommunicationException - Thrown if there is a problem communicating with the directory.
AccessControlException - Thrown if the currently bound Manager doesn't have permission to read Substitutions.

getSubstitution

Substitution getSubstitution(String varName)
                             throws AccessControlException,
                                    CommunicationException
Returns the Substitution for the named variable, or null if none exists.

Returns:
net.juniper.smgt.ent.im.Substitution the Substitution for varName or null if no such Substitution
Throws:
CommunicationException - Thrown if there is a problem communicating with the directory.
AccessControlException - Thrown if the currently bound Manager doesn't have permission to read Substitutions.

putSubstitution

Substitution putSubstitution(Substitution subst)
                             throws CommunicationException,
                                    AccessControlException
Defines a Substitution for this object. If there is already a Substitution for the variable named in subst, it is replaced.

Parameters:
subst - The Substitution to add to this object.
Returns:
The Substitution that was replaced, or null if none was replaced.
Throws:
CommunicationException - Thrown if there is a problem communicating with the directory.
AccessControlException - Thrown if the currently bound Manager doesn't have permission to change Substitutions.

delSubstitution

Substitution delSubstitution(String varName)
                             throws CommunicationException,
                                    AccessControlException
Deletes the Substitution for the named variable. Returns the Substitution that was deleted, or null if there was no Substitution for the named variable.

Parameters:
varName - The name of the variable whose Substitution is to be deleted.
Returns:
The Substitution that was deleted, or null if there was no substitution for the named variable.
Throws:
CommunicationException - Thrown if there is a problem communicating with the directory.
AccessControlException - Thrown if the bound Manager does not have permission to change Substitutions.

EASP API 7.6.0