Package com.ptc.core.foundation.folder.server.impl

Class SACFFolderKey

java.lang.Object

com.ptc.core.foundation.folder.server.impl.SACFFolderKey

All Implemented Interfaces:

AttributeContainerFunction, ServerAttributeContainerFunction, Serializable

public final class SACFFolderKey
extends Object
implements ServerAttributeContainerFunction

Places a Server Calculated Attribute in the AttributeContainer whose content is a String whose value is based on the Folder name. LogicalIdentifier is: folder = SCA|folder.key

Supported API: true

Extendable: false

See Also:

• Serialized Form

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.

Methods inherited from class java.lang.Object

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

Method Details

calculate

public Object calculate(AttributeContainer the_attribute_container)
                 throws InvalidFunctionArgumentException

Supported API: true

Specified by:

calculate in interface AttributeContainerFunction

Parameters:

the_attribute_container -

Returns:

Object

Throws:

InvalidFunctionArgumentException

calculate

public Object calculate(AttributeContainer the_attribute_container,
 AssociationIdentifier entry_point)
                 throws InvalidFunctionArgumentException

Supported API: true

Specified by:

calculate in interface AttributeContainerFunction

Parameters:

the_attribute_container -

entry_point -

Returns:

Object

Throws:

InvalidFunctionArgumentException

getArguments

public Object[] getArguments()

Supported API: true

Specified by:

getArguments in interface AttributeContainerFunction

Returns:

Object[]

getPrimaryArgument

public Object getPrimaryArgument()

Supported API: true

Specified by:

getPrimaryArgument in interface AttributeContainerFunction

Returns:

Object

getArgumentsRecursive

public Object[] getArgumentsRecursive()

Supported API: true

Specified by:

getArgumentsRecursive in interface AttributeContainerFunction

Returns:

Object[]

getArgumentsRecursive

public AttributeIdentifier[] getArgumentsRecursive(AttributeContainer the_attribute_container,
 AssociationIdentifier entry_point)

Supported API: true

Specified by:

getArgumentsRecursive in interface AttributeContainerFunction

Parameters:

the_attribute_container -

entry_point -

Returns:

AttributeIdentifier[]

equals

public boolean equals(Object obj)

Supported API: true

Specified by:

equals in interface AttributeContainerFunction

Overrides:

equals in class Object

Parameters:

obj -

Returns:

boolean

cloneWithNewArguments

public AttributeContainerFunction cloneWithNewArguments(HashMap old_to_new_map)
                                                 throws InvalidFunctionArgumentException

Supported API: true

Specified by:

cloneWithNewArguments in interface AttributeContainerFunction

Parameters:

old_to_new_map -

Returns:

AttributeContainerFunction

Throws:

InvalidFunctionArgumentException

valueOf

public 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

Specified by:

valueOf in interface AttributeContainerFunction

Parameters:

str - A String representation of AttributeContainerFunction

Returns:

AttributeContainerFunction

Throws:

InvalidFunctionArgumentException