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 allowing mapping of user attributes between the portal implementation
23   * and the portlet attribute definition according to the Portlet specs (PLT.17.2 Accessing
24   * User Attributes).  This is a Jetspeed 2 specific extension that allows to map a user-attribute
25   * name used in the portlet to a user attribute name-link used in the portal implementation.</p>
26   * 
27   * @author <a href="mailto:dlestrat@apache.org">David Le Strat</a>
28   *
29   */
30  public interface UserAttributeRef extends Serializable
31  {
32      /*** Getter for the user-attribute-ref name. */
33      String getName();
34      
35      /*** Setter for the user-attribute-ref name. */
36      void setName(String name);
37      
38      /*** Getter for the user-attribute-ref name-link. */
39      String getNameLink();
40      
41      /*** Setter for the user-attribute-ref name-link. */
42      void setNameLink(String nameLink);
43      
44      /*** Getter for the user-attribute description. */
45      String getDescription();
46      
47      /*** Setter for the user-attribute description. */
48      void setDescription(String description);
49  
50  }