KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > openmdx > base > cci > Segment


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:07 CEST 2006
9
//
10
// GENERATED - DO NOT CHANGE MANUALLY
11
//
12
//////////////////////////////////////////////////////////////////////////////
13
package org.openmdx.base.cci;
14
15 public interface Segment
16   extends
17  org.openmdx.base.cci.ContextCapable,
18  org.openmdx.compatibility.view1.cci.ViewCapable {
19 // ----------------------------------------------------------------------------
20
// Instance/IntfAttributeGet0_1
21
// ----------------------------------------------------------------------------
22
/**
23    * @return The possibly null value for attribute <code>description</code>.
24    * @exception JmiException If the value cannot be retrieved for some reason.
25    */

26   public String JavaDoc getDescription(
27   );
28
29 // ----------------------------------------------------------------------------
30
// Instance/IntfAttributeSet0_1
31
// ----------------------------------------------------------------------------
32

33
34   /**
35    * Sets a new value for the attribute <code>description</code>.
36    * @param newValue The possibly null new value for attribute <code>description</code>.
37    * @exception JmiException If the value cannot be set for some reason.
38    */

39   public void setDescription(
40     String JavaDoc newValue
41   );
42
43 // ----------------------------------------------------------------------------
44
// Instance/IntfReferenceGet0_1WithQualifier
45
// ----------------------------------------------------------------------------
46
/**
47    * Retrieves the value for the reference <code>extent</code> for the
48    * specified qualifier attribute value.
49    * @param identity The value for the qualifier attribute that qualifies this reference.
50    * @return The possibly null value for this reference.
51    * @exception JmiException If the value cannot be retrieved for some reason.
52    */

53   public org.openmdx.base.cci.ExtentCapable getExtent(
54     String JavaDoc identity
55   );
56
57 // ----------------------------------------------------------------------------
58
// Instance/IntfReferenceGet0_nWithFilter
59
// ----------------------------------------------------------------------------
60
/**
61    * Retrieves a collection containing all the elements for the reference
62    * <code>extent</code>.
63    * @return A collection containing all the elements for this reference.
64    * @exception JmiException If the values cannot be retrieved for some reason.
65    */

66   public java.util.Collection JavaDoc getExtent(
67   );
68
69   /**
70    * Retrieves the value for the reference <code>extent</code> for the
71    * specified filter.
72    * @param filter filter which is applied to the set of referenced objects.
73    * @return The filtered collection of referenced objects.
74    * @exception JmiException If the value cannot be retrieved for some reason.
75    */

76   public java.util.List JavaDoc getExtent(
77     org.openmdx.base.cci.ExtentCapableFilter filter
78   );
79
80 // ----------------------------------------------------------------------------
81
// Instance/IntfReferenceGet1_1NoQualifier
82
// ----------------------------------------------------------------------------
83
/**
84    * Retrieves the value for the reference <code>provider</code>.
85    * @return The non-null value for this reference.
86    * @exception JmiException If the value cannot be retrieved for some reason.
87    */

88   public org.openmdx.base.cci.Provider getProvider(
89   );
90
91 // ----------------------------------------------------------------------------
92
// Instance/IntfEnd.vm
93
// ----------------------------------------------------------------------------
94
}
95
Popular Tags