COSMOS ${releaseVersion} resource-modeling Project
Internal API Specification

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

All Superinterfaces:
org.eclipse.cosmos.rm.repository.provisional.resource.ISMLDocumentFragment, ISMLResourceBase
All Known Implementing Classes:
SMLFileResourceFacet

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

A convenience API for a more strongly typed SML document fragment. Facets can contain other facets, properties, and resources.


Method Summary
 ISMLResourceFacet resolveReference()
          If this object happens to represent a reference to a facet (i.e. isReference() returns true), then this method will have it resolved to the actual facet.
 ISMLResourceFacet[] retrieveFacets()
          Retrieves and returns the facets that are directly referenced by this facet.
 ISMLResourceProperty[] retrieveProperties()
          Retrieves and returns the properties that are directly referenced by this facet.
 ISMLResourceInstance[] retrieveResources()
          Retrieves and returns the resources that are directly referenced by this facet.
 
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

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

Returns:
An object representing the resolved resource that this reference points to

retrieveResources

ISMLResourceInstance[] retrieveResources()
Retrieves and returns the resources that are directly referenced by this facet.

Returns:
The direct resources referenced by this facet

retrieveFacets

ISMLResourceFacet[] retrieveFacets()
Retrieves and returns the facets that are directly referenced by this facet.

Returns:
The direct facets referenced by this facet

retrieveProperties

ISMLResourceProperty[] retrieveProperties()
Retrieves and returns the properties that are directly referenced by this facet.

Returns:
The direct properties referenced by this facet

COSMOS ${releaseVersion} resource-modeling Project
Internal API Specification