Package wt.epm.structure

Interface EPMStructureService

@RemoteInterface
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

Modifier and Type	Method	Description
WTKeyedMap	getEPMMemberLinks(WTCollection usageLinks)	API to get the EPMMemberLinks in document structure for which the given built WTPartUsageLink is addded in products structure.
WTKeyedMap	getImages(WTCollection sources, boolean onlyDirect, boolean navigateRules)	Returns WTKeyedMap with key as source document passed as argument and value as WTCollection of latest compatible images for the source in the key.
WTKeyedMap	navigateBuildRuleSources(WTCollection objects, boolean onlyOtherSide, EPMWorkspace workspace, NavigationCriteria navCriteria)	Navigates the build rules from the input build targets and returns either the build sources or the build rules depending upon whether onlyOtherSide is true or false respectively.
WTKeyedMap	navigateBuildRuleSources(WTCollection objects, boolean onlyOtherSide, EPMWorkspace workspace, NavigationCriteria navCriteria, boolean latestPerVersion)	Navigates the build rules from the input build targets and returns either the build sources or the build rules depending upon whether onlyOtherSide is true or false respectively.
WTKeyedMap	navigateBuildRuleTargets(WTCollection objects, boolean onlyOtherSide, EPMWorkspace workspace, NavigationCriteria navCriteria)	Navigates the build rules from the input build sources and returns either the build targets or the build rules depending upon whether onlyOtherSide is true or false respectively.
WTKeyedMap	navigateBuildRuleTargets(WTCollection objects, boolean onlyOtherSide, EPMWorkspace workspace, NavigationCriteria navCriteria, boolean latestPerVersion)	Navigates the build rules from the input build sources and returns either the build targets or the build rules depending upon whether onlyOtherSide is true or false respectively.
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.
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.
WTKeyedMap	navigateDescribedBy(WTCollection objects, boolean onlyOtherSide, EPMWorkspace workspace, NavigationCriteria navCriteria, boolean latestPerVersion)	Navigates the describes links from the input described objects and returns either the describing objects or the describes links depending upon whether onlyOtherSide is true or false respectively.
WTKeyedMap	navigateDescribes(WTCollection objects, boolean onlyOtherSide, EPMWorkspace workspace, NavigationCriteria navCriteria, boolean latestPerVersion)	Navigates the describes links from the input describing objects and returns either the described objects or the describes links depending upon whether onlyOtherSide is true or false respectively.
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	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, 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.
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	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, 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.
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 Details

navigateUses

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

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

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

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

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

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

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

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

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

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

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

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

navigateGeneric

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

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

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

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

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

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

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

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

navigateContainedIn

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

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

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

getImages

WTKeyedMap getImages(WTCollection sources,
 boolean onlyDirect,
 boolean navigateRules)
              throws WTException

Returns WTKeyedMap with key as source document passed as argument and value as WTCollection of latest compatible images for the source in the key.

Supported API: true

Parameters:

sources - collection of sources

onlyDirect - If onlyDirect is true the only direct images will be returned otherwise all images will be returned.

navigateRules - If navigateRules is true then derived rep rules will be navigated to retrieve images if source do not have derived histories and source is latest iteration

Returns:

WTKeyedMap

Throws:

WTException

getEPMMemberLinks

WTKeyedMap getEPMMemberLinks(WTCollection usageLinks)
                      throws WTException

API to get the EPMMemberLinks in document structure for which the given built WTPartUsageLink is addded in products structure. Returns WTKeyedMap where key is usage link and value is WTCollection of member links from which usage link was built. Memberlinks are from the iteration of CAD Document that originally built the WTPart structure.

Supported API: true

Parameters:

usageLinks - Collection of usage links.

Returns:

WTKeyedMap

Throws:

WTException

navigateBuildRuleSources

WTKeyedMap navigateBuildRuleSources(WTCollection objects,
 boolean onlyOtherSide,
 EPMWorkspace workspace,
 NavigationCriteria navCriteria)
                             throws WTException

Navigates the build rules from the input build targets and returns either the build sources or the build rules depending upon whether onlyOtherSide is true or false respectively.

If the optional workspace is non-null, working copies of build sources in that workspace only (if present) are returned. Otherwise, if working copies of some build sources do not exist or if the latter are not checked out to that workspace, the workspace config spec is used to determine the versions of those build sources.

On the other hand, if the optional navCriteria is non-null, the ConfigSpecs from it are applied to determine the versions of the build sources to be returned. This option is considered only if workspace is null.

Note that this method may return multiple versions of the same build source in case both workspace and navCriteria are null.

If onlyOtherSide is false, the result is a WTKeyedMap of input objects having build rules v/s WTCollections of build rules.

If onlyOtherSide is true, the result is a WTKeyedMap of input objects having build rules v/s WTCollections of build sources.

Supported API: true

Parameters:

objects - Persistable objects (i.e. build targets) to navigate from

onlyOtherSide - Indicates whether to return the objects on the other side of the association. If true return build sources, otherwise return build rules.

workspace - An optional workspace which can be used to filter working copies

navCriteria - Optional NavigationCriteria containing ConfigSpecs

Returns:

WTKeyedMap of input objects having build rules v/s WTCollections of either build rules or build sources depending upon whether onlyOtherSide is false or true respectively

Throws:

WTException

navigateBuildRuleTargets

WTKeyedMap navigateBuildRuleTargets(WTCollection objects,
 boolean onlyOtherSide,
 EPMWorkspace workspace,
 NavigationCriteria navCriteria)
                             throws WTException

Navigates the build rules from the input build sources and returns either the build targets or the build rules depending upon whether onlyOtherSide is true or false respectively.

If the optional workspace is non-null, working copies of build targets in that workspace only (if present) are returned. Otherwise, if working copies of some build targets do not exist or if the latter are not checked out to that workspace, the workspace config spec is used to determine the versions of those build targets.

On the other hand, if the optional navCriteria is non-null, the ConfigSpecs from it are applied to determine the versions of the build targets to be returned. This option is considered only if workspace is null.

Note that this method may return multiple versions of the same build target in case both workspace and navCriteria are null.

If onlyOtherSide is false, the result is a WTKeyedMap of input objects having build rules v/s WTCollections of build rules.

If onlyOtherSide is true, the result is a WTKeyedMap of input objects having build rules v/s WTCollections of build targets.

Supported API: true

Parameters:

objects - Persistable objects (i.e. build sources) to navigate from

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

workspace - An optional workspace which can be used to filter working copies

navCriteria - Optional NavigationCriteria containing ConfigSpecs

Returns:

WTKeyedMap of input objects having build rules v/s WTCollections of either build rules or build targets depending upon whether onlyOtherSide is false or true respectively

Throws:

WTException

navigateBuildRuleSources

WTKeyedMap navigateBuildRuleSources(WTCollection objects,
 boolean onlyOtherSide,
 EPMWorkspace workspace,
 NavigationCriteria navCriteria,
 boolean latestPerVersion)
                             throws WTException

Navigates the build rules from the input build targets and returns either the build sources or the build rules depending upon whether onlyOtherSide is true or false respectively.

If the optional workspace is non-null, working copies of build sources in that workspace only (if present) are returned. Otherwise, if working copies of some build sources do not exist or if the latter are not checked out to that workspace, the workspace config spec is used to determine the versions of those build sources.

On the other hand, if the optional navCriteria is non-null, the ConfigSpecs from it are applied to determine the versions of the build sources to be returned. This option is considered only if workspace is null.

Note that this method returns latest iterations of all versions of the same build source having build rules with the respective build target if latestPerVersion is true. Otherwise, it returns the latest iteration of the latest version of each build source having a build rule with the respective build target. The latest version here is not necessarily always the absolute latest version of the build source but the latest one having a build rule with the build target. This parameter has no effect if either workspace or navCriteria is non-null.

If onlyOtherSide is false, the result is a WTKeyedMap of input objects having build rules v/s WTCollections of build rules.

If onlyOtherSide is true, the result is a WTKeyedMap of input objects having build rules v/s WTCollections of build sources.

Supported API: true

Parameters:

objects - Persistable objects (i.e. build targets) to navigate from

onlyOtherSide - Indicates whether to return the objects on the other side of the association. If true return build sources, otherwise return build rules.

workspace - An optional workspace which can be used to filter working copies

navCriteria - Optional NavigationCriteria containing ConfigSpecs

latestPerVersion - If true, return the latest iteration of each associated version of each build source or the build rule pointing to the latest iteration of each associated version of each build source. If false, return only the latest iteration of the latest associated version of each build source or the build rule pointing to the latest iteration of the latest associated version of each build source. This parameter has no effect if either workspace or navCriteria is non-null.

Returns:

WTKeyedMap of input objects having build rules v/s WTCollections of either build rules or build sources depending upon whether onlyOtherSide is false or true respectively

Throws:

WTException

navigateBuildRuleTargets

WTKeyedMap navigateBuildRuleTargets(WTCollection objects,
 boolean onlyOtherSide,
 EPMWorkspace workspace,
 NavigationCriteria navCriteria,
 boolean latestPerVersion)
                             throws WTException

Navigates the build rules from the input build sources and returns either the build targets or the build rules depending upon whether onlyOtherSide is true or false respectively.

If the optional workspace is non-null, working copies of build targets in that workspace only (if present) are returned. Otherwise, if working copies of some build targets do not exist or if the latter are not checked out to that workspace, the workspace config spec is used to determine the versions of those build targets.

On the other hand, if the optional navCriteria is non-null, the ConfigSpecs from it are applied to determine the versions of the build targets to be returned. This option is considered only if workspace is null.

Note that this method returns latest iterations of all versions of the same build target having build rules with the respective build source if latestPerVersion is true. Otherwise, it returns the latest iteration of the latest version of each build target having a build rule with the respective build source. The latest version here is not necessarily always the absolute latest version of the build target but the latest one having a build rule with the build source. This parameter has no effect if either workspace or navCriteria is non-null.

If onlyOtherSide is false, the result is a WTKeyedMap of input objects having build rules v/s WTCollections of build rules.

If onlyOtherSide is true, the result is a WTKeyedMap of input objects having build rules v/s WTCollections of build targets.

Supported API: true

Parameters:

objects - Persistable objects (i.e. build sources) to navigate from

onlyOtherSide - Indicates whether to return the objects on the other side of the association. If true return build targets, otherwise return build rules.

workspace - An optional workspace which can be used to filter working copies

navCriteria - Optional NavigationCriteria containing ConfigSpecs

latestPerVersion - If true, return the latest iteration of each associated version of each build target or the build rule pointing to the latest iteration of each associated version of each build target. If false, return only the latest iteration of the latest associated version of each build target or the build rule pointing to the latest iteration of the latest associated version of each build target. This parameter has no effect if either workspace or navCriteria is non-null.

Returns:

WTKeyedMap of input objects having build rules v/s WTCollections of either build rules or build targets depending upon whether onlyOtherSide is false or true respectively

Throws:

WTException

navigateDescribedBy

WTKeyedMap navigateDescribedBy(WTCollection objects,
 boolean onlyOtherSide,
 EPMWorkspace workspace,
 NavigationCriteria navCriteria,
 boolean latestPerVersion)
                        throws WTException

Navigates the describes links from the input described objects and returns either the describing objects or the describes links depending upon whether onlyOtherSide is true or false respectively.

If the optional workspace is non-null, working copies of describing objects in that workspace only (if present) are returned. Otherwise, if working copies of some describing objects do not exist or if the latter are not checked out to that workspace, the workspace config spec is used to determine the versions of those describing objects.

On the other hand, if the optional navCriteria is non-null, the ConfigSpecs from it are applied to determine the versions of the describing objects to be returned. This option is considered only if workspace is null.

Note that this method returns the latest iteration of each version of the same describing object having a describes link with the respective described object if latestPerVersion is true. Otherwise, it returns the latest iteration of the latest version of each describing object having a describes link with the respective described object. The latest version here is not necessarily always the absolute latest version of the describing object but the latest one having a describes link with the described object. This parameter has no effect if either workspace or navCriteria is non-null.

If onlyOtherSide is false, the result is a WTKeyedMap of input objects having describes links v/s WTCollections of content associations.

If onlyOtherSide is true, the result is a WTKeyedMap of input objects having describes links v/s WTCollections of describing objects.

Supported API: true

Parameters:

objects - Persistable objects (i.e. described objects) to navigate from

onlyOtherSide - Indicates whether to return the objects on the other side of the describes link. If true return describing objects, otherwise return describes links.

workspace - An optional workspace which can be used to filter working copies

navCriteria - Optional NavigationCriteria containing ConfigSpecs

latestPerVersion - If true, return the latest iteration of each version of each describing object or the describes link pointing to the latest iteration of each version of each describing object having a describes link with the described object. If false, return only the latest iteration of the latest version of each describing object having a describes link with the described object or the describes link pointing to the latest iteration of the latest version of each describing object. This parameter has no effect if either workspace or navCriteria is non-null.

Returns:

WTKeyedMap of input objects having describes links v/s WTCollections of either content associations or describing objects depending upon whether onlyOtherSide is false or true respectively

Throws:

WTException

navigateDescribes

WTKeyedMap navigateDescribes(WTCollection objects,
 boolean onlyOtherSide,
 EPMWorkspace workspace,
 NavigationCriteria navCriteria,
 boolean latestPerVersion)
                      throws WTException

Navigates the describes links from the input describing objects and returns either the described objects or the describes links depending upon whether onlyOtherSide is true or false respectively.

If the optional workspace is non-null, working copies of described objects in that workspace only (if present) are returned. Otherwise, if working copies of some described objects do not exist or if the latter are not checked out to that workspace, the workspace config spec is used to determine the versions of those described objects.

On the other hand, if the optional navCriteria is non-null, the ConfigSpecs from it are applied to determine the versions of the described objects to be returned. This option is considered only if workspace is null.

Note that this method returns the latest iteration of each version of the same described object having describes link with the respective describing object if latestPerVersion is true. Otherwise, it returns the latest iteration of the latest version of each described object having a describes link with the respective describing object. The latest version here is not necessarily always the absolute latest version of the described object but the latest one having a describes link with the describing object. This parameter has no effect if either workspace or navCriteria is non-null.

If onlyOtherSide is false, the result is a WTKeyedMap of input objects having describes links v/s WTCollections of describes links.

If onlyOtherSide is true, the result is a WTKeyedMap of input objects having describes links v/s WTCollections of described objects.

Supported API: true

Parameters:

objects - Persistable objects (i.e. describing objects) to navigate from

onlyOtherSide - Indicates whether to return the objects on the other side of the association. If true return described objects, otherwise return content associations.

workspace - An optional workspace which can be used to filter working copies

navCriteria - Optional NavigationCriteria containing ConfigSpecs

latestPerVersion - If true, return the latest iteration of each version of each described object or the describes link pointing to the latest iteration of each version of each described object. If false, return only the latest iteration of the latest version of each described object or the describes link pointing to the latest iteration of the latest version of each described object. This parameter has no effect if either workspace or navCriteria is non-null.

Returns:

WTKeyedMap of input objects having content associations v/s WTCollections of either content associations or described objects depending upon whether onlyOtherSide is false or true respectively

Throws:

WTException