/**
* $Id: EntitySummary.java 105077 2012-02-24 22:54:29Z ottenhoff@longsight.com $
* $URL: https://source.sakaiproject.org/svn/entitybroker/trunk/api/src/java/org/sakaiproject/entitybroker/entityprovider/annotations/EntitySummary.java $
* EntitySummary.java - entity-broker - Apr 13, 2008 12:17:49 PM - azeckoski
**************************************************************************
* Copyright (c) 2008, 2009 The Sakai Foundation
*
* Licensed under the Educational Community 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.opensource.org/licenses/ECL-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.sakaiproject.entitybroker.entityprovider.annotations;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
/**
* Marks a getter method or field as the summary or description text for an entity,
* Example: the summary for a blog entry or email, the instructions text for a test or survey
* the convention is to run toString on the return from the
* "getSummary" method or the value in the "summary" field<br/>
* <b>NOTE:</b> This annotation should only be used once in a class,
* the getter method must take no arguments and return an object
*
* @author Aaron Zeckoski (aaron@caret.cam.ac.uk)
*/
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.METHOD, ElementType.FIELD})
public @interface EntitySummary { }