01: package net.javacoding.jspider.api.model;
02:
03: /**
04: * Interface to be implemented upon classes that will represent a
05: * DesisionStep, a step in the process of the decision taking on a
06: * resource URL whether it should be spidered and/or parsed.
07: *
08: * $Id: DecisionStep.java,v 1.2 2003/04/04 20:06:02 vanrogu Exp $
09: *
10: * @author Günther Van Roey.
11: */
12: public interface DecisionStep {
13:
14: /**
15: * Determines whether it is a GENERAL rule or SITE local rule.
16: * @return the type of the rule that took the decision
17: */
18: public int getRuleType();
19:
20: /**
21: * Returns the name of the rule that took this decision step
22: * @return the name of the rule that took this decision step
23: */
24: public String getRule();
25:
26: /**
27: * The decision that was taken by the rule (DONTCARE, ACCEPT, IGNORE, FORBIDDEN)
28: * @return the decision taken by the rule
29: */
30: public int getDecision();
31:
32: /**
33: * Returns any comment or explanation given by the rule about it's explanation
34: * @return comment on the decisionstep
35: */
36: public String getComment();
37:
38: }
|