Expire xref

This project has retired. For details please refer to its Attic page.
Expire xref

1   /*
2    * Copyright 2000-2001,2004 The Apache Software Foundation.
3    * 
4    * Licensed under the Apache License, Version 2.0 (the "License");
5    * you may not use this file except in compliance with the License.
6    * You may obtain a copy of the License at
7    * 
8    *      http://www.apache.org/licenses/LICENSE-2.0
9    * 
10   * Unless required by applicable law or agreed to in writing, software
11   * distributed under the License is distributed on an "AS IS" BASIS,
12   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13   * See the License for the specific language governing permissions and
14   * limitations under the License.
15   */
16  
17  package org.apache.jetspeed.portal.expire;
18  
19  import org.apache.jetspeed.portal.*;
20  
21  import java.io.Serializable;
22  /***
23  Handles content expiration
24  
25  @author <a href="mailto:burton@apache.org">Kevin A. Burton</a>
26  @version $Id: Expire.java,v 1.5 2004/02/23 03:24:40 jford Exp $
27  */
28  public interface Expire extends Serializable{
29  
30      
31      /***
32      Initialize this Expiration mechanism
33  
34      @author <a href="mailto:burton@apache.org">Kevin A. Burton</a>
35      @version $Id: Expire.java,v 1.5 2004/02/23 03:24:40 jford Exp $
36      */
37      public void init();
38  
39      /***
40      Return true if this object has expired.  Provide your own implementation of
41      this if you want to determine dynamic expiration.
42  
43      @author <a href="mailto:burton@apache.org">Kevin A. Burton</a>
44      @version $Id: Expire.java,v 1.5 2004/02/23 03:24:40 jford Exp $
45      */
46      public boolean isExpired();
47  
48      /***
49      Set this as expired.
50  
51      @author <a href="mailto:burton@apache.org">Kevin A. Burton</a>
52      @version $Id: Expire.java,v 1.5 2004/02/23 03:24:40 jford Exp $
53      */
54      public void setExpired( boolean expired );
55  
56      /***
57      Get the time this Expire object was created
58  
59      @author <a href="mailto:burton@apache.org">Kevin A. Burton</a>
60      @version $Id: Expire.java,v 1.5 2004/02/23 03:24:40 jford Exp $
61      */
62      public long getCreationTime();
63    
64      /***
65      Set the time this Expire object was created
66      @author <a href="mailto:burton@apache.org">Kevin A. Burton</a>
67      @version $Id: Expire.java,v 1.5 2004/02/23 03:24:40 jford Exp $
68      */
69      public void setCreationTime( long creationTime );
70      
71      /***
72      Set a property
73      
74      @author <a href="mailto:burton@apache.org">Kevin A. Burton</a>
75      @version $Id: Expire.java,v 1.5 2004/02/23 03:24:40 jford Exp $
76      */
77      public void setProperty( String name, String value );
78  
79      /***
80      Get a property
81      
82      @author <a href="mailto:burton@apache.org">Kevin A. Burton</a>
83      @version $Id: Expire.java,v 1.5 2004/02/23 03:24:40 jford Exp $
84      */
85      public String getProperty( String name );
86  
87      /***
88      Get the Portlet on which this is based.
89      
90      @author <a href="mailto:burton@apache.org">Kevin A. Burton</a>
91      @version $Id: Expire.java,v 1.5 2004/02/23 03:24:40 jford Exp $
92      */
93      public Portlet getPortlet();
94      
95      /***
96      Set the Portlet on which this is based.
97      
98      @author <a href="mailto:burton@apache.org">Kevin A. Burton</a>
99      @version $Id: Expire.java,v 1.5 2004/02/23 03:24:40 jford Exp $
100     */
101     public void setPortlet( Portlet portlet );
102     
103 
104     
105 }
106