com.novell.emframe.dev

Class AdvSelTypeInfo

java.lang.Object

com.novell.emframe.dev.AdvSelTypeInfo

public class AdvSelTypeInfo
extends java.lang.Object

Class returned by the AdvSelTypeInfoCallback routine which contains information necessary for the Advanced Selector widget to display the Advanced Search criterion screen. The Advanced Selector knows nothing about eDirectory or any other type of directory that the Object Selector may browse. In order for the Advanced Selector to display the correct attributes, operations, and values for those attributes for a particular class of object, the calling task must provide an AdvSelTypeInfo object containing this information. By default, iManager has an AdvSelTypeInfoCallback function that returns an AdvSelTypeInfo for base eDirectory objects. However, as a plug-in writer you may want to provide your own callback function that returns an AdvSelTypeInfo.

Constructor Summary

Constructors

Constructor and Description
AdvSelTypeInfo() Constructs an AdvSelTypeInfo object for a specific ds type (class).
AdvSelTypeInfo(java.lang.String[] defaultOps) Constructs an AdvSelTypeInfo object with a nonstandard list of default operations for a specific ds type (class).
AdvSelTypeInfo(java.lang.String[] defaultOps, java.lang.String opResBundle) Constructs an AdvSelTypeInfo object with a nonstandard list of default operations for a specific ds type (class) and a resource bundle to use to display the localized operation names.

Method Summary

Modifier and Type	Method and Description
void	addAttribute(java.lang.String name, java.lang.String[] ops) Add an attribute with its corresponding list of operations.
void	addAttribute(java.lang.String name, java.lang.String[] ops, java.lang.String[] values) Add an attribute with its corresponding list of operations and valid values.
void	addAuxClasses(java.lang.String[] auxClasses) Allows ids of all auxClasses to be stored in the info structure
java.lang.String[]	getAllOps() Returns an array of all defined operations to compare attribute values.
int	getAllOpsLength() Return the number of unique operators.
java.lang.String	getAttributeName(int index) Returns a string resprenting the name of the ds attribute at position index in the collection.
java.lang.String[]	getAttributeOps(int index) Returns an array of strings resprenting the comparision operations allowed for the ds attribute at position index in the collection.
java.lang.String[]	getAttributeValues(int index) Returns an array of strings resprenting the comparision values allowed for the ds attribute at position index in the collection.
java.lang.String[]	getAuxClasses() Returns a String[] of all auxClasses that have been stored
java.lang.String	getDefaultName() Returns the internal name of the default attribute in the collection.
java.lang.String[]	getDefaultOps() Returns an array of strings resprenting the default comparision operations allowed for the ds attribute at position index in the collection.
int	getDefaultOpsLength() Returns the number of default operations that have been defined for this collection.
java.lang.String	getOpResourceBundle() Returns the name of the resource bundle where the localized ops can be found.
java.lang.String[]	getUniOps() Return an array of all unary operators used in this type info.
int	getUniOpsLength() Return the number of unique unary operators.
int	length() Returns how many attributes have been defined in this collection.

Methods inherited from class java.lang.Object

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

Constructor Detail

AdvSelTypeInfo

public AdvSelTypeInfo(java.lang.String[] defaultOps,
                      java.lang.String opResBundle)

Constructs an AdvSelTypeInfo object with a nonstandard list of default operations for a specific ds type (class) and a resource bundle to use to display the localized operation names.

Parameters:

defaultOps - A String array containing a list of operations to be used when an attribute has none defined. This parameter may be null to specify the standard list of default operations.

opResBundle - String containing the name of a resource bundle to use to display the localized operation names.

AdvSelTypeInfo

public AdvSelTypeInfo(java.lang.String[] defaultOps)

Constructs an AdvSelTypeInfo object with a nonstandard list of default operations for a specific ds type (class). FwResources.properties is assumed for the resource bundle.

Parameters:

defaultOps - A String array containing a list of operations to be used when an attribute has none defined.

AdvSelTypeInfo

public AdvSelTypeInfo()

Constructs an AdvSelTypeInfo object for a specific ds type (class). The default list of attribute operations will be used. No attribute values are specified (all values are allowed). FwResources.properties is assumed for resource bundle.

Method Detail

addAuxClasses

public void addAuxClasses(java.lang.String[] auxClasses)

Allows ids of all auxClasses to be stored in the info structure

Parameters:

auxClasses - String[] of auxClass ids representing all auxilliary classes defined in the directory

getAuxClasses

public java.lang.String[] getAuxClasses()

Returns a String[] of all auxClasses that have been stored

Returns:

m_allAuxClasses String[] of auxClass ids

addAttribute

public void addAttribute(java.lang.String name,
                         java.lang.String[] ops,
                         java.lang.String[] values)

Add an attribute with its corresponding list of operations and valid values.

Parameters:

name - String containing the ds name for this attribute. If name==null, nothing happens.

ops - String array representing the relations operation that will be allowed for this attribute. If ops[]==null, implies default ops will be used.

values - String array representing the allowed values that may be specified for this attribute. If values[]==null, no list of allowed values exists for this attribute (any values are allowed).

addAttribute

public void addAttribute(java.lang.String name,
                         java.lang.String[] ops)

Add an attribute with its corresponding list of operations. Any value is allowed for this attribute.

Parameters:

name - String containing the ds name for this attribute. If name==null, nothing happens

ops - String array representing the relations operation that will be allowed for this attribute. If ops[]==null, implies default ops will be used.

length

public int length()

Returns how many attributes have been defined in this collection.

Returns:

int containing the number of attributes defined

getAttributeName

public java.lang.String getAttributeName(int index)

Returns a string resprenting the name of the ds attribute at position index in the collection.

Parameters:

index - int specifying the position of the attribute

Returns:

String containing the name of the attribute at index. Returns null if index is out of bounds.

getAttributeOps

public java.lang.String[] getAttributeOps(int index)

Returns an array of strings resprenting the comparision operations allowed for the ds attribute at position index in the collection.

Parameters:

index - int specifying the position of the attribute

Returns:

String array containing the list of operations allowed for this attribute. Returns null if index is out of bounds or if no operations have been defined.

getAttributeValues

public java.lang.String[] getAttributeValues(int index)

Returns an array of strings resprenting the comparision values allowed for the ds attribute at position index in the collection.

Parameters:

index - int specifying the position of the attribute

Returns:

String array containing the list of valid values for this attribute. Returns null if index is out of bounds or if no operations have been defined.

getDefaultName

public java.lang.String getDefaultName()

Returns the internal name of the default attribute in the collection.

Returns:

String containing ""

getDefaultOps

public java.lang.String[] getDefaultOps()

Returns an array of strings resprenting the default comparision operations allowed for the ds attribute at position index in the collection.

Returns:

String array containing the default list of operations allowed. Returns null if no default operations have been defined.

See Also:

getDefaultOpsLength()

getDefaultOpsLength

public int getDefaultOpsLength()

Returns the number of default operations that have been defined for this collection.

Returns:

int containging the number of default operations, or 0 if none are defined.

See Also:

getDefaultOps()

getAllOps

public java.lang.String[] getAllOps()

Returns an array of all defined operations to compare attribute values.

Returns:

String array of operation names

See Also:

getAllOpsLength()

getAllOpsLength

public int getAllOpsLength()

Return the number of unique operators.

Returns:

int containing the number of defined operations

See Also:

getAllOps()

getUniOps

public java.lang.String[] getUniOps()

Return an array of all unary operators used in this type info. Unary operators are used for attribute comparision for things like "does this attribute exist" where there is no value.

Returns:

String array containing a list of all unary operators.

See Also:

getUniOpsLength()

getUniOpsLength

public int getUniOpsLength()

Return the number of unique unary operators.

Returns:

int containing the number of defined unary operators

See Also:

getAllOps()

getOpResourceBundle

public java.lang.String getOpResourceBundle()

Returns the name of the resource bundle where the localized ops can be found.

Returns:

String containing the name of the resource bundle