View Javadoc

1   package org.ocltf.model;
2   
3   /***
4    * Specifies a "facade" for an underlying association end. 
5    *
6    * @author Chad Brandon
7    */
8   public interface AssociationEndFacade extends ElementFacade {
9   
10  	/***
11  	 * Returns true if the association end is on association and its aggregation
12  	 * is composition
13  	 * 
14  	 * @return boolean true if its composition, false otherwise
15  	 */
16  	public boolean isAggregationComposition();
17  
18  	/***
19  	 * Returns true if the association end is an association and its aggregation
20  	 * is aggregate
21  	 * 
22  	 * @return boolean true if its composition, false otherwise
23  	 */
24  	public boolean isAggregationAggregate();
25  
26  	/***
27  	 * Returns true if the association end is an association and is ordered.
28  	 * 
29  	 * @return boolean true if the association end is ordered, false otherwise
30  	 */
31  	public boolean isOrdered();
32  
33  	/***
34  	 * Returns true if the association end is navigable.
35  	 * 
36  	 * @return boolean true if the association end is navigable, false otherwise
37  	 */
38  	public boolean isNavigable();
39  	
40  	/***
41  	 * Returns true if the associationEnd is required (i.e the
42  	 * lower limit of multiplicity range isn't 0).
43  	 * 
44  	 * @return boolean 
45  	 */
46  	public boolean isRequired();
47  	
48  	/***
49  	 * Returns true if the associationEnd's multiplicity
50  	 * is many.
51  	 * 
52  	 * @return boolean 
53  	 */
54  	public boolean isMany();
55  	
56  	/***
57  	 * Returns true if the associationEnd is the single side of a
58  	 * one-to-many association
59  	 * 
60  	 * @return boolean 
61  	 */
62  	public boolean isOneToMany();
63      
64  	/***
65  	 * Returns true if the associationEnd is the many side in a
66  	 * many-to-many association
67  
68  	 * @return boolean 
69  	 */
70  	public boolean isManyToMany();
71  
72  	/***
73  	 * Returns true if the associationEnd is a single side in a
74  	 * one-to-one association
75  	 * 
76  	 * @return boolean
77  	 */
78  	public boolean isOneToOne();
79      
80  	/***
81  	 * Returns true if the associationEnd is the many side in a
82  	 * many-to-one association
83  	 * 
84  	 * @return boolean
85  	 */
86  	public boolean isManyToOne();
87  	
88  	/***
89  	 * Gets the association that is the owner of the specified AssociationEnd
90  	 * 
91  	 * @return AssociationFacade
92  	 */
93  	public AssociationFacade getOwner();
94  
95  	/***
96  	 * Retrives the other end of an AssociationEnd.
97  	 * 
98  	 * @return AssociationEndFacade
99  	 */
100 	public AssociationEndFacade getConnectingEnd();
101 
102 }