com.ashridgetech.jamda.uml
Interface Property

All Superinterfaces:
TypedItem
All Known Implementing Classes:
Association.End.PropertyImpl, Attribute.PropertyImpl, PropertyBuilder.PropertyImpl, StructuredType.PropertyImpl

public interface Property
extends TypedItem

Interface for items which represent a property of a StructuredType. Includes Attribute and Association.End.

Version:
1.0
Author:
paulb

Method Summary
 StructuredType.Aggregation getAggregation()
          Get the aggregation level of this property.
 Association.End getAssociationEnd()
          Get the Association.End connected with this property, if there is one.
 Attribute getAttribute()
          Get the Attribute connected with this property, if there is one.
 ModelElement getDirectSource()
          Get the immediate source element of the underlying element of this property.
 Operation getGetter()
          Get the getter Operation connected with this property, if there is one.
 ModelElement getOriginalSource()
          Get the original source element of the underlying element of this property.
 Parameter getParameter()
          Get the Parameter connected with this property, if there is one.
 java.util.Set getReaders()
          Get Actors who can read this Property
 Operation getSetter()
          Get the setter Operation connected with this property, if there is one.
 ModelElement getUnderlyingElement()
          Get the underlying element of this property.
 java.util.Set getWriters()
          Get Actors who can write this Property
 boolean isOid()
          Indicate whether this property is an object identifier (OID) for its StructuredType.
 boolean isReadable()
          Indicate whether the value(s) of this property can be read.
 boolean isReadableBy(Actor actor)
          Indicate whether the value(s) of this property can be read by a given Actor.
 boolean isWritable()
          Indicate whether the value(s) of this property can be written.
 boolean isWritableBy(Actor actor)
          Indicate whether the value(s) of this property can be written by a given Actor.
 
Methods inherited from interface com.ashridgetech.jamda.uml.TypedItem
getComment, getMultName, getName, getType, isMultiple
 

Method Detail

isReadable

public boolean isReadable()
Indicate whether the value(s) of this property can be read.

Returns:
true if the values can be read

isReadableBy

public boolean isReadableBy(Actor actor)
Indicate whether the value(s) of this property can be read by a given Actor.

Returns:
true if the values can be read

getReaders

public java.util.Set getReaders()
Get Actors who can read this Property

Returns:
the set of Actors. May be null to indicate that ALL Actors can read this Property, or an empty Set to indicate that NO Actors can read this Property

getWriters

public java.util.Set getWriters()
Get Actors who can write this Property

Returns:
the set of Actors. May be null to indicate that ALL Actors can write this Property, or an empty Set to indicate that NO Actors can write this Property

isWritable

public boolean isWritable()
Indicate whether the value(s) of this property can be written.

Returns:
true if the values can be updated

isWritableBy

public boolean isWritableBy(Actor actor)
Indicate whether the value(s) of this property can be written by a given Actor.

Returns:
true if the values can be updated

getAggregation

public StructuredType.Aggregation getAggregation()
Get the aggregation level of this property.

Returns:
the Aggregation instance

isOid

public boolean isOid()
Indicate whether this property is an object identifier (OID) for its StructuredType.

Returns:
true if this property is an oid

getDirectSource

public ModelElement getDirectSource()
Get the immediate source element of the underlying element of this property.

Returns:
the source element
See Also:
getUnderlyingElement(), getOriginalSource()

getOriginalSource

public ModelElement getOriginalSource()
Get the original source element of the underlying element of this property.

Returns:
the source element
See Also:
getUnderlyingElement(), getDirectSource()

getUnderlyingElement

public ModelElement getUnderlyingElement()
Get the underlying element of this property. This will be one of the elements returned by getGetter(), getSetter(), getAttribute() or getAssociationEnd().

Returns:
the source element
See Also:
getUnderlyingElement()

getGetter

public Operation getGetter()
Get the getter Operation connected with this property, if there is one.

Returns:
the getter - may be null

getSetter

public Operation getSetter()
Get the setter Operation connected with this property, if there is one.

Returns:
the setter - may be null

getAttribute

public Attribute getAttribute()
Get the Attribute connected with this property, if there is one.

Returns:
the Attribute - may be null

getAssociationEnd

public Association.End getAssociationEnd()
Get the Association.End connected with this property, if there is one.

Returns:
the association end - may be null

getParameter

public Parameter getParameter()
Get the Parameter connected with this property, if there is one.

Returns:
the parameter - may be null


Copyright © 2003 Ashridge Technologies Ltd. All Rights Reserved.