Uses of Class
org.sakaiproject.entitybroker.EntityView

Packages that use EntityView

org.sakaiproject.entitybroker
org.sakaiproject.entitybroker.access
org.sakaiproject.entitybroker.entityprovider.capabilities
org.sakaiproject.entitybroker.providers

Uses of EntityView in org.sakaiproject.entitybroker

Methods in org.sakaiproject.entitybroker that return EntityView

EntityView	EntityView.copy()
static EntityView	EntityView.copy(EntityView ev) Makes a copy of an EntityView which can be changed independently
EntityView	EntityBroker.getEntityView(String reference, String viewKey, String extension) Get the EntityView object which represents a specific view of an entity or entity collection, this is similar to EntityBroker.getEntityURL(String, String, String) but allows the developer to deal with the EntityView object if desired
EntityView	EntityBrokerManager.makeEntityView(EntityReference ref, String viewKey, String extension) Reduce code duplication and ensure custom templates are used
EntityView	EntityBrokerManager.parseEntityURL(String entityURL) Parses an entity URL into an entity view object, handles custom parsing templates
EntityView	EntityView.setEntityReference(EntityReference ref) Allows for easy chained construction of EntityViews by setting an EntityReference, does not set the viewkey or extension unless they are unset, maintains current extension

Methods in org.sakaiproject.entitybroker with parameters of type EntityView

static EntityView

EntityView.copy(EntityView ev) Makes a copy of an EntityView which can be changed independently

Uses of EntityView in org.sakaiproject.entitybroker.access

Methods in org.sakaiproject.entitybroker.access with parameters of type EntityView

void

EntityViewAccessProvider.handleAccess(EntityView view, javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res) Make and return the data responses for this type of data provider for a specific entity view and entity reference (contained within the entity view), use the request to get any additional sent in information you may need or want and use the response to hold the output you generate NOTE: If you decide that you cannot handle this access request for any reason you can either throw an EntityException to specify why OR throw a general Exception, both will kill the request entirely but the general exception will pass through the system while the EntityException will produce a handled result

Uses of EntityView in org.sakaiproject.entitybroker.entityprovider.capabilities

Methods in org.sakaiproject.entitybroker.entityprovider.capabilities with parameters of type EntityView

void	RequestInterceptor.after(EntityView view, javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res) Take actions after the request is handled for an entity view, this will be called just before each response is sent back to the requester, normally this would be used to add something to the response as it is getting ready to be sent back to the requester
void	RequestInterceptor.before(EntityView view, javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res) Take actions before the request is handled for an entity view, this will be called just before each request is sent to the correct request handler, this might be used to add information to the response before it goes on to be handled or to take some action as a result of information in the request or reference, if you want to interrupt the handling of this request (stop it) then throw an EntityException and include the type of response you would like to return in the exception (this can be a success or failure response status)
Object	ActionsExecutionControllable.executeActions(EntityView entityView, String action, Map<String,Object> actionParams, OutputStream outputStream) This allows the developer to define how to execute custom actions on entities, this method will be called every time a custom action execution is requested, the incoming data provides the context for the action to be executed NOTE: The return data can be complex so please read carefully, entity data is returned as the default for the request if no format is specified

Uses of EntityView in org.sakaiproject.entitybroker.providers

Methods in org.sakaiproject.entitybroker.providers with parameters of type EntityView

ActionReturn

EntityRESTProvider.handleCustomActionExecution(ActionsExecutable actionProvider, EntityReference ref, String action, Map<String,Object> actionParams, OutputStream outputStream, EntityView view, Map<String,Object> searchParams) This will execute a custom action for an entity or space/collection of entities This is meant for specialized usage as custom actions are typically meant to be executed by REST calls only