com.novell.application.console.snapin

Class ObjectEntry

java.lang.Object

com.novell.application.console.snapin.ObjectEntry

All Implemented Interfaces:

java.io.Serializable

public class ObjectEntry
extends java.lang.Object
implements java.io.Serializable

Defines an entry that represents each object inside of a namespace.

An ObjectEntry is a lightweight representation of a named object in a namespace. This class is made final so that it cannot be subclassed. Each ObjectEntry contains a reference to an ObjectType.

See Also:

ObjectType, Serialized Form

Constructor Summary

Constructors

Constructor and Description
ObjectEntry(java.lang.String name, ObjectType type) Contructs an ObjectEntry of the specified ObjectType.
ObjectEntry(java.lang.String name, ObjectType type, long objectFlags) Contructs an ObjectEntry of the specified ObjectType with objectFlags.
ObjectEntry(java.lang.String name, ObjectType type, ObjectEntry parent) Contructs an ObjectEntry of the specified ObjectType with the object parent.
ObjectEntry(java.lang.String name, ObjectType type, ObjectEntry parent, long objectFlags) Contructs an ObjectEntry of the specified ObjectType with objectFlags and object parent.
ObjectEntry(java.lang.String oeName, ObjectType oeType, ObjectEntry parent, long objectFlags, boolean nameMayBeComplex) Contructs an ObjectEntry of the specified ObjectType with objectFlags and object parent.

Method Summary

Modifier and Type	Method and Description
void	addSubType(ObjectType type) Adds an ObjectType to the array of subtypes for this entry.
boolean	equals(java.lang.Object object) Compares this ObjectEntry to the ObjectEntry passed in and returns true if their full names, ObjectType names, and namespace unique IDs are the same.
boolean	equalsIgnoreCase(java.lang.Object object) Compares this ObjectEntry to the ObjectEntry passed in and returns true if their full names, ObjectType names, and Namespace unique IDs are the same.
AdminNamespace	getAdminNamespace() Returns the namespace used in this ObjectEntry.
java.lang.String	getAsIsName() Returns the object's name as it was passed in at construct time.
ObjectEntry	getAsIsParent() Returns the specified ObjectEntry's parent object as it was passed in at construct time.
java.lang.String	getFullName() Returns the object's full name as a String.
java.lang.String	getName() Returns the object's name as a String.
NamespaceSnapin	getNamespace() Returns the namespace used in this ObjectEntry as a NamespaceSnapin object.
java.lang.String	getNamespaceUniqueID() Returns a short string identifying the namespace protocol.
long	getObjectFlags() Returns the flags associated with an object.
ObjectType	getObjectType() Returns the object's class or type as an ObjectType.
ObjectType[]	getObjectTypes() Deprecated. As of ConsoleOne version 1.2, use getSubTypes() instead.
ObjectEntry	getParent() Returns the specified ObjectEntry's parent object.
ObjectEntry	getRoot() Returns the root object in the lineage of this ObjectEntry.
int	getSubordinateCount() Returns the subordinate count of this ObjectEntry.
ObjectType[]	getSubTypes() Returns the subtypes of this ObjectEntry.
java.lang.String	getTypeName() Returns the object's type as a String.
int	hashCode() Returns the hash code for this ObjectEntry for use in hash tables.
boolean	isComplexName() Returns true if the object's name is complex like "name.c.b" else returns false because it is a simple name.
boolean	removeSubType(ObjectType type) Removes an ObjectType from the array of subtypes for this entry.
void	setObjectFlags(long objectFlags) Sets the flags to be associated with an object.
void	setSubordinateCount(int count) Sets the subordinate count for this ObjectEntry.
void	setSubTypes(ObjectType[] types) Sets all of the subtypes for this ObjectEntry.
java.lang.String	toString() Returns the object's name as a String.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ObjectEntry

public ObjectEntry(java.lang.String name,
                   ObjectType type)

Contructs an ObjectEntry of the specified ObjectType.

Parameters:

name - The name (RDN) of the object.

type - The ObjectType of the object.

ObjectEntry

public ObjectEntry(java.lang.String name,
                   ObjectType type,
                   long objectFlags)

Contructs an ObjectEntry of the specified ObjectType with objectFlags.

Parameters:

name - The name (RDN) of the object.

type - The ObjectType of the object.

objectFlags - The flags associated with the object.

ObjectEntry

public ObjectEntry(java.lang.String name,
                   ObjectType type,
                   ObjectEntry parent)

Contructs an ObjectEntry of the specified ObjectType with the object parent.

Parameters:

name - The name (RDN) of the object.

type - The ObjectType of the object.

parent - The parent of the object.

ObjectEntry

public ObjectEntry(java.lang.String name,
                   ObjectType type,
                   ObjectEntry parent,
                   long objectFlags)

Contructs an ObjectEntry of the specified ObjectType with objectFlags and object parent.

Parameters:

name - The name (RDN) of the object.

type - The ObjectType of the object.

parent - The parent of the object.

objectFlags - The flags associated with the object.

ObjectEntry

public ObjectEntry(java.lang.String oeName,
                   ObjectType oeType,
                   ObjectEntry parent,
                   long objectFlags,
                   boolean nameMayBeComplex)

Contructs an ObjectEntry of the specified ObjectType with objectFlags and object parent.

The passed-in name may be a complex name that spans across several containers ("name.c.b.a"), but it should never contain the tree name as part of the complex string. A tree OE should always be built separately as a single entity so that when you call getParent() and the result is null you are guaranteed to have a tree name and only a tree name. The getRoot() call depends on this. This is the requirement for all root level OE's that are created.

While this handles complex names with dot's it does not handle any strings that have the tree name (dot or slash form) as part of the name. The user must create the tree OE with appropriate constructor calls.

Parameters:

oeName - The name (RDN or FDN) of the object without the tree name.

oeType - The ObjectType of the object.

parent - The parent of the object.

objectFlags - The flags associated with the object.

nameMayBeComplex - The name may or may not have multiple RDNs in it. It is parsed to determine if there are any delimiters.

Method Detail

setSubTypes

public void setSubTypes(ObjectType[] types)

Sets all of the subtypes for this ObjectEntry.

Parameters:

types - The array of ObjectTypes that represent this entry's subtypes.

getSubTypes

public ObjectType[] getSubTypes()

Returns the subtypes of this ObjectEntry. Subtypes should be of the same namespace as the base ObjectType. Snap-ins registered to subtypes appear in such areas as the toolbar menu when an entry is selected.

Returns:

The array of ObjectTypes that represent this entry's subtypes.

addSubType

public void addSubType(ObjectType type)

Adds an ObjectType to the array of subtypes for this entry.

Parameters:

type - The ObjectType to add as a subtype for this entry.

removeSubType

public boolean removeSubType(ObjectType type)

Removes an ObjectType from the array of subtypes for this entry.

Parameters:

type - The ObjectType to remove as a subtype for this entry.

Returns:

True if the subtype was removed, or false if the type could not be removed.

getName

public java.lang.String getName()

Returns the object's name as a String.

Returns:

The name of the object.

getAsIsName

public java.lang.String getAsIsName()

Returns the object's name as it was passed in at construct time. It may be simple or complex. What you gave is what you get back.

Returns:

The name of the object.

isComplexName

public boolean isComplexName()

Returns true if the object's name is complex like "name.c.b" else returns false because it is a simple name.

getFullName

public java.lang.String getFullName()

Returns the object's full name as a String.

Returns:

The full name of the object.

getObjectType

public ObjectType getObjectType()

Returns the object's class or type as an ObjectType.

Returns:

The class or type of the object.

getObjectFlags

public long getObjectFlags()

Returns the flags associated with an object.

Returns:

The flags associated with the object.

See Also:

setObjectFlags(long)

setObjectFlags

public void setObjectFlags(long objectFlags)

Sets the flags to be associated with an object.

Parameters:

objectFlags - The flags to be associated with the object.

See Also:

getObjectFlags()

getParent

public ObjectEntry getParent()

Returns the specified ObjectEntry's parent object.

When the getParent() method is called it assumes the first ObjectType is being used. If there is no parent to return, ObjectEntry returns null.

Returns:

The parent of the given ObjectEntry, or null if there is no parent.

getAsIsParent

public ObjectEntry getAsIsParent()

Returns the specified ObjectEntry's parent object as it was passed in at construct time. This may be the actual parent object or the parent several steps up in the heirarchy this object contains a complex name.

Returns:

The parent of the given ObjectEntry, or null if there is no parent.

getRoot

public ObjectEntry getRoot()

Returns the root object in the lineage of this ObjectEntry.

The root is defined as the object with a null parent or the object that returns a parent object from another namespace.

Returns:

The root ObjectEntry of this object.

equals

public boolean equals(java.lang.Object object)

Compares this ObjectEntry to the ObjectEntry passed in and returns true if their full names, ObjectType names, and namespace unique IDs are the same.

This is preferred over == for comparing ObjectEntries because there may be two different instances of the same logical ObjectEntry.

Overrides:

equals in class java.lang.Object

Parameters:

object - The ObjectEntry passed in to be used in the comparison.

Returns:

True if the ObjectEntries are equal, otherwise false.

equalsIgnoreCase

public boolean equalsIgnoreCase(java.lang.Object object)

Compares this ObjectEntry to the ObjectEntry passed in and returns true if their full names, ObjectType names, and Namespace unique IDs are the same. This version will return true if the full names are equal, but have different case.

Parameters:

object - ObjectEntry passed in to be used in the comparison.

Returns:

True if the ObjectEntries are equal, otherwise false.

hashCode

public int hashCode()

Returns the hash code for this ObjectEntry for use in hash tables. Two ObjectEntries compare to true, using the equals method, will return the same hash code.

Overrides:

hashCode in class java.lang.Object

Returns:

The 32-bit hash code for this ObjectEntry.

toString

public java.lang.String toString()

Returns the object's name as a String.

Overrides:

toString in class java.lang.Object

Returns:

The name of the object.

getTypeName

public java.lang.String getTypeName()

Returns the object's type as a String.

Returns:

The structural object class (base class) of the object

getNamespaceUniqueID

public java.lang.String getNamespaceUniqueID()

Returns a short string identifying the namespace protocol. It returns "NDS" for eDirectory/NDAP, and "LDAP" for either eDirectory or NVDS running over LDAP protocol. This method is useful for determining the namespace protocol without requiring any protocol specific imports, as would be the case for the test:
if (namespace instanceof LDAPNamespace) ...

See the method AdminNamespace.isSupported() for ways to detect if specific features are present, as well as determining if the target server is eDirectory vs NVDS.

Returns:

The String "NDS" or "LDAP".

getNamespace

public NamespaceSnapin getNamespace()

Returns the namespace used in this ObjectEntry as a NamespaceSnapin object. This is an older method retained for compatibility. The newer getAdminNamespace() method is recommended.

Returns:

the namespace object

getAdminNamespace

public AdminNamespace getAdminNamespace()

Returns the namespace used in this ObjectEntry.

Returns:

the namespace object

getSubordinateCount

public int getSubordinateCount()

Returns the subordinate count of this ObjectEntry. -1 indicates no count information is available. The subordinate count does not necessarily indicate the number of objects a user will see if he browses into the container, since he may not have rights to see them or he may be using a search filter.

Returns:

the subordinate count

setSubordinateCount

public void setSubordinateCount(int count)

Sets the subordinate count for this ObjectEntry. Normally this method is only called by the namespace when creating the objectEntry. -1 indicates no count information is available. The subordinate count does not necessarily indicate the number of objects a user will see if he browses into the container, since he may not have rights to see them or he may be using a search filter.

getObjectTypes

public ObjectType[] getObjectTypes()

Deprecated. As of ConsoleOne version 1.2, use getSubTypes() instead.