oracle.dss.metadataManager.common
Class MDFolder

java.lang.Object
  |
  +--oracle.dss.metadataUtil.PropertyBag
        |
        +--oracle.dss.metadataManager.common.MDObject
              |
              +--oracle.dss.metadataManager.common.MDFolder

All Implemented Interfaces:

BIContext, javax.naming.Context, javax.naming.directory.DirContext, java.io.Serializable

Direct Known Subclasses:

MDDimension, MDHierarchy, MDRoot

public class MDFolder

extends MDObject

implements BIContext

The directory service class for the MetadataManager. An MDFolder represents a folder in the hierarchy of metadata objects.

An MDFolder is a DirContext in the Java Naming and Directory Interface (JNDI).

See Also:

DirContext, Serialized Form

Fields inherited from interface javax.naming.directory.DirContext

ADD_ATTRIBUTE, REMOVE_ATTRIBUTE, REPLACE_ATTRIBUTE

Fields inherited from interface javax.naming.Context

APPLET, AUTHORITATIVE, BATCHSIZE, DNS_URL, INITIAL_CONTEXT_FACTORY, LANGUAGE, OBJECT_FACTORIES, PROVIDER_URL, REFERRAL, SECURITY_AUTHENTICATION, SECURITY_CREDENTIALS, SECURITY_PRINCIPAL, SECURITY_PROTOCOL, STATE_FACTORIES, URL_PKG_PREFIXES

Method Summary

java.lang.Object	addToEnvironment(java.lang.String propName, java.lang.Object propValue) Adds a property to the current environment setting.
void	bind(javax.naming.Name name, java.lang.Object object) Saves an object through the MetadataManager.
void	bind(javax.naming.Name name, java.lang.Object object, javax.naming.directory.Attributes attrs) Saves an object through the MetadataManager.
void	bind(java.lang.String name, java.lang.Object object) Saves an object through the MetadataManager.
void	bind(java.lang.String name, java.lang.Object object, javax.naming.directory.Attributes attrs) Saves an object through the MetadataManager.
void	close() Closes this context and releases all the resources that it held.
javax.naming.Name	composeName(javax.naming.Name name, javax.naming.Name prefix) Combines parts of a path name to a single Name.
java.lang.String	composeName(java.lang.String name, java.lang.String prefix) Combines parts of a path name to a single Name.
void	copy(javax.naming.Name name, javax.naming.directory.DirContext context, javax.naming.Name newName, int mode) Copies an existing context or object.
void	copy(java.lang.String name, javax.naming.directory.DirContext context, java.lang.String newName, int mode) Copies an existing context or object.
javax.naming.Context	createSubcontext(javax.naming.Name name) Creates an MDFolder that represents a folder.
javax.naming.directory.DirContext	createSubcontext(javax.naming.Name name, javax.naming.directory.Attributes attrs) Creates an MDFolder that represents a folder.
javax.naming.Context	createSubcontext(java.lang.String name) Creates an MDFolder that represents a folder.
javax.naming.directory.DirContext	createSubcontext(java.lang.String name, javax.naming.directory.Attributes attrs) Creates an MDFolder that represents a folder.
void	destroySubcontext(javax.naming.Name name) Removes a folder from the MetadataManager.
void	destroySubcontext(java.lang.String name) Removes a folder from the MetadataManager.
Acl	getAcl() Retrieves the access control list for this context.
javax.naming.directory.Attributes	getAttributes(javax.naming.Name name) Retrieves all of the persistence attributes for an object, and for an OLAP object, all OLAP-specific properties of the object.
javax.naming.directory.Attributes	getAttributes(javax.naming.Name name, java.lang.String[] attrIds) Retrieves the specified persistence attributes for an object.
javax.naming.directory.Attributes	getAttributes(java.lang.String name) Retrieves all of the persistence attributes for an object, and for an OLAP object, all OLAP-specific properties of the object.
javax.naming.directory.Attributes	getAttributes(java.lang.String name, java.lang.String[] attrIds) Retrieves the specified persistence attributes for an object.
MDDimension[]	getDimensions() Retrieves the dimensions in this folder.
java.util.Hashtable	getEnvironment() Retrieves the environment for this context.
ErrorHandler	getErrorHandler() Retrieves the error handler for this folder.
MDFolder[]	getFolders() Retrieves the folders that are children of this folder.
java.util.Locale	getLocale() Retrieves the locale for this folder.
MDMeasure[]	getMeasures() Retrieves the measures in this folder.
javax.naming.NameParser	getNameParser(javax.naming.Name name) Retrieves the name parser for a folder.
javax.naming.NameParser	getNameParser(java.lang.String name) Retrieves the name parser for a folder.
MDSelection[]	getSelections() Retrieves the selections in this folder.
javax.naming.NamingEnumeration	list(javax.naming.Name name) Enumerates the names and class names of the objects in a folder.
javax.naming.NamingEnumeration	list(java.lang.String name) Enumerates the names and class names of the objects in a folder.
javax.naming.NamingEnumeration	listBindings(javax.naming.Name name) Enumerates the objects in a folder, with their names and class names.
javax.naming.NamingEnumeration	listBindings(java.lang.String name) Enumerates the objects in a folder, with their names and class names.
java.lang.Object	lookup(javax.naming.Name name) Loads a Persistable object or folder from the MetadataManager.
java.lang.Object	lookup(javax.naming.Name name, java.util.Hashtable referenceResolver) Loads a Persistable object or folder from the MetadataManager.
java.lang.Object	lookup(javax.naming.Name name, Persistable obj) Applies XML from a Persistable object from the MetadataManager to an existing Persistable object.
java.lang.Object	lookup(javax.naming.Name name, Persistable _pObj, java.util.Hashtable referenceResolver) Applies XML from a Persistable object to an existing Persistable object.
java.lang.Object	lookup(java.lang.String name) Loads a Persistable object or folder from the MetadataManager.
java.lang.Object	lookup(java.lang.String name, java.util.Hashtable referenceResolver) Loads a Persistable object or folder from the MetadataManager.
java.lang.Object	lookup(java.lang.String name, Persistable obj) Applies XML from a Persistable object to an existing Persistable object.
java.lang.Object	lookup(java.lang.String name, Persistable obj, java.util.Hashtable referenceResolver) Applies XML from a Persistable object to an existing Persistable object.
java.lang.Object	lookupLink(javax.naming.Name name) Loads a Persistable object or folder through the MetadataManager.
java.lang.Object	lookupLink(java.lang.String name) Loads a Persistable object or folder from the MetadataManager.
void	modifyAttributes(javax.naming.Name name, int mod_op, javax.naming.directory.Attributes attrs) Modifies persistence attributes for an object.
void	modifyAttributes(javax.naming.Name name, javax.naming.directory.ModificationItem[] mods) Modifies persistence attributes for an object.
void	modifyAttributes(java.lang.String name, int mod_op, javax.naming.directory.Attributes attrs) Modifies persistence attributes for an object.
void	modifyAttributes(java.lang.String name, javax.naming.directory.ModificationItem[] mods) Modifies persistence attributes for an object.
void	move(javax.naming.Name name, javax.naming.directory.DirContext context) Moves an existing context or object.
void	move(java.lang.String name, javax.naming.directory.DirContext context) Moves an existing context or object.
void	rebind(javax.naming.Name name, java.lang.Object object) Saves an object through the MetadataManager.
void	rebind(javax.naming.Name name, java.lang.Object object, javax.naming.directory.Attributes attrs) Saves an object through the MetadataManager.
void	rebind(java.lang.String name, java.lang.Object object) Saves an object through the MetadataManager.
void	rebind(java.lang.String name, java.lang.Object object, javax.naming.directory.Attributes attrs) Saves an object through the MetadataManager.
java.lang.Object	removeFromEnvironment(java.lang.String propName) Removes a property from the environment setting.
void	rename(javax.naming.Name oldName, javax.naming.Name newName) Renames a Persistable object in the MetadataManager in this context.
void	rename(java.lang.String oldName, java.lang.String newName) Renames a Persistable object in the MetadataManager in this context.
javax.naming.NamingEnumeration	search(javax.naming.Name name, javax.naming.directory.Attributes matchingAttributes) Searches a folder for objects that have specified attributes.
javax.naming.NamingEnumeration	search(javax.naming.Name name, javax.naming.directory.Attributes matchingAttributes, javax.naming.directory.SearchControls controls) Searches a folder for objects that have specified attributes, using the specified search scope.
javax.naming.NamingEnumeration	search(javax.naming.Name name, javax.naming.directory.Attributes matchingAttributes, java.lang.String[] attributesToReturn) Searches a folder for objects that have specified attributes.
javax.naming.NamingEnumeration	search(java.lang.String name, javax.naming.directory.Attributes matchingAttributes) Searches a folder for objects that have specified attributes.
javax.naming.NamingEnumeration	search(java.lang.String name, javax.naming.directory.Attributes matchingAttributes, javax.naming.directory.SearchControls controls) Searches a folder for objects that have specified attributes, using the specified search scope.
javax.naming.NamingEnumeration	search(java.lang.String name, javax.naming.directory.Attributes matchingAttributes, java.lang.String[] attributesToReturn) Searches a folder for objects that have specified attributes.
int	setFolders(MDFolder[] folders) Specifies folders to be children of this folder.
void	setLocale(java.util.Locale locale) Specifies the locale for this folder.
void	unbind(javax.naming.Name name) Removes a Persistable object from the MetadataManager.
void	unbind(java.lang.String name) Removes a Persistable from the MetadataManager.

Methods inherited from class oracle.dss.metadataManager.common.MDObject

getClassName, getDescription, getDriverType, getDriverTypes, getLabel, getLongLabel, getMetadataManagerServices, getName, getObjectType, getPath, getShortLabel, getSubObjectType, getUniqueID, nameEquals, setClassName, setDriverType, setMetadataManagerServices, setName, setObjectType, setSubObjectType, toString, toString

Methods inherited from class oracle.dss.metadataUtil.PropertyBag

getIntPropertyValue, getLongPropertyValue, getObjPropertyValue, getPropertyDataType, getStringVectorPropertyValue, getStrPropertyValue, mergePropertyBags, removeProperty, setIntPropertyValue, setIntPropertyValue, setLongPropertyValue, setLongPropertyValue, setObjPropertyValue, setObjPropertyValue, setProperty, setPropertyBag, setStringVectorPropertyValue, setStringVectorPropertyValue, setStrPropertyValue, setStrPropertyValue, size

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface oracle.dss.bicontext.BIContext

refresh

Methods inherited from interface javax.naming.directory.DirContext

getSchema, getSchema, getSchemaClassDefinition, getSchemaClassDefinition, search, search, search, search

Methods inherited from interface javax.naming.Context

getNameInNamespace

Method Detail

getErrorHandler

public ErrorHandler getErrorHandler()

Retrieves the error handler for this folder.

Returns:

The error handler for this folder.

lookup

public java.lang.Object lookup(javax.naming.Name name)
                        throws javax.naming.NamingException

Loads a Persistable object or folder from the MetadataManager. If you are retrieving an object, then this method instantiates a new Persistable object. To reuse an existing Persistable, call one of the lookup methods that takes a Persistable as a parameter.

Specified by:

lookup in interface javax.naming.Context

Parameters:

name - The name of the object to load. Do not pass null.

Returns:

The requested object or folder. The object will implement the Persistable interface.

Throws:

BIInvalidNameException - If name is null or empty.

BINameNotFoundException - If the object or folder cannot be found.

BINamingException - if any other naming error occurs.

See Also:

lookup(String), lookup(Name, Persistable), lookup(Name, Persistable, Hashtable), Persistable

lookup

public java.lang.Object lookup(javax.naming.Name name,
                               java.util.Hashtable referenceResolver)
                        throws javax.naming.NamingException

Loads a Persistable object or folder from the MetadataManager.

Parameters:

name - The name of the object to load. Do not pass null.

referenceResolver - Any arguments that the object needs in order to be loaded. For example, if you are loading a Query object, pass a QueryManager in the referenceResolver hash table.

Returns:

The requested object or folder. The object will implement the Persistable interface.

Throws:

BIInvalidNameException - If name is null or empty.

BINameNotFoundException - If the object or folder cannot be found.

BINamingException - if any other naming error occurs.

See Also:

lookup(String, Hashtable), MDObject, Query, QueryManager, Persistable

lookup

public java.lang.Object lookup(javax.naming.Name name,
Persistable obj)
                        throws javax.naming.NamingException

Applies XML from a Persistable object from the MetadataManager to an existing Persistable object.

Specified by:

lookup in interface BIContext

Parameters:

name - The name of the object whose XML to read. Do not pass null.

obj - The Persistable object into which to read the XML from name. It must be the same object type as name.

Returns:

The requested object or folder. The object is the same object that you passed in obj, with the saved XML applied to it.

Throws:

BIInvalidNameException - If name is null or empty.

BINameNotFoundException - If the object or folder cannot be found.

BINamingException - if any other naming error occurs.

See Also:

lookup(String, Persistable), Persistable

lookup

public java.lang.Object lookup(javax.naming.Name name,
Persistable _pObj,
                               java.util.Hashtable referenceResolver)
                        throws javax.naming.NamingException

Applies XML from a Persistable object to an existing Persistable object.

Specified by:

lookup in interface BIContext

Parameters:

name - The name of the object whose XML to read. Do not pass null.

_pObj - The Persistable object into which to read the XML from name. It must be the same object type as name.

referenceResolver - Any arguments that the object needs in order to be loaded. For example, if you are loading a Query object, pass a QueryManager in the referenceResolver hash table.

Returns:

The requested object or folder. The object is the same object that you passed in obj, with the saved XML applied to it.

Throws:

BIInvalidNameException - If name is null or empty.

BINameNotFoundException - If the object or folder cannot be found.

BINamingException - If any other naming error occurs.

See Also:

lookup(String, Persistable, Hashtable), Persistable, Query, QueryManager, Persistable

lookup

public java.lang.Object lookup(java.lang.String name)
                        throws javax.naming.NamingException

Loads a Persistable object or folder from the MetadataManager. If you are looking up an object, then this method instantiates a new Persistable object. To reuse an existing Persistable, call one of the lookup methods that takes a Persistable as a parameter.

Specified by:

lookup in interface javax.naming.Context

Parameters:

name - The name of the object to load. Do not pass null.

Returns:

The requested object or folder. The object will implement the Persistable interface.

Throws:

BIInvalidNameException - If name is null or empty.

BINameNotFoundException - If the object or folder cannot be found.

BINamingException - If any other naming error occurs.

See Also:

lookup(Name), lookup(String, Persistable), lookup(String, Persistable, Hashtable), Persistable

lookup

public java.lang.Object lookup(java.lang.String name,
                               java.util.Hashtable referenceResolver)
                        throws javax.naming.NamingException

Loads a Persistable object or folder from the MetadataManager.

Parameters:

name - The name of the object to load. Do not pass null.

referenceResolver - Any arguments that the object needs in order to be loaded. For example, if you are loading a Query object, pass a QueryManager in the referenceResolver hash table.

Returns:

The requested object or folder. The object will implement the Persistable interface.

Throws:

BIInvalidNameException - If name is null or empty.

BINameNotFoundException - If the object or folder cannot be found.

BINamingException - If any other naming error occurs.

See Also:

lookup(Name, Hashtable), Query, QueryManager, Persistable

lookup

public java.lang.Object lookup(java.lang.String name,
Persistable obj)
                        throws javax.naming.NamingException

Applies XML from a Persistable object to an existing Persistable object.

Specified by:

lookup in interface BIContext

Parameters:

name - The name of the object whose XML to read. Do not pass null.

obj - The Persistable object into which to read the XML from name. It must be the same object type as name.

Returns:

The requested object. The object is the same object that you passed in obj, with the saved XML applied to it.

Throws:

BIInvalidNameException - If name is null or empty.

BINameNotFoundException - If the object or folder cannot be found.

BINamingException - If any other naming error occurs.

See Also:

lookup(Name, Persistable), Persistable

lookup

public java.lang.Object lookup(java.lang.String name,
Persistable obj,
                               java.util.Hashtable referenceResolver)
                        throws javax.naming.NamingException

Applies XML from a Persistable object to an existing Persistable object.

Specified by:

lookup in interface BIContext

Parameters:

name - The name of the object to load. Do not pass null.

obj - The Persistable object into which to read the XML from name. It must be the same object type as name.

referenceResolver - Any arguments that the object needs in order to be loaded. For example, if you are loading a Query object, pass a QueryManager in the referenceResolver hash table.

Returns:

The requested object. The object is the same object that you passed in obj, with the saved XML applied to it.

Throws:

BIInvalidNameException - If name is null or empty.

BINameNotFoundException - If the object or folder cannot be found.

BINamingException - If any other naming error occurs.

See Also:

lookup(Name, Persistable, Hashtable), Query, QueryManager, Persistable

bind

public void bind(javax.naming.Name name,
                 java.lang.Object object)
          throws javax.naming.NamingException

Saves an object through the MetadataManager. This method binds name to object, so that object can be found later. This method is useful only for Persistable objects that are being stored in the BI Beans Catalog. Calling this method on a metadata object is not useful.

Specified by:

bind in interface javax.naming.Context

Parameters:

name - The path name of the object that this method saves. Do not pass null or an empty Name. The path that you specify must exist. This method does not create intermediate subcontexts.

object - The object to save. The object must implement the the Persistable interface.

Throws:

BIInvalidNameException - If name is null or empty.

BINameAlreadyBoundException - If another object is already bound to name. Call rebind to replace a binding.

BINoPermissionException - If the caller does not have permission to save objects to this context.

BINamingException - If another naming error occurs, such as when object is null or when object does not implement the Persistable interface. Also throws BINamingException if you try to use this method to create a folder. Call createSubcontext instead.

See Also:

bind(String, Object), createSubcontext(javax.naming.Name), rebind(javax.naming.Name, java.lang.Object), Persistable

bind

public void bind(java.lang.String name,
                 java.lang.Object object)
          throws javax.naming.NamingException

Saves an object through the MetadataManager. This method binds name to object, so that object can be found later. This method is useful only for Persistable objects that are being stored in the BI Beans Catalog. Calling this method on a metadata object is not useful.

Specified by:

bind in interface javax.naming.Context

Parameters:

name - The path name of the object that this method saves. Do not pass null or an empty Name. The path that you specify must exist. This method does not create intermediate subcontexts.

object - The object to save. The object must implement the the Persistable interface.

Throws:

BIInvalidNameException - If name is null or empty.

BINameAlreadyBoundException - If another object is already bound to name. Call rebind to replace a binding.

BINoPermissionException - If the caller does not have permission to save objects to this context.

BINamingException - If another naming error occurs, such as when object is null or when object does not implement the Persistable interface. Also throws BINamingException if you try to use this method to create a folder. Call createSubcontext instead.

See Also:

bind(Name, Object), createSubcontext(javax.naming.Name), rebind(javax.naming.Name, java.lang.Object), MDObject, Persistable

rebind

public void rebind(javax.naming.Name name,
                   java.lang.Object object)
            throws javax.naming.NamingException

Saves an object through the MetadataManager. This method binds name to object, so that object can be found later. This method is useful only for Persistable objects that are being stored in the BI Beans Catalog. Calling this method on a metadata object is not useful.

This method binds an object to a name that might be already bound, if that is the case, the old object is replaced. If the name is not already bound, then this method binds the object to the name, just as the bind method does.

Specified by:

rebind in interface javax.naming.Context

Parameters:

name - The path name of the object that this method saves. Do not pass null or an empty Name. The path that you specify must exist. This method does not create intermediate subcontexts.

object - The object to save. The object must implement the the Persistable interface.

attrs - Attributes for object.

Throws:

BIInvalidNameException - If name is null or empty.

BINamingException - If object is a PersistenceManagerImpl. Call createSubcontext to create a folder.

BINoPermissionException - If the caller does not have permission to save objects to this context.

javax.naming.NamingException - If another naming error occurs, such as when object is null or when object does not implement the Persistable interface. Also throws BINamingException if you try to use this method to create a folder. Call createSubcontext instead.

See Also:

rebind(String, Object), Persistable

rebind

public void rebind(java.lang.String name,
                   java.lang.Object object)
            throws javax.naming.NamingException

Saves an object through the MetadataManager. This method binds name to object, so that object can be found later. This method is useful only for Persistable objects that are being stored in the BI Beans Catalog. Calling this method on a metadata object is not useful.

This method binds an object to a name that might be already bound, if that is the case, the old object is replaced. If the name is not already bound, then this method binds the object to the name, just as the bind method does.

Specified by:

rebind in interface javax.naming.Context

Parameters:

name - The path name of the object that this method saves. Do not pass null or an empty Name. The path that you specify must exist. This method does not create intermediate subcontexts.

object - The object to save. The object must implement the the Persistable interface.

attrs - Attributes for object.

Throws:

BIInvalidNameException - If name is null or empty.

BINamingException - If object is a PersistenceManagerImpl. Call createSubcontext to create a folder.

BINoPermissionException - If the caller does not have permission to save objects to this context.

javax.naming.NamingException - If another naming error occurs, such as when object is null or when object does not implement the Persistable interface. Also throws BINamingException if you try to use this method to create a folder. Call createSubcontext instead.

See Also:

rebind(Name, Object), Persistable

unbind

public void unbind(javax.naming.Name name)
            throws javax.naming.NamingException

Removes a Persistable object from the MetadataManager. This method removes the binding of the object. This method is useful only for Persistable objects. Calling this method on a metadata object is not useful.

Specified by:

unbind in interface javax.naming.Context

Parameters:

name - The name of the object to remove.

Throws:

BINameNotFoundException - If the named object is not found in the MetadataManager.

BIInvalidNameException - If name is null or empty.

BIOperationNotSupportedException - If name identifies an OLAP object, such as a dimension.

BINamingException - If any other naming error occurs.

See Also:

unbind(String)

unbind

public void unbind(java.lang.String name)
            throws javax.naming.NamingException

Removes a Persistable from the MetadataManager. This method removes the binding of the object. This method is useful only for Persistable objects. Calling this method on a metadata object is not useful.

Specified by:

unbind in interface javax.naming.Context

Parameters:

name - The name of the object to remove.

Throws:

BINameNotFoundException - If the named object is not found in the MetadataManager.

BIInvalidNameException - If name is null or empty.

BIOperationNotSupportedException - If name identifies an OLAP object, such as a dimension.

BINamingException - If any other naming error occurs.

See Also:

unbind(String)

rename

public void rename(javax.naming.Name oldName,
                   javax.naming.Name newName)
            throws javax.naming.NamingException

Renames a Persistable object in the MetadataManager in this context. The oldName and the newName arguments must both specify the same context. To move an object from one folder to another, use the move method.

This method is useful only for Persistable objects. Calling this method on a metadata object is not useful.

Specified by:

rename in interface javax.naming.Context

Parameters:

oldName - The current name of an existing object or folder. Do not pass null or an empty Name.

newName - The new name to assign to this object or folder. Do not pass null or an empty Name.

Throws:

BIInvalidNameException - If name is null or empty.

BINameNotFoundException - If oldName cannot be found in this context.

BINameAlreadyBoundException - If newName is already bound to an object.

BINoPermissionException - If the caller does not have permission to rename objects in this context.

BINamingException - If any other naming error occurs.

See Also:

rename(String, String)

rename

public void rename(java.lang.String oldName,
                   java.lang.String newName)
            throws javax.naming.NamingException

Renames a Persistable object in the MetadataManager in this context. The oldName and the newName arguments must both specify the same context. To move an object from one folder to another, use the move method.

This method is useful only for Persistable objects. Calling this method on a metadata object is not useful.

Specified by:

rename in interface javax.naming.Context

Parameters:

oldName - The current name of an existing object or folder. Do not pass null or an empty Name.

newName - The new name to assign to this object or folder. Do not pass null or an empty Name.

Throws:

BIInvalidNameException - If name is null or empty.

BINameNotFoundException - If oldName cannot be found in this context.

BINameAlreadyBoundException - If newName is already bound to an object.

BINoPermissionException - If the caller does not have permission to rename objects in this context.

BINamingException - If any other naming error occurs.

See Also:

rename(Name, Name)

list

public javax.naming.NamingEnumeration list(javax.naming.Name name)
                                    throws javax.naming.NamingException

Enumerates the names and class names of the objects in a folder. This method returns an enumeration of names and class names of the objects in a specified folder. If you want access to the objects, call listBindings.

Specified by:

list in interface javax.naming.Context

Parameters:

name - The name of the folder whose contents you want. Do not pass null or an empty Name.

Returns:

An enumeration of NameClassPair objects, one for each object in the folder. Each NameClassPair contains the name and the class name of an object.

Throws:

BIInvalidNameException - If name is null or empty.

BINamingException - If any other naming error occurs.

See Also:

listBindings(javax.naming.Name), list(String), NameClassPair

list

public javax.naming.NamingEnumeration list(java.lang.String name)
                                    throws javax.naming.NamingException

Enumerates the names and class names of the objects in a folder. This method returns an enumeration of names and class names of the objects in a specified folder. If you want access to the objects, call listBindings.

Specified by:

list in interface javax.naming.Context

Parameters:

name - The name of the folder whose contents you want. Do not pass null or an empty Name.

Returns:

An enumeration of NameClassPair objects, one for each object in the folder. Each NameClassPair contains the name and the class name of an object.

Throws:

BIInvalidNameException - If name is null or empty.

BINamingException - If any other naming error occurs.

See Also:

listBindings(javax.naming.Name), list(Name), NameClassPair

listBindings

public javax.naming.NamingEnumeration listBindings(javax.naming.Name name)
                                            throws javax.naming.NamingException

Enumerates the objects in a folder, with their names and class names. If you do not need access to the objects, call list.

Specified by:

listBindings in interface javax.naming.Context

Parameters:

name - The name of the folder whose contents you want. Do not pass null. To specify the current folder, pass an empty Name.

Returns:

An enumeration of Binding objects, one for each object in the folder. Each Binding contains the name of an object, its class name, and the object itself.

Throws:

BIInvalidNameException - if name is null.

BINamingException - If any other naming error occurs.

See Also:

list(javax.naming.Name), listBindings(String), Binding

listBindings

public javax.naming.NamingEnumeration listBindings(java.lang.String name)
                                            throws javax.naming.NamingException

Enumerates the objects in a folder, with their names and class names. If you do not need access to the objects, call list.

Specified by:

listBindings in interface javax.naming.Context

Parameters:

name - The name of the folder whose contents you want. Do not pass null. To specify the current folder, pass an empty Name.

Returns:

An enumeration of Binding objects, one for each object in the folder. Each Binding contains the name of an object, its class name, and the object itself.

Throws:

BIInvalidNameException - if name is null.

BINamingException - If any other naming error occurs.

See Also:

list(javax.naming.Name), listBindings(Name), Binding

destroySubcontext

public void destroySubcontext(javax.naming.Name name)
                       throws javax.naming.NamingException

Removes a folder from the MetadataManager. This method is useful only when the MDFolder is not a metadata object, such as an MDDimension. Calling this method on a metadata object is not useful.

Specified by:

destroySubcontext in interface javax.naming.Context

Parameters:

name - The name of the folder to remove. Do not pass null or an empty Name.

Throws:

BIInvalidNameException - If name is null or empty.

BINoPermissionException - If the caller does not have the level of privilege necessary to remove the folder. You must have permission to all folders in the path.

BINotContextException - If name is not a context. To remove an object, call unbind.

BINamingException - If any other naming error occurs.

See Also:

destroySubcontext(String)

destroySubcontext

public void destroySubcontext(java.lang.String name)
                       throws javax.naming.NamingException

Removes a folder from the MetadataManager. This method is useful only when the MDFolder is not a metadata object, such as an MDDimension. Calling this method on a metadata object is not useful.

Specified by:

destroySubcontext in interface javax.naming.Context

Parameters:

name - The name of the folder to remove. Do not pass null or an empty Name.

Throws:

BIInvalidNameException - If name is null or empty.

BINoPermissionException - If the caller does not have the level of privilege necessary to remove the folder. You must have permission to all folders in the path.

BINamingException - If any other naming error occurs.

See Also:

destroySubcontext(Name)

createSubcontext

public javax.naming.Context createSubcontext(javax.naming.Name name)
                                      throws javax.naming.NamingException

Creates an MDFolder that represents a folder. This method is useful only when the MDFolder is not a metadata object, such as an MDDimension. Calling this method on a metadata object is not useful.

Specified by:

createSubcontext in interface javax.naming.Context

Parameters:

name - The name for the folder to create. Do not pass null or an empty Name.

Returns:

The MDFolder for the new folder.

Throws:

BIInvalidNameException - If name is null or empty.

BINameAlreadyBoundException - If another object is already bound to name.

BINoPermissionException - If the caller does not have permission to create folders in this context.

BIOperationNotSupportedException - If name identifies an OLAP object.

javax.naming.NamingException - If any other naming error occurs.

See Also:

createSubcontext(String)

createSubcontext

public javax.naming.Context createSubcontext(java.lang.String name)
                                      throws javax.naming.NamingException

Creates an MDFolder that represents a folder. This method is useful only when the MDFolder is not a metadata object, such as an MDDimension. Calling this method on a metadata object is not useful.

Specified by:

createSubcontext in interface javax.naming.Context

Parameters:

name - The name for the folder to create. Do not pass null or an empty Name.

Returns:

The MDFolder for the new folder.

Throws:

BIInvalidNameException - If name is null or empty.

BINameAlreadyBoundException - If another object is already bound to name.

BINoPermissionException - If the caller does not have permission to create folders in this context.

javax.naming.NamingException - If any other naming error occurs.

See Also:

createSubcontext(Name)

lookupLink

public java.lang.Object lookupLink(javax.naming.Name name)
                            throws javax.naming.NamingException

Loads a Persistable object or folder through the MetadataManager. Currently, this method simply calls the lookup method.

This method is useful only for Persistable objects. Calling this method on a metadata object is not useful.

Specified by:

lookupLink in interface javax.naming.Context

Parameters:

name - The name of the object to load. The object must implement the Persistable interface. Do not pass null.

Returns:

The requested object or folder.

Throws:

BINameNotFoundException - If the object or folder cannot be found.

BINamingException - If any other naming error occurs.

See Also:

lookupLink(String), Persistable

lookupLink

public java.lang.Object lookupLink(java.lang.String name)
                            throws javax.naming.NamingException

Loads a Persistable object or folder from the MetadataManager. Currently, this method simply calls the lookup method.

This method is useful only for Persistable objects. Calling this method on a metadata object is not useful.

Specified by:

lookupLink in interface javax.naming.Context

Parameters:

name - The name of the object to load. The object must be an instance of the MDObject class or any of its subclasses. Do not pass null.

Returns:

The requested object or folder.

Throws:

BINameNotFoundException - If the object or folder cannot be found.

BINamingException - If any other naming error occurs.

See Also:

lookupLink(Name), Persistable

getNameParser

public javax.naming.NameParser getNameParser(javax.naming.Name name)
                                      throws javax.naming.NamingException

Retrieves the name parser for a folder.

Specified by:

getNameParser in interface javax.naming.Context

Parameters:

name - The name of the folder for which to get the parser. Currently, all folders uses the same name parser, so you can pass the name of any context.

Returns:

The name parser for the specified folder.

Throws:

javax.naming.NamingException - If a naming error occurs.

See Also:

getNameParser(String)

getNameParser

public javax.naming.NameParser getNameParser(java.lang.String name)
                                      throws javax.naming.NamingException

Retrieves the name parser for a folder.

Specified by:

getNameParser in interface javax.naming.Context

Parameters:

name - The name of the folder for which to get the parser. Currently, all folders uses the same name parser, so you can pass the name of any context.

Returns:

The name parser for the specified folder.

Throws:

javax.naming.NamingException - If a naming error occurs.

See Also:

getNameParser(String)

composeName

public javax.naming.Name composeName(javax.naming.Name name,
                                     javax.naming.Name prefix)
                              throws javax.naming.NamingException

Combines parts of a path name to a single Name. Normally, you use this method to combine the name of an object relative to this context with the name of this context, to create a full path name.

Specified by:

composeName in interface javax.naming.Context

Parameters:

name - The name of an object in this context or one of its subcontexts.

prefix - The name of this context, as it relates to one of its ancestors. Do not pass null.

Returns:

The name that is composed from prefix and name.

Throws:

InvalidNameException - If name is not a valid name, or if the resulting name is not valid.

javax.naming.NamingException - If any other naming error occurs.

See Also:

composeName(String, String)

composeName

public java.lang.String composeName(java.lang.String name,
                                    java.lang.String prefix)
                             throws javax.naming.NamingException

Combines parts of a path name to a single Name. Normally, you use this method to combine the name of an object relative to this context with the name of this context, to create a full path name.

Specified by:

composeName in interface javax.naming.Context

Parameters:

name - The name of an object in this context or one of its subcontexts.

prefix - The name of this context, as it relates to one of its ancestors. Do not pass null.

Returns:

The name that is composed from prefix and name.

Throws:

InvalidNameException - If name is not a valid name, or if the resulting name is not valid.

javax.naming.NamingException - If any other naming error occurs.

See Also:

composeName(Name, Name)

addToEnvironment

public java.lang.Object addToEnvironment(java.lang.String propName,
                                         java.lang.Object propValue)
                                  throws javax.naming.NamingException

Adds a property to the current environment setting. If the property already exists, then this method replaces the existing property and returns the replaced property.

Specified by:

addToEnvironment in interface javax.naming.Context

Parameters:

propName - The name of the property to add. Do not pass null.

propValue - The value of the property to add. Do not pass null.

Returns:

The name of the replaced property, if one exists. Otherwise, returns null.

Throws:

javax.naming.NamingException - If a naming error occurs.

removeFromEnvironment

public java.lang.Object removeFromEnvironment(java.lang.String propName)
                                       throws javax.naming.NamingException

Removes a property from the environment setting.

Specified by:

removeFromEnvironment in interface javax.naming.Context

Parameters:

propName - The property to remove. Do not pass null.

Returns:

The value that was stored for the removed property, or null.

Throws:

javax.naming.NamingException - If a naming error occurs.

getEnvironment

public java.util.Hashtable getEnvironment()
                                   throws javax.naming.NamingException

Retrieves the environment for this context. This method returns a copy of the environment Hashtable. Changes you make to the returned Hashtable are not reflected in the original environment. To modify the environment, call addToEnvironment or removeFromEnvironment.

Specified by:

getEnvironment in interface javax.naming.Context

Returns:

A copy of the environment settings for this context.

Throws:

javax.naming.NamingException - If a naming error occurs.

See Also:

addToEnvironment(java.lang.String, java.lang.Object), removeFromEnvironment(java.lang.String)

close

public void close()
           throws javax.naming.NamingException

Closes this context and releases all the resources that it held.

Specified by:

close in interface javax.naming.Context

Throws:

javax.naming.NamingException - If a naming error occurs.

getAttributes

public javax.naming.directory.Attributes getAttributes(javax.naming.Name name)
                                                throws javax.naming.NamingException

Retrieves all of the persistence attributes for an object, and for an OLAP object, all OLAP-specific properties of the object.

Specified by:

getAttributes in interface javax.naming.directory.DirContext

Parameters:

name - The name of the object that you want attributes for. Do not pass null.

Returns:

The attributes for name.

Throws:

BIInvalidNameException - If name is null or empty.

BINoPermissionException - If name is the root folder.

javax.naming.NamingException - If any other naming error occurs.

See Also:

getAttributes(String)

getAttributes

public javax.naming.directory.Attributes getAttributes(java.lang.String name)
                                                throws javax.naming.NamingException

Retrieves all of the persistence attributes for an object, and for an OLAP object, all OLAP-specific properties of the object.

Specified by:

getAttributes in interface javax.naming.directory.DirContext

Parameters:

name - The name of the object that you want attributes for. Do not pass null.

Returns:

The attributes for name.

Throws:

BIInvalidNameException - If name is null or empty.

BINoPermissionException - If name is the root folder.

javax.naming.NamingException - If any other naming error occurs.

See Also:

getAttributes(Name)

getAttributes

public javax.naming.directory.Attributes getAttributes(javax.naming.Name name,
                                                       java.lang.String[] attrIds)
                                                throws javax.naming.NamingException

Retrieves the specified persistence attributes for an object. For an OLAP object, this method also retrieves specified OLAP-specific properties.

Specified by:

getAttributes in interface javax.naming.directory.DirContext

Parameters:

name - The name of the object that you want attributes for. Do not pass null.

attrIds - The attributes that you want to retrieve. To retrieve all of the attributes, pass null. If you pass an empty array, then this method returns null.

Returns:

The requested attributes for name.

Throws:

BIInvalidNameException - If name is null or empty.

BINoPermissionException - If name is in the root folder.

BINamingException - If any other naming error occurs.

See Also:

getAttributes(String, String[])

getAttributes

public javax.naming.directory.Attributes getAttributes(java.lang.String name,
                                                       java.lang.String[] attrIds)
                                                throws javax.naming.NamingException

Retrieves the specified persistence attributes for an object. For an OLAP object, this method also retrieves specified OLAP-specific properties.

Specified by:

getAttributes in interface javax.naming.directory.DirContext

Parameters:

name - The name of the object that you want attributes for. Do not pass null.

attrIds - The attributes that you want to retrieve. To retrieve all of the attributes, pass null. If you pass an empty array, then this method returns null.

Returns:

The requested attributes for name.

Throws:

BIInvalidNameException - If name is null or empty.

BINoPermissionException - If name is in the root folder.

BINamingException - If any other naming error occurs.

See Also:

getAttributes(Name, String[])

modifyAttributes

public void modifyAttributes(javax.naming.Name name,
                             int mod_op,
                             javax.naming.directory.Attributes attrs)
                      throws javax.naming.NamingException

Modifies persistence attributes for an object. Use this method when you want to use the same modification operation on multiple attributes.

Specified by:

modifyAttributes in interface javax.naming.directory.DirContext

Parameters:

name - The name of the object whose attributes you want to set. Do not pass null.

mod_op - A constant that identifies the modification that you want to make. This implementation supports only javax.naming.directory.DirContext.REPLACE_ATTRIBUTE. If you pass any other value, this method ignores the value and logs a message to the error handler.

attrs - A list of attributes that you want to modify.

Throws:

BIInvalidNameException - If name is null or empty.

BINoPermissionException - If name is in the root folder.

BIAttributeModificationException - If the modification fails.

BINamingException - If any other naming error occurs.

See Also:

modifyAttributes(String, int, Attributes)

modifyAttributes

public void modifyAttributes(java.lang.String name,
                             int mod_op,
                             javax.naming.directory.Attributes attrs)
                      throws javax.naming.NamingException

Modifies persistence attributes for an object. Use this method when you want to use the same modification operation on multiple attributes.

Specified by:

modifyAttributes in interface javax.naming.directory.DirContext

Parameters:

name - The name of the object whose attributes you want to set. Do not pass null.

mod_op - A constant that identifies the modification that you want to make. This implementation supports only javax.naming.directory.DirContext.REPLACE_ATTRIBUTE. If you pass any other value, this method ignores the value and logs a message to the error handler.

attrs - A list of attributes that you want to modify.

Throws:

BIInvalidNameException - If name is null or empty.

BINoPermissionException - If name is in the root folder.

BIAttributeModificationException - If the modification fails.

BINamingException - If any other naming error occurs.

See Also:

modifyAttributes(Name, int, Attributes)

modifyAttributes

public void modifyAttributes(javax.naming.Name name,
                             javax.naming.directory.ModificationItem[] mods)
                      throws javax.naming.NamingException

Modifies persistence attributes for an object.

Specified by:

modifyAttributes in interface javax.naming.directory.DirContext

Parameters:

name - The name of the object whose attributes you want to set. Do not pass null.

mods - An array of modifications that you want to make. Each ModificationItem identifies the modification that you want and the attribute that you want to change.

Throws:

BIInvalidNameException - If name is null or empty.

BINoPermissionException - If name is in the root folder.

BIAttributeModificationException - If the modification fails.

javax.naming.NamingException - If any other naming error occurs.

See Also:

modifyAttributes(String, ModificationItem[])

modifyAttributes

public void modifyAttributes(java.lang.String name,
                             javax.naming.directory.ModificationItem[] mods)
                      throws javax.naming.NamingException

Modifies persistence attributes for an object.

Specified by:

modifyAttributes in interface javax.naming.directory.DirContext

Parameters:

name - The name of the object whose attributes you want to set. Do not pass null.

mods - An array of modifications that you want to make. Each ModificationItem identifies the modification that you want and the attribute that you want to change.

Throws:

BIInvalidNameException - If name is null or empty.

BINoPermissionException - If name is in the root folder.

BIAttributeModificationException - If the modification fails.

javax.naming.NamingException - If any other naming error occurs.

See Also:

modifyAttributes(Name, ModificationItem[]), ModificationItem

bind

public void bind(javax.naming.Name name,
                 java.lang.Object object,
                 javax.naming.directory.Attributes attrs)
          throws javax.naming.NamingException

Saves an object through the MetadataManager. This method binds name to object, so that object can be found later. This method is useful only for Persistable objects that are being stored in the BI Beans Catalog. Calling this method on a metadata object is not useful.

Specified by:

bind in interface javax.naming.directory.DirContext

Parameters:

name - The path name of the object that this method saves. Do not pass null or an empty Name. The path that you specify must exist. This method does not create intermediate subcontexts.

object - The object to save. The object must implement the the Persistable interface.

attrs - Attributes for object.

Throws:

BIInvalidNameException - If name is null or empty.

BINameAlreadyBoundException - If another object is already bound to name. Call rebind to replace a binding.

BIInvalidAttributesException - If any of the attributes in attrs is invalid.

BINoPermissionException - If the caller does not have permission to save objects to this context.

BINamingException - If another naming error occurs, such as when object is null or when object does not implement the Persistable interface. Also throws BINamingException if you try to use this method to create a folder. Call createSubcontext instead.

See Also:

bind(String, Object, Attributes), createSubcontext(javax.naming.Name), rebind(javax.naming.Name, java.lang.Object), Persistable

bind

public void bind(java.lang.String name,
                 java.lang.Object object,
                 javax.naming.directory.Attributes attrs)
          throws javax.naming.NamingException

Saves an object through the MetadataManager. This method binds name to object, so that object can be found later. This method is useful only for Persistable objects that are being stored in the BI Beans Catalog. Calling this method on a metadata object is not useful.

Specified by:

bind in interface javax.naming.directory.DirContext

Parameters:

name - The path name of the object that this method saves. Do not pass null or an empty Name. The path that you specify must exist. This method does not create intermediate subcontexts.

object - The object to save. The object must implement the the Persistable interface.

attrs - Attributes for object.

Throws:

BIInvalidNameException - If name is null or empty.

BINameAlreadyBoundException - If another object is already bound to name. Call rebind to replace a binding.

BIInvalidAttributesException - If any of the attributes in attrs is invalid.

BINoPermissionException - If the caller does not have permission to save objects to this context.

BINamingException - If another naming error occurs, such as when object is null or when object does not implement the Persistable interface. Also throws BINamingException if you try to use this method to create a folder. Call createSubcontext instead.

See Also:

bind(Name, Object, Attributes), createSubcontext(javax.naming.Name), rebind(javax.naming.Name, java.lang.Object), Persistable

rebind

public void rebind(javax.naming.Name name,
                   java.lang.Object object,
                   javax.naming.directory.Attributes attrs)
            throws javax.naming.NamingException

Saves an object through the MetadataManager. This method binds name to object, so that object can be found later. This method is useful only for Persistable objects that are being stored in the BI Beans Catalog. Calling this method on a metadata object is not useful.

This method binds an object to a name that might be already bound, if that is the case, the old object is replaced. If the name is not already bound, then this method binds the object to the name, just as the bind method does.

Specified by:

rebind in interface javax.naming.directory.DirContext

Parameters:

name - The path name of the object that this method saves. Do not pass null or an empty Name. The path that you specify must exist. This method does not create intermediate subcontexts.

object - The object to save. The object must implement the the Persistable interface.

attrs - Attributes for object.

Throws:

BIInvalidNameException - If name is null or empty.

BINameAlreadyBoundException - If another object is already bound to name. Call rebind to replace a binding.

BIInvalidAttributesException - If any of the attributes in attrs is invalid.

BINoPermissionException - If the caller does not have permission to save objects to this context.

BINamingException - If another naming error occurs, such as when object is null or when object does not implement the Persistable interface. Also throws BINamingException if you try to use this method to create a folder. Call createSubcontext instead.

See Also:

bind(String, Object, Attributes), createSubcontext(javax.naming.Name), rebind(javax.naming.Name, java.lang.Object), Persistable

rebind

public void rebind(java.lang.String name,
                   java.lang.Object object,
                   javax.naming.directory.Attributes attrs)
            throws javax.naming.NamingException

Saves an object through the MetadataManager. This method binds name to object, so that object can be found later. This method is useful only for Persistable objects that are being stored in the BI Beans Catalog. Calling this method on a metadata object is not useful.

This method binds an object to a name that might be already bound, if that is the case, the old object is replaced. If the name is not already bound, then this method binds the object to the name, just as the bind method does.

Specified by:

rebind in interface javax.naming.directory.DirContext

Parameters:

name - The path name of the object that this method saves. Do not pass null or an empty Name. The path that you specify must exist. This method does not create intermediate subcontexts.

object - The object to save. The object must implement the the Persistable interface.

attrs - Attributes for object.

Throws:

BIInvalidNameException - If name is null or empty.

BINameAlreadyBoundException - If another object is already bound to name. Call rebind to replace a binding.

BIInvalidAttributesException - If any of the attributes in attrs is invalid.

BINoPermissionException - If the caller does not have permission to save objects to this context.

BINamingException - If another naming error occurs, such as when object is null or when object does not implement the Persistable interface. Also throws BINamingException if you try to use this method to create a folder. Call createSubcontext instead.

See Also:

bind(Name, Object, Attributes), createSubcontext(javax.naming.Name), rebind(javax.naming.Name, java.lang.Object), Persistable

createSubcontext

public javax.naming.directory.DirContext createSubcontext(javax.naming.Name name,
                                                          javax.naming.directory.Attributes attrs)
                                                   throws javax.naming.NamingException

Creates an MDFolder that represents a folder. This method is useful only when the MDFolder is not a metadata object, such as an MDDimension. Calling this method on a metadata object is not useful.

Specified by:

createSubcontext in interface javax.naming.directory.DirContext

Parameters:

name - The name for the folder to create. Do not pass null or an empty Name.

attrs - The attributes for the folder.

Returns:

The MDFolder for the new folder.

Throws:

BIInvalidNameException - If name is null or empty.

BINameAlreadyBoundException - If another object is already bound to name.

BINoPermissionException - If the caller does not have permission to create folders in this context.

javax.naming.NamingException - If another naming error occurs.

See Also:

createSubcontext(String, Attributes)

createSubcontext

public javax.naming.directory.DirContext createSubcontext(java.lang.String name,
                                                          javax.naming.directory.Attributes attrs)
                                                   throws javax.naming.NamingException

Creates an MDFolder that represents a folder. This method is useful only when the MDFolder is not a metadata object, such as an MDDimension. Calling this method on a metadata object is not useful.

Specified by:

createSubcontext in interface javax.naming.directory.DirContext

Parameters:

name - The name for the folder to create. Do not pass null or an empty Name.

attrs - The attributes for the folder.

Returns:

The MDFolder for the new folder.

Throws:

BIInvalidNameException - If name is null or empty.

BINameAlreadyBoundException - If another object is already bound to name.

BINoPermissionException - If the caller does not have permission to create folders in this context.

javax.naming.NamingException - If another naming error occurs.

See Also:

createSubcontext(Name, Attributes)

search

public javax.naming.NamingEnumeration search(javax.naming.Name name,
                                             javax.naming.directory.Attributes matchingAttributes,
                                             java.lang.String[] attributesToReturn)
                                      throws javax.naming.NamingException

Searches a folder for objects that have specified attributes. This method retrieves specified attributes of the found objects.

Specified by:

search in interface javax.naming.directory.DirContext

Parameters:

name - The name of the folder to search.

matchingAttributes - The attributes of the objects that you want to find.

attributesToReturn - The attributes that you want this search to retrieve for objects that have matchingAttributes.

Returns:

An enumeration of SearchResult objects. The search results contain the attributes that you requested in attributesToReturn, and the name of the object, relative to name.

Throws:

BINameNotFoundException - If name cannot be found.

BINoPermissionException - If the caller does not have appropriate permission to search in name.

BINamingException - If another naming error occurs.

See Also:

DirContext.search(Name, Attributes, String[])

search

public javax.naming.NamingEnumeration search(java.lang.String name,
                                             javax.naming.directory.Attributes matchingAttributes,
                                             java.lang.String[] attributesToReturn)
                                      throws javax.naming.NamingException

Searches a folder for objects that have specified attributes. This method retrieves specified attributes of the found objects.

Specified by:

search in interface javax.naming.directory.DirContext

Parameters:

name - The name of the folder to search.

matchingAttributes - The attributes of the objects that you want to find.

attributesToReturn - The attributes that you want this search to retrieve for objects that have matchingAttributes.

Returns:

An enumeration of SearchResult objects. The search results contain the attributes that you requested in attributesToReturn, and the name of the object, relative to name.

Throws:

BINameNotFoundException - If name cannot be found.

BINoPermissionException - If the caller does not have appropriate permission to search in name.

BINamingException - If another naming error occurs.

See Also:

DirContext.search(String, Attributes, String[])

search

public javax.naming.NamingEnumeration search(javax.naming.Name name,
                                             javax.naming.directory.Attributes matchingAttributes)
                                      throws javax.naming.NamingException

Searches a folder for objects that have specified attributes. This method retrieves the found objects.

Specified by:

search in interface javax.naming.directory.DirContext

Parameters:

name - The name of the folder to search.

matchingAttributes - The attributes of the objects that you want to find.

Returns:

An enumeration of SearchResult objects. The objects match the search criteria.

Throws:

BINameNotFoundException - If name cannot be found.

BINoPermissionException - If the caller does not have appropriate permission to search in name.

BINamingException - If another naming error occurs.

See Also:

DirContext.search(Name, Attributes)

search

public javax.naming.NamingEnumeration search(java.lang.String name,
                                             javax.naming.directory.Attributes matchingAttributes)
                                      throws javax.naming.NamingException

Searches a folder for objects that have specified attributes. This method retrieves the found objects.

Specified by:

search in interface javax.naming.directory.DirContext

Parameters:

name - The name of the folder to search.

matchingAttributes - The attributes of the objects that you want to find.

Returns:

An enumeration of SearchResult objects. The objects match the search criteria.

Throws:

BINameNotFoundException - If name cannot be found.

BINoPermissionException - If the caller does not have appropriate permission to search in name.

BINamingException - If another naming error occurs.

See Also:

DirContext.search(String, Attributes)

search

public javax.naming.NamingEnumeration search(javax.naming.Name name,
                                             javax.naming.directory.Attributes matchingAttributes,
                                             javax.naming.directory.SearchControls controls)
                                      throws javax.naming.NamingException

Searches a folder for objects that have specified attributes, using the specified search scope. This method retrieves specified attributes of the found objects.

Specified by:

search in interface BIContext

Parameters:

name - The name of the folder to search.

matchingAttributes - The attributes of the objects that you want to find.

searchControls - The search controls that specify the scope of the search. This argument can be null.

Returns:

An enumeration of SearchResult objects. The search results contain the attributes that you requested in attributesToReturn, and the name of the object, relative to name.

Throws:

BINameNotFoundException - If name cannot be found.

BIInvalidSearchControlsException - If SearchControls is not valid

BINoPermissionException - If the caller does not have appropriate permission to search in name.

BINamingException - If another naming error occurs.

See Also:

BISearchControls, search(String, Attributes, SearchControls)

search

public javax.naming.NamingEnumeration search(java.lang.String name,
                                             javax.naming.directory.Attributes matchingAttributes,
                                             javax.naming.directory.SearchControls controls)
                                      throws javax.naming.NamingException

Searches a folder for objects that have specified attributes, using the specified search scope. This method retrieves specified attributes of the found objects.

Specified by:

search in interface BIContext

Parameters:

name - The name of the folder to search.

matchingAttributes - The attributes of the objects that you want to find.

searchControls - The search controls that specify the scope of the search. This argument can be null.

Returns:

An enumeration of SearchResult objects. The search results contain the attributes that you requested in attributesToReturn, and the name of the object, relative to name.

Throws:

BINameNotFoundException - If name cannot be found.

BIInvalidSearchControlsException - If SearchControls is not valid

BINoPermissionException - If the caller does not have appropriate permission to search in name.

BINamingException - If another naming error occurs.

See Also:

BISearchControls, search(Name, Attributes, SearchControls)

copy

public void copy(javax.naming.Name name,
                 javax.naming.directory.DirContext context,
                 javax.naming.Name newName,
                 int mode)
          throws javax.naming.NamingException

Copies an existing context or object. This method is useful only when the object being copied is not a metadata object, such as an MDDimension. Calling this method on a metadata object is not useful.

Specified by:

copy in interface BIContext

Parameters:

name - The name of the object to copy. Use a slash (/) to separate folder names. The path in name is relative to this context.

context - The context into which to copy name.

newName - The name given to the copy of the object in the target context. If the value is null, then the name is the same as the name of the original object.

mode - A constant that identifies whether to copy related objects or only name.

Throws:

NameAlreadyBoundException - If there is already an object with the name specified in newName in the target context.

NameNotFoundException - If the named object to be copied cannot be found.

NoPermissionException - If the user does not have enough permission to copy the object to the target context.

BIOperationNotSupportedException - If either name identifies an OLAP object or if context is an OLAP folder.

javax.naming.NamingException - If there is a problem during copy.

See Also:

PSRConstants.NORMAL_COPY, PSRConstants.DEEP_COPY

copy

public void copy(java.lang.String name,
                 javax.naming.directory.DirContext context,
                 java.lang.String newName,
                 int mode)
          throws javax.naming.NamingException

Copies an existing context or object. This method is useful only when the object being copied is not a metadata object, such as an MDDimension. Calling this method on a metadata object is not useful.

Specified by:

copy in interface BIContext

Parameters:

name - The name of the object to copy. Use a slash (/) to separate folder names. The path in name is relative to this context.

context - The context into which to copy name.

newName - The name given to the copy of the object in the target context. If the value is null, then the name is the same as the name of the original object.

mode - A constant that identifies whether to copy related objects or only name.

Throws:

NameAlreadyBoundException - If there is already an object with the name specified in newName in the target context.

NameNotFoundException - If the named object to be copied cannot be found.

NoPermissionException - If the user does not have enough permission to copy the object to the target context.

BIOperationNotSupportedException - If either name identifies an OLAP object or if context is an OLAP folder.

javax.naming.NamingException - If there is a problem during copy.

See Also:

PSRConstants.NORMAL_COPY, PSRConstants.DEEP_COPY

move

public void move(javax.naming.Name name,
                 javax.naming.directory.DirContext context)
          throws javax.naming.NamingException

Moves an existing context or object. This method is useful only when the object being moved is not a metadata object, such as an MDDimension. Calling this method on a metadata object is not useful.

Specified by:

move in interface BIContext

Parameters:

name - The name of the object to move. The path in name is relative to this context.

context - The context into which to move name.

Throws:

NameAlreadyBoundException - If there is already an object with the name specified in newName in the target context.

NameNotFoundException - If the named object to be copied cannot be found.

NoPermissionException - If the user does not have enough permission to copy the object to the target context.

BIOperationNotSupportedException - If name identifies an OLAP object or if context is an OLAP folder.

javax.naming.NamingException - If there is a problem during move.

move

public void move(java.lang.String name,
                 javax.naming.directory.DirContext context)
          throws javax.naming.NamingException

Moves an existing context or object. This method is useful only when the object being moved is not a metadata object, such as an MDDimension. Calling this method on a metadata object is not useful.

Specified by:

move in interface BIContext

Parameters:

name - The name of the object to move. The path in name is relative to this context.

context - The context into which to move name.

Throws:

javax.naming.NamingException - If there is a problem with the name.

NameAlreadyBoundException - If there is already an object with the name specified in newName in the target context.

NameNotFoundException - If the named object to be copied cannot be found.

NoPermissionException - If the user does not have enough permission to copy the object to the target context.

BIOperationNotSupportedException - If name identifies an OLAP object or If context is an OLAP folder.

javax.naming.NamingException - If there is a problem during copy.

getAcl

public Acl getAcl()
           throws javax.naming.NamingException

Retrieves the access control list for this context. The access control list is a list of permissions.

Specified by:

getAcl in interface BIContext

Returns:

The access control list for this context.

Throws:

BINamingException - If a naming error occurs.

getFolders

public MDFolder[] getFolders()
                      throws MetadataManagerException

Retrieves the folders that are children of this folder.

Returns:

All of the folders in this folder.

Throws:

MetadataManagerException - If the connection fails during the execution of this method or if there is a problem retrieving objects from the server.

setFolders

public int setFolders(MDFolder[] folders)

Specifies folders to be children of this folder.

Parameters:

folders - The folders that you want this folder to contain.

Returns:

A constant that represents success or failure. Valid constants are listed in the See Also section.

See Also:

MDU.SUCCESS, MDU.FAILURE

getMeasures

public MDMeasure[] getMeasures()
                        throws MetadataManagerException

Retrieves the measures in this folder.

Returns:

The measures that this folder contains, or null if this folder contains no measures.

Throws:

MetadataManagerException - If the connection fails during the execution of this method or if there is a problem retrieving objects from the server.

getSelections

public MDSelection[] getSelections()
                            throws MetadataManagerException

Retrieves the selections in this folder.

Returns:

The selections that this folder contains, or null if this folder contains no selections.

Throws:

MetadataManagerException - If the connection fails during the execution of this method or if there is a problem retrieving objects from the server.

getDimensions

public MDDimension[] getDimensions()
                            throws MetadataManagerException

Retrieves the dimensions in this folder.

Returns:

The dimensions that this folder contains, or null if this folder contains no dimensions.

Throws:

MetadataManagerException - If the connection fails during the execution of this method or if there is a problem retrieving objects from the server.

getLocale

public java.util.Locale getLocale()

Retrieves the locale for this folder.

Specified by:

getLocale in interface BIContext

Returns:

The locale of this folder.

setLocale

public void setLocale(java.util.Locale locale)

Specifies the locale for this folder. This method also changes the locale in the MetadataManager.

Specified by:

setLocale in interface BIContext

Parameters:

locale - The locale that the MetadataManager should use.