wt.fc.manifest
Class Manifest

java.lang.Object
  wt.fc.manifest.Manifest

public final class Manifest

extends Object

This class serves as a data container for gathering Directive objects to be passed from one or many services to another service optimized to handle the required interaction with the database for the set of Directive objects it contains. An instance of Manifest is created by using the createManifest() API from ManifestServerHelper. Directive objects are added via helper methods defined on ManifestServerHelper class. A Manifest is processed by passing it to theManifestServerHelper.service.processManifest(manifest : Manifest) API from ManifestServiceSvr. A Manifest which has been processed will contain Directive objects that have their own results via the Directive/DirectiveResult relationship.

Supported API: true

Extendable: false

See Also:

Directive, DirectiveResult, ManifestServerHelper, ManifestServiceSvr

Field Summary

private static String	CLASSNAME
private HashMap	directivesMap
private boolean	manifestProcessed
private static String	RESOURCE
private static boolean	verbose

Constructor Summary

protected

Manifest() Instances of this class should be created using the createManifest API available on ManifestServerHelper to ensure proper initialization.

Method Summary

DirectiveResult[]	getAllDirectiveResults() Gets all the DirectiveResult objects for allDirective objects within the Manifest.
protected Directive[]	getAllDirectives() Gets all the Directive objects contained wihin the Manifest instance.
DirectiveResult[]	getDirectiveResults(String name) Gets the DirectiveResult for a specific Directive object within the Manifest based on the name that is specified.
protected Directive[]	getDirectives(String name) Gets the Directive objects associated with the specified group name.
protected Directive[]	getDirectivesByType(String directiveType) Gets all the Directive objects of the type specified by directiveType (the fully qualified class name of the Directive type to be retrieved).
protected String[]	getDirectiveTypes() Gets the class names for each unique type of Directive contained within this Manifest.
protected String	insertDirective(Directive directive, String name) Inserts a Directive object into the Manifest.
protected boolean	isManifestProcessed() Gets the value of the attribute: manifestProcessed; Flag for recording whether or not the Manifest object has been processed.
protected void	removeDirectives(String name) Removes the Directive objects identified by the group name from the Manifest.
protected Manifest	resetManifest() Completely empties the Manifest object and returns it to it's initial creation state.
protected void	setManifestProcessed(boolean a_ManifestProcessed) Sets the value of the attribute: manifestProcessed; Flag for recording whether or not the Manifest object has been processed.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

RESOURCE

private static final String RESOURCE

See Also:

Constant Field Values

CLASSNAME

private static final String CLASSNAME

verbose

private static boolean verbose

manifestProcessed

private boolean manifestProcessed

directivesMap

private HashMap directivesMap

Constructor Detail

Manifest

protected Manifest()

Instances of this class should be created using the createManifest API available on ManifestServerHelper to ensure proper initialization.

Supported API: false

See Also:

ManifestServerHelper

Method Detail

isManifestProcessed

protected boolean isManifestProcessed()

Gets the value of the attribute: manifestProcessed; Flag for recording whether or not the Manifest object has been processed. This should only be set by the code that processed the Manifest.

Supported API: false

Returns:

boolean

setManifestProcessed

protected void setManifestProcessed(boolean a_ManifestProcessed)
                             throws WTPropertyVetoException

Sets the value of the attribute: manifestProcessed; Flag for recording whether or not the Manifest object has been processed. This should only be set by the code that processed the Manifest.

Supported API: false

Parameters:

a_ManifestProcessed -

Throws:

WTPropertyVetoException

resetManifest

protected Manifest resetManifest()

Completely empties the Manifest object and returns it to it's initial creation state.

Supported API: false

Returns:

Manifest

insertDirective

protected String insertDirective(Directive directive,
                                 String name)
                          throws WTException

Inserts a Directive object into the Manifest. If a valid value for name is provided it will attempt to store the specified Directive with the name provided, and return that value. If the name is invalid for any reason an exception is thrown. If a null value is passed for name the Manifest will create a storage name and return that value.

Supported API: false

Parameters:

directive - Directive object to be added to the Manifest.

name - Optional storage name for the Directive being inserted, if a null name is provided a storage name is internally generated by the Manifest.

Returns:

String

Throws:

WTException

removeDirectives

protected void removeDirectives(String name)
                         throws WTException

Removes the Directive objects identified by the group name from the Manifest.

Supported API: false

Parameters:

name - Internal storage name of the Directive objects to be removed. This should be the whatever was returned when the Directive was inserted with insertDirective(directive, name).

Throws:

WTException

getDirectives

protected Directive[] getDirectives(String name)
                             throws WTException

Gets the Directive objects associated with the specified group name.

Supported API: false

Parameters:

name - Internal storage name of the Directive objects to be retrieved. This should be whatever was returned when the Directive was inserted with insertDirective(directive, name).

Returns:

Directive[]

Throws:

WTException

getAllDirectives

protected Directive[] getAllDirectives()
                                throws WTException

Gets all the Directive objects contained wihin the Manifest instance.

Supported API: false

Returns:

Directive[]

Throws:

WTException

getDirectiveResults

public DirectiveResult[] getDirectiveResults(String name)
                                      throws WTException

Gets the DirectiveResult for a specific Directive object within the Manifest based on the name that is specified. If the Manifest has not been processed, or the Directive specified by name does not exist, a WTException is thrown.

Supported API: true

Parameters:

name - Internal storage name of the group whose results will be retrieved. This should be the whatever was returned when the Directive was inserted with insertDirective(directive, name).

Returns:

DirectiveResult[]

Throws:

WTException

getAllDirectiveResults

public DirectiveResult[] getAllDirectiveResults()

Gets all the DirectiveResult objects for allDirective objects within the Manifest. If the Manifest has not been processed, a WTException is thrown.

Supported API: true

Returns:

DirectiveResult[]

getDirectiveTypes

protected String[] getDirectiveTypes()

Gets the class names for each unique type of Directive contained within this Manifest.

Supported API: false

Returns:

String[]

getDirectivesByType

protected Directive[] getDirectivesByType(String directiveType)

Gets all the Directive objects of the type specified by directiveType (the fully qualified class name of the Directive type to be retrieved).

Supported API: false

Parameters:

directiveType - String representing the class name of the Directive objects to be retrieved from the Manifest.

Returns:

Directive[]

toString

public String toString()