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.util.Collection;
20  import java.util.Locale;
21  
22  /***
23   * GenericMetadata <br/>Interface that allows retrieving localized information
24   * 
25   * @author <a href="mailto:jford@apache.org">Jeremy Ford </a>
26   * @version $Id: GenericMetadata.java 516448 2007-03-09 16:25:47Z ate $
27   */
28  public interface GenericMetadata
29  {
30      /***
31       * 
32       * <p>
33       * addField
34       * </p>
35       *
36       * @param locale
37       * @param name
38       * @param value
39       */
40      public void addField( Locale locale, String name, String value );
41      
42      /***
43       * 
44       * <p>
45       * addField
46       * </p>
47       *
48       * @param field
49       */
50      public void addField( LocalizedField field );
51      
52      /***
53       * 
54       * <p>
55       * getFields
56       * </p>
57       *
58       * @param name
59       * @return
60       */
61      public Collection getFields( String name );
62      
63      /***
64       * 
65       * <p>
66       * setFields
67       * </p>
68       *
69       * @param name
70       * @param values
71       */
72      public void setFields( String name, Collection values );
73      
74      /***
75       * 
76       * <p>
77       * getFields
78       * </p>
79       *
80       * @return
81       */
82      public Collection getFields();
83      
84      /***
85       * 
86       * <p>
87       * setFields
88       * </p>
89       *
90       * @param fields
91       */
92      public void setFields( Collection fields );
93      
94      /***
95       * 
96       * <p>
97       * createLocalizedField
98       * </p>
99       *
100      * @return
101      */
102     LocalizedField createLocalizedField();
103 
104     /***
105      * 
106      * <p>
107      * copyFields
108      * </p>
109      *
110      * @param fields
111      */
112     public void copyFields( Collection fields );
113 }