View Javadoc
1   /*
2    * Copyright 2007 The Kuali Foundation
3    * 
4    * Licensed under the Educational Community License, Version 2.0 (the "License");
5    * you may not use this file except in compliance with the License.
6    * You may obtain a copy of the License at
7    * 
8    * http://www.opensource.org/licenses/ecl2.php
9    * 
10   * Unless required by applicable law or agreed to in writing, software
11   * distributed under the License is distributed on an "AS IS" BASIS,
12   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13   * See the License for the specific language governing permissions and
14   * limitations under the License.
15   */
16  package org.kuali.ole.vnd.businessobject;
17  
18  /**
19   * Defines methods that must be implemented by classes providing a VendorRoutingComparable.
20   */
21  public interface VendorRoutingComparable {
22  
23      /**
24       * A predicate to test equality of all the persisted attributes of an instance of this class, not including
25       * member collections. This is used to help determine whether to route.
26       * 
27       * @param toCompare An Object, which should be of this class if the comparison is to be meaningful.
28       * @return True if all non-derived attributes of the given object other than collections are equal to this one's. False if the
29       *         given object is null or of a different class.
30       */
31      public boolean isEqualForRouting(Object toCompare);
32  
33  }