/**
* $Id: Inputable.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/capabilities/Inputable.java $
* Inputable.java - entity-broker - Apr 12, 2008 1:36:32 PM - azeckoski
**************************************************************************
* Copyright (c) 2008 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.capabilities;
import org.sakaiproject.entitybroker.access.EntityViewAccessProvider;
import org.sakaiproject.entitybroker.entityprovider.EntityProvider;
import org.sakaiproject.entitybroker.entityprovider.extension.Formats;
/**
* These entities can be entered as certain input formats which are handled automatically
* and translated into entity objects (of the type defined by {@link Sampleable})<br/>
* If you want to define the way the input is translated instead of using the internal methods
* then use {@link InputTranslatable}<br/>
* <br/>
* <b>NOTE:</b> By default all entity view requests go through to the available access providers:
* {@link EntityViewAccessProvider} or {@link HttpServletAccessProvider}
*
* @author Aaron Zeckoski (aaron@caret.cam.ac.uk)
*/
public interface Inputable extends EntityProvider, Formats, Sampleable {
/**
* Defines the input format types (extensions) handled by this provider<br/>
* <b>NOTE:</b> In the case of an entity view the extension
* which goes on the end of an entity URL (after a ".") indicates the input type<br/>
* <b>WARNING:</b> not including {@link #HTML} in the return will stop all redirects to the access providers
* and therefore will cause HTML requests for entities to go nowhere
*
* @return an array containing the extension formats (from {@link Formats}) handled,
* use the constants (example: {@link #XML}) or feel free to make up your own if you like
*/
public String[] getHandledInputFormats();
}