01: package com.sun.portal.rewriter.admin.model;
02:
03: import java.util.List;
04: import java.util.Map;
05: import com.iplanet.am.console.base.model.AMModel;
06:
07: /**
08: * The interface uses by the create rule view bean to create
09: * a new ruleset XML.
10: */
11: public interface RewriterModel extends AMModel {
12:
13: /**
14: * Gets the Ruleset XML from the XML template
15: * @return ruleset XML Template as String
16: */
17: public String getRulesetXMLTemplate();
18:
19: /**
20: * Saves the modified XML
21: * @param xml XML data to save
22: * @param isEdit value is set to true if the save operation is done after an
23: * edit operation
24: * @throws Exception when the XML data is not a valid Ruleset XML
25: */
26: public void saveRulesetXML(String xml, boolean isEdit)
27: throws Exception;
28:
29: /**
30: * Called by the CreateRuleViewbean to check if the current ruleset is
31: * overwriting an existing rule.
32: * @param xml New ruleset XML as String
33: * @throws Exception when the XML input is not valid RuleSet XML
34: * @return true if a ruleSet exists with the same ID as new ruleset that
35: * is created
36: */
37: public boolean isCreateOverwrite(String xml) throws Exception;
38:
39: /**
40: * This method is called by the EditRuleSet viewbean to check if another
41: * ruleset exists with the same ID as in the edited xml ruleset.
42: * @param ruleOrigName Original name of the ruleset that is being edited
43: * @param editedXML Modified XML as String
44: * @throws Exception when the input XML data is not a
45: * valid RuleSet XML
46: * @return true if another ruleset exists with the same ID
47: */
48: public boolean isEditOverwrite(String ruleOrigName, String editedXML)
49: throws Exception;
50:
51: /**
52: * Gets the Ruleset XML for a given ruleset ID
53: * @param ruleSetName Ruleset name as String
54: * @return RuleSet XML as String
55: */
56: public String getRulesetXML(String ruleSetName);
57:
58: /**
59: * Deletes the Rulesets
60: * @param rules a List of Ruleset IDs
61: * @throws Exception When the delete operation fails
62: */
63: public Map deleteRules(List rules);
64:
65: /**
66: * Gets the Rulesets available
67: * @return Ruleset names as a List
68: */
69: public List getRuleSetNames();
70:
71: /**
72: * Stores values in the session
73: * @param name Key of the value to be stored in the session
74: * @param values List of values to be stored
75: */
76: public void storeToSession(String name, List values);
77:
78: /**
79: * Gets values stored in the session
80: * @param name Key of the values to be retrived from the session
81: * @return a List of values from the session
82: */
83: public List getFromSession(String name);
84:
85: /**
86: * Gets URL for an online help document. Default URL to English online
87: * help if it is not found.
88: *
89: * @param docName - online help document file name
90: * @return URL for an online help document
91: */
92: public String getHelpUrl(String docName);
93: }
|