01: /**********************************************************************************
02: * $URL: $
03: * $Id: $
04: ***********************************************************************************
05: *
06: * Copyright (c) 2006, 2007 The Sakai Foundation.
07: *
08: * Licensed under the Educational Community License, Version 1.0 (the "License");
09: * you may not use this file except in compliance with the License.
10: * You may obtain a copy of the License at
11: *
12: * http://www.opensource.org/licenses/ecl1.php
13: *
14: * Unless required by applicable law or agreed to in writing, software
15: * distributed under the License is distributed on an "AS IS" BASIS,
16: * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
17: * See the License for the specific language governing permissions and
18: * limitations under the License.
19: *
20: **********************************************************************************/package org.sakaiproject.content.api;
21:
22: import org.sakaiproject.entity.api.Reference;
23:
24: /**
25: *
26: *
27: */
28: public interface ServiceLevelAction extends ResourceToolAction {
29: /**
30: * This method is invoked before the Resources tool does its part of the action
31: * in case the registrant needs to participate in the action at that point.
32: * @param reference A reference to the entity with respect to which the action is taken
33: */
34: public void initializeAction(Reference reference);
35:
36: /**
37: * This method is invoked after the Resources tool does its part of the action
38: * in case the registrant needs to participate in the action at that point. Will
39: * not be invoked after cancelAction(Reference reference) is invoked.
40: * @param entity A reference to the entity with respect to which the action is taken
41: */
42: public void finalizeAction(Reference reference);
43:
44: /**
45: * This method is invoked if the Resources tool cancels the action after invoking
46: * the initializeAction(Reference reference) method in case the registrant needs to
47: * clean up a canceled action at that point. Will not be invoked after
48: * finalizeAction(Reference reference) is invoked.
49: * @param entity A reference to the entity with respect to which the action is taken
50: */
51: public void cancelAction(Reference reference);
52:
53: // ignored for now
54: // will deal with actions on multiple items (like copy, move, delete)
55: public boolean isMultipleItemAction();
56:
57: }
|