WebObjects 5.2

com.webobjects.webservices.generation
Class WOSearchOperation

java.lang.Object
  |
  +--com.webobjects.appserver.WOElement
        |
        +--com.webobjects.appserver.WOComponent
              |
              +--com.webobjects.webservices.generation.WOOperation
                    |
                    +--com.webobjects.webservices.generation.WOSearchOperation
All Implemented Interfaces:
Cloneable, NSKeyValueCoding, NSKeyValueCoding.ErrorHandling, NSKeyValueCodingAdditions, NSValidation, Serializable, WOActionResults
Direct Known Subclasses:
WOFetchSpecSearchOperation

public class WOSearchOperation
extends WOOperation

See Also:
Serialized Form

Inner classes inherited from class com.webobjects.appserver.WOComponent
WOComponent.Event
 
Inner classes inherited from class com.webobjects.foundation.NSKeyValueCoding
NSKeyValueCoding.DefaultImplementation, NSKeyValueCoding.ErrorHandling, NSKeyValueCoding.Null, NSKeyValueCoding.UnknownKeyException, NSKeyValueCoding.Utility, NSKeyValueCoding.ValueAccessor
 
Inner classes inherited from class com.webobjects.foundation.NSKeyValueCodingAdditions
NSKeyValueCodingAdditions.DefaultImplementation, NSKeyValueCodingAdditions.Utility
 
Inner classes inherited from class com.webobjects.foundation.NSValidation
NSValidation.DefaultImplementation, NSValidation.Utility, NSValidation.ValidationException
 
Fields inherited from interface com.webobjects.foundation.NSKeyValueCoding
NullValue
 
Fields inherited from interface com.webobjects.foundation.NSKeyValueCodingAdditions
KeyPathSeparator
 
Constructor Summary
WOSearchOperation(WOContext context)
           
 
Method Summary
 int fetchLimit()
          Returns the maximum number of objects to fetch for this operation.
 Object invoke()
          Performs a search using an EOFetchSpecification based on the argument keys paths, and argument values.
 EOQualifier qualifier(EOEntity entity, NSArray inputPartKeyPaths, NSArray values, NSArray comparisonKeys, NSArray attributeClassNames, String unspecifiedArgumentKey)
          Returns a qualifier for searching on an entity.
 
Methods inherited from class com.webobjects.webservices.generation.WOOperation
aggregateValuesResult, attributeClassNames, classesForKeyPaths, comparisonKeys, d2wContext, editingContext, gidArgumentKey, inputPartKeyPaths, inputPartNames, inputPartValues, outputPartKeyPaths, outputPartNames, propertyNameForPartName, requiresEntity, saveChangesInEditingContext, serializationStrategy, setD2wContext, unspecifiedArgumentKey
 
Methods inherited from class com.webobjects.appserver.WOComponent
appendToResponse, application, awake, baseURL, bindingKeys, canAccessFieldsDirectly, canGetValueForBinding, canSetValueForBinding, clone, context, debugString, descriptionForResponse, ensureAwakeInContext, frameworkName, generateResponse, handleQueryWithUnboundKey, handleTakeValueForUnboundKey, hasBinding, hasSession, invokeAction, isCachingEnabled, isEventLoggingEnabled, isStateless, logString, name, pageWithName, parent, path, performParentAction, pullValuesFromParent, pushValuesToParent, reset, session, set_componentUnroll, set_unroll, setCachingEnabled, setValueForBinding, sleep, synchronizesVariablesWithBindings, takeValueForKey, takeValueForKeyPath, takeValuesFromRequest, template, templateWithHTMLString, templateWithName, toString, unableToSetNullForKey, validateTakeValueForKeyPath, validateValueForKey, validationFailedWithException, valueForBinding, valueForKey, valueForKeyPath
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

WOSearchOperation

public WOSearchOperation(WOContext context)
Method Detail

fetchLimit

public int fetchLimit()
Returns the maximum number of objects to fetch for this operation. Subclasses should override this method to provide a custom fetch limit based on operation attributes or D2WContext information. The default implementation returns the D2WContext value for the key fetchLimit.
Returns:
the fetch limit to use in this operation's EOFetchSpecification

invoke

public Object invoke()
Performs a search using an EOFetchSpecification based on the argument keys paths, and argument values.
Overrides:
invoke in class WOOperation
Returns:
NSArray of objects matching search arguments

qualifier

public EOQualifier qualifier(EOEntity entity,
                             NSArray inputPartKeyPaths,
                             NSArray values,
                             NSArray comparisonKeys,
                             NSArray attributeClassNames,
                             String unspecifiedArgumentKey)
Returns a qualifier for searching on an entity. Subclasses should override this method to provide custom qualifiers based on operation attributes or d2wContext() information. The default implementation invokes WOServiceUtilities.buildQualifier()
Parameters:
entity - the EOEntity that will be the root entity for the qualifier to build
inputPartKeyPaths - array of property key paths
values - array of values corresponding to inputPartKeyPaths
comparisonKeys - array of key-comparison keys
attributeClassNames - array of Class objects
unspecifiedArgumentKey - String key representing a value that was not specified by the client
Returns:
a qualifier to use in this operation's EOFetchSpecification
See Also:
WOServiceUtilities.buildQualifier(com.webobjects.eoaccess.EOEntity, com.webobjects.foundation.NSArray, com.webobjects.foundation.NSArray, com.webobjects.foundation.NSArray, com.webobjects.foundation.NSArray, java.lang.String)

Last updated Fri Feb 21 13:15:00 PST 2003.

Copyright © 2003 Apple Computer, Inc.