01: /**********************************************************************************
02: * $URL: https://source.sakaiproject.org/svn/entity/tags/sakai_2-4-1/entity-api/api/src/java/org/sakaiproject/entity/api/EntitySummary.java $
03: * $Id: EntitySummary.java 22615 2007-03-14 19:53:58Z chmaurer@iupui.edu $
04: ***********************************************************************************
05: *
06: * Copyright (c) 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: **********************************************************************************/
21:
22: /**
23: *
24: */package org.sakaiproject.entity.api;
25:
26: import java.util.Map;
27:
28: import org.sakaiproject.exception.IdInvalidException;
29: import org.sakaiproject.exception.IdUsedException;
30: import org.sakaiproject.exception.PermissionException;
31:
32: /**
33: * <p>
34: * Services which implement EntitySummary declare themselves as willing and able to supply summary information for synoptics.
35: * </p>
36: */
37: public interface EntitySummary {
38:
39: Map getSummary(String summarizableReference, int items, int days)
40: throws IdUsedException, IdInvalidException,
41: PermissionException;
42:
43: /**
44: * Provide the string array of tool ids, for tools that we claim as manipulating our entities.
45: *
46: * @return
47: */
48: String[] summarizableToolIds();
49:
50: String getSummarizableReference(String siteId);
51: }
|