1   /*
    2    * Copyright (c) 2000, 2005, Oracle and/or its affiliates. All rights reserved.
    3    * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
    4    *
    5    * This code is free software; you can redistribute it and/or modify it
    6    * under the terms of the GNU General Public License version 2 only, as
    7    * published by the Free Software Foundation.  Oracle designates this
    8    * particular file as subject to the "Classpath" exception as provided
    9    * by Oracle in the LICENSE file that accompanied this code.
   10    *
   11    * This code is distributed in the hope that it will be useful, but WITHOUT
   12    * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
   13    * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
   14    * version 2 for more details (a copy is included in the LICENSE file that
   15    * accompanied this code).
   16    *
   17    * You should have received a copy of the GNU General Public License version
   18    * 2 along with this work; if not, write to the Free Software Foundation,
   19    * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
   20    *
   21    * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
   22    * or visit www.oracle.com if you need additional information or have any
   23    * questions.
   24    */
   25   
   26   package javax.management.relation;
   27   
   28   import java.util.ArrayList; // for Javadoc
   29   import java.util.List;
   30   
   31   import java.io.Serializable;
   32   
   33   /**
   34    * The RelationType interface has to be implemented by any class expected to
   35    * represent a relation type.
   36    *
   37    * @since 1.5
   38    */
   39   public interface RelationType extends Serializable {
   40   
   41       //
   42       // Accessors
   43       //
   44   
   45       /**
   46        * Returns the relation type name.
   47        *
   48        * @return the relation type name.
   49        */
   50       public String getRelationTypeName();
   51   
   52       /**
   53        * Returns the list of role definitions (ArrayList of RoleInfo objects).
   54        *
   55        * @return an {@link ArrayList} of {@link RoleInfo}.
   56        */
   57       public List<RoleInfo> getRoleInfos();
   58   
   59       /**
   60        * Returns the role info (RoleInfo object) for the given role info name
   61        * (null if not found).
   62        *
   63        * @param roleInfoName  role info name
   64        *
   65        * @return RoleInfo object providing role definition
   66        * does not exist
   67        *
   68        * @exception IllegalArgumentException  if null parameter
   69        * @exception RoleInfoNotFoundException  if no role info with that name in
   70        * relation type.
   71        */
   72       public RoleInfo getRoleInfo(String roleInfoName)
   73           throws IllegalArgumentException,
   74                  RoleInfoNotFoundException;
   75   }