wt.epm.structure
Interface EPMStructureService

All Known Implementing Classes:

EPMStandardStructureService, EPMStructureServiceFwd

public interface EPMStructureService

The service for the struct package containing "navigetters" to navigate the EPMMemberLink or EPMReferenceLink to both masters and iterations.

Supported API: true

Extendable: false

Method Summary

QueryResult	navigate(QueryResult objects, Class linkClass, String otherSideRole, QuerySpec querySpec, boolean onlyOtherSide) Navigates the links of the specified class to the given role from the supplied Persistable objects.
WTKeyedMap	navigate(WTCollection objects, Class linkClass, String otherSideRole, QuerySpec querySpec, boolean onlyOtherSide) Navigates the links of the specified class to the given role from each Persistable in the given WTCollection using a single query.
QueryResult	navigateBothRoles(EPMDocument document, Class linkClass) Navigates the both roles of the given link class.
QueryResult	navigateContainedIn(EPMDocument contained, QuerySpec querySpec, boolean onlyOtherSide) Navigates the CONTAINED_IN role of an EPMContainedInLink.
QueryResult	navigateContainedIn(EPMDocument contained, QuerySpec querySpec, boolean onlyOtherSide, ConfigSpec configSpec) Navigates the CONTAINED_IN role of the EPMContainedInLink and finds the appropriate iterations of the "container" EPM family table by applying the configSpec.
WTKeyedMap	navigateContainedIn(WTCollection documents, QuerySpec querySpec, boolean onlyOtherSide) For the given WTCollection of EPMDocuments, navigates the CONTAINED_IN role of the EPMContainedIn link and returns a WTKeyedMap whose values are WTSets of EPMContainedIn links or EPMFamilyTables depending upon the value of the onlyOtherSide flag.
QueryResult	navigateContains(EPMFamilyTable container, QuerySpec querySpec, boolean onlyOtherSide) Navigates the CONTAINS role of an EPMContainedInLink.
QueryResult	navigateContains(EPMFamilyTable container, QuerySpec querySpec, boolean onlyOtherSide, ConfigSpec configSpec) Deprecated.
WTKeyedMap	navigateContains(WTCollection familyTables, QuerySpec querySpec, boolean onlyOtherSide) For the given WTCollection of EPMFamilyTables, navigates the CONTAINS role of the EPMContainedIn link and returns a WTKeyedMap whose values are WTSets of EPMContainedIn links or EPMDocuments depending upon the value of the onlyOtherSide flag.
QueryResult	navigateGeneric(EPMDocument variant, QuerySpec querySpec, boolean onlyOtherSide) Navigates the GENERIC role of the EPM Variant Link.
WTKeyedMap	navigateGeneric(WTCollection variants, QuerySpec querySpec, boolean onlyOtherSide) For the given WTCollection of EPMDocuments, navigates the GENERIC role of the EPMVariantLink and returns a WTKeyedMap whose values are WTSets of EPMVariantLinks or EPMDocumentMasters depending upon the value of the onlyOtherSide flag.
QueryResult	navigateGenericToIteration(EPMDocument variant, QuerySpec querySpec, boolean onlyOtherSide, ConfigSpec configSpec) Navigates the GENERIC role of the EPMVariantLink and finds the appropriate iteration of the generic for this variant by applying the configSpec.
WTKeyedMap	navigateGenericToIteration(WTCollection variants, QuerySpec querySpec, boolean onlyOtherSide, ConfigSpec configSpec) For the given WTCollection of EPMDocuments, navigates the GENERIC role of the EPMVariantLink and finds the appropriate iteration for each other-side EPMDocumentMaster by applying the config spec.
QueryResult	navigateMasterToIteration(QueryResult objects, Class linkClass, QuerySpec querySpec, boolean onlyOtherSide, ConfigSpec configSpec) Navigates the links of the specified class to Mastered objects from the supplied Persistable objects and finds the appropriate iterations for those Mastered objects by applying the configSpec.
QueryResult	navigateReferencedBy(DocumentMaster master, QuerySpec querySpec) Deprecated. at R6.2, please use navigateReferencedBy(EPMDocumentMaster, QuerySpec, boolean)
QueryResult	navigateReferencedBy(DocumentMaster master, QuerySpec querySpec, boolean onlyOtherSide) Navigates the REFERENCED_BY role of the EPMReferenceLink and returns a QueryResult of EPMReferenceLinks if the value of onlyOtherSide is "false" or EPMDocuments if the value is "true".
WTKeyedMap	navigateReferencedBy(WTCollection masters, QuerySpec querySpec, boolean onlyOtherSide) For the given WTCollection of DocumentMasters, navigates the REFERENCED_BY role of the EPMReferenceLink and returns a WTKeyedMap whose values are WTSets of EPMReferenceLinks or EPMDocuments depending upon the value of the onlyOtherSide flag.
QueryResult	navigateReferences(EPMDocument document, QuerySpec querySpec) Deprecated. at R6.2, please use navigateReferences(EPMDocument, QuerySpec, boolean)
QueryResult	navigateReferences(EPMDocument document, QuerySpec querySpec, boolean onlyOtherSide) Navigates the REFERENCES role of the EPMReferenceLink, returning a QueryResult of EPMReferenceLinks if the value of onlyOtherSide is "false" or DocumentMasters if the value is "true".
WTKeyedMap	navigateReferences(WTCollection documents, QuerySpec querySpec, boolean onlyOtherSide) For the given WTCollection of EPMDocuments, navigates the REFERENCES role of the EPMReferenceLink and returns a WTKeyedMap whose values are WTSets of EPMReferenceLinks or DocumentMasters depending upon the value of the onlyOtherSide flag.
QueryResult	navigateReferencesToIteration(EPMDocument document, QuerySpec querySpec, boolean onlyOtherSide, ConfigSpec configSpec) Navigates the REFERENCES role of the EPMReferenceLink and finds the appropriate iterations for the DocumentMasters by applying the configSpec.
EPMRecursiveResultSet	navigateReferencesToIteration(EPMDocument document, QuerySpec querySpec, boolean onlyOtherSide, ConfigSpec configSpec, int depth) Navigate the REFERENCES role of the EPMReferenceLink and finds the appropriate iterations for those DocumentMasters by applying the configSpec.
QueryResult	navigateReferencesToIteration(EPMDocument document, QuerySpec querySpec, ConfigSpec configSpec) Deprecated. at R6.2, please use navigateReferencesToIteration(EPMDocument, QuerySpec, boolean, ConfigSpec)
EPMRecursiveResultSet	navigateReferencesToIteration(EPMDocument document, QuerySpec querySpec, ConfigSpec configSpec, int depth) Deprecated. at R6.2, please use navigateReferencesToIteration(EPMDocument, QuerySpec, boolean, ConfigSpec, int)
WTKeyedMap	navigateReferencesToIteration(WTCollection documents, QuerySpec querySpec, boolean onlyOtherSide, ConfigSpec configSpec) For the given WTCollection of EPMDocuments, navigates the REFERENCES role of the EPMReferenceLink and finds the appropriate iteration for each other-side DocumentMaster by applying the config spec.
QueryResult	navigateToIteration(QueryResult objects, Class linkClass, String otherSideRole, QuerySpec querySpec, boolean onlyOtherSide, ConfigSpec configSpec) Navigates the links of the specified class to Iterated objects from the supplied Persistable objects and finds the appropriate Iterated objects by applying the configSpec.
QueryResult	navigateUsedBy(EPMDocumentMaster master, QuerySpec querySpec) Deprecated. at R6.2, please use navigateUsedBy(EPMDocumentMaster, QuerySpec, boolean)
QueryResult	navigateUsedBy(EPMDocumentMaster master, QuerySpec querySpec, boolean onlyOtherSide) Navigates the USED_BY role of the EPMMemberLink and returns a QueryResult of EPMMemberLinks if the value of onlyOtherSide is "false" or EPMDocuments if the value is "true".
WTKeyedMap	navigateUsedBy(WTCollection masters, QuerySpec querySpec, boolean onlyOtherSide) For the given WTCollection of EPMDocumentMasters, navigates the USED_BY role of the EPMMemberLink and returns a WTKeyedMap whose values are WTSets of EPMMemberLinks or EPMDocuments depending upon the value of the onlyOtherSide flag.
QueryResult	navigateUses(EPMDocument document, QuerySpec querySpec) Deprecated. at R6.2, please use navigateUses(EPMDocument, QuerySpec, boolean)
QueryResult	navigateUses(EPMDocument document, QuerySpec querySpec, boolean onlyOtherSide) Navigates the USES role of the EPMMemberLink, returning a QueryResult of EPMMemberLinks if onlyOtherSide is "false" or EPMDocumentMasters if onlyOtherSide is "true".
WTKeyedMap	navigateUses(WTCollection documents, QuerySpec querySpec, boolean onlyOtherSide) For the given WTCollection of EPMDocuments, navigates the USES role of the EPMMemberLink and returns a WTKeyedMap whose values are WTSets of EPMMemberLinks or EPMDocumentMasters depending upon the value of the onlyOtherSide flag.
QueryResult	navigateUsesToIteration(EPMDocument document, QuerySpec querySpec, boolean onlyOtherSide, ConfigSpec configSpec) Navigate the USES role of the EPMMemberLink and finds the appropriate iterations for those EPMDocumentMasters by applying the configSpec.
EPMRecursiveResultSet	navigateUsesToIteration(EPMDocument document, QuerySpec querySpec, boolean onlyOtherSide, ConfigSpec configSpec, int depth) Navigate the USES role of the EPMMemberLink and finds the appropriate iterations for those EPMDocumentMasters by applying the configSpec.
QueryResult	navigateUsesToIteration(EPMDocument document, QuerySpec querySpec, ConfigSpec configSpec) Deprecated. at R6.2, please use navigateUsesToIteration(EPMDocument, QuerySpec, boolean, ConfigSpec)
EPMRecursiveResultSet	navigateUsesToIteration(EPMDocument document, QuerySpec querySpec, ConfigSpec configSpec, int depth) Deprecated. at R6.2, please use navigateUsesToIteration(EPMDocument, QuerySpec, boolean, ConfigSpec, int)
WTKeyedMap	navigateUsesToIteration(WTCollection documents, QuerySpec querySpec, boolean onlyOtherSide, ConfigSpec configSpec) For the given WTCollection of EPMDocuments, navigates the USES role of the EPMMemberLink and finds the appropriate iteration for each other-side EPMDocumentMaster by applying the config spec.
QueryResult	navigateVariant(EPMDocumentMaster genericMaster, QuerySpec querySpec, boolean onlyOtherSide) Navigates the VARIANT role of the EPMVariantLink.
WTKeyedMap	navigateVariant(WTCollection masters, QuerySpec querySpec, boolean onlyOtherSide) For the given WTCollection of EPMDocumentMasters, navigates the VARIANT role of the EPMVariantLink and returns a WTKeyedMap whose values are WTSets of EPMVariantLinks or EPMDocuments depending upon the value of the onlyOtherSide flag.

Method Detail

navigateUses

public QueryResult navigateUses(EPMDocument document,
                                QuerySpec querySpec)
                         throws WTException

Deprecated. at R6.2, please use navigateUses(EPMDocument, QuerySpec, boolean)

Navigates the uses role of the EPMMemberLink, returning a QueryResult of EPMDocumentMasters.

Supported API: false

Parameters:

document - The document USED_BY the link.

querySpec - null or a QuerySpec that specifies additional criteria for selecting the links

Returns:

QueryResult

Throws:

WTException

navigateUses

public QueryResult navigateUses(EPMDocument document,
                                QuerySpec querySpec,
                                boolean onlyOtherSide)
                         throws WTException

Navigates the USES role of the EPMMemberLink, returning a QueryResult of EPMMemberLinks if onlyOtherSide is "false" or EPMDocumentMasters if onlyOtherSide is "true".

Supported API: true

Parameters:

document - The document USED_BY the link.

querySpec - null or a QuerySpec that specifies additional criteria for selecting the links

onlyOtherSide - Indicates whether to return only the objects on the other side of the association. If true return a QueryResult of EPMDocumentMasters otherwise return a QueryResult of EPMMemberLinks.

Returns:

QueryResult

Throws:

WTException

navigateUses

public WTKeyedMap navigateUses(WTCollection documents,
                               QuerySpec querySpec,
                               boolean onlyOtherSide)
                        throws WTException

For the given WTCollection of EPMDocuments, navigates the USES role of the EPMMemberLink and returns a WTKeyedMap whose values are WTSets of EPMMemberLinks or EPMDocumentMasters depending upon the value of the onlyOtherSide flag.

Supported API: true

Parameters:

documents - EPMDocuments that USE other EPMDocumentMasters

querySpec - null or a QuerySpec that specifies additional criteria for selecting the links

onlyOtherSide - Indicates whether to return the links or the other-side objects. If true return a WTKeyedMap whose values are WTSets of EPMDocumentMasters. If false, the values are WTSets of EPMMemberLinks.

Returns:

WTKeyedMap

Throws:

WTException

navigateUsedBy

public QueryResult navigateUsedBy(EPMDocumentMaster master,
                                  QuerySpec querySpec)
                           throws WTException

Deprecated. at R6.2, please use navigateUsedBy(EPMDocumentMaster, QuerySpec, boolean)

Navigates the USED_BY role of the EPMMemberLink and returns a QueryResult of EPMDocuments.

Supported API: false

Parameters:

master - The EPMDocumentMaster that the link USES.

querySpec - null or a QuerySpec that specifies additional criteria for selecting the links

Returns:

QueryResult

Throws:

WTException

navigateUsedBy

public QueryResult navigateUsedBy(EPMDocumentMaster master,
                                  QuerySpec querySpec,
                                  boolean onlyOtherSide)
                           throws WTException

Navigates the USED_BY role of the EPMMemberLink and returns a QueryResult of EPMMemberLinks if the value of onlyOtherSide is "false" or EPMDocuments if the value is "true".

Supported API: true

Parameters:

master - The EPMDocumentMaster that the link USES.

querySpec - null or a QuerySpec that specifies additional criteria for selecting the links

onlyOtherSide - Indicates whether to return only the objects on the other side of the association. If true, return a QueryResult of EPMDocuments otherwise return a QueryResult of EPMMemberLinks.

Returns:

QueryResult

Throws:

WTException

navigateUsedBy

public WTKeyedMap navigateUsedBy(WTCollection masters,
                                 QuerySpec querySpec,
                                 boolean onlyOtherSide)
                          throws WTException

For the given WTCollection of EPMDocumentMasters, navigates the USED_BY role of the EPMMemberLink and returns a WTKeyedMap whose values are WTSets of EPMMemberLinks or EPMDocuments depending upon the value of the onlyOtherSide flag.

Supported API: true

Parameters:

masters - EPMDocumentMasters that are USED_BY other EPMDocuments

querySpec - null or a QuerySpec that specifies additional criteria for selecting the links

onlyOtherSide - Indicates whether to return the links or the other-side objects. If true return a WTKeyedMap whose values are WTSets of EPMDocuments. If false, the values are WTSets of EPMMemberLinks.

Returns:

WTKeyedMap

Throws:

WTException

navigateUsesToIteration

public QueryResult navigateUsesToIteration(EPMDocument document,
                                           QuerySpec querySpec,
                                           ConfigSpec configSpec)
                                    throws WTException,
                                           ConfigException

Deprecated. at R6.2, please use navigateUsesToIteration(EPMDocument, QuerySpec, boolean, ConfigSpec)

Navigates the USES role of the EPMMemberLink and finds the appropriate iterations for the EPMDocumentMasters by applying the configSpec. Returns a QueryResult of those EPMDocuments that match as well as EPMDocumentMasters for which there were no matching iterations.

Supported API: false

Parameters:

document - The document USED_BY the link.

querySpec - null or a QuerySpec that specifies additional criteria for selecting the links

configSpec -

Returns:

QueryResult

Throws:

WTException

ConfigException

navigateUsesToIteration

public QueryResult navigateUsesToIteration(EPMDocument document,
                                           QuerySpec querySpec,
                                           boolean onlyOtherSide,
                                           ConfigSpec configSpec)
                                    throws WTException,
                                           ConfigException

Navigate the USES role of the EPMMemberLink and finds the appropriate iterations for those EPMDocumentMasters by applying the configSpec.

If onlyOtherSide is "true", this method returns a QueryResult of EPMDocuments and EPMDocumentMasters. An EPMDocumentMaster is returned when none of its iterations match the configSpec criteria.

If onlyOtherSide is "false", returns a QueryResult of Persistable[] in which the 0th Persistable in the array is the EPMMemberLink and the 1th position is the matching EPMDocument or EPMDocumentMaster when none of its iterations match the configSpec criteria.

Supported API: true

Parameters:

document - The document USED_BY the link.

querySpec - null or a QuerySpec that specifies additional criteria for selecting the links

onlyOtherSide - If onlyOtherSide is "true", returns a QueryResult of EPMDocuments and EPMDocumentMasters. An EPMDocumentMaster is returned when none of its iteration match the ConfigSpec. If "false", returns a QueryResult of Persistable[] in which the 0th Persistable in the array is the EPMMemberLink and the 1th position is the matching EPMDocument or EPMDocumentMaster.

configSpec -

Returns:

QueryResult

Throws:

WTException

ConfigException

navigateUsesToIteration

public WTKeyedMap navigateUsesToIteration(WTCollection documents,
                                          QuerySpec querySpec,
                                          boolean onlyOtherSide,
                                          ConfigSpec configSpec)
                                   throws WTException

For the given WTCollection of EPMDocuments, navigates the USES role of the EPMMemberLink and finds the appropriate iteration for each other-side EPMDocumentMaster by applying the config spec.

This method returns a WTKeyedMap. If onlyOtherSide is "true", the values are WTSets of EPMDocuments and possibly EPMDocumentMasters. If onlyOtherSide is "false", the values are Lists of two-element Persistable arrays where the first element is an EPMMemberLink and the second element is either an EPMDocument or possibly an EPMDocumentMaster. An EPMDocumentMaster is returned when none of its iterations match the config spec criteria.

Supported API: true

Parameters:

documents - EPMDocuments that USE other EPMDocumentMasters

querySpec - null or a QuerySpec that specifies additional criteria for selecting the links

onlyOtherSide - Indicates whether to return the config spec selected iterations of the other-side EPMDocumentMasters or the EPMMemberLinks paired with the selected iterations . If true, the values of the WTKeyedMap are WTSets of EPMDocuments. If false, the values are Lists of two-element Persistable arrays.

configSpec - config spec that selects the appropriate iteration of each other-side master

Returns:

WTKeyedMap

Throws:

WTException

navigateReferences

public QueryResult navigateReferences(EPMDocument document,
                                      QuerySpec querySpec)
                               throws WTException

Deprecated. at R6.2, please use navigateReferences(EPMDocument, QuerySpec, boolean)

Navigates the REFERENCES role of the EPMReferenceLink, returning a QueryResult of DocumentMasters.

Supported API: false

Parameters:

document - The document REFERENCED_BY the link.

querySpec - null or a QuerySpec that specifies additional criteria for selecting the links

Returns:

QueryResult

Throws:

WTException

navigateReferences

public QueryResult navigateReferences(EPMDocument document,
                                      QuerySpec querySpec,
                                      boolean onlyOtherSide)
                               throws WTException

Navigates the REFERENCES role of the EPMReferenceLink, returning a QueryResult of EPMReferenceLinks if the value of onlyOtherSide is "false" or DocumentMasters if the value is "true".

Supported API: true

Parameters:

document - The document USED_BY the link.

querySpec - null or a QuerySpec that specifies additional criteria for selecting the links

onlyOtherSide - Indicates whether to return only the objects on the other side of the association. If true return a QueryResult of DocumentMasters otherwise return a QueryResult of EPMReferenceLinks.

Returns:

QueryResult

Throws:

WTException

navigateReferences

public WTKeyedMap navigateReferences(WTCollection documents,
                                     QuerySpec querySpec,
                                     boolean onlyOtherSide)
                              throws WTException

For the given WTCollection of EPMDocuments, navigates the REFERENCES role of the EPMReferenceLink and returns a WTKeyedMap whose values are WTSets of EPMReferenceLinks or DocumentMasters depending upon the value of the onlyOtherSide flag.

Supported API: true

Parameters:

documents - EPMDocuments that REFERENCE other EPMDocumentMasters

querySpec - null or a QuerySpec that specifies additional criteria for selecting the links

onlyOtherSide - Indicates whether to return the links or the other-side objects. If true return a WTKeyedMap whose values are WTSets of DocumentMasters. If false, the values are WTSets of EPMReferenceLinks.

Returns:

WTKeyedMap

Throws:

WTException

navigateReferencedBy

public QueryResult navigateReferencedBy(DocumentMaster master,
                                        QuerySpec querySpec)
                                 throws WTException

Deprecated. at R6.2, please use navigateReferencedBy(EPMDocumentMaster, QuerySpec, boolean)

Navigates the REFERENCED_BY role of the EPMReferenceLink and returns a QueryResult of all EPMDocuments that reference this DocumentMaster.

Supported API: false

Parameters:

master - The DocumentMaster that the link REFERENCES.

querySpec - null or a QuerySpec that specifies additional criteria for selecting the links

Returns:

QueryResult

Throws:

WTException

navigateReferencedBy

public QueryResult navigateReferencedBy(DocumentMaster master,
                                        QuerySpec querySpec,
                                        boolean onlyOtherSide)
                                 throws WTException

Navigates the REFERENCED_BY role of the EPMReferenceLink and returns a QueryResult of EPMReferenceLinks if the value of onlyOtherSide is "false" or EPMDocuments if the value is "true".

Supported API: true

Parameters:

master - The DocumentMaster that the link REFERENCES.

querySpec - null or a QuerySpec that specifies additional criteria for selecting the links

onlyOtherSide - Indicates whether to return only the objects on the other side of the association. If true, return a QueryResult of EPMDocuments otherwise return a QueryResult of EPMReferenceLinks.

Returns:

QueryResult

Throws:

WTException

navigateReferencedBy

public WTKeyedMap navigateReferencedBy(WTCollection masters,
                                       QuerySpec querySpec,
                                       boolean onlyOtherSide)
                                throws WTException

For the given WTCollection of DocumentMasters, navigates the REFERENCED_BY role of the EPMReferenceLink and returns a WTKeyedMap whose values are WTSets of EPMReferenceLinks or EPMDocuments depending upon the value of the onlyOtherSide flag.

Supported API: true

Parameters:

masters - DocumentMasters that are REFERENCED_BY other EPMDocuments

querySpec - null or a QuerySpec that specifies additional criteria for selecting the links

onlyOtherSide - Indicates whether to return the links or the other-side objects. If true return a WTKeyedMap whose values are WTSets of EPMDocuments. If false, the values are WTSets of EPMReferenceLinks.

Returns:

WTKeyedMap

Throws:

WTException

navigateReferencesToIteration

public QueryResult navigateReferencesToIteration(EPMDocument document,
                                                 QuerySpec querySpec,
                                                 ConfigSpec configSpec)
                                          throws WTException,
                                                 ConfigException

Deprecated. at R6.2, please use navigateReferencesToIteration(EPMDocument, QuerySpec, boolean, ConfigSpec)

Navigates the REFERENCES role of the EPMReferenceLink and finds the appropriate iterations for the DocumentMasters by applying the configSpec. Returns a QueryResult of those iterations that match as well as the DocumentMasters for which there were no matching iterations.

Supported API: false

Parameters:

document - The document REFERENCED_BY the link.

querySpec - null or a QuerySpec that specifies additional criteria for selecting the links

configSpec -

Returns:

QueryResult

Throws:

WTException

ConfigException

navigateReferencesToIteration

public QueryResult navigateReferencesToIteration(EPMDocument document,
                                                 QuerySpec querySpec,
                                                 boolean onlyOtherSide,
                                                 ConfigSpec configSpec)
                                          throws WTException,
                                                 ConfigException

Navigates the REFERENCES role of the EPMReferenceLink and finds the appropriate iterations for the DocumentMasters by applying the configSpec.

If onlyOtherSide is "true", this method returns a QueryResult of DocumentMaster iterations and DocumentMasters. A DocumentMaster is returned when none of its iteration match the configSpec. If "false", returns a QueryResult of Persistable[] in which the 0th Persistable in the array is the EPMReferenceLink and the 1th position is the matching DocumentMaster iteration or DocumentMaster.

Supported API: true

Parameters:

document - The document USED_BY the link.

querySpec - null or a QuerySpec that specifies additional criteria for selecting the links

onlyOtherSide - If onlyOtherSide is "true", this method returns a QueryResult of DocumentMaster iterations and DocumentMaster objects. A DocumentMastered is returned when none of its iteration match the configSpec. If "false", returns a QueryResult of Persistable[] in which the 0th Persistable in the array is the EPMReferenceLink and the 1th position is the matching DocumentMaster iteration or DocumentMaster object.

configSpec -

Returns:

QueryResult

Throws:

WTException

ConfigException

navigateReferencesToIteration

public WTKeyedMap navigateReferencesToIteration(WTCollection documents,
                                                QuerySpec querySpec,
                                                boolean onlyOtherSide,
                                                ConfigSpec configSpec)
                                         throws WTException

For the given WTCollection of EPMDocuments, navigates the REFERENCES role of the EPMReferenceLink and finds the appropriate iteration for each other-side DocumentMaster by applying the config spec.

This method returns a WTKeyedMap. If onlyOtherSide is "true", the values are WTSets of Documents and possibly DocumentMasters. If onlyOtherSide is "false", the values are Lists of two-element Persistable arrays where the first element is an EPMReferenceLink and the second element is either a Document or possibly a DocumentMaster. A DocumentMaster is returned when none of its iterations match the config spec criteria.

Supported API: true

Parameters:

documents - EPMDocuments that USE other EPMDocumentMasters

querySpec - null or a QuerySpec that specifies additional criteria for selecting the links

onlyOtherSide - Indicates whether to return the config spec selected iterations of the other-side DocumentMasters or the EPMReferenceLinks paired with the selected iterations . If true, the values of the WTKeyedMap are WTSets of Documents. If false, the values are Lists of two-element Persistable arrays.

configSpec - config spec that selects the appropriate iteration of each other-side master

Returns:

WTKeyedMap

Throws:

WTException

navigateUsesToIteration

public EPMRecursiveResultSet navigateUsesToIteration(EPMDocument document,
                                                     QuerySpec querySpec,
                                                     ConfigSpec configSpec,
                                                     int depth)
                                              throws WTException,
                                                     ConfigException

Deprecated. at R6.2, please use navigateUsesToIteration(EPMDocument, QuerySpec, boolean, ConfigSpec, int)

Navigates the USES role of the EPMMemberLink and finds the appropriate iterations for the EPMDocumentMasters by applying the configSpec. Returns a EPMRecursiveResultSet of those EPMDocuments that match the configSpec criteria as well as EPMDocumentMasters for which there were no matching iterations.

Supported API: false

Parameters:

document - The EPMDocument USED_BY the link.

querySpec - null or a QuerySpec that specifies additional criteria for selecting the links

configSpec -

depth - Number of levels to recursive traverse

Returns:

EPMRecursiveResultSet

Throws:

WTException

ConfigException

navigateUsesToIteration

public EPMRecursiveResultSet navigateUsesToIteration(EPMDocument document,
                                                     QuerySpec querySpec,
                                                     boolean onlyOtherSide,
                                                     ConfigSpec configSpec,
                                                     int depth)
                                              throws WTException,
                                                     ConfigException

Navigate the USES role of the EPMMemberLink and finds the appropriate iterations for those EPMDocumentMasters by applying the configSpec.

If onlyOtherSide is true, the EPMRecursiveResultSet returned will not contain infomation about the EPMMemberLinks otherwise it will.

Supported API: true

Parameters:

document - The document USED_BY the link.

querySpec - null or a QuerySpec that specifies additional criteria for selecting the links

onlyOtherSide - If "true", the EPMRecursiveResultSet returned will not contain any information about the EPMMemberLinks otherwise it will.

configSpec -

depth -

Returns:

EPMRecursiveResultSet

Throws:

WTException

ConfigException

navigateReferencesToIteration

public EPMRecursiveResultSet navigateReferencesToIteration(EPMDocument document,
                                                           QuerySpec querySpec,
                                                           ConfigSpec configSpec,
                                                           int depth)
                                                    throws WTException,
                                                           ConfigException

Deprecated. at R6.2, please use navigateReferencesToIteration(EPMDocument, QuerySpec, boolean, ConfigSpec, int)

Navigates the REFERENCES role of the EPMReferenceLink and finds the appropriate iterations for the DocumentMasters by applying the configSpec. It returns an EPMRecursiveResultSet of those iterations that match as well as the DocumentMaster for which there were no matching iterations.

Supported API: false

Parameters:

document - The document USED_BY the link.

querySpec - null or a QuerySpec that specifies additional criteria for selecting the links

configSpec -

depth -

Returns:

EPMRecursiveResultSet

Throws:

WTException

ConfigException

navigateReferencesToIteration

public EPMRecursiveResultSet navigateReferencesToIteration(EPMDocument document,
                                                           QuerySpec querySpec,
                                                           boolean onlyOtherSide,
                                                           ConfigSpec configSpec,
                                                           int depth)
                                                    throws WTException,
                                                           ConfigException

Navigate the REFERENCES role of the EPMReferenceLink and finds the appropriate iterations for those DocumentMasters by applying the configSpec.

If onlyOtherSide is true, this method returns a EPMRecursiveResultSet that does not contain infomation about the EPMReferenceLinks otherwise it does.

Supported API: true

Parameters:

document - The document USED_BY the link.

querySpec - null or a QuerySpec that specifies additional criteria for selecting the links

onlyOtherSide - If true, the EPMRecursiveResultSet returned will not contain infomation about the EPMReferenceLinks otherwise it will.

configSpec -

depth -

Returns:

EPMRecursiveResultSet

Throws:

WTException

ConfigException

navigateGeneric

public QueryResult navigateGeneric(EPMDocument variant,
                                   QuerySpec querySpec,
                                   boolean onlyOtherSide)
                            throws WTException

Navigates the GENERIC role of the EPM Variant Link.

If onlyOtherSide is true, it returns a QueryResult that holds the Master of the EPM Document that is the generic for this variant. If onlyOtherSide is false, it returns a QueryResult that holds the EPM Variant link to the generic.

Supported API: true

Parameters:

variant -

querySpec - null or a QuerySpec that specifies additional criteria for selecting the links

onlyOtherSide - Indicates whether to return only the objects on the other side of the association. If true return a QueryResult of EPMDocumentMasters otherwise return a QueryResult of EPMVariantLinks.

Returns:

QueryResult

Throws:

WTException

navigateGeneric

public WTKeyedMap navigateGeneric(WTCollection variants,
                                  QuerySpec querySpec,
                                  boolean onlyOtherSide)
                           throws WTException

For the given WTCollection of EPMDocuments, navigates the GENERIC role of the EPMVariantLink and returns a WTKeyedMap whose values are WTSets of EPMVariantLinks or EPMDocumentMasters depending upon the value of the onlyOtherSide flag.

Supported API: true

Parameters:

variants - EPMDocuments that are variants of other EPMDocumentMasters

querySpec - null or a QuerySpec that specifies additional criteria for selecting the links

onlyOtherSide - Indicates whether to return the links or the other-side objects. If true return a WTKeyedMap whose values are WTSets of EPMDocumentMasters. If false, the values are WTSets of EPMVariantLinks.

Returns:

WTKeyedMap

Throws:

WTException

navigateGenericToIteration

public QueryResult navigateGenericToIteration(EPMDocument variant,
                                              QuerySpec querySpec,
                                              boolean onlyOtherSide,
                                              ConfigSpec configSpec)
                                       throws WTException,
                                              ConfigException

Navigates the GENERIC role of the EPMVariantLink and finds the appropriate iteration of the generic for this variant by applying the configSpec.

If onlyOtherSide is true, it returns a QueryResult that holds the EPMDocument that is the generic for this variant. An EPMDocumentMaster is returned when none of the iterations of the generic match the configSpec criteria.

If onlyOtherSide is false, it returns a QueryResult of Persistable[] in which the first Persistable in the array is the EPMVariantLink and the second is the matching EPMDocument or EPMDocumentMaster when none of its iterations match the configSpec criteria.

Supported API: true

Parameters:

variant -

querySpec - null or a QuerySpec that specifies additional criteria for selecting the links

onlyOtherSide - If onlyOtherSide is "true", returns a QueryResult of EPMDocuments and EPMDocumentMasters. An EPMDocumentMaster is returned when none of its iteration match the ConfigSpec. If "false", returns a QueryResult of Persistable[] in which the 0th Persistable in the array is the EPMVariantLink and the 1th position is the matching EPMDocument or EPMDocumentMaster.

configSpec -

Returns:

QueryResult

Throws:

WTException

ConfigException

navigateGenericToIteration

public WTKeyedMap navigateGenericToIteration(WTCollection variants,
                                             QuerySpec querySpec,
                                             boolean onlyOtherSide,
                                             ConfigSpec configSpec)
                                      throws WTException

For the given WTCollection of EPMDocuments, navigates the GENERIC role of the EPMVariantLink and finds the appropriate iteration for each other-side EPMDocumentMaster by applying the config spec.

This method returns a WTKeyedMap. If onlyOtherSide is "true", the values are WTSets of EPMDocuments and possibly EPMDocumentMasters. If onlyOtherSide is "false", the values are Lists of two-element Persistable arrays where the first element is an EPMVariantLink and the second element is either an EPMDocument or possibly an EPMDocumentMaster. An EPMDocumentMaster is returned when none of its iterations match the config spec criteria.

Supported API: true

Parameters:

variants - EPMDocuments that are variants of other EPMDocumentMasters

querySpec - null or a QuerySpec that specifies additional criteria for selecting the links

onlyOtherSide - Indicates whether to return the config spec selected iterations of the other-side EPMDocumentMasters or the EPMVariantLinks paired with the selected iterations . If true, the values of the WTKeyedMap are WTSets of EPMDocuments. If false, the values are Lists of two-element Persistable arrays.

configSpec - config spec that selects the appropriate iteration of each other-side master

Returns:

WTKeyedMap

Throws:

WTException

navigateVariant

public QueryResult navigateVariant(EPMDocumentMaster genericMaster,
                                   QuerySpec querySpec,
                                   boolean onlyOtherSide)
                            throws WTException

Navigates the VARIANT role of the EPMVariantLink.

If onlyOtherSide is true, it returns a QueryResult of all EPMDocuments that are variants of this generic. If onlyOtherSide is false, it returns a QueryResult of all EPMVariantLinks to those EPMDocuments.

Supported API: true

Parameters:

genericMaster -

querySpec - null or a QuerySpec that specifies additional criteria for selecting the links

onlyOtherSide - Indicates whether to return only the objects on the other side of the association. If true, return a QueryResult of EPMDocuments otherwise return a QueryResult of EPMVariantLinks.

Returns:

QueryResult

Throws:

WTException

navigateVariant

public WTKeyedMap navigateVariant(WTCollection masters,
                                  QuerySpec querySpec,
                                  boolean onlyOtherSide)
                           throws WTException

For the given WTCollection of EPMDocumentMasters, navigates the VARIANT role of the EPMVariantLink and returns a WTKeyedMap whose values are WTSets of EPMVariantLinks or EPMDocuments depending upon the value of the onlyOtherSide flag.

Supported API: true

Parameters:

masters - EPMDocumentMasters whose iterations are generics for other EPMDocuments

querySpec - null or a QuerySpec that specifies additional criteria for selecting the links

onlyOtherSide - Indicates whether to return the links or the other-side objects. If true return a WTKeyedMap whose values are WTSets of EPMDocuments. If false, the values are WTSets of EPMVariantLinks.

Returns:

WTKeyedMap

Throws:

WTException

navigateContains

public QueryResult navigateContains(EPMFamilyTable container,
                                    QuerySpec querySpec,
                                    boolean onlyOtherSide)
                             throws WTException

Navigates the CONTAINS role of an EPMContainedInLink.

If onlyOtherSide is true, it returns a QueryResult that holds all EPMDocuments that represent an object that is contained in the CAD file that belongs to the "container" EPMFamilyTable.

If onlyOtherSide is false, it returns a QueryResult that holds the EPMContainedInLinks to those EPMDocuments.

Supported API: true

Parameters:

container - an EPMFamilyTable that holds a CAD file that exposes objects "contained in it" as separate EPMDocuments

querySpec - null or a QuerySpec that specifies additional criteria for selecting the links

onlyOtherSide - Indicates whether to return only the objects on the other side of the association. If true return a QueryResult of EPMDocuments otherwise return a QueryResult of EPMContainedInLinks.

Returns:

QueryResult

Throws:

WTException

navigateContains

public WTKeyedMap navigateContains(WTCollection familyTables,
                                   QuerySpec querySpec,
                                   boolean onlyOtherSide)
                            throws WTException

For the given WTCollection of EPMFamilyTables, navigates the CONTAINS role of the EPMContainedIn link and returns a WTKeyedMap whose values are WTSets of EPMContainedIn links or EPMDocuments depending upon the value of the onlyOtherSide flag.

Supported API: true

Parameters:

familyTables - EPMFamilyTables that holds CAD files that expose objects "contained in it" as separate EPMDocuments

querySpec - null or a QuerySpec that specifies additional criteria for selecting the links

onlyOtherSide - Indicates whether to return the links or the other-side objects. If true return a WTKeyedMap whose values are WTSets of EPMDocuments. If false, the values are WTSets of EPMContainedIn links.

Returns:

WTKeyedMap

Throws:

WTException

navigateContains

public QueryResult navigateContains(EPMFamilyTable container,
                                    QuerySpec querySpec,
                                    boolean onlyOtherSide,
                                    ConfigSpec configSpec)
                             throws WTException,
                                    ConfigException

Deprecated.

Navigates the CONTAINS role of the EPMContainedInLink and finds the appropriate iterations of the "contained" EPM documents by applying the configSpec. If none of the iterations of a particular "contained" document match the selection criteria of the configSpec, its master is returned instead.

If onlyOtherSide is true, it returns a QueryResult of all iterations of all "contained" EPM documents selected by the configSpec. If no iterations of a particular "contained" document were selected, its master is returned instead.

If onlyOtherSide is false, it returns a QueryResult of Persistable[] in which the first element in the array is the EPMContainedInLink and the second is the matching EPMDocument selected by the configSpec. For a particular "contained" document, if none of its iterations were selected by the configSpec, the first element in the array will be null and the second will be its master.

Supported API: true

Parameters:

container - an EPMFamilyTable that holds a CAD file that exposes objects "contained in it" as separate EPMDocuments

querySpec - null or a QuerySpec that specifies additional criteria for selecting the links

onlyOtherSide - If onlyOtherSide is "true", returns a QueryResult of EPMDocuments and EPMDocumentMasters. An EPMDocumentMaster is returned when none of its iteration match the ConfigSpec. If "false", returns a QueryResult of Persistable[] in which the 0th Persistable in the array is the EPMContainedInLink or null and the 1th position is the matching EPMDocument or EPMDocumentMaster.

configSpec -

Returns:

QueryResult

Throws:

WTException

ConfigException

navigateContainedIn

public QueryResult navigateContainedIn(EPMDocument contained,
                                       QuerySpec querySpec,
                                       boolean onlyOtherSide)
                                throws WTException

Navigates the CONTAINED_IN role of an EPMContainedInLink.

If onlyOtherSide is true, it returns a QueryResult that holds all iterations of the "container" EPMFamilyTable that the object represented by the "contained" EPMDocument is found in.

If onlyOtherSide is false, it returns a QueryResult that holds the EPMContainedInLinks to those EPMFamilyTables.

Supported API: true

Parameters:

contained - an EPMDocument that represents an object that is "contained in" a CAD file that belongs to another EPMFamilyTable

querySpec - null or a QuerySpec that specifies additional criteria for selecting the links

onlyOtherSide - Indicates whether to return only the objects on the other side of the association. If true, return a QueryResult of EPMDocuments otherwise return a QueryResult of EPMContainedInLinks.

Returns:

QueryResult

Throws:

WTException

navigateContainedIn

public WTKeyedMap navigateContainedIn(WTCollection documents,
                                      QuerySpec querySpec,
                                      boolean onlyOtherSide)
                               throws WTException

For the given WTCollection of EPMDocuments, navigates the CONTAINED_IN role of the EPMContainedIn link and returns a WTKeyedMap whose values are WTSets of EPMContainedIn links or EPMFamilyTables depending upon the value of the onlyOtherSide flag.

Supported API: true

Parameters:

documents - EPMDocuments whose CAD definition is "contained in" an EPMFamilyTable

querySpec - null or a QuerySpec that specifies additional criteria for selecting the links

onlyOtherSide - Indicates whether to return the links or the other-side objects. If true return a WTKeyedMap whose values are WTSets of EPMFamilyTables. If false, the values are WTSets of EPMContainedIn links.

Returns:

WTKeyedMap

Throws:

WTException

navigateContainedIn

public QueryResult navigateContainedIn(EPMDocument contained,
                                       QuerySpec querySpec,
                                       boolean onlyOtherSide,
                                       ConfigSpec configSpec)
                                throws WTException,
                                       ConfigException

Navigates the CONTAINED_IN role of the EPMContainedInLink and finds the appropriate iterations of the "container" EPM family table by applying the configSpec. If none of the iterations of the "container" document match the selection criteria of configSpec, its master is returned instead.

If onlyOtherSide is true, it returns a QueryResult of all iterations of the "container" EPM family table selected by the configSpec. If none were selected, its master is returned instead.

If onlyOtherSide is false, it returns a QueryResult of Persistable[] in which the first element in the array is the EPMContainedInLink and the second is the matching EPMFamilyTAble selected by the configSpec. If none of the iterations of "container" document match the selection criteria of the configSpec, the first element in the array will be null and the second will be the master of the "container" EPM document.

Supported API: true

Parameters:

contained - an EPMDocument that represents an object that is "contained in" a CAD file that belongs to another EPMDocument

querySpec - null or a QuerySpec that specifies additional criteria for selecting the links

onlyOtherSide - If onlyOtherSide is "true", returns a QueryResult of EPMDocuments and EPMDocumentMasters. An EPMDocumentMaster is returned when none of its iteration match the ConfigSpec. If "false", returns a QueryResult of Persistable[] in which the 0th Persistable in the array is the EPMContainedInLink or null and the 1th position is the matching EPMDocument or EPMDocumentMaster.

configSpec -

Returns:

QueryResult

Throws:

WTException

ConfigException

navigateBothRoles

public QueryResult navigateBothRoles(EPMDocument document,
                                     Class linkClass)
                              throws WTException

Navigates the both roles of the given link class. Returns a QueryResult of all links of the given class whose RoleA object or RoleB object is the given EPM Document.

Supported API: true

Parameters:

document -

linkClass - link class that implements BinaryLink

Returns:

QueryResult

Throws:

WTException

navigate

public QueryResult navigate(QueryResult objects,
                            Class linkClass,
                            String otherSideRole,
                            QuerySpec querySpec,
                            boolean onlyOtherSide)
                     throws WTException

Navigates the links of the specified class to the given role from the supplied Persistable objects.

If onlyOtherSide is true, it returns a QueryResult that holds the other side objects associated via a link of the specified class with any of the supplied objects. If onlyOtherSide is false, it returns a QueryResult that holds the links of the specified class from all of the supplied objects.

This method navigates the links associated with all of the supplied objects with a single query.

Supported API: false

Parameters:

objects - Persistable objects to navigate from

linkClass - Class of link to navigate

otherSideRole - Role to navigate to

querySpec - null or a QuerySpec that specifies additional criteria for selecting the links

onlyOtherSide - Indicates whether to return the objects on the other side of the association. If true return the other side objects otherwise return links.

Returns:

QueryResult

Throws:

WTException

navigateMasterToIteration

public QueryResult navigateMasterToIteration(QueryResult objects,
                                             Class linkClass,
                                             QuerySpec querySpec,
                                             boolean onlyOtherSide,
                                             ConfigSpec configSpec)
                                      throws WTException

Navigates the links of the specified class to Mastered objects from the supplied Persistable objects and finds the appropriate iterations for those Mastered objects by applying the configSpec.

If onlyOtherSide is true, it returns a QueryResult of the iterations of those Mastered objects and possibly the Mastered objects themselves. A Mastered object is returned when none of its iteration match the configSpec criteria.

If onlyOtherSide is "false", returns a QueryResult of Persistable[] in which the 0th Persistable in the array is the link and the 1th position is the matching iteration of the Mastered object or the Mastered object itself when none of its iterations match the configSpec criteria.

This method navigates the links to Mastered objects from the all of the supplied objects and finds the appropriate iterations for those Mastered objects using two queries.

Supported API: false

Parameters:

objects - Persistable objects to navigate from

linkClass - Class of link to navigate

querySpec - null or a QuerySpec that specifies additional criteria for selecting the links

onlyOtherSide - Indicates whether to return the objects on the other side of the association. If true return the other side objects otherwise return links.

configSpec -

Returns:

QueryResult

Throws:

WTException

navigateToIteration

public QueryResult navigateToIteration(QueryResult objects,
                                       Class linkClass,
                                       String otherSideRole,
                                       QuerySpec querySpec,
                                       boolean onlyOtherSide,
                                       ConfigSpec configSpec)
                                throws WTException

Navigates the links of the specified class to Iterated objects from the supplied Persistable objects and finds the appropriate Iterated objects by applying the configSpec. If none of the Iterated objects match the selection criteria of configSpec, the Master is returned instead.

If onlyOtherSide is false, it returns a QueryResult of Persistable[] in which the first element in the array is the link and the second is the matching Iterated object selected by the configSpec. If none of the Iterated objects match the selection criteria of the configSpec, the first element in the array will be null and the second will be the Master.

This method navigates the links to Iterated objects from all of the supplied objects and finds the appropriate ones by applying the configSpec using two queries.

Supported API: false

Parameters:

objects - Persistable objects to navigate from

linkClass - Class of link to navigate

otherSideRole - Role to navigate to

querySpec - null or a QuerySpec that specifies additional criteria for selecting the links

onlyOtherSide - Indicates whether to return the objects on the other side of the association. If true return the other side objects otherwise return links.

configSpec -

Returns:

QueryResult

Throws:

WTException

navigate

public WTKeyedMap navigate(WTCollection objects,
                           Class linkClass,
                           String otherSideRole,
                           QuerySpec querySpec,
                           boolean onlyOtherSide)
                    throws WTException

Navigates the links of the specified class to the given role from each Persistable in the given WTCollection using a single query. It returns a WTKeyedMap whose values are WTSets of links or other-side objects depending upon the value of the onlyOtherSide flag.

Supported API: false

Parameters:

objects - Persistable objects to navigate from

linkClass - Class of link to navigate

otherSideRole - Role to navigate to

querySpec - null or a QuerySpec that specifies additional criteria for selecting the links

onlyOtherSide - Indicates whether to return the links or the other-side objects. If true return a WTKeyedMap whose values are WTSets of the other-side objects. If false, the values are WTSets of links.

Returns:

WTKeyedMap

Throws:

WTException