gomperson.java

lucene2.2.0版本

/**
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.apache.lucene.gdata.gom;


/**
 * 
 * GOMPerson type used for feed and entry authors and contributors. It may also
 * be used by custom elements.
 * 
 * <pre>
 *  
 *   atomPersonConstruct =
 *   atomCommonAttributes,
 *   (element atom:name { text }
 *   &amp; element atom:uri { atomUri }?
 *   &amp; element atom:email { atomEmailAddress }?
 *   &amp; extensionElement*)
 *   }
 * </pre>
 * 
 * @author Simon Willnauer
 * @see org.apache.lucene.gdata.gom.GOMAuthor
 */
public interface GOMPerson extends GOMElement {
	/**
	 *  Atom local name for the xml element
	 */
	public static final String LOCALNAME = "person";

	/**
	 * @param aName - the person name value
	 */
	public abstract void setName(String aName);

	/**
	 * @param aEmail - the person email value
	 */
	public abstract void setEmail(String aEmail);

	/**
	 * @param uri - the person uri value
	 */
	public abstract void setUri(String uri);

	/**
	 * @return - the person name value
	 */
	public abstract String getName();

	/**
	 * @return - the person email value
	 */
	public abstract String getEmail();

	/**
	 * @return - the person uri value
	 */
	public abstract String getUri();
	// TODO needs extension possibility
}