01: /**********************************************************************************
02: * $URL: https://source.sakaiproject.org/svn/content/tags/sakai_2-4-1/content-api/api/src/java/org/sakaiproject/content/api/ContentTypeImageService.java $
03: * $Id: ContentTypeImageService.java 7256 2006-03-30 04:32:55Z ggolden@umich.edu $
04: ***********************************************************************************
05: *
06: * Copyright (c) 2003, 2004, 2005, 2006 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 java.util.List;
23:
24: /**
25: * <p>ContentTypeImageService is the Interface for looking up proper image based on the content type. It also
26: * associates a display name and a set of file extensions to known types.</p>
27: * @author University of Michigan, CHEF Software Development Team
28: * @version $Revision: 7256 $
29: */
30: public interface ContentTypeImageService {
31: /** This string can be used to find the service in the service manager. */
32: public static final String SERVICE_NAME = ContentTypeImageService.class
33: .getName();
34:
35: /**
36: * Get the image file name based on the content type.
37: * @param contentType The content type string.
38: * @return The image file name based on the content type.
39: */
40: public String getContentTypeImage(String contentType);
41:
42: /**
43: * Get the display name of the content type.
44: * @param contentType The content type string.
45: * @return The display name of the content type.
46: */
47: public String getContentTypeDisplayName(String contentType);
48:
49: /**
50: * Get the file extension value of the content type.
51: * @param contentType The content type string.
52: * @return The file extension value of the content type.
53: */
54: public String getContentTypeExtension(String contentType);
55:
56: /**
57: * Get the content type string that is used for this file extension.
58: * @param extension The file extension (to the right of the dot, not including the dot).
59: * @return The content type string that is used for this file extension.
60: */
61: public String getContentType(String extension);
62:
63: /**
64: * Is the type one of the known types used when the file type is unknown?
65: * @param contentType The content type string to test.
66: * @return true if the type is a type used for unknown file types, false if not.
67: */
68: public boolean isUnknownType(String contentType);
69:
70: /**
71: * Access an ordered list of all mimetype categories.
72: * @return The list of mimetype categories in alphabetic order.
73: */
74: public List getMimeCategories();
75:
76: /**
77: * Access an ordered list of all mimetype subtypes for a particular category.
78: * @param category The category.
79: * @return The list of mimetype subtypes in alphabetic order.
80: */
81: public List getMimeSubtypes(String category);
82:
83: } // ContentTypeImageService
|