com.ptc.core.adapter.server.impl
Class ObjectWebject

java.lang.Object
  com.ptc.core.adapter.server.impl.AbstractWebject
      com.ptc.core.adapter.server.impl.ObjectWebject

All Implemented Interfaces:

com.infoengine.object.factory.AdapterWebject, com.ptc.core.adapter.server.impl.TypeAwareWebjectDelegate, Externalizable, Serializable

Direct Known Subclasses:

com.ptc.core.adapter.server.impl.QueryObjectsWebjectDelegate

public abstract class ObjectWebject
extends AbstractWebject

The base class for Windchill Adapter OBJ webjects. This abstract class contains only the most basic and widely shared functionality used by all Windchill Adapter OBJ webjects.

Supported API: true

Extendable: true

See Also:

Serialized Form

Field Summary

Fields inherited from class com.ptc.core.adapter.server.impl.AbstractWebject

adapterLogger, attributeLogger, attributeParams, commandFilter, containerQueryCriteria, containerRefs, descriptorParams, formatAttributes, groupOutClass, groupOutName, includeArgs, includeConstraints, includeDescriptors, locale, nextOp, objectRefs, referenceAttributes, referenceDelimiter, referenceExceptions, referenceOutputDelimiter, targetType, traceLogger, unformatted, webject, webjectLogger, whereClause

Method Summary

protected com.infoengine.object.factory.Group	getUfidsAsGroup(com.infoengine.object.factory.Task task) Retrieves the default input Group from the VDB and combines any OBJECT_REF parameters with it.
protected void	postProcess(com.infoengine.object.factory.Element e, boolean purgeDefault) Subclasses can over-ride if they want to tweak the Element as it's added to the results.
void	preset(com.infoengine.object.factory.Task task) This convenience method is intended to be called in the invoke() method to convert collect and process webject parameters and basic initialization.
protected void	setHandleGroupIn(boolean b) Explicitly tells whether the GROUP_IN parameter should be processed.

Methods inherited from class com.ptc.core.adapter.server.impl.AbstractWebject

addFilteredTypeInstance, addTypeInstance, executeCommand, getAdditionalAttributeContainerSet, getAttributeContainerSet, getAttributeIdentifier, getAttributes, getAttributeTranslator, getAttributeTranslator, getAttributeTypeIdentifier, getAttributeTypeIdentifiers, getBasicResultSpec, getContainerQueryCriteria, getContainers, getDefaultAttributes, getFilter, getFilter, getLocalDomain, getLocale, getLocalGuid, getOBID, getPageCount, getPageMode, getPageOffset, getRemoteObject, getResultContainer, getSortSpec, getTargetTypeInstances, getTypeIdentifier, getTypeInstance, getTypeInstance, getTypeInstance, getTypeInstances, getTypeInstances, inputObjectRefsFromGroup, invoke, isFormatAttributes, isLocalDomain, postExecute, refreshTypeInstance, refreshTypeInstance, setFormatAttributes, setLocale, setRequestedAttributeNames

Methods inherited from class java.lang.Object

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

Method Detail

preset

public void preset(com.infoengine.object.factory.Task task)
            throws WTException

This convenience method is intended to be called in the invoke() method to convert collect and process webject parameters and basic initialization.

Supported API: true

Overrides:

preset in class AbstractWebject

Parameters:

task - The Info*Engine task executed by the user. This is usually the same Task received by the invoke() method.

Throws:

WTException

setHandleGroupIn

protected void setHandleGroupIn(boolean b)

Explicitly tells whether the GROUP_IN parameter should be processed. By default GROUP_IN will be processed in search of ufids to add to the objectRefs array. If a subclass does not desire this behaviour then it should call this method with a value of false. This method should only be called before preset.

Supported API: true

Parameters:

b - The new value for handlGroupIn.

getUfidsAsGroup

protected com.infoengine.object.factory.Group getUfidsAsGroup(com.infoengine.object.factory.Task task)

Retrieves the default input Group from the VDB and combines any OBJECT_REF parameters with it. The resulting Group will have an attribute named "obid" in each element. The default input group is assumed to be formatted this way (not verified) so callers should skip elements missing an obid attirubte or complain as they see fit. This method should only be called after preset.

Supported API: true

Parameters:

task - The input task.

Returns:

Group The ufid group.

postProcess

protected void postProcess(com.infoengine.object.factory.Element e,
                           boolean purgeDefault)
                    throws WTException

Subclasses can over-ride if they want to tweak the Element as it's added to the results.

Supported API: true

Parameters:

e - The Element added to the results.

purgeDefault - The flag (true) to purge default contents from the element

Throws:

WTException