All Packages  Class Hierarchy  This Package  Previous  Next  Index

Interface uhr.core.dk.ParamDrivenAide

public interface ParamDrivenAide
This serves as an "aide-de-camp" to a ParamDriven. The main useful feature is deferred dk lookup. The implementation constructor should set the ParamDriven for use in calling ParamDriven.setDK(Object dk) when the dk in the aide is set.

Method Index

o getDK()
Returns the part's DK.
o getDKType()
Returns the DK type.
o isImmediate()
Determines whether the DK will be provided immediately or not.
o isProvided()
Determines whether the DK has been provided or not.
o provideDK()
Causes deferred Dk to be provided by getting it using the ReadDKService, storing the reference, and calling setDK(Object dk) on the part.
o setDK(Object)
Sets the part's dk.
o setDKType(String)
Sets the type for the DK Object.
o setImmediate(boolean)
Sets the immediate property.
o setReadDKService(UF_Object_String_String)
Sets the service used to read the DK.
o setURL(String)
Sets the url for the dk.

Methods

o setDK 
 public abstract void setDK(Object dk)
Sets the part's dk. First the dk is stored in the aide for later use. Then, using the ParamDriven reference in the aide, ParamDriven.setDK(Object dk) is called.

Parameters:
dk - the data structure containing the DK.
o getDK 
 public abstract Object getDK()
Returns the part's DK. This method is used for editing and then reapplying to the part using ParamDrivenAide.setDK(Object dk).

If the DK is null but available then this becomes a way of providing DK on a deffered, just-in-time basis. Using other state in the aide, the DK will be looked up, stored here, setDK() called on the ParamDriven, and then the DK is returned.

Returns:
the current DK.
Throws: IllegalStateException
if DK is unavailable, since DK should always be available for a ParamDriven part.
o setDKType 
 public abstract void setDKType(String type)
Sets the type for the DK Object. The default is uhr.core.tron.Flexitron.

Parameters:
type - the Java class name for the type.
o getDKType 
 public abstract String getDKType()
Returns the DK type.

Returns:
the DK type.
o setImmediate 
 public abstract void setImmediate(boolean isImmediate)
Sets the immediate property. The default is false. If true the part's setDK(Object dk) will be called immediately just after the part is created.

o isImmediate 
 public abstract boolean isImmediate()
Determines whether the DK will be provided immediately or not.

Returns:
true for immediately or false for deferred.
o provideDK 
 public abstract void provideDK()
Causes deferred Dk to be provided by getting it using the ReadDKService, storing the reference, and calling setDK(Object dk) on the part. Has no effect if already provided.

o isProvided 
 public abstract boolean isProvided()
Determines whether the DK has been provided or not. This is the same as testing whether the DK is null.

Returns:
true for provided (dk is not null) or false for not provided (dk is null).
o setURL 
 public abstract void setURL(String url)
Sets the url for the dk.

Parameters:
url - the dk url.
o setReadDKService 
 public abstract void setReadDKService(UF_Object_String_String service)
Sets the service used to read the DK.

Parameters:
service - the service used to read the DK. 
All Packages  Class Hierarchy  This Package  Previous  Next  Index