001/*
002 * Copyright 2007 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.ole.vnd.businessobject;
017
018/**
019 * Defines methods that must be implemented by classes providing a VendorRoutingComparable.
020 */
021public interface VendorRoutingComparable {
022
023    /**
024     * A predicate to test equality of all the persisted attributes of an instance of this class, not including
025     * member collections. This is used to help determine whether to route.
026     * 
027     * @param toCompare An Object, which should be of this class if the comparison is to be meaningful.
028     * @return True if all non-derived attributes of the given object other than collections are equal to this one's. False if the
029     *         given object is null or of a different class.
030     */
031    public boolean isEqualForRouting(Object toCompare);
032
033}