org.araneaframework
Interface Scope

All Superinterfaces:

Serializable

All Known Implementing Classes:

StandardScope

public interface Scope

extends Serializable

Scope is an abstraction of the location of the component in the hierarchy. Every component has its scope.

Since:

1.1

Method Summary

Object	getId() Every component has its unique ID compared to other children of its parent.
Scope	getParent() Every component has a parent except the root component.
Path	toPath() Builds and returns the full path of the component.

Method Detail

getId

public Object getId()

Every component has its unique ID compared to other children of its parent. Here is a way to view the ID of the component.

Returns:

the ID of the component.

getParent

public Scope getParent()

Every component has a parent except the root component. Here is a way to view the scope of the parent component.

Returns:

the scope of the parent component.

toPath

public Path toPath()

Builds and returns the full path of the component. The path consists of the IDs of all the components starting with the root flow. For example, if a is the ID of the root flow, and c is the ID of the component whose path we want to know, the path may be like following: a.b.c.

Returns:

the Path of the component.