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.krad.workflow.service;
017
018import org.kuali.rice.kew.api.document.attribute.DocumentAttribute;
019import org.kuali.rice.kew.docsearch.SearchableAttributeValue;
020import org.kuali.rice.krad.bo.BusinessObject;
021import org.kuali.rice.krad.datadictionary.RoutingTypeDefinition;
022import org.kuali.rice.krad.datadictionary.WorkflowAttributes;
023import org.kuali.rice.krad.document.Document;
024
025import java.util.List;
026import java.util.Map;
027
028/**
029 * A service which will resolve workflow attributes into the proper data for routing qualifier resolution 
030 */
031public interface WorkflowAttributePropertyResolutionService {
032
033    /** 
034     * Generates a List of Map<String, String> data from the data on the document for the given WorkflowAttributeDefinitions
035     * @param document the document to gather data from
036     * @param routingTypeDefinition 
037     * @return a List of populated Map<String, String> data
038     */
039    public abstract List<Map<String, String>> resolveRoutingTypeQualifiers(Document document, RoutingTypeDefinition routingTypeDefinition);
040    
041    /**
042     * Given a document, returns the searchable attribute values to index for it
043     * @param document the document to find indexable searchable attribute values for
044     * @param workflowAttributes the WorkflowAttributes data dictionary metadata which contains the searchable attributes to index 
045     * @return a List of SearchableAttributeValue objects for index
046     */
047    public abstract List<DocumentAttribute> resolveSearchableAttributeValues(Document document, WorkflowAttributes workflowAttributes);
048    
049    /**
050     * Retrieves an object, the child of another given object passed in as a parameter, by the given path
051     * @param object an object to find a child object of
052     * @param path the path to that child object
053     * @return the child object
054     */
055    public abstract Object getPropertyByPath(Object object, String path);
056    
057    /**
058     * Determines the type of the field which is related to the given attribute name on instances of the given business object class
059     * @param businessObjectClass the class of the business object which has an attribute
060     * @param attributeName the name of the attribute
061     * @return the String constrant representing what Field#fieldDataType this represents
062     */
063    public abstract String determineFieldDataType(Class<? extends BusinessObject> businessObjectClass, String attributeName);
064    
065    /**
066     * Using the type of the sent in value, determines what kind of SearchableAttributeValue implementation should be passed back 
067     * @param attributeKey
068     * @param value
069     * @return
070     */
071    public DocumentAttribute buildSearchableAttribute(Class<? extends BusinessObject> businessObjectClass, String attributeKey, Object value);
072    
073}