wt.epm.delegate
Class Cadds5AuthoringAppDelegate

java.lang.Object
  wt.epm.delegate.Cadds5AuthoringAppDelegate

All Implemented Interfaces:

AuthoringAppDelegate, Externalizable, Serializable

public class Cadds5AuthoringAppDelegate

extends Object

implements AuthoringAppDelegate, Externalizable

Supported API: false

Extendable: false

See Also:

Serialized Form

Field Summary

private static String	CLASSNAME
static long	EXTERNALIZATION_VERSION_UID
protected static long	OLD_FORMAT_VERSION_UID
private static String	RESOURCE
(package private) static long	serialVersionUID

Constructor Summary

Cadds5AuthoringAppDelegate()

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	readExternal(ObjectInput input) Reads the non-transient fields of this class from an external source.
private boolean	readOldVersion(ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone) Reads the non-transient fields of this class from an external source, which is not the current version.
protected boolean	readVersion(Cadds5AuthoringAppDelegate thisObject, ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone) Reads the non-transient fields of this class from an external source.
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.
void	writeExternal(ObjectOutput output) Writes the non-transient fields of this class to an external source.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

RESOURCE

private static final String RESOURCE

See Also:

Constant Field Values

CLASSNAME

private static final String CLASSNAME

serialVersionUID

static final long serialVersionUID

See Also:

Constant Field Values

EXTERNALIZATION_VERSION_UID

public static final long EXTERNALIZATION_VERSION_UID

See Also:

Constant Field Values

OLD_FORMAT_VERSION_UID

protected static final long OLD_FORMAT_VERSION_UID

See Also:

Constant Field Values

Constructor Detail

Cadds5AuthoringAppDelegate

public Cadds5AuthoringAppDelegate()

Method Detail

writeExternal

public void writeExternal(ObjectOutput output)
                   throws IOException

Writes the non-transient fields of this class to an external source.

Supported API: false

Specified by:

writeExternal in interface Externalizable

Parameters:

output -

Throws:

IOException

readExternal

public void readExternal(ObjectInput input)
                  throws IOException,
                         ClassNotFoundException

Reads the non-transient fields of this class from an external source.

Supported API: false

Specified by:

readExternal in interface Externalizable

Parameters:

input -

Throws:

IOException

ClassNotFoundException

readVersion

protected boolean readVersion(Cadds5AuthoringAppDelegate thisObject,
                              ObjectInput input,
                              long readSerialVersionUID,
                              boolean passThrough,
                              boolean superDone)
                       throws IOException,
                              ClassNotFoundException

Reads the non-transient fields of this class from an external source.

Supported API: false

Parameters:

thisObject -

input -

readSerialVersionUID -

passThrough -

superDone -

Returns:

boolean

Throws:

IOException

ClassNotFoundException

readOldVersion

private boolean readOldVersion(ObjectInput input,
                               long readSerialVersionUID,
                               boolean passThrough,
                               boolean superDone)
                        throws IOException,
                               ClassNotFoundException

Reads the non-transient fields of this class from an external source, which is not the current version.

Parameters:

input -

readSerialVersionUID -

passThrough -

superDone -

Returns:

boolean

Throws:

IOException

ClassNotFoundException

contentContainsDependentCADName

public boolean contentContainsDependentCADName()

Supported API: false

Specified by:

contentContainsDependentCADName in interface AuthoringAppDelegate

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

Specified by:

allowDeleteInWorkspace in interface AuthoringAppDelegate

Returns:

boolean

isCopyAllowed

public boolean isCopyAllowed(EPMAuthoringAppVersion authoringAppVersion)

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

Supported API: false

Specified by:

isCopyAllowed in interface AuthoringAppDelegate

Parameters:

authoringAppVersion -

Returns:

boolean

isPartialFamilyCopyAllowed

public boolean isPartialFamilyCopyAllowed(EPMAuthoringAppVersion authoringAppVersion)

Return true if partial copy of epmfamily is allowed.

Supported API: false

Specified by:

isPartialFamilyCopyAllowed in interface AuthoringAppDelegate

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

Specified by:

validateCADName in interface AuthoringAppDelegate

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

Specified by:

getStaleContents in interface AuthoringAppDelegate

Parameters:

info - Containing an EPMDocument and its related stale information

Returns:

WTCollection

Throws:

WTException