com.novell.admin.ns.nds
Class PathFacade

java.lang.Object
  extended bycom.novell.admin.ns.ValueListFacade
      extended bycom.novell.admin.ns.nds.PathFacade

public final class PathFacade
extends ValueListFacade

Facade for NDS Path syntax. This is the same as the LDAP "Tagged Name and String" syntax. The Path syntax consists of: type: an integer volume: a DN string path: a string


Field Summary
 
Fields inherited from class com.novell.admin.ns.ValueListFacade
valueList
 
Constructor Summary
PathFacade(ValueList comp)
          Facade constructor
 
Method Summary
static ValueList createValueList(long type, java.lang.String volume, java.lang.String path)
          Creates an NDS Path ValueList.
static ValueList createValueList(long type, java.lang.String volume, java.lang.String path, Syntax syn)
          Creates an NDS Path ValueList.
 java.lang.String getPath()
          Retrieves the path name.
 long getType()
          Retrieves the path type.
 java.lang.String getVolume()
          Retrieves the volume name.
 void setPath(java.lang.String path)
          Sets the path.
 void setType(long type)
          Sets the path type.
 void setVolume(java.lang.String volume)
          Sets the volume name.
 
Methods inherited from class com.novell.admin.ns.ValueListFacade
getValueList, replaceBooleanValue, replaceHexValue, replaceLongValue, replaceStringValue, replaceValueList
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

PathFacade

public PathFacade(ValueList comp)
           throws IncompatibleComponentException
Facade constructor

Parameters:
comp - The ValueList that represents the Path (Tagged Name and String) value.
Throws:
IncompatibleComponentException - Not used.
Method Detail

createValueList

public static ValueList createValueList(long type,
                                        java.lang.String volume,
                                        java.lang.String path)
Creates an NDS Path ValueList. This form is provided for backward compatibility and assumes NDS syntax.

Parameters:
type - Refer to NDS Schema Reference.
volume - Refer to NDS Schema Reference.
path - Refer to NDS Schema Reference.
Returns:
A new Path ValueList.

createValueList

public static ValueList createValueList(long type,
                                        java.lang.String volume,
                                        java.lang.String path,
                                        Syntax syn)
Creates an NDS Path ValueList.

Parameters:
type - Refer to NDS Schema Reference.
volume - Refer to NDS Schema Reference.
path - Refer to NDS Schema Reference.
syn - The syntax for this value, either NDSSyntax.SYN_PATH or LDAPSyntax.SYN_TAGGED_NAME_AND_STRING.
Returns:
A new Path ValueList.

getPath

public java.lang.String getPath()
Retrieves the path name.

Returns:
The path name.

getType

public long getType()
Retrieves the path type.

Returns:
The path type.

getVolume

public java.lang.String getVolume()
Retrieves the volume name.

Returns:
The volume name.

setPath

public void setPath(java.lang.String path)
Sets the path.

Parameters:
path - The path.

setType

public void setType(long type)
Sets the path type.

Parameters:
type - The type.

setVolume

public void setVolume(java.lang.String volume)
Sets the volume name.

Parameters:
volume - The volume name.
Throws:
FacadeParameterException - Can not set to value requested.


API Documentation Copyright © 1998-2004 Novell, Inc. All rights reserved.
NDS is a registered trademark of Novell, Inc. in the United States and other countries.
Generated September 2 2004 0111.