javax.constraints
Interface ConstrainedVariable

All Known Subinterfaces:
Var, VarBool, VarReal, VarSet, VarString
All Known Implementing Classes:
AbstractConstrainedVariable, AbstractVar, BasicVarSet, BasicVarString

public interface ConstrainedVariable

This is a base interface for all constrained variable. It defines variable names, a Problem to which the variable belongs to, an associated business object, etc.


Method Summary
 java.lang.Object getImpl()
          This method should be defined by a concrete solver implementation.
 java.lang.String getName()
          Returns the name of this object.
 java.lang.Object getObject()
          This method may be used to get an attached Business Object for this object.
 Problem getProblem()
          Return a problem to which this object belongs
 void setImpl(java.lang.Object impl)
          This method defines an Object that represents an actual implementation of this object inside a concrete solver.
 void setName(java.lang.String name)
          Sets the name of this object.
 void setObject(java.lang.Object obj)
          This method may be used to attach a business object to this object.
 

Method Detail

getImpl

java.lang.Object getImpl()
This method should be defined by a concrete solver implementation. This method returns an Object that represents an actual implementation of this object inside an underlying solver.

Returns:
an Object that represents an actual implementation of this Constrained Object inside an underlying solver.

getName

java.lang.String getName()
Returns the name of this object.

Returns:
the name of this object.

getObject

java.lang.Object getObject()
This method may be used to get an attached Business Object for this object.

Returns:
the Business Object attached to this object.

getProblem

Problem getProblem()
Return a problem to which this object belongs

Returns:
a problem to which this object belongs

setImpl

void setImpl(java.lang.Object impl)
This method defines an Object that represents an actual implementation of this object inside a concrete solver.

Parameters:
impl - the Object that represents an actual implementation of this object inside a implementation solver.

setName

void setName(java.lang.String name)
Sets the name of this object.

Parameters:
name - the name for this object.

setObject

void setObject(java.lang.Object obj)
This method may be used to attach a business object to this object.

Parameters:
obj - the business object being attached.