oracle.jdeveloper.audit.analyzer

Interface AuditTaskContext

All Known Implementing Classes:

DefaultAuditTaskContext

public interface AuditTaskContext

Method Summary

Modifier and Type	Method and Description
<T extends ModelAdapter> ModelAdapter	getModel(java.lang.Class<T> type, java.net.URL url, Project project, Workspace workspace) Gets the adapter for the model corresponding to a workspace, project, and url.
<T extends ModelAdapter> ModelAdapter	getModelAdapter(java.lang.Class<T> type, java.net.URL url, Project project, Workspace workspace) Deprecated. Use getModel(Class, URL, Project, Workspace)
boolean	isCancelled() Gets whether the invoking audit has been cancelled.
IssueReport	report(Rule rule, Location location) Reports a rule violation for a construct.
IssueReport	report(Rule rule, ModelAdapter model, java.lang.Object construct) Reports a rule violation for a construct.
void	taskCompleted() Reports that this task has completed or cancelled.

Method Detail

taskCompleted

void taskCompleted()

Reports that this task has completed or cancelled.

isCancelled

boolean isCancelled()

Gets whether the invoking audit has been cancelled.

getModel

<T extends ModelAdapter> ModelAdapter getModel(java.lang.Class<T> type,
                                               java.net.URL url,
                                               Project project,
                                               Workspace workspace)

Gets the adapter for the model corresponding to a workspace, project, and url. This method provides the argument required to specify the location of a violation.

report

IssueReport report(Rule rule,
                   ModelAdapter model,
                   java.lang.Object construct)

Reports a rule violation for a construct. report returns a IssueReport which allows parameters and other attributes to be added to the violation. See getModel(Class,URL,Project,Workspace), and Location.getModel() to obtain a model.

See the class overview for more information.

Parameters:

rule - The rule violated.

model - The model containing the violating construct.

construct - The violating construct.

report

IssueReport report(Rule rule,
                   Location location)

Reports a rule violation for a construct. report returns a IssueReport which allows parameters and other attributes to be added to the violation. See the class overview for more information.

Parameters:

rule - The rule violated.

location - The Location of the violating construct.

getModelAdapter

<T extends ModelAdapter> ModelAdapter getModelAdapter(java.lang.Class<T> type,
                                                      java.net.URL url,
                                                      Project project,
                                                      Workspace workspace)

Deprecated. Use getModel(Class, URL, Project, Workspace)

Gets the adapter for the model corresponding to a workspace, project, and url. This method provides the argument required to specify the location of a violation.