org.modelio.api.module.context.project

Interface IFragmentStructure

public interface IFragmentStructure

This interface describes a Fragment in a project: ie a name, a version, a type...

Since:

3.5

Method Summary

Modifier and Type	Method and Description
java.lang.String	getName() Get the fragment name.
java.lang.String	getRemoteLocation() Get the fragment's URI in the opened project.
java.util.List<Element>	getRoots() Get the root elements of the fragment.
java.lang.String	getState() Get the state of the fragment.
java.lang.String	getType() Get the fragment type identifier.

Method Detail

getName

java.lang.String getName()

Get the fragment name.

Returns:

a name.

getType

java.lang.String getType()

Get the fragment type identifier.

Might be EXML, EXML_URL, EXML_SVN, RAMC or MDA.

Returns:

the fragment type.

getRemoteLocation

java.lang.String getRemoteLocation()

Get the fragment's URI in the opened project.

Returns:

the mounted URI or null if the fragment is not mounted.

getState

java.lang.String getState()

Get the state of the fragment.

Should be UP_FULL, UP_LIGHT or DOWN.

Returns:

the fragment state.

getRoots

java.util.List<Element> getRoots()

Get the root elements of the fragment.

Returns:

the root elements of the fragment.