org.apache.directory.shared.ldap.schema
Interface SchemaObject

All Superinterfaces:
java.io.Serializable
All Known Subinterfaces:
AttributeType, DITContentRule, DITStructureRule, MatchingRule, MatchingRuleUse, MutableSchemaObject, NameForm, ObjectClass, Syntax
All Known Implementing Classes:
AbstractAttributeType, AbstractMatchingRule, AbstractSchemaObject, AbstractSyntax, DefaultObjectClass

public interface SchemaObject
extends java.io.Serializable

Most schema objects have some common attributes. This super interface represents the minimum set of properties exposed by a SchemaObject.

Version:
$Rev: 664290 $
Author:
Apache Directory Project

Method Summary
 java.lang.String getDescription()
          Gets a short description about this SchemaObject.
 java.lang.String getName()
          Gets the first name in the set of short names for this SchemaObject if any exists for it.
 java.lang.String[] getNamesRef()
          Gets short names for this SchemaObject if any exists for it.
 java.lang.String getOid()
          Gets usually what is the numeric object identifier assigned to this SchemaObject.
 java.lang.String getSchema()
          Gets the name of the schema this SchemaObject is associated with.
 boolean isObsolete()
          Gets whether or not this SchemaObject has been inactivated.
 void setSchema(java.lang.String schemaName)
          Sets the name of the schema this SchemaObject is associated with.
 

Method Detail

isObsolete

boolean isObsolete()
Gets whether or not this SchemaObject has been inactivated. All SchemaObjects except Syntaxes allow for this parameter within their definition. For Syntaxes this property should always return false in which case it is never included in the description.

Returns:
true if inactive, false if active

getOid

java.lang.String getOid()
Gets usually what is the numeric object identifier assigned to this SchemaObject. All schema objects except for MatchingRuleUses have an OID assigned specifically to then. A MatchingRuleUse's OID really is the OID of it's MatchingRule and not specific to the MatchingRuleUse. This effects how MatchingRuleUse objects are maintained by the system.

Returns:
an OID for this SchemaObject or its MatchingRule if this SchemaObject is a MatchingRuleUse object

getNamesRef

java.lang.String[] getNamesRef()
Gets short names for this SchemaObject if any exists for it.

Returns:
the names for this SchemaObject

getName

java.lang.String getName()
Gets the first name in the set of short names for this SchemaObject if any exists for it.

Returns:
the first of the names for this SchemaObject or null if one does not exist

getDescription

java.lang.String getDescription()
Gets a short description about this SchemaObject.

Returns:
a short description about this SchemaObject

getSchema

java.lang.String getSchema()
Gets the name of the schema this SchemaObject is associated with.

Returns:
the name of the schema associated with this schemaObject

setSchema

void setSchema(java.lang.String schemaName)
Sets the name of the schema this SchemaObject is associated with.

Parameters:
schemaName - the new schema name


Copyright © 2003-2011 Apache Software Foundation. All Rights Reserved.