com.novell.admin.ns

Interface Schema

All Known Subinterfaces:

LDAPschema, NDSSchema

public interface Schema

This is the schema service interface for reading and writing to and from NDS.

All schema modifications should be made through SchemaDefinition. This interface provides methods to get the SchemaDefinition and attribute and class definitions. Applications should never use this interface directly to modify the schema.

See Also:

SchemaDefinition

Method Summary

Modifier and Type	Method and Description
void	deleteAttributeDefinition(AttributeDefinition attributeDef) Deletes the attribute definition from NDS.
void	deleteClassDefinition(ClassDefinition classDef) Deletes the class definition from NDS.
AttributeDefinition	getAttributeDefinition(java.lang.String attrName) Returns the definition for a specific attribute.
ClassDefinition	getClassDefinition(java.lang.String className) Returns the definition for a specific class.
ObjectType	getObjectType(java.lang.String className) Returns an ObjectType object for a specific class.
SchemaDefinition	getSchemaDefinition() Returns the schema definition from NDS.
void	modifyAttributeDefinition(AttributeDefinition attributeDef) Modifies the attribute definition in NDS.
void	modifyClassDefinition(ClassDefinition classDef) Modifies the class definition in NDS.
void	refreshSchema() Forces the entire schema to be re-read from NDS.
void	writeAttributeDefinition(AttributeDefinition attributeDef) Writes the attribute definition to NDS.
void	writeClassDefinition(ClassDefinition classDef) Writes the class definition to NDS.

Method Detail

getObjectType

ObjectType getObjectType(java.lang.String className)
                  throws SPIException

Returns an ObjectType object for a specific class.

Parameters:

className - The name of the class.

Returns:

A valid ObjectType.

Throws:

SPIException - Refer to SPIException documentation.

getClassDefinition

ClassDefinition getClassDefinition(java.lang.String className)
                            throws SPIException

Returns the definition for a specific class.

Parameters:

className - The name of the class.

Returns:

The definition information for the class.

Throws:

SPIException - Refer to SPIException documentation.

See Also:

SchemaDefinition.getClassDefinition(String)

getAttributeDefinition

AttributeDefinition getAttributeDefinition(java.lang.String attrName)
                                    throws SPIException

Returns the definition for a specific attribute.

Parameters:

attrName - The name of the attribute.

Returns:

The definition information for the attribute.

Throws:

SPIException - Refer to SPIException documentation.

getSchemaDefinition

SchemaDefinition getSchemaDefinition()
                              throws SPIException

Returns the schema definition from NDS.

Returns:

The schema definition object.

Throws:

SPIException - Refer to SPIException documentation.

refreshSchema

void refreshSchema()

Forces the entire schema to be re-read from NDS.

writeAttributeDefinition

void writeAttributeDefinition(AttributeDefinition attributeDef)
                       throws SPIException

Writes the attribute definition to NDS.

Parameters:

attributeDef - The attribute definition.

Throws:

SPIException - Refer to SPIException documentation.

deleteAttributeDefinition

void deleteAttributeDefinition(AttributeDefinition attributeDef)
                        throws SPIException

Deletes the attribute definition from NDS.

Parameters:

attributeDef - The attribute definition.

Throws:

SPIException - Refer to SPIException documentation.

modifyClassDefinition

void modifyClassDefinition(ClassDefinition classDef)
                    throws SPIException

Modifies the class definition in NDS.

Parameters:

classDef - The class definition.

Throws:

SPIException - Refer to SPIException documentation.

modifyAttributeDefinition

void modifyAttributeDefinition(AttributeDefinition attributeDef)
                        throws SPIException

Modifies the attribute definition in NDS.

Parameters:

attributeDef - The attribute definition.

Throws:

SPIException - Refer to SPIException documentation.

writeClassDefinition

void writeClassDefinition(ClassDefinition classDef)
                   throws SPIException

Writes the class definition to NDS.

Parameters:

classDef - The class definition.

Throws:

SPIException - Refer to SPIException documentation.

deleteClassDefinition

void deleteClassDefinition(ClassDefinition classDef)
                    throws SPIException

Deletes the class definition from NDS.

Parameters:

classDef - The class definition.

Throws:

SPIException - Refer to SPIException documentation.