wt.epm
Interface EPMObject

All Known Subinterfaces:

EPMDependencyLink, EPMFamilyTable, EPMFamilyTableMaster

All Known Implementing Classes:

EPMBuildRule, EPMContainedIn, EPMDocument, EPMDocumentMaster, EPMMemberLink, EPMReferenceLink, EPMSepFamilyTable, EPMSepFamilyTableMaster, EPMSupportingData, EPMVariantLink

public interface EPMObject

This interface is used by all objects that want to allow for application-based vetoing of modifications.

Supported API: true

Extendable: false

See Also:

EPMConstructorListener, EPMVetoableChangeListener

Field Summary

static String	AUTHORING_APPLICATION Label for the attribute; Indicates that the named application authored the object.
static String	OWNER_APPLICATION Label for the attribute; Indicate that the named application owns the object.
static int	UNSPECIFIED Supported API: false

Method Summary

void	checkAttributes() Validate the values of this Persistable object's attributes.
EPMAuthoringAppType	getAuthoringApplication() Gets the value of the attribute: AUTHORING_APPLICATION.
EPMApplicationType	getOwnerApplication() Gets the value of the attribute: OWNER_APPLICATION.

Field Detail

UNSPECIFIED

public static final int UNSPECIFIED

Supported API: false

See Also:

Constant Field Values

OWNER_APPLICATION

public static final String OWNER_APPLICATION

Label for the attribute; Indicate that the named application owns the object.

The parameter is an EPMApplicationType, so that any sort of checking can be done at run-time.

Supported API: true

See Also:

Constant Field Values

AUTHORING_APPLICATION

public static final String AUTHORING_APPLICATION

Label for the attribute; Indicates that the named application authored the object.

The parameter is an EPMAuthoringAppType, so that any sort of checking can be done at run-time.

Supported API: true

See Also:

Constant Field Values

Method Detail

getOwnerApplication

public EPMApplicationType getOwnerApplication()

Gets the value of the attribute: OWNER_APPLICATION. Indicate that the named application owns the object.

The parameter is an EPMApplicationType, so that any sort of checking can be done at run-time.

Supported API: true

Returns:

EPMApplicationType

getAuthoringApplication

public EPMAuthoringAppType getAuthoringApplication()

Gets the value of the attribute: AUTHORING_APPLICATION. Indicates that the named application authored the object.

The parameter is an EPMAuthoringAppType, so that any sort of checking can be done at run-time.

Supported API: true

Returns:

EPMAuthoringAppType

checkAttributes

public void checkAttributes()
                     throws InvalidAttributeException

Validate the values of this Persistable object's attributes.

In particular, this must check that the modifications to the object were made by an approved application.

Supported API: true

Throws:

InvalidAttributeException