wt.epm.delegate
Interface AuthoringAppDelegate

All Known Implementing Classes:

Cadds5AuthoringAppDelegate, CatiaAuthoringAppDelegate, DefaultAuthoringAppDelegate, ProeAuthoringAppDelegate

public interface AuthoringAppDelegate

WARNING : End User should not provide implementation for this delegate. If new delegate is required, GSO needs to develop this in consultation with R & D.

Supported API: false

Extendable: false

Method Summary

boolean	allowDeleteInWorkspace() A flag to determine if deleting an EPMDocument in workspace is allowed or not by an given authoring application.
boolean	contentContainsDependentCADName() Supported API: false
WTCollection	getStaleContents(StaleDocumentInfo info) Given a EPMDocument, a list of modified IBAs, a list of modified ContentItems and a list of remaining unchanged ContentItems on the document, returns a subset of the unchanged ContentItems that should be marked as stale.
boolean	isCopyAllowed(EPMAuthoringAppVersion authoringAppVersion) Return true if copy of EPMDocument with the EPMAuthoringAppVersion is allowed.
boolean	isPartialFamilyCopyAllowed(EPMAuthoringAppVersion authoringAppVersion) Return true if partial copy of epmfamily is allowed.
void	validateCADName(EPMDocumentMaster master, String newCADName) Given a EPMDocumentMaster and its new CAD name, applies authoring application specific rules to validate the new CAD name.

Method Detail

contentContainsDependentCADName

public boolean contentContainsDependentCADName()

Supported API: false

Returns:

boolean

allowDeleteInWorkspace

public boolean allowDeleteInWorkspace()

A flag to determine if deleting an EPMDocument in workspace is allowed or not by an given authoring application.

Supported API: false

Returns:

boolean

isCopyAllowed

public boolean isCopyAllowed(EPMAuthoringAppVersion authoringAppVersion)

Return true if copy of EPMDocument with the EPMAuthoringAppVersion is allowed.

Supported API: false

Parameters:

authoringAppVersion -

Returns:

boolean

isPartialFamilyCopyAllowed

public boolean isPartialFamilyCopyAllowed(EPMAuthoringAppVersion authoringAppVersion)

Return true if partial copy of epmfamily is allowed.

Supported API: false

Parameters:

authoringAppVersion -

Returns:

boolean

validateCADName

public void validateCADName(EPMDocumentMaster master,
                            String newCADName)
                     throws WTException

Given a EPMDocumentMaster and its new CAD name, applies authoring application specific rules to validate the new CAD name. Throws an exception if the new CAD name is not valid.

Supported API: false

Parameters:

master -

newCADName -

Throws:

WTException

getStaleContents

public WTCollection getStaleContents(StaleDocumentInfo info)
                              throws WTException

Given a EPMDocument, a list of modified IBAs, a list of modified ContentItems and a list of remaining unchanged ContentItems on the document, returns a subset of the unchanged ContentItems that should be marked as stale.

Supported API: false

Parameters:

info - Containing an EPMDocument and its related stale information

Returns:

WTCollection

Throws:

WTException