com.iplanet.ums.cos

Interface ICOSDefinition

All Known Implementing Classes:

DirectCOSDefinition

public interface ICOSDefinition

This interface provides method signatures which will be implemented for COS definitions. Each of the COS definition classes implement this interface, and provide implementations for these methods.

Field Summary

Fields

Modifier and Type	Field and Description
static String	COSATTRIBUTE This field represents a keyword used in COS definitions.
static String	COSSPECIFIER This field represents a keyword used in COS definitions.
static String	COSSUPERDEF_NAME_SEARCH This field represents an LDAP search filter used for searching for COS definitions by name.
static String	COSSUPERDEF_SEARCH This field represents an LDAP search filter used for searching for COS definitions.
static String	COSTARGETTREE This field represents a keyword used in Directory Server 4.x COS implementations.
static String	COSTEMPLATEDN This field represents a keyword used in COS definitions.
static int	DEFAULT This field represents the numeric qualifier constant for "default".
static String	DEFAULT_NAMING_ATTR This field represents the default naming attribute for COS definitions.
static String	ICOSSPECIFIER This field represents a keyword used in COS definitions.
static int	maxQualifier This field represents the maximum value a COS attribute qualifier may have.
static int	MERGE_SCHEMES This field represents the numeric qualifier constant for "merge-schemes".
static int	minQualifier This field represents the minimum value a COS attribute qualifier may have.
static int	OPERATIONAL This field represents the numeric qualifier constant for "operational".
static int	OVERRIDE This field represents the numeric qualifier constant for "override".
static String[]	qualifiers This represents a string array of COS attribute qualifiers.

Method Summary

Modifier and Type	Method and Description
void	addCOSAttribute(String attrName, int qualifier) This method adds a COS attribute to the COS definition.
String[]	getCOSAttributes() This method returns an array of COS attributes.
String	getName() This method returns the name of the COS definition.
void	removeCOSAttribute(String attrName) This method removes a COS attribute from the COS definiton.
void	setName(String name) This method sets the name for the COS definition.

Field Detail

DEFAULT_NAMING_ATTR

static final String DEFAULT_NAMING_ATTR

This field represents the default naming attribute for COS definitions.

See Also:

Constant Field Values

COSTEMPLATEDN

static final String COSTEMPLATEDN

This field represents a keyword used in COS definitions.

See Also:

Constant Field Values

COSSPECIFIER

static final String COSSPECIFIER

This field represents a keyword used in COS definitions.

See Also:

Constant Field Values

ICOSSPECIFIER

static final String ICOSSPECIFIER

This field represents a keyword used in COS definitions.

See Also:

Constant Field Values

COSATTRIBUTE

static final String COSATTRIBUTE

This field represents a keyword used in COS definitions.

See Also:

Constant Field Values

COSSUPERDEF_NAME_SEARCH

static final String COSSUPERDEF_NAME_SEARCH

This field represents an LDAP search filter used for searching for COS definitions by name.

See Also:

Constant Field Values

COSSUPERDEF_SEARCH

static final String COSSUPERDEF_SEARCH

This field represents an LDAP search filter used for searching for COS definitions.

See Also:

Constant Field Values

COSTARGETTREE

static final String COSTARGETTREE

This field represents a keyword used in Directory Server 4.x COS implementations.

See Also:

Constant Field Values

minQualifier

static final int minQualifier

This field represents the minimum value a COS attribute qualifier may have.

See Also:

Constant Field Values

maxQualifier

static final int maxQualifier

This field represents the maximum value a COS attribute qualifier may have.

See Also:

Constant Field Values

DEFAULT

static final int DEFAULT

This field represents the numeric qualifier constant for "default".

See Also:

Constant Field Values

OVERRIDE

static final int OVERRIDE

This field represents the numeric qualifier constant for "override".

See Also:

Constant Field Values

OPERATIONAL

static final int OPERATIONAL

This field represents the numeric qualifier constant for "operational".

See Also:

Constant Field Values

MERGE_SCHEMES

static final int MERGE_SCHEMES

This field represents the numeric qualifier constant for "merge-schemes".

See Also:

Constant Field Values

qualifiers

static final String[] qualifiers

This represents a string array of COS attribute qualifiers. The valid values are "default", "override", "operational", and "merge-schemes".

Method Detail

setName

void setName(String name)

This method sets the name for the COS definition.

Parameters:

name - the name of this COS definition.

getName

String getName()

This method returns the name of the COS definition.

Returns:

the name of the COS definition.

addCOSAttribute

void addCOSAttribute(String attrName,
                     int qualifier)
              throws UMSException

This method adds a COS attribute to the COS definition.

Parameters:

attrName - the name of the attribute.

qualifier - The qualifier for the attribute. The valid range of values are: 0 (default), 1 (override), 2 (operational), 3 (merge-schemes).

Throws:

UMSException - if an exception occurs.

removeCOSAttribute

void removeCOSAttribute(String attrName)

This method removes a COS attribute from the COS definiton.

Parameters:

attrName - The name of the COS attribute to be removed.

getCOSAttributes

String[] getCOSAttributes()

This method returns an array of COS attributes.

Returns:

an array of COS attributes.