Java Doc for SOIFGetter.java in  » Portal » Open-Portal » soif » Java Source Code / Java DocumentationJava Source Code and Java Documentation

A status flag needs to be correctly maintained by subclasses. Calling the constructor of this class will set the status to PREPARED. Constructors of subclasses that do not call this constructor should mark the status as PREPARED. Subclasses that override the run() method should mark the status as PROCESSING as early as possible in the subclass's run() method. When the subclass's run() method completes, the status should be marked COMPLETE for successful completion or ABEND for completion with errors. If the subclass calls this class's getSOIF() method and the status gets set to ABEND by this class's getSOIF() method, that status should not be changed to COMPLETE by the subclass. Once the status is set to ABEND, it cannot be changed to COMPLETE. The status is maintained by a setStatus() method which enforces the ABEND/COMPLETE restriction and cannot be overridden. An "empty" getter instance is sometimes useful; this is created using the argumentless constructor, has a status of UNINITIALIZED and cannot be exectuted.

Note: The RDMHeader class is not currently used to formulate requests. This may change. Both SchemaGetter and TaxonomyGetter initialize their RDM header strings with a correct RDM request. Because there are other schema and taxonomy requests that can be made which are currently not well (or not at all) documented the standard request can be changed using setRDMHeader() which allows you to put in anything but prevents you from changing the request during processing (the scope of the processing phase far exceeds the requirement for safe operation). The setRDMHeader() method should be used with the understanding that the interface will very likely change. It is also possible that the constructors will change, but the most likely scenario is that RDMHeader savvy constructors will be added.