com.novell.application.console.snapin
Class ResultModifier

java.lang.Object
  com.novell.application.console.snapin.ResultModifier

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

AdvancedResultModifier, FilterResultModifier, NDSResultModifier

public class ResultModifier

extends java.lang.Object

implements java.io.Serializable

Defines a ResultModifier, which represents a namespace-specific description of how list and search operations are sorted and filtered.

All extensions of ResultModifier must be serializable. Extending classes must consider the implications of adding large data members. Make all data members transient, unless persistence is required.

See Also:

NamespaceSnapin.getChildren(ObjectEntry parent, ResultModifier modifier), NamespaceSnapin.getChildContainers(ObjectEntry parent, ResultModifier modifier), Serialized Form

Field Summary

static int	SORTBY_KEY_NAME
static int	SORTBY_KEY_TYPE
static int	SORTBY_KEY_TYPE_NAME
static int	SORTBY_KEY_UNSORTED
static int	SORTORDER_KEY_ASCENDING
static int	SORTORDER_KEY_DECENDING

Constructor Summary

ResultModifier(java.lang.String descriptiveName)
Contructs an ResultModifier with the specified descriptive name.

ResultModifier(java.lang.String descriptiveName, int sortByKey, int sortOrderKey, ResultModifierFilterEntry filterEntry)
Deprecated. As of ConsoleOne version 1.3, use constructor with new subcontainer search field.

ResultModifier(java.lang.String descriptiveName, int sortByKey, int sortOrderKey, ResultModifierFilterEntry filterEntry, boolean subContainerSearch)
Contructs a ResultModifier with the specified descriptive name, sort information, and filters.

Method Summary

void	addFilter(ResultModifierFilterEntry filterEntry) Adds a filter to the ResultModifier.
void	clearFilters() Removes all filters from the ResultModifier.
boolean	equals(java.lang.Object obj) Tests for equivalency of two ResultModifiers.
java.lang.String	getDescriptiveName() Obtains the descriptive name of the ResultModifier.
boolean	getFiltered() Determines if the ResultModifier can filter.
ResultModifierFilterEntry[]	getFilters() Obtains the array of filters currently in the ResultModifier.
java.lang.String	getFilterString() Helper method to build a filter which can consist of the naming attributes of objects and a set of baseClasses.
boolean	getIncludeAuxClasses()
boolean	getIncludeSubClasses()
boolean	getSimpleAndOpAdvanced()
int	getSortByKey() Obtains the sort-by key of the ResultModifier.
int	getSortOrderKey() Obtains the sort key of the ResultModifier.
boolean	isSubContainerSearch() Determine if result modifier applies to subcontainers.
void	setSortByKey(int sortByKey) Sets the sort-by key in the ResultModifier.
void	setSortOrderKey(int sortOrderKey) Sets the sort-order key in the ResultModifier.
void	setSubContainerSearch(boolean subContainerSearch) Setup the result modifier subcontainers search mode.

Methods inherited from class java.lang.Object

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

Field Detail

SORTBY_KEY_NAME

public static final int SORTBY_KEY_NAME

See Also:

Constant Field Values

SORTBY_KEY_TYPE

public static final int SORTBY_KEY_TYPE

See Also:

Constant Field Values

SORTBY_KEY_TYPE_NAME

public static final int SORTBY_KEY_TYPE_NAME

See Also:

Constant Field Values

SORTBY_KEY_UNSORTED

public static final int SORTBY_KEY_UNSORTED

See Also:

Constant Field Values

SORTORDER_KEY_ASCENDING

public static final int SORTORDER_KEY_ASCENDING

See Also:

Constant Field Values

SORTORDER_KEY_DECENDING

public static final int SORTORDER_KEY_DECENDING

See Also:

Constant Field Values

Constructor Detail

ResultModifier

public ResultModifier(java.lang.String descriptiveName)

Contructs an ResultModifier with the specified descriptive name.

The default state of the ResultModifier will be: SORTBY_KEY_TYPE_NAME SORTORDER_KEY_ASCENDING no type filter no name filter no subcontainer search

Parameters:

descriptiveName - The descriptive name of the ResultModifier.

ResultModifier

public ResultModifier(java.lang.String descriptiveName,
                      int sortByKey,
                      int sortOrderKey,
                      ResultModifierFilterEntry filterEntry)

Deprecated. As of ConsoleOne version 1.3, use constructor with new subcontainer search field.

Contructs a ResultModifier with the specified descriptive name, sort information, filters and no subcontainer search.

Parameters:

descriptiveName - The descriptive name of the ResultModifier.

sortByKey - The sort-by key (ResultModifier.SORTBY_KEY_*).

sortOrderKey - The sort-order key (ResultModifier.SORTORDER_KEY_*).

filterEntry - A filter entry. Can be null if none is desired.

ResultModifier

public ResultModifier(java.lang.String descriptiveName,
                      int sortByKey,
                      int sortOrderKey,
                      ResultModifierFilterEntry filterEntry,
                      boolean subContainerSearch)

Contructs a ResultModifier with the specified descriptive name, sort information, and filters.

Parameters:

descriptiveName - The descriptive name of the ResultModifier.

sortByKey - The sort-by key (ResultModifier.SORTBY_KEY_*).

sortOrderKey - The sort-order key (ResultModifier.SORTORDER_KEY_*).

filterEntry - A filter entry. Can be null if none is desired.

subContainerSearch - A boolean indicating whether subcontainers are being searched.

Method Detail

addFilter

public void addFilter(ResultModifierFilterEntry filterEntry)

Adds a filter to the ResultModifier.

Parameters:

filterEntry - - The filter to add to the ResultModifier.

clearFilters

public void clearFilters()

Removes all filters from the ResultModifier.

equals

public boolean equals(java.lang.Object obj)

Tests for equivalency of two ResultModifiers.

Parameters:

obj - The ResultModifier to compare against.

Returns:

True if the two ResultModifiers are equal.

getDescriptiveName

public java.lang.String getDescriptiveName()

Obtains the descriptive name of the ResultModifier.

Returns:

The descriptive name of the ResultModifier.

getFiltered

public boolean getFiltered()

Determines if the ResultModifier can filter.

Returns:

True if the ResultModifier has a name or type filter.

getFilters

public ResultModifierFilterEntry[] getFilters()

Obtains the array of filters currently in the ResultModifier.

Returns:

An array of ResultModifierFilterEntries that represent the filters currently applied in the ResultModifier. Can return null.

getFilterString

public java.lang.String getFilterString()

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.

Returns:

The filter formated for NDS API's. (subset of RFC2254)

getIncludeAuxClasses

public boolean getIncludeAuxClasses()

getIncludeSubClasses

public boolean getIncludeSubClasses()

getSimpleAndOpAdvanced

public boolean getSimpleAndOpAdvanced()

getSortByKey

public int getSortByKey()

Obtains the sort-by key of the ResultModifier.

Returns:

The sort-by key name.

getSortOrderKey

public int getSortOrderKey()

Obtains the sort key of the ResultModifier.

Returns:

The sort key name.

isSubContainerSearch

public boolean isSubContainerSearch()

Determine if result modifier applies to subcontainers.

Returns:

True if subcontainers should be searched.

setSortByKey

public void setSortByKey(int sortByKey)

Sets the sort-by key in the ResultModifier.

Parameters:

sortByKey - The sort-by key: ResultModifier.SORTBY_KEY_*.

setSortOrderKey

public void setSortOrderKey(int sortOrderKey)

Sets the sort-order key in the ResultModifier.

Parameters:

sortOrderKey - The sort-order key: ResultModifier.SORTORDER_KEY_*.

setSubContainerSearch

public void setSubContainerSearch(boolean subContainerSearch)

Setup the result modifier subcontainers search mode.

Parameters:

subContainerSearch - - True if subcontainers should be searched, false otherwise.