Realm


1   // ----------------------------------------------------------------------------
2   // Instance/IntfBegin
3   // ----------------------------------------------------------------------------
4   //////////////////////////////////////////////////////////////////////////////
5   //
6   // Name: $Id: JMIAbstractMapper.java,v 1.11 2006/01/21 23:09:07 wfro Exp $
7   // Generated by: openMDX JMI Mapper
8   // Date: Mon Apr 03 11:39:05 CEST 2006
9   //
10  // GENERATED - DO NOT CHANGE MANUALLY
11  //
12  //////////////////////////////////////////////////////////////////////////////
13  package org.openmdx.security.realm1.cci;
14  
15  public interface Realm
16    extends
17   org.openmdx.base.cci.BasicObject {
18  // ----------------------------------------------------------------------------
19  // Instance/IntfAttributeGet0_1
20  // ----------------------------------------------------------------------------
21    /**
22     * @return The possibly null value for attribute <code>description</code>.
23     * @exception JmiException If the value cannot be retrieved for some reason.
24     */
25    public String   getDescription(
26    );
27  
28  // ----------------------------------------------------------------------------
29  // Instance/IntfAttributeSet0_1
30  // ----------------------------------------------------------------------------
31  
32  
33    /**
34     * Sets a new value for the attribute <code>description</code>.
35     * @param newValue The possibly null new value for attribute <code>description</code>.
36     * @exception JmiException If the value cannot be set for some reason.
37     */
38    public void setDescription(
39      String   newValue
40    );
41  
42  // ----------------------------------------------------------------------------
43  // Instance/IntfAttributeGet1_1
44  // ----------------------------------------------------------------------------
45    /**
46     * Retrieves the value for the attribute <code>name</code>.
47     * @return The non-null value for attribute <code>name</code>.
48     * @exception JmiException If the value cannot be retrieved for some reason.
49     */
50    public String   getName(
51    );
52  
53  // ----------------------------------------------------------------------------
54  // Instance/IntfReferenceGet0_1WithQualifier
55  // ----------------------------------------------------------------------------
56    /**
57     * Retrieves the value for the reference <code>principal</code> for the 
58     * specified qualifier attribute value. 
59     * @param name The value for the qualifier attribute that qualifies this reference.
60     * @return The possibly null value for this reference.
61     * @exception JmiException If the value cannot be retrieved for some reason.
62     */
63    public org.openmdx.security.realm1.cci.Principal getPrincipal(
64      String   name
65    );
66  
67  // ----------------------------------------------------------------------------
68  // Instance/IntfReferenceGet0_nWithFilter
69  // ----------------------------------------------------------------------------
70    /**
71     * Retrieves a collection containing all the elements for the reference 
72     * <code>principal</code>. 
73     * @return A collection containing all the elements for this reference.
74     * @exception JmiException If the values cannot be retrieved for some reason.
75     */
76    public java.util.Collection   getPrincipal(
77    );
78  
79    /**
80     * Retrieves the value for the reference <code>principal</code> for the 
81     * specified filter. 
82     * @param filter filter which is applied to the set of referenced objects.
83     * @return The filtered collection of referenced objects.
84     * @exception JmiException If the value cannot be retrieved for some reason.
85     */
86    public java.util.List   getPrincipal(
87      org.openmdx.security.realm1.cci.PrincipalFilter filter
88    );
89  
90  // ----------------------------------------------------------------------------
91  // Instance/IntfReferenceAddWithQualifier
92  // ----------------------------------------------------------------------------
93    /**
94     * @param name The qualifier attribute value that qualifies the reference to get the element to be appended.
95     * @param newValue The element to be appended.
96     * @exception JmiException If the value cannot be appended for some reason.
97     */
98    public void addPrincipal (
99      String   name,
100     org.openmdx.security.realm1.cci.Principal newValue
101   );
102 
103 // ----------------------------------------------------------------------------
104 // Instance/IntfReferenceAddWithoutQualifier
105 // ----------------------------------------------------------------------------
106   /**
107    * @param newValue The element to be appended.
108    * @exception JmiException If the value cannot be appended for some reason.
109    */
110   public void addPrincipal (
111     org.openmdx.security.realm1.cci.Principal newValue
112   );
113 
114 // ----------------------------------------------------------------------------
115 // Instance/IntfReferenceRemoveWithQualifier
116 // ----------------------------------------------------------------------------
117   /**
118    * @exception JmiException If the value cannot be removed for some reason.
119    */
120   public void removePrincipal (
121     String   name
122   );
123 // ----------------------------------------------------------------------------
124 // Instance/IntfEnd.vm
125 // ----------------------------------------------------------------------------
126 }
127
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags