Package com.ptc.core.meta.container.common

Interface AttributeContainerFunction

All Superinterfaces:

Serializable

All Known Subinterfaces:

ServerAttributeContainerFunction

All Known Implementing Classes:

AbstractAttributeContainerFunction, com.ptc.core.meta.container.common.ACFCompare, ACFConditionalExpression, ACFDescendantsOf, ACFEquals, ACFIsElementOf, ACFIsInstanceOf, ACFMessageFormat, ACFValueOf, ChangesRecordedElement, SACFAmlPreference, SACFAvlPreference, SACFBuildStatus, SACFCabinetKey, SACFContainerPrivateAccess, SACFContainerReferenceName, SACFCurrentPrincipal, SACFDataFormatIconPath, SACFDataFormatKey, SACFDisplayIdentifier, SACFDisplayIdentifierWithLabels, SACFDisplayIdentity, SACFDisplayIdentityUsesTypePref, SACFDisplayIdentityWithLabels, SACFDisplayType, SACFDisplayTypeUsesPref, SACFFolderKey, SACFLifeCycleTemplateKey, SACFObjectImageWithGlyphs, SACFOccurrenceLocation, SACFOccurrenceMatrixLocation, SACFOrgGlobalIdentifier, SACFPrincipalKey, SACFProjectKey, SACFReferenceDesignatorRange, SACFRichTextDescription, SACFThumbnail, SACFTwoWayAlternate, SACFVersionDisplayIdentifier, SACFViewKey, SACFViewPrimaryContentURL, ValueWrapperFunction

public interface AttributeContainerFunction
extends Serializable

Supported API: true

Extendable: true

Method Summary

Modifier and Type	Method	Description
Object	calculate(AttributeContainer the_attribute_container)	Supported API: true
Object	calculate(AttributeContainer the_attribute_container, AssociationIdentifier entry_point)	Supported API: true
AttributeContainerFunction	cloneWithNewArguments(HashMap old_to_new_map)	Supported API: true
boolean	equals(Object obj)	Supported API: true
Object[]	getArguments()	Supported API: true
Object[]	getArgumentsRecursive()	Supported API: true
AttributeIdentifier[]	getArgumentsRecursive(AttributeContainer the_attribute_container, AssociationIdentifier entry_point)	Supported API: true
Object	getPrimaryArgument()	Supported API: true
AttributeContainerFunction	valueOf(String str)	Returns the AttributeContainerFunction object represented by the specified String.

Method Details

calculate

Object calculate(AttributeContainer the_attribute_container)
          throws InvalidFunctionArgumentException

Supported API: true

Parameters:

the_attribute_container -

Returns:

Object

Throws:

InvalidFunctionArgumentException

calculate

Object calculate(AttributeContainer the_attribute_container,
 AssociationIdentifier entry_point)
          throws InvalidFunctionArgumentException

Supported API: true

Parameters:

the_attribute_container -

entry_point -

Returns:

Object

Throws:

InvalidFunctionArgumentException

getArguments

Object[] getArguments()

Supported API: true

Returns:

Object[]

getPrimaryArgument

Object getPrimaryArgument()

Supported API: true

Returns:

Object

getArgumentsRecursive

Object[] getArgumentsRecursive()

Supported API: true

Returns:

Object[]

getArgumentsRecursive

AttributeIdentifier[] getArgumentsRecursive(AttributeContainer the_attribute_container,
 AssociationIdentifier entry_point)

Supported API: true

Parameters:

the_attribute_container -

entry_point -

Returns:

AttributeIdentifier[]

equals

boolean equals(Object obj)

Supported API: true

Overrides:

equals in class Object

Parameters:

obj -

Returns:

boolean

cloneWithNewArguments

AttributeContainerFunction cloneWithNewArguments(HashMap old_to_new_map)
                                          throws InvalidFunctionArgumentException

Supported API: true

Parameters:

old_to_new_map -

Returns:

AttributeContainerFunction

Throws:

InvalidFunctionArgumentException

valueOf

AttributeContainerFunction valueOf(String str)
                            throws InvalidFunctionArgumentException

Returns the AttributeContainerFunction object represented by the specified String. An AttributeContainerFunction object with empty constructor has to be created , then call this method to complete the argument setup. No new AttributeContainerFuncion object will be created.

Supported API: true

Parameters:

str - A String representation of AttributeContainerFunction

Returns:

AttributeContainerFunction

Throws:

InvalidFunctionArgumentException