entityownership/mdsal-eos-common-api/src/main/java/org/opendaylight/mdsal/eos/common/api/GenericEntityOwnershipCandidateRegistration.java

   1 /*
   2  * Copyright (c) 2015 Brocade Communications Systems, Inc. and others.  All rights reserved.
   3  *
   4  * This program and the accompanying materials are made available under the
   5  * terms of the Eclipse Public License v1.0 which accompanies this distribution,
   6  * and is available at http://www.eclipse.org/legal/epl-v10.html
   7  */
   8 package org.opendaylight.mdsal.eos.common.api;
   9
  10 import org.opendaylight.yangtools.concepts.ObjectRegistration;
  11 import org.opendaylight.yangtools.concepts.Path;
  12
  13 /**
  14  * An interface that records a request to register a Candidate for a given Entity. Calling close on the
  15  * registration will remove the Candidate from any future ownership considerations for that Entity.
  16  *
  17  * @author Thomas Pantelis
  18  *
  19  * @param <P> the instance identifier type
  20  * @param <E> the GenericEntity type
  21  */
  22 public interface GenericEntityOwnershipCandidateRegistration<P extends Path<P>, E extends GenericEntity<P>>
  23         extends ObjectRegistration<E> {
  24
  25    /**
  26     * Unregister the candidate
  27     */
  28    @Override
  29    void close();
  30 }