wt.vc.struct
Interface StructService

All Known Implementing Classes:
StandardStructService

public interface StructService

This service for the struct package contains "navigetters" to navigate the IteratedUsageLink, IteratedReferenceLink and IteratedDescribeLink to both Mastered and Iterated objects.



Supported API: true

Extendable: true


Method Summary
 WTKeyedMap navigateDescribedBys(WTCollection iterations)
          Navigates the describedBy roles of the IteratedDescribeLinks returning a WTKeyedMap of keys = iterations and values = a WTList of other side objects per iteration, i.e.
 WTKeyedMap navigateDescribedBys(WTCollection iterations, boolean onlyOtherSide)
          Navigates the describedBy roles of the IteratedDescribeLinks returning a WTKeyedMap of keys = iterations and values = a WTList of links or other side objects per iteration, i.e.
 WTKeyedMap navigateDescribedBys(WTCollection iterations, Class iteratedDescribeLinkClass, boolean onlyOtherSide)
          Navigates the describedBy roles of the IteratedDescribeLinks returning a WTKeyedMap of keys = iterations and values = a WTList of links or other side objects per iteration, i.e.
 WTKeyedMap navigateDescribes(WTCollection iterations)
          Navigates the describes roles of the IteratedDescribeLinks returning a WTKeyedMap of keys = iterations and values = a WTList of other side objects per iteration, i.e.
 WTKeyedMap navigateDescribes(WTCollection iterations, boolean onlyOtherSide)
          Navigates the describes roles of the IteratedDescribeLinks returning a WTKeyedMap of keys = iterations and values = a WTList of links or other side objects per iteration, i.e.
 WTKeyedMap navigateDescribes(WTCollection iterations, Class iteratedDescribeLinkClass, boolean onlyOtherSide)
          Navigates the describes roles of the IteratedDescribeLinks returning a WTKeyedMap of keys = iterations and values = a WTList of links or other side objects per iteration, i.e.
 QueryResult navigateReferencedBy(Mastered master)
          Navigates the referencedBy role of the IteratedReferenceLink, returning a QueryResult of latest iterations.
 QueryResult navigateReferencedBy(Mastered master, boolean onlyOtherSide)
          Navigates the referencedBy role of the IteratedReferenceLink, returning a QueryResult of IteratedReferenceLinks if the value of onlyOtherSide is "false or iterations if the value is "true".
 QueryResult navigateReferencedBy(Mastered master, Class iteratedReferenceLinkClass, boolean onlyOtherSide)
          Navigates the referencedBy role of the IteratedReferenceLink, returning a QueryResult of IteratedReferenceLinks if the value of onlyOtherSide is "false or iterations if the value is "true".
 WTKeyedMap navigateReferencedBy(WTCollection masters)
          Navigates the referencedBy role of the IteratedReferenceLinks, returning a WTKeyedMap of masters mapped to WTLists of latest iterations.
 WTKeyedMap navigateReferencedBy(WTCollection masters, boolean onlyOtherSide)
          Navigates the referencedBy role of the IteratedReferenceLinks, returning a WTKeyedMap of masters mapped to WTLists of IteratedReferenceLinks if the value of onlyOtherSide is "false" or of latest iterations if the value is "true".
 WTKeyedMap navigateReferencedBy(WTCollection masters, Class iteratedReferenceLinkClass, boolean onlyOtherSide)
          Navigates the referencedBy role of the IteratedReferenceLinks, returning a WTKeyedMap of masters mapped to WTLists of IteratedReferenceLinks if the value of onlyOtherSide is "false" or of latest iterations if the value is "true".
 QueryResult navigateReferences(Iterated iteration)
          Navigates the references role of the IteratedReferenceLink, returning a QueryResult of masters.
 QueryResult navigateReferences(Iterated iteration, boolean onlyOtherSide)
          Navigates the references role of the IteratedReferenceLink, returning a QueryResult of IteratedReferenceLinks if the value of onlyOtherSide is "false" or iterations if the value is "true".
 QueryResult navigateReferences(Iterated iteration, Class iteratedReferenceLinkClass, boolean onlyOtherSide)
          Navigates the references role of the IteratedReferenceLink, returning a QueryResult of IteratedReferenceLinks if the value of onlyOtherSide is "false" or iterations if the value is "true".
 WTKeyedMap navigateReferences(WTCollection iterations)
          Navigates the references role of the IteratedReferenceLinks, returning a WTKeyedMap of iterations mapped to WTLists of masters.
 WTKeyedMap navigateReferences(WTCollection iterations, boolean onlyOtherSide)
          Navigates the references role of the IteratedReferenceLinks, returning a WTKeyedMap of iterations mapped to WTLists of IteratedReferenceLinks if the value of onlyOtherSide is "false" or of masters if the value is "true".
 WTKeyedMap navigateReferences(WTCollection iterations, Class iteratedReferenceLinkClass, boolean onlyOtherSide)
          Navigates the references role of the IteratedReferenceLinks, returning a WTKeyedMap of iterations mapped to WTLists of IteratedReferenceLinks if the value of onlyOtherSide is "false" or of masters if the value is "true".
 QueryResult navigateReferencesToIteration(Iterated iteration, boolean onlyOtherSide, ConfigSpec configSpec)
          Navigate the references role of the IteratedReferenceLink and finds the appropriate iterations for those masters by applying the ConfigSpec.
 QueryResult navigateReferencesToIteration(Iterated iteration, Class iteratedReferenceLinkClass, boolean onlyOtherSide, ConfigSpec configSpec)
          Navigate the references role of the IteratedReferenceLink and finds the appropriate iterations for those masters by applying the ConfigSpec.
 QueryResult navigateReferencesToIteration(Iterated iteration, ConfigSpec configSpec)
          Navigates the references role of the IteratedReferenceLink and finds the appropriate iterations for the masters given the configSpec and returns a QueryResult of those iterations that match as well as the masters for which there were no matching iterations.
 QueryResult navigateUsedBy(Mastered master)
          Navigates the usedBy role of the IteratedUsageLink, returning a QueryResult of latest iterations.
 QueryResult navigateUsedBy(Mastered master, boolean onlyOtherSide)
          Navigates the usedBy role of the IteratedUsageLink, returning a QueryResult of IteratedUsageLinks if the value of onlyOtherSide is "false or iterations if the value is "true".
 QueryResult navigateUsedBy(Mastered master, Class iteratedUsageLinkClass, boolean onlyOtherSide)
          Navigates the usedBy role of the IteratedUsageLink, returning a QueryResult of IteratedUsageLinks if the value of onlyOtherSide is "false or iterations if the value is "true".
 WTKeyedMap navigateUsedBy(WTCollection masters)
          Navigates the usedBy role of the IteratedUsageLinks, returning a WTKeyedMap of masters mapped to WTLists of latest iterations.
 WTKeyedMap navigateUsedBy(WTCollection masters, boolean onlyOtherSide)
          Navigates the usedBy role of the IteratedUsageLinks, returning a WTKeyedMap of masters mapped to WTLists of IteratedUsageLinks if the value of onlyOtherSide is "false" or of latest iterations if the value is "true".
 WTKeyedMap navigateUsedBy(WTCollection masters, Class iteratedUsageLinkClass, boolean onlyOtherSide)
          Navigates the usedBy role of the IteratedUsageLinks, returning a WTKeyedMap of masters mapped to WTLists of IteratedUsageLinks if the value of onlyOtherSide is "false" or of latest iterations if the value is "true".
 QueryResult navigateUsedByToIteration(Iterated iteration, boolean onlyOtherSide, ConfigSpec configSpec)
          Navigates the used by role of the IteratedUsageLink and finds the appropriate iterations for the masters given the configSpec, then for the masters of those iterations is uses filteredIterationsOf to double check that those iterations where the ones that should have been chosen by the config spec, and returns a QueryResult of those iterations that match as well as the masters for which there were no matching iterations.
 QueryResult navigateUsedByToIteration(Iterated iteration, Class iteratedUsageLinkClass, boolean onlyOtherSide, ConfigSpec configSpec)
          Navigates the used by role of the IteratedUsageLink and finds the appropriate iterations for the masters given the configSpec, then for the masters of those iterations is uses filteredIterationsOf to double check that those iterations where the ones that should have been chosen by the config spec, and returns a QueryResult of those iterations that match as well as the masters for which there were no matching iterations.
 QueryResult navigateUsedByToIteration(Iterated iteration, ConfigSpec configSpec)
          Navigates the used by role of the IteratedUsageLink and finds the appropriate iterations for the masters given the configSpec, then for the masters of those iterations is uses filteredIterationsOf to double check that those iterations where the ones that should have been chosen by the config spec, and returns a QueryResult of those iterations that match as well as the masters for which there were no matching iterations.
 QueryResult navigateUses(Iterated iteration)
          Navigates the uses role of the IteratedUsageLink, returning a QueryResult of masters.
 QueryResult navigateUses(Iterated iteration, boolean onlyOtherSide)
          Navigates the uses role of the IteratedUsageLink, returning a QueryResult of IteratedUsageLinks if the value of onlyOtherSide is "false" or iterations if the value is "true".
 QueryResult navigateUses(Iterated iteration, Class iteratedUsageLinkClass, boolean onlyOtherSide)
          Navigates the uses role of the IteratedUsageLink, returning a QueryResult of IteratedUsageLinks if the value of onlyOtherSide is "false" or iterations if the value is "true".
 WTKeyedMap navigateUses(WTCollection iterations)
          Navigates the uses role of the IteratedUsageLinks, returning a WTKeyedMap of iterations mapped to WTLists of masters.
 WTKeyedMap navigateUses(WTCollection iterations, boolean onlyOtherSide)
          Navigates the uses role of the IteratedUsageLinks, returning a WTKeyedMap of iterations mapped to WTLists of IteratedUsageLinks if the value of onlyOtherSide is "false" or of masters if the value is "true".
 WTKeyedMap navigateUses(WTCollection iterations, Class iteratedUsageLinkClass, boolean onlyOtherSide)
          Navigates the uses role of the IteratedUsageLinks, returning a WTKeyedMap of iterations mapped to WTLists of IteratedUsageLinks if the value of onlyOtherSide is "false" or of masters if the value is "true".
 QueryResult navigateUsesToIteration(Iterated iteration, boolean onlyOtherSide, ConfigSpec configSpec)
          Navigate the uses role of the IteratedUsageLink and finds the appropriate iterations for those masters by applying the ConfigSpec.
 QueryResult navigateUsesToIteration(Iterated iteration, Class iteratedUsageLinkClass, boolean onlyOtherSide, ConfigSpec configSpec)
          Navigate the uses role of the IteratedUsageLink and finds the appropriate iterations for those masters by applying the ConfigSpec.
 QueryResult navigateUsesToIteration(Iterated iteration, ConfigSpec configSpec)
          Navigates the uses role of the IteratedUsageLink and finds the appropriate iterations for the masters given the configSpec and returns a QueryResult of those iterations that match as well as the masters for which there were no matching iterations.
 WTKeyedMap navigateUsesToIteration(WTCollection iterations, boolean onlyOtherSide, ConfigSpec configSpec)
          Navigate the uses role of the IteratedUsageLinks and finds the appropriate iterations for those masters by applying the ConfigSpec.
 WTKeyedMap navigateUsesToIteration(WTCollection iterations, Class iteratedUsageLinkClass, boolean onlyOtherSide, ConfigSpec configSpec)
          Navigate the uses role of the IteratedUsageLinks and finds the appropriate iterations for those masters by applying the ConfigSpec.
 WTKeyedMap navigateUsesToIteration(WTCollection iterations, ConfigSpec configSpec)
          Navigates the uses role of the IteratedUsageLinks and finds the appropriate iterations for the masters given the configSpec and returns a WTKeyedMap the iterations mapped to QueryResults of those iterations that match as well as the masters for which there were no matching iterations.
 

Method Detail

navigateUses

QueryResult navigateUses(Iterated iteration)
                         throws WTException
Navigates the uses role of the IteratedUsageLink, returning a QueryResult of masters.

Supported API: true

Parameters:
iteration -
Returns:
QueryResult
Throws:
WTException
See Also:
IteratedUsageLink, Mastered

navigateUses

QueryResult navigateUses(Iterated iteration,
                         boolean onlyOtherSide)
                         throws WTException
Navigates the uses role of the IteratedUsageLink, returning a QueryResult of IteratedUsageLinks if the value of onlyOtherSide is "false" or iterations if the value is "true".

Supported API: true

Parameters:
iteration -
onlyOtherSide -
Returns:
QueryResult
Throws:
WTException
See Also:
IteratedUsageLink, Mastered

navigateUses

QueryResult navigateUses(Iterated iteration,
                         Class iteratedUsageLinkClass,
                         boolean onlyOtherSide)
                         throws WTException
Navigates the uses role of the IteratedUsageLink, returning a QueryResult of IteratedUsageLinks if the value of onlyOtherSide is "false" or iterations if the value is "true".

Supported API: true

Parameters:
iteration -
iteratedUsageLinkClass -
onlyOtherSide -
Returns:
QueryResult
Throws:
WTException
See Also:
IteratedUsageLink, Mastered

navigateUses

WTKeyedMap navigateUses(WTCollection iterations)
                        throws WTException
Navigates the uses role of the IteratedUsageLinks, returning a WTKeyedMap of iterations mapped to WTLists of masters.

Supported API: true

Parameters:
iterations -
Returns:
WTKeyedMap
Throws:
WTException
See Also:
IteratedUsageLink, Mastered

navigateUses

WTKeyedMap navigateUses(WTCollection iterations,
                        boolean onlyOtherSide)
                        throws WTException
Navigates the uses role of the IteratedUsageLinks, returning a WTKeyedMap of iterations mapped to WTLists of IteratedUsageLinks if the value of onlyOtherSide is "false" or of masters if the value is "true".

Supported API: true

Parameters:
iterations -
onlyOtherSide -
Returns:
WTKeyedMap
Throws:
WTException
See Also:
IteratedUsageLink, Mastered

navigateUses

WTKeyedMap navigateUses(WTCollection iterations,
                        Class iteratedUsageLinkClass,
                        boolean onlyOtherSide)
                        throws WTException
Navigates the uses role of the IteratedUsageLinks, returning a WTKeyedMap of iterations mapped to WTLists of IteratedUsageLinks if the value of onlyOtherSide is "false" or of masters if the value is "true".

Supported API: true

Parameters:
iterations -
iteratedUsageLinkClass -
onlyOtherSide -
Returns:
WTKeyedMap
Throws:
WTException
See Also:
IteratedUsageLink, Mastered

navigateUsedByToIteration

QueryResult navigateUsedByToIteration(Iterated iteration,
                                      ConfigSpec configSpec)
                                      throws WTException,
                                             wt.vc.config.ConfigException
Navigates the used by role of the IteratedUsageLink and finds the appropriate iterations for the masters given the configSpec, then for the masters of those iterations is uses filteredIterationsOf to double check that those iterations where the ones that should have been chosen by the config spec, and returns a QueryResult of those iterations that match as well as the masters for which there were no matching iterations.

Supported API: true

Parameters:
iteration -
configSpec -
Returns:
QueryResult
Throws:
WTException
wt.vc.config.ConfigException
See Also:
IteratedUsageLink, Mastered, Iterated, ConfigSpec

navigateUsedByToIteration

QueryResult navigateUsedByToIteration(Iterated iteration,
                                      boolean onlyOtherSide,
                                      ConfigSpec configSpec)
                                      throws WTException,
                                             wt.vc.config.ConfigException
Navigates the used by role of the IteratedUsageLink and finds the appropriate iterations for the masters given the configSpec, then for the masters of those iterations is uses filteredIterationsOf to double check that those iterations where the ones that should have been chosen by the config spec, and returns a QueryResult of those iterations that match as well as the masters for which there were no matching iterations. If onlyOtherSide" is true", it returns a QueryResult of matching iterations and masters if no iterations matched. If "false", returns a QueryResult of Persistable[] in which the 0th Persistable in the array is the IteratedUsageLink and the 1th position is the matching iteration or master if no matching iteration was found.

Supported API: true

Parameters:
iteration -
onlyOtherSide -
configSpec -
Returns:
QueryResult
Throws:
WTException
wt.vc.config.ConfigException
See Also:
IteratedUsageLink, Mastered, Iterated, ConfigSpec

navigateUsedByToIteration

QueryResult navigateUsedByToIteration(Iterated iteration,
                                      Class iteratedUsageLinkClass,
                                      boolean onlyOtherSide,
                                      ConfigSpec configSpec)
                                      throws WTException,
                                             wt.vc.config.ConfigException
Navigates the used by role of the IteratedUsageLink and finds the appropriate iterations for the masters given the configSpec, then for the masters of those iterations is uses filteredIterationsOf to double check that those iterations where the ones that should have been chosen by the config spec, and returns a QueryResult of those iterations that match as well as the masters for which there were no matching iterations. If onlyOtherSide" is true", it returns a QueryResult of matching iterations and masters if no iterations matched. If "false", returns a QueryResult of Persistable[] in which the 0th Persistable in the array is the IteratedUsageLink and the 1th position is the matching iteration or master if no matching iteration was found.

Supported API: true

Parameters:
iteration -
iteratedUsageLinkClass -
onlyOtherSide -
configSpec -
Returns:
QueryResult
Throws:
WTException
wt.vc.config.ConfigException
See Also:
IteratedUsageLink, Mastered, Iterated, ConfigSpec

navigateUsedBy

QueryResult navigateUsedBy(Mastered master)
                           throws WTException
Navigates the usedBy role of the IteratedUsageLink, returning a QueryResult of latest iterations.

Supported API: true

Parameters:
master -
Returns:
QueryResult
Throws:
WTException
See Also:
IteratedUsageLink, Iterated

navigateUsedBy

QueryResult navigateUsedBy(Mastered master,
                           boolean onlyOtherSide)
                           throws WTException
Navigates the usedBy role of the IteratedUsageLink, returning a QueryResult of IteratedUsageLinks if the value of onlyOtherSide is "false or iterations if the value is "true".

Supported API: true

Parameters:
master -
onlyOtherSide -
Returns:
QueryResult
Throws:
WTException
See Also:
IteratedUsageLink, wt.vc.version.Version

navigateUsedBy

QueryResult navigateUsedBy(Mastered master,
                           Class iteratedUsageLinkClass,
                           boolean onlyOtherSide)
                           throws WTException
Navigates the usedBy role of the IteratedUsageLink, returning a QueryResult of IteratedUsageLinks if the value of onlyOtherSide is "false or iterations if the value is "true".

Supported API: true

Parameters:
master -
iteratedUsageLinkClass -
onlyOtherSide -
Returns:
QueryResult
Throws:
WTException
See Also:
IteratedUsageLink, wt.vc.version.Version

navigateUsedBy

WTKeyedMap navigateUsedBy(WTCollection masters)
                          throws WTException
Navigates the usedBy role of the IteratedUsageLinks, returning a WTKeyedMap of masters mapped to WTLists of latest iterations.

Supported API: true

Parameters:
masters -
Returns:
WTKeyedMap
Throws:
WTException
See Also:
IteratedUsageLink, Iterated

navigateUsedBy

WTKeyedMap navigateUsedBy(WTCollection masters,
                          boolean onlyOtherSide)
                          throws WTException
Navigates the usedBy role of the IteratedUsageLinks, returning a WTKeyedMap of masters mapped to WTLists of IteratedUsageLinks if the value of onlyOtherSide is "false" or of latest iterations if the value is "true".

Supported API: true

Parameters:
masters -
onlyOtherSide -
Returns:
WTKeyedMap
Throws:
WTException
See Also:
IteratedUsageLink, Iterated

navigateUsedBy

WTKeyedMap navigateUsedBy(WTCollection masters,
                          Class iteratedUsageLinkClass,
                          boolean onlyOtherSide)
                          throws WTException
Navigates the usedBy role of the IteratedUsageLinks, returning a WTKeyedMap of masters mapped to WTLists of IteratedUsageLinks if the value of onlyOtherSide is "false" or of latest iterations if the value is "true".

Supported API: true

Parameters:
masters -
iteratedUsageLinkClass -
onlyOtherSide -
Returns:
WTKeyedMap
Throws:
WTException
See Also:
IteratedUsageLink, Iterated

navigateUsesToIteration

QueryResult navigateUsesToIteration(Iterated iteration,
                                    ConfigSpec configSpec)
                                    throws WTException,
                                           wt.vc.config.ConfigException
Navigates the uses role of the IteratedUsageLink and finds the appropriate iterations for the masters given the configSpec and returns a QueryResult of those iterations that match as well as the masters for which there were no matching iterations.

Supported API: true

Parameters:
iteration -
configSpec -
Returns:
QueryResult
Throws:
WTException
wt.vc.config.ConfigException
See Also:
IteratedUsageLink, Mastered, Iterated, ConfigSpec

navigateUsesToIteration

QueryResult navigateUsesToIteration(Iterated iteration,
                                    boolean onlyOtherSide,
                                    ConfigSpec configSpec)
                                    throws WTException,
                                           wt.vc.config.ConfigException
Navigate the uses role of the IteratedUsageLink and finds the appropriate iterations for those masters by applying the ConfigSpec. If onlyOtherSide" is true", it returns a QueryResult of matching iterations and masters if no iterations matched. If "false", returns a QueryResult of Persistable[] in which the 0th Persistable in the array is the IteratedUsageLink and the 1th position is the matching iteration or master if no matching iteration was found.

Supported API: true

Parameters:
iteration -
onlyOtherSide -
configSpec -
Returns:
QueryResult
Throws:
WTException
wt.vc.config.ConfigException
See Also:
IteratedUsageLink, Mastered, Iterated, ConfigSpec

navigateUsesToIteration

QueryResult navigateUsesToIteration(Iterated iteration,
                                    Class iteratedUsageLinkClass,
                                    boolean onlyOtherSide,
                                    ConfigSpec configSpec)
                                    throws WTException,
                                           wt.vc.config.ConfigException
Navigate the uses role of the IteratedUsageLink and finds the appropriate iterations for those masters by applying the ConfigSpec. If onlyOtherSide" is true", it returns a QueryResult of matching iterations and masters if no iterations matched. If "false", returns a QueryResult of Persistable[] in which the 0th Persistable in the array is the IteratedUsageLink and the 1th position is the matching iteration or master if no matching iteration was found.

Supported API: true

Parameters:
iteration -
iteratedUsageLinkClass -
onlyOtherSide -
configSpec -
Returns:
QueryResult
Throws:
WTException
wt.vc.config.ConfigException
See Also:
IteratedUsageLink, Mastered, Iterated, ConfigSpec

navigateUsesToIteration

WTKeyedMap navigateUsesToIteration(WTCollection iterations,
                                   ConfigSpec configSpec)
                                   throws WTException,
                                          wt.vc.config.ConfigException
Navigates the uses role of the IteratedUsageLinks and finds the appropriate iterations for the masters given the configSpec and returns a WTKeyedMap the iterations mapped to QueryResults of those iterations that match as well as the masters for which there were no matching iterations.

Supported API: true

Parameters:
iterations -
configSpec -
Returns:
WTKeyedMap
Throws:
WTException
wt.vc.config.ConfigException
See Also:
IteratedUsageLink, Mastered, Iterated, ConfigSpec

navigateUsesToIteration

WTKeyedMap navigateUsesToIteration(WTCollection iterations,
                                   boolean onlyOtherSide,
                                   ConfigSpec configSpec)
                                   throws WTException,
                                          wt.vc.config.ConfigException
Navigate the uses role of the IteratedUsageLinks and finds the appropriate iterations for those masters by applying the ConfigSpec. If onlyOtherSide is "true", it returns a WTKeyedMap of the iterations mapped to WTLists of those matching iterations and masters if no iterations matched. If "false", returns a WTKeyedMap of the iterations mapped to QueryResults of Persistable[] in which the 0th Persistable in the array is the IteratedUsageLink and the 1th position is the matching iteration or master if no matching iteration was found.

Supported API: true

Parameters:
iterations -
onlyOtherSide -
configSpec -
Returns:
WTKeyedMap
Throws:
WTException
wt.vc.config.ConfigException
See Also:
IteratedUsageLink, Mastered, Iterated, ConfigSpec

navigateUsesToIteration

WTKeyedMap navigateUsesToIteration(WTCollection iterations,
                                   Class iteratedUsageLinkClass,
                                   boolean onlyOtherSide,
                                   ConfigSpec configSpec)
                                   throws WTException,
                                          wt.vc.config.ConfigException
Navigate the uses role of the IteratedUsageLinks and finds the appropriate iterations for those masters by applying the ConfigSpec. If onlyOtherSide is "true", it returns a WTKeyedMap of the iterations mapped to WTLists of those matching iterations and masters if no iterations matched. If "false", returns a WTKeyedMap of the iterations mapped to QueryResults of Persistable[] in which the 0th Persistable in the array is the IteratedUsageLink and the 1th position is the matching iteration or master if no matching iteration was found.

Supported API: true

Parameters:
iterations -
iteratedUsageLinkClass -
onlyOtherSide -
configSpec -
Returns:
WTKeyedMap
Throws:
WTException
wt.vc.config.ConfigException
See Also:
IteratedUsageLink, Mastered, Iterated, ConfigSpec

navigateReferences

QueryResult navigateReferences(Iterated iteration)
                               throws WTException
Navigates the references role of the IteratedReferenceLink, returning a QueryResult of masters.

Supported API: true

Parameters:
iteration -
Returns:
QueryResult
Throws:
WTException
See Also:
IteratedReferenceLink, Mastered

navigateReferences

QueryResult navigateReferences(Iterated iteration,
                               boolean onlyOtherSide)
                               throws WTException
Navigates the references role of the IteratedReferenceLink, returning a QueryResult of IteratedReferenceLinks if the value of onlyOtherSide is "false" or iterations if the value is "true".

Supported API: true

Parameters:
iteration -
onlyOtherSide -
Returns:
QueryResult
Throws:
WTException
See Also:
IteratedReferenceLink, Mastered

navigateReferences

QueryResult navigateReferences(Iterated iteration,
                               Class iteratedReferenceLinkClass,
                               boolean onlyOtherSide)
                               throws WTException
Navigates the references role of the IteratedReferenceLink, returning a QueryResult of IteratedReferenceLinks if the value of onlyOtherSide is "false" or iterations if the value is "true".

Supported API: true

Parameters:
iteration -
iteratedReferenceLinkClass -
onlyOtherSide -
Returns:
QueryResult
Throws:
WTException
See Also:
IteratedReferenceLink, Mastered

navigateReferences

WTKeyedMap navigateReferences(WTCollection iterations)
                              throws WTException
Navigates the references role of the IteratedReferenceLinks, returning a WTKeyedMap of iterations mapped to WTLists of masters.

Supported API: true

Parameters:
iterations -
Returns:
WTKeyedMap
Throws:
WTException
See Also:
IteratedReferenceLink, Mastered

navigateReferences

WTKeyedMap navigateReferences(WTCollection iterations,
                              boolean onlyOtherSide)
                              throws WTException
Navigates the references role of the IteratedReferenceLinks, returning a WTKeyedMap of iterations mapped to WTLists of IteratedReferenceLinks if the value of onlyOtherSide is "false" or of masters if the value is "true".

Supported API: true

Parameters:
iterations -
onlyOtherSide -
Returns:
WTKeyedMap
Throws:
WTException
See Also:
IteratedReferenceLink, Mastered

navigateReferences

WTKeyedMap navigateReferences(WTCollection iterations,
                              Class iteratedReferenceLinkClass,
                              boolean onlyOtherSide)
                              throws WTException
Navigates the references role of the IteratedReferenceLinks, returning a WTKeyedMap of iterations mapped to WTLists of IteratedReferenceLinks if the value of onlyOtherSide is "false" or of masters if the value is "true".

Supported API: true

Parameters:
iterations -
iteratedReferenceLinkClass -
onlyOtherSide -
Returns:
WTKeyedMap
Throws:
WTException
See Also:
IteratedReferenceLink, Mastered

navigateReferencedBy

QueryResult navigateReferencedBy(Mastered master)
                                 throws WTException
Navigates the referencedBy role of the IteratedReferenceLink, returning a QueryResult of latest iterations.

Supported API: true

Parameters:
master -
Returns:
QueryResult
Throws:
WTException
See Also:
IteratedReferenceLink, Iterated

navigateReferencedBy

QueryResult navigateReferencedBy(Mastered master,
                                 boolean onlyOtherSide)
                                 throws WTException
Navigates the referencedBy role of the IteratedReferenceLink, returning a QueryResult of IteratedReferenceLinks if the value of onlyOtherSide is "false or iterations if the value is "true".

Supported API: true

Parameters:
master -
onlyOtherSide -
Returns:
QueryResult
Throws:
WTException
See Also:
IteratedReferenceLink, wt.vc.version.Version

navigateReferencedBy

QueryResult navigateReferencedBy(Mastered master,
                                 Class iteratedReferenceLinkClass,
                                 boolean onlyOtherSide)
                                 throws WTException
Navigates the referencedBy role of the IteratedReferenceLink, returning a QueryResult of IteratedReferenceLinks if the value of onlyOtherSide is "false or iterations if the value is "true".

Supported API: true

Parameters:
master -
iteratedReferenceLinkClass -
onlyOtherSide -
Returns:
QueryResult
Throws:
WTException
See Also:
IteratedReferenceLink, wt.vc.version.Version

navigateReferencedBy

WTKeyedMap navigateReferencedBy(WTCollection masters)
                                throws WTException
Navigates the referencedBy role of the IteratedReferenceLinks, returning a WTKeyedMap of masters mapped to WTLists of latest iterations.

Supported API: true

Parameters:
masters -
Returns:
WTKeyedMap
Throws:
WTException
See Also:
IteratedReferenceLink, Iterated

navigateReferencedBy

WTKeyedMap navigateReferencedBy(WTCollection masters,
                                boolean onlyOtherSide)
                                throws WTException
Navigates the referencedBy role of the IteratedReferenceLinks, returning a WTKeyedMap of masters mapped to WTLists of IteratedReferenceLinks if the value of onlyOtherSide is "false" or of latest iterations if the value is "true".

Supported API: true

Parameters:
masters -
onlyOtherSide -
Returns:
WTKeyedMap
Throws:
WTException
See Also:
IteratedReferenceLink, Iterated

navigateReferencedBy

WTKeyedMap navigateReferencedBy(WTCollection masters,
                                Class iteratedReferenceLinkClass,
                                boolean onlyOtherSide)
                                throws WTException
Navigates the referencedBy role of the IteratedReferenceLinks, returning a WTKeyedMap of masters mapped to WTLists of IteratedReferenceLinks if the value of onlyOtherSide is "false" or of latest iterations if the value is "true".

Supported API: true

Parameters:
masters -
iteratedReferenceLinkClass -
onlyOtherSide -
Returns:
WTKeyedMap
Throws:
WTException
See Also:
IteratedReferenceLink, Iterated

navigateReferencesToIteration

QueryResult navigateReferencesToIteration(Iterated iteration,
                                          ConfigSpec configSpec)
                                          throws WTException,
                                                 wt.vc.config.ConfigException
Navigates the references role of the IteratedReferenceLink and finds the appropriate iterations for the masters given the configSpec and returns a QueryResult of those iterations that match as well as the masters for which there were no matching iterations.

Supported API: true

Parameters:
iteration -
configSpec -
Returns:
QueryResult
Throws:
WTException
wt.vc.config.ConfigException
See Also:
IteratedReferenceLink, Mastered, Iterated, ConfigSpec

navigateReferencesToIteration

QueryResult navigateReferencesToIteration(Iterated iteration,
                                          boolean onlyOtherSide,
                                          ConfigSpec configSpec)
                                          throws WTException,
                                                 wt.vc.config.ConfigException
Navigate the references role of the IteratedReferenceLink and finds the appropriate iterations for those masters by applying the ConfigSpec. If onlyOtherSide" is true", it returns a QueryResult of matching iterations and masters if no iterations matched. If "false", returns a QueryResult of Persistable[] in which the 0th Persistable in the array is the IteratedReferenceLink and the 1th position is the matching iteration or master if no matching iteration was found.

Supported API: true

Parameters:
iteration -
onlyOtherSide -
configSpec -
Returns:
QueryResult
Throws:
WTException
wt.vc.config.ConfigException
See Also:
IteratedReferenceLink, Mastered, Iterated, ConfigSpec

navigateReferencesToIteration

QueryResult navigateReferencesToIteration(Iterated iteration,
                                          Class iteratedReferenceLinkClass,
                                          boolean onlyOtherSide,
                                          ConfigSpec configSpec)
                                          throws WTException,
                                                 wt.vc.config.ConfigException
Navigate the references role of the IteratedReferenceLink and finds the appropriate iterations for those masters by applying the ConfigSpec. If onlyOtherSide" is true", it returns a QueryResult of matching iterations and masters if no iterations matched. If "false", returns a QueryResult of Persistable[] in which the 0th Persistable in the array is the IteratedReferenceLink and the 1th position is the matching iteration or master if no matching iteration was found.

Supported API: true

Parameters:
iteration -
iteratedReferenceLinkClass -
onlyOtherSide -
configSpec -
Returns:
QueryResult
Throws:
WTException
wt.vc.config.ConfigException
See Also:
IteratedReferenceLink, Mastered, Iterated, ConfigSpec

navigateDescribes

WTKeyedMap navigateDescribes(WTCollection iterations)
                             throws WTException
Navigates the describes roles of the IteratedDescribeLinks returning a WTKeyedMap of keys = iterations and values = a WTList of other side objects per iteration, i.e. each iteration key corresponds to a WTList.

Supported API: true

Parameters:
iterations -
Returns:
WTKeyedMap
Throws:
WTException
See Also:
IteratedDescribeLink, wt.vc.version.Iterated

navigateDescribes

WTKeyedMap navigateDescribes(WTCollection iterations,
                             boolean onlyOtherSide)
                             throws WTException
Navigates the describes roles of the IteratedDescribeLinks returning a WTKeyedMap of keys = iterations and values = a WTList of links or other side objects per iteration, i.e. each iteration key corresponds to a WTList. IteratedDescribeLinks are returned if the value of onlyOtherSide is "false or iterations if the value is "true".

Supported API: true

Parameters:
iterations -
onlyOtherSide -
Returns:
WTKeyedMap
Throws:
WTException
See Also:
IteratedDescribeLink, wt.vc.version.Iterated

navigateDescribes

WTKeyedMap navigateDescribes(WTCollection iterations,
                             Class iteratedDescribeLinkClass,
                             boolean onlyOtherSide)
                             throws WTException
Navigates the describes roles of the IteratedDescribeLinks returning a WTKeyedMap of keys = iterations and values = a WTList of links or other side objects per iteration, i.e. each iteration key corresponds to a WTList. IteratedDescribeLinks are returned if the value of onlyOtherSide is "false or iterations if the value is "true".

Supported API: true

Parameters:
iterations -
iteratedDescribeLinkClass -
onlyOtherSide -
Returns:
WTKeyedMap
Throws:
WTException
See Also:
IteratedDescribeLink, wt.vc.version.Iterated

navigateDescribedBys

WTKeyedMap navigateDescribedBys(WTCollection iterations)
                                throws WTException
Navigates the describedBy roles of the IteratedDescribeLinks returning a WTKeyedMap of keys = iterations and values = a WTList of other side objects per iteration, i.e. each iteration key corresponds to a WTList.

Supported API: true

Parameters:
iterations -
Returns:
WTKeyedMap
Throws:
WTException
See Also:
IteratedDescribeLink, wt.vc.version.Iterated

navigateDescribedBys

WTKeyedMap navigateDescribedBys(WTCollection iterations,
                                boolean onlyOtherSide)
                                throws WTException
Navigates the describedBy roles of the IteratedDescribeLinks returning a WTKeyedMap of keys = iterations and values = a WTList of links or other side objects per iteration, i.e. each iteration key corresponds to a WTList. IteratedDescribeLinks are returned if the value of onlyOtherSide is "false or iterations if the value is "true".

Supported API: true

Parameters:
iterations -
onlyOtherSide -
Returns:
WTKeyedMap
Throws:
WTException
See Also:
IteratedDescribeLink, wt.vc.version.Iterated

navigateDescribedBys

WTKeyedMap navigateDescribedBys(WTCollection iterations,
                                Class iteratedDescribeLinkClass,
                                boolean onlyOtherSide)
                                throws WTException
Navigates the describedBy roles of the IteratedDescribeLinks returning a WTKeyedMap of keys = iterations and values = a WTList of links or other side objects per iteration, i.e. each iteration key corresponds to a WTList. IteratedDescribeLinks are returned if the value of onlyOtherSide is "false or iterations if the value is "true".

Supported API: true

Parameters:
iterations -
iteratedDescribeLinkClass -
onlyOtherSide -
Returns:
WTKeyedMap
Throws:
WTException
See Also:
IteratedDescribeLink, wt.vc.version.Iterated