com.ptc.core.meta.container.common
Interface AttributeContainerFunction

All Superinterfaces:
Serializable
All Known Subinterfaces:
ServerAttributeContainerFunction
All Known Implementing Classes:
AbstractAttributeContainerFunction, ACFConcatenate, ACFConditionalExpression, ACFDescendantsOf, ACFEquals, ACFIsElementOf, ACFMessageFormat, ACFNot, ACFValueOf, ChangesRecordedElement, SACFAmlPreference, SACFAvlPreference, SACFCabinetKey, SACFComponentLogic, SACFContainerPrivateAccess, SACFContainerReferenceName, SACFCurrentPrincipal, SACFDataFormatIconPath, SACFDataFormatKey, SACFDisplayIdentifier, SACFDisplayIdentifierWithLabels, SACFDisplayIdentity, SACFDisplayIdentityUsesTypePref, SACFDisplayIdentityWithLabels, SACFDisplayType, SACFDisplayTypeUsesPref, SACFFolderKey, SACFLifeCycleTemplateKey, SACFLogicBase, SACFObjectImageWithGlyphs, SACFOccurrenceLocation, SACFOccurrenceMatrixLocation, SACFOrgGlobalIdentifier, SACFPrincipalKey, SACFProjectKey, SACFReferenceDesignatorRange, SACFThumbnail, SACFTwoWayAlternate, SACFViewKey, SACFViewPrimaryContentURL, ValueWrapperFunction

public interface AttributeContainerFunction
extends Serializable



Supported API: true

Extendable: true


Method Summary
 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 Detail

calculate

Object calculate(AttributeContainer the_attribute_container)
                 throws com.ptc.core.meta.container.common.InvalidFunctionArgumentException


Supported API: true

Parameters:
the_attribute_container -
Returns:
Object
Throws:
com.ptc.core.meta.container.common.InvalidFunctionArgumentException

calculate

Object calculate(AttributeContainer the_attribute_container,
                 AssociationIdentifier entry_point)
                 throws com.ptc.core.meta.container.common.InvalidFunctionArgumentException


Supported API: true

Parameters:
the_attribute_container -
entry_point -
Returns:
Object
Throws:
com.ptc.core.meta.container.common.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 com.ptc.core.meta.container.common.InvalidFunctionArgumentException


Supported API: true

Parameters:
old_to_new_map -
Returns:
AttributeContainerFunction
Throws:
com.ptc.core.meta.container.common.InvalidFunctionArgumentException

valueOf

AttributeContainerFunction valueOf(String str)
                                   throws com.ptc.core.meta.container.common.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:
com.ptc.core.meta.container.common.InvalidFunctionArgumentException