01: // THIS SOFTWARE IS PROVIDED BY SOFTARIS PTY.LTD. AND OTHER METABOSS
02: // CONTRIBUTORS ``AS IS'' AND ANY EXPRESSED OR IMPLIED WARRANTIES, INCLUDING,
03: // BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
04: // FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SOFTARIS PTY.LTD.
05: // OR OTHER METABOSS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
06: // INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
07: // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA,
08: // OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
09: // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
10: // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
11: // EVEN IF SOFTARIS PTY.LTD. OR OTHER METABOSS CONTRIBUTORS ARE ADVISED OF THE
12: // POSSIBILITY OF SUCH DAMAGE.
13: //
14: // Copyright 2000-2005 © Softaris Pty.Ltd. All Rights Reserved.
15: package com.metaboss.sdlctools.domains.enterprisemodel;
16:
17: import com.metaboss.enterprise.bo.BOException;
18: import com.oldboss.framework.bo.BOObject;
19:
20: public interface BOReportEntity extends BOObject {
21: /** Retrieves report this report entity belongs to. Together with name
22: * forms primary key for this object */
23: public BOReport getReport() throws BOException;
24:
25: /** Retrieves the level at which this report entity is positioned in the report */
26: public int getReportLevel() throws BOException;
27:
28: /** Retrieves singular role name - used to name singular reference member variables and access methods.
29: * this name is always present */
30: public String getName() throws BOException;
31:
32: /** Retrieves plural role name - used to name collection member variables and access methods.
33: * May not be present if Name is good enough or association role is singular */
34: public String getPluralName() throws BOException;
35:
36: /** Retrieves entity for which this role is described */
37: public BOEntity getEntity() throws BOException;
38:
39: /** Retrieves description */
40: public String getDescription() throws BOException;
41:
42: /* Retrieves the cardinality of the report entity */
43: public com.metaboss.sdlctools.types.enterprisemodel.ReportEntityCardinality getCardinality()
44: throws BOException;
45:
46: /** Retireves attributes delivered inside this entity. Note that the generated
47: * code normally allows to fetch any atrribute and association from the entity, however
48: * performance may suffer if business service will use attributes not declared here
49: * Also note that the instance id and version id of the entity is always included */
50: public BOReportEntityAttributeList getRetrievedAttributes()
51: throws BOException;
52: }
|