View Javadoc

1   /* 
2    * Licensed to the Apache Software Foundation (ASF) under one or more
3    * contributor license agreements.  See the NOTICE file distributed with
4    * this work for additional information regarding copyright ownership.
5    * The ASF licenses this file to You under the Apache License, Version 2.0
6    * (the "License"); you may not use this file except in compliance with
7    * the License.  You may obtain a copy of the License at
8    *
9    *     http://www.apache.org/licenses/LICENSE-2.0
10   *
11   * Unless required by applicable law or agreed to in writing, software
12   * distributed under the License is distributed on an "AS IS" BASIS,
13   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14   * See the License for the specific language governing permissions and
15   * limitations under the License.
16   */
17  package org.apache.jetspeed.om.common;
18  
19  import java.io.Serializable;
20  
21  /***
22   * <p>Interface representing user attribute as defined in Portlet specs: 
23   * PLT.17.2 Accessing User Attributes.</p>
24   * @author <a href="mailto:dlestrat@apache.org">David Le Strat</a>
25   *
26   */
27  public interface UserAttribute extends Serializable
28  {
29      /*** Getter for the user-attribute name. */
30      String getName();
31      
32      /*** Setter for the user-attribute name. */
33      void setName(String name);
34      
35      /*** Getter for the user-attribute description. */
36      String getDescription();
37      
38      /*** Setter for the user-attribute description. */
39      void setDescription(String description);
40  
41  }