01: /**********************************************************************************
02: * $URL: https://source.sakaiproject.org/svn/alias/tags/sakai_2-4-1/alias-api/api/src/java/org/sakaiproject/alias/api/Alias.java $
03: * $Id: Alias.java 7289 2006-03-30 21:24:09Z 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.alias.api;
21:
22: import org.sakaiproject.entity.api.Entity;
23: import org.sakaiproject.time.api.Time;
24: import org.sakaiproject.user.api.User;
25:
26: /**
27: * <p>
28: * Alias ...
29: * </p>
30: */
31: public interface Alias extends Entity, Comparable {
32: /**
33: * @return the user who created this.
34: */
35: User getCreatedBy();
36:
37: /**
38: * @return the user who last modified this.
39: */
40: User getModifiedBy();
41:
42: /**
43: * @return the time created.
44: */
45: Time getCreatedTime();
46:
47: /**
48: * @return the time last modified.
49: */
50: Time getModifiedTime();
51:
52: // TODO:
53:
54: /**
55: * Access the alias target.
56: *
57: * @return The alias target.
58: */
59: String getTarget();
60:
61: /**
62: * @return a description of the item this alias's target applies to.
63: */
64: String getDescription();
65: }
|