001/**
002 * Copyright 2005-2016 The Kuali Foundation
003 *
004 * Licensed under the Educational Community License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 * http://www.opensource.org/licenses/ecl2.php
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 */
016package org.kuali.rice.kns.workflow.attribute;
017
018import org.kuali.rice.krad.bo.BusinessObject;
019
020/**
021 * This interface is used to get the cglib Enhancer to simulate the returnUrl bean property required by workflow on the
022 * BusinessObject proxies returned by the getSearchResults(Map fieldValues, Map fieldConversions) method of WorkflowLookupableImpl.
023 * It also extends Map and simulates a bean property of itself on the proxy, because we want a generic getter that returns objects
024 * and will allow us to format booleans.
025 * 
026 * 
027 * @see org.kuali.rice.kew.attribute.WorkflowLookupableImpl
028 * @see WorkflowLookupableInvocationHandler
029 * @deprecated This will go away once workflow supports simple url integration for custom attribute lookups.
030 */
031public interface WorkflowLookupableResult extends BusinessObject {
032    /**
033     * Gets the returnUrl attribute.
034     * 
035     * @return Returns the returnUrl.
036     */
037    public String getReturnUrl();
038
039    /**
040     * Sets the returnUrl attribute.
041     * 
042     * @param returnUrl The returnUrl to set.
043     */
044    public void setReturnUrl(String returnUrl);
045
046    /**
047     * Gets the workflowLookupableResult attribute.
048     * 
049     * @return Returns the workflowLookupableResult
050     */
051    public WorkflowLookupableResult getWorkflowLookupableResult();
052
053    /**
054     * Sets the workflowLookupableResult attribute.
055     * 
056     * @param workflowLookupableResult The workflowLookupableResult to set.
057     */
058    public void setWorkflowLookupableResult(WorkflowLookupableResult workflowLookupableResult);
059}