wt.fc.manifest
Interface Directive

All Known Implementing Classes:
AbstractDirective

public interface Directive

This interface is used to define a high level set of database operations such as a query, insert, or delete. Conceptually, a Directive has a DirectiveResult which is populated after the Directive has been processed. A Directive also has a set of DirectiveCriteria which represent the data that is necessary to process itself.

Supported API: false

Extendable: false


Field Summary
static String CRITERIA
          Label for the attribute.
static String RESULT
          Label for the attribute.
 
Method Summary
 void addOperation(Directive directive)
          Allows an additional database operation(s) to be added to this Directive by essentially adding another Directive object.
 DirectiveCriteria[] getDirectiveCriteria(DirectiveCriteriaKey key)
          Get a DirectiveCriteria array given the input DirectiveCriteriaKey.
 DirectiveResult getResult()
          Gets the object for the association that plays role: RESULT.
 String[] getTypes()
          Determines what types are internally stored in the DirectiveCriteria objects for this Directive, and returns an array of String objects representing the list of fully qualified class names for those types.
 void putDirectiveCriteria(DirectiveCriteria directiveCriteria, DirectiveCriteriaKey key)
          This method checks for an existing DirectiveCriteria object that is the same is the input object.
 void setResult(DirectiveResult a_Result)
          Sets the object for the association that plays role: RESULT.
 

Field Detail

RESULT

public static final String RESULT
Label for the attribute.

Supported API: false

See Also:
Constant Field Values

CRITERIA

public static final String CRITERIA
Label for the attribute.

Supported API: false

See Also:
Constant Field Values
Method Detail

getResult

public DirectiveResult getResult()
Gets the object for the association that plays role: RESULT.

Supported API: false

Returns:
DirectiveResult

setResult

public void setResult(DirectiveResult a_Result)
               throws WTPropertyVetoException
Sets the object for the association that plays role: RESULT.

Supported API: false

Parameters:
a_Result -
Throws:
WTPropertyVetoException

addOperation

public void addOperation(Directive directive)
                  throws WTException
Allows an additional database operation(s) to be added to this Directive by essentially adding another Directive object.

Supported API: false

Parameters:
directive - Represents the database operation or set of database operations that are being added to this Directive object.
Throws:
WTException

getTypes

public String[] getTypes()
Determines what types are internally stored in the DirectiveCriteria objects for this Directive, and returns an array of String objects representing the list of fully qualified class names for those types.

Supported API: false

Returns:
String[]

getDirectiveCriteria

public DirectiveCriteria[] getDirectiveCriteria(DirectiveCriteriaKey key)
Get a DirectiveCriteria array given the input DirectiveCriteriaKey.

Supported API: false

Parameters:
key -
Returns:
DirectiveCriteria[]

putDirectiveCriteria

public void putDirectiveCriteria(DirectiveCriteria directiveCriteria,
                                 DirectiveCriteriaKey key)
This method checks for an existing DirectiveCriteria object that is the same is the input object. If it finds one it appends any QueryKey objects are already stored in the existing DirectiveCriteria object otherwise it is added to the list of DirectiveCriteria objects associated to the input Directive.

Supported API: false

Parameters:
directiveCriteria -
key -