com.novell.admin.ns
Class AdvancedResultModifier

java.lang.Object
  extended bycom.novell.application.console.snapin.ResultModifier
      extended bycom.novell.admin.ns.AdvancedResultModifier
All Implemented Interfaces:
java.io.Serializable

public class AdvancedResultModifier
extends ResultModifier

This class is used for complex attribute syntax searches. It allows an LDAP search filter string to be specified directly. This class is only effective on LDAP. The filter is ignored on NDAP, so all objects are returned. 'filterArguments' are never used in either case.

See Also:
Serialized Form

Field Summary
 
Fields inherited from class com.novell.application.console.snapin.ResultModifier
SORTBY_KEY_NAME, SORTBY_KEY_TYPE, SORTBY_KEY_TYPE_NAME, SORTBY_KEY_UNSORTED, SORTORDER_KEY_ASCENDING, SORTORDER_KEY_DECENDING
 
Constructor Summary
AdvancedResultModifier(java.lang.String descriptiveName, boolean subContainer)
          Constructor that creates an extended filter for object search.
AdvancedResultModifier(java.lang.String descriptiveName, int sortKey, boolean subContainer)
          Constructor that creates an extended filter for object search.
 
Method Summary
 java.lang.Object[] getArguments()
           
 java.lang.String getFilterString()
          Helper method to build a filter which can consist of the naming attributes of objects and a set of baseClasses.
 void setArguments(java.lang.Object[] filterArguments)
           
 void setFilterString(java.lang.String filterString)
           
 
Methods inherited from class com.novell.application.console.snapin.ResultModifier
addFilter, clearFilters, equals, getDescriptiveName, getFiltered, getFilters, getIncludeAuxClasses, getIncludeSubClasses, getSimpleAndOpAdvanced, getSortByKey, getSortOrderKey, isSubContainerSearch, setSortByKey, setSortOrderKey, setSubContainerSearch
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

AdvancedResultModifier

public AdvancedResultModifier(java.lang.String descriptiveName,
                              boolean subContainer)
Constructor that creates an extended filter for object search.

Parameters:
descriptiveName - The description of the filter.
subContainer - The search depth.

AdvancedResultModifier

public AdvancedResultModifier(java.lang.String descriptiveName,
                              int sortKey,
                              boolean subContainer)
Constructor that creates an extended filter for object search.

Parameters:
descriptiveName - The description of the filter.
sortKey - SORTKEY_UNSORTED - No special sorting required. SORTKEY_TYPE - Sort baseclass in accending order. SORTKEY_NAME - Sort name in accending order. SORTKEY_TYPE_NAME - Sort baseclass then by name in accending order.
subContainer - The search depth.
Method Detail

getArguments

public java.lang.Object[] getArguments()

getFilterString

public java.lang.String getFilterString()
Description copied from class: ResultModifier
Helper method to build a filter which can consist of the naming attributes of objects and a set of baseClasses. This is used for searching.

Overrides:
getFilterString in class ResultModifier
Returns:
The filter formated for NDS API's. (subset of RFC2254)

setArguments

public void setArguments(java.lang.Object[] filterArguments)

setFilterString

public void setFilterString(java.lang.String filterString)


API Documentation Copyright © 1998-2004 Novell, Inc. All rights reserved.
NDS is a registered trademark of Novell, Inc. in the United States and other countries.
Generated September 2 2004 0111.