Overview - Common API - Client API - Admin API - Runtime API
RelationshipDeclaration
Class representing a relationship between model elements
Details
Extends Property
Module common
See also
- See Property
Method Summary
| Name | Returns | Description |
|---|---|---|
| constructor | void |
Create a Relationship |
| toString | String |
Returns a string representation of this property |
Inherited Method Summary
| Supertype | Name | Returns | Description |
|---|---|---|---|
| Property | getParent | ClassDeclaration |
Returns the owner of this property |
| Property | getName | string |
Returns the name of a property |
| Property | getType | string |
Returns the type of a property |
| Property | isOptional | boolean |
Returns true if the field is optional |
| Property | getFullyQualifiedTypeName | string |
Returns the fully qualified type name of a property |
| Property | getFullyQualifiedName | string |
Returns the fully name of a property (ns + class name + property name) |
| Property | getNamespace | string |
Returns the namespace of the parent of this property |
| Property | isArray | boolean |
Returns true if the field is declared as an array type |
| Property | isTypeEnum | boolean |
Returns true if the field is declared as an enumerated value |
| Property | isPrimitive | boolean |
Returns true if this property is a primitive type |
Method Details
new RelationshipDeclaration()
Create a Relationship.
Parameters
| Name | Type | Mandatory | Description |
|---|---|---|---|
| parent | ClassDeclaration | Yes | The owner of this property |
| ast | Object | Yes | The AST created by the parser |
toString
String toString( )
Returns a string representation of this property
Returns
String - the string version of the property.
Parameters
No parameters
Inherited methods
getParent
ClassDeclaration getParent( )
Inherited from: Property
Returns the owner of this property
Returns
ClassDeclaration - the parent class declaration
Parameters
No parameters
getName
string getName( )
Inherited from: Property
Returns the name of a property
Returns
string - the name of this field
Parameters
No parameters
getType
string getType( )
Inherited from: Property
Returns the type of a property
Returns
string - the type of this field
Parameters
No parameters
isOptional
boolean isOptional( )
Inherited from: Property
Returns true if the field is optional
Returns
boolean - true if the field is optional
Parameters
No parameters
getFullyQualifiedTypeName
string getFullyQualifiedTypeName( )
Inherited from: Property
Returns the fully qualified type name of a property
Returns
string - the fully qualified type of this property
Parameters
No parameters
getFullyQualifiedName
string getFullyQualifiedName( )
Inherited from: Property
Returns the fully name of a property (ns + class name + property name)
Returns
string - the fully qualified name of this property
Parameters
No parameters
getNamespace
string getNamespace( )
Inherited from: Property
Returns the namespace of the parent of this property
Returns
string - the namespace of the parent of this property
Parameters
No parameters
isArray
boolean isArray( )
Inherited from: Property
Returns true if the field is declared as an array type
Returns
boolean - true if the property is an array type
Parameters
No parameters
isTypeEnum
boolean isTypeEnum( )
Inherited from: Property
Returns true if the field is declared as an enumerated value
Returns
boolean - true if the property is an enumerated value
Parameters
No parameters
isPrimitive
boolean isPrimitive( )
Inherited from: Property
Returns true if this property is a primitive type.
Returns
boolean - true if the property is a primitive type.
Parameters
No parameters