org.eclipse.cosmos.rm.repository.internal.application
Interface ISMLResourceProperty

All Superinterfaces:

org.eclipse.cosmos.rm.repository.provisional.resource.ISMLDocumentFragment, ISMLResourceBase

All Known Implementing Classes:

SMLResourceProperty

public interface ISMLResourceProperty
extends org.eclipse.cosmos.rm.repository.provisional.resource.ISMLDocumentFragment, ISMLResourceBase

Represents a property which is a strongly typed SML document fragment. A facet contains

Method Summary

ISMLResourceProperty	resolveReference() If this object happens to represent a reference to a property (i.e. isReference() returns true), then this method will have it resolved to the actual property.
java.lang.String[]	retrieveAttributes() Retrieves and returns the attributes of this property
ISMLResourceProperty[]	retrieveChildren() Retrieves the children of this property if it has any An empty array is returned if this property does not have any children.
java.lang.String	retrievePropertyName() Returns the property name of this object
java.lang.String	retrieveValue(java.lang.String attribute) Retrieves the value of the attribute with the name that is passed in.

Methods inherited from interface org.eclipse.cosmos.rm.repository.provisional.resource.ISMLDocumentFragment

getNodeList, getParentDocument

Methods inherited from interface org.eclipse.cosmos.rm.repository.internal.application.ISMLResourceBase

isReference, retrieveDescription, retrieveDisplayName, retrieveName

Method Detail

resolveReference

ISMLResourceProperty resolveReference()

If this object happens to represent a reference to a property (i.e. isReference() returns true), then this method will have it resolved to the actual property. If isReference() happens to return false, then the return value of this method is this object.

Returns:

An object representing the resolved property that this reference points to

retrievePropertyName

java.lang.String retrievePropertyName()

Returns the property name of this object

Returns:

the property name

retrieveChildren

ISMLResourceProperty[] retrieveChildren()

Retrieves the children of this property if it has any An empty array is returned if this property does not have any children.

Returns:

The children of this property

retrieveAttributes

java.lang.String[] retrieveAttributes()

Retrieves and returns the attributes of this property

Returns:

The attributes of this property

retrieveValue

java.lang.String retrieveValue(java.lang.String attribute)

Retrieves the value of the attribute with the name that is passed in.

Parameters:

attribute - The attribute name

Returns:

The value if of the attribute if it exists; null othewise