Oracle™ Business Intelligence Beans Java API Reference
Release 10
g (9.0.4)
Part number B12159_01


oracle.dss.persistence.persistencemanager.client
Class InitialPersistenceManager

java.lang.Object
  |
  +--javax.naming.InitialContext
        |
        +--javax.naming.directory.InitialDirContext
              |
              +--oracle.dss.persistence.persistencemanager.client.InitialPersistenceManager
All Implemented Interfaces:
BIContext, javax.naming.Context, javax.naming.directory.DirContext, ErrorHandlerCallback, PersistenceManager

public class InitialPersistenceManager
extends javax.naming.directory.InitialDirContext
implements PersistenceManager, ErrorHandlerCallback

The root context for BI Beans persistence management. This class represents the root folder for users that have access to the BI Beans Catalog. The root folder is the starting point for all name resolution.

This context (the root folder) has the PUBLIC privilege for EVERYONE.

This implementation of the root context is determined at runtime, using the environment setting "java.naming.factory.initial", which contains the class name of the initial context factory. If this setting is null, then the system creates a default initial context. If this root context cannot be created, then any method that uses the InitialPersistenceManager can throw a BINoInitialContextException.

See Also:
PersistenceManager, InitialDirContext

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

 

Constructor Summary
InitialPersistenceManager()
          Constructor that does not specify environment properties.
InitialPersistenceManager(java.util.Hashtable env)
          Constructor that specifies environment properties.

 

Method Summary
 void addErrorHandler(ErrorHandler eh)
          Adds a single error handler to this InitialPersistenceManager.
 void associate(javax.naming.Name relativeSourceName, javax.naming.Name[] fullNameOfTarget, javax.naming.directory.Attribute[] identifiers)
          Associates an object with a set of objects.
 void associate(javax.naming.Name relativeSourceName, javax.naming.Name fullNameOfTarget, javax.naming.directory.Attribute identifier)
          Associates an object with another object.
 void associate(java.lang.String relativeSourceName, java.lang.String[] fullNameOfTarget, javax.naming.directory.Attribute[] identifiers)
          Associates an object with a set of objects.
 void associate(java.lang.String relativeSourceName, java.lang.String fullNameOfTarget, javax.naming.directory.Attribute identifier)
          Associates an object with another object.
 void copy(javax.naming.Name name, javax.naming.directory.DirContext context, javax.naming.Name newName, int mode)
          Copies an object or a folder to another folder.
 void copy(java.lang.String name, javax.naming.directory.DirContext context, java.lang.String newName, int mode)
          Copies an object or a folder to another folder.
 void dissociate(javax.naming.Name relativeSourceName, javax.naming.directory.Attribute identifier)
          Dissociates an object from other objects.
 void dissociate(javax.naming.Name relativeSourceName, javax.naming.directory.Attribute[] identifiers)
          Dissociates an object from other objects.
 void dissociate(java.lang.String relativeSourceName, javax.naming.directory.Attribute identifier)
          Dissociates an object from other objects.
 void dissociate(java.lang.String relativeSourceName, javax.naming.directory.Attribute[] identifiers)
          Dissociates an object from other objects.
 boolean exportSubcontext(javax.naming.directory.Attributes filterAttrs, java.lang.String exportFileName)
          Exports the current folder to an external source.
 boolean exportSubcontext(java.lang.String fileName, TransferControl control)
          Exports contents of the current folder to a file.
 Acl getAcl()
          Retrieves the access control list of this folder.
 java.lang.Object getAssociateObject(javax.naming.Name relativeSourceName, javax.naming.directory.Attribute identifier)
          Retrieve the associated object specified by the identifier.
 java.lang.Object getAssociateObject(java.lang.String relativeSourceName, javax.naming.directory.Attribute identifier)
          Retrieve the associated object specified by the identifier.
 java.util.Locale getLocale()
          Retrieves the locale for the persistence system.
 ObjectFactory getObjectFactory(boolean remote)
          Retrieves the object factory that this InitialPersistenceManager uses to create new objects when loading XML from the BI Beans Catalog.
 boolean importSubcontext(java.lang.String importFileName)
          Imports a folder from an external source.
 boolean importSubcontext(java.lang.String fileName, TransferControl control)
          Imports the content of a folder from a file.
 java.util.Vector listAssociates(javax.naming.Name relativeSourceName, java.lang.String[] attrsToReturn, javax.naming.directory.Attribute identifier)
          Returns a list of associate objects specified by the identifier.
 java.util.Vector listAssociates(java.lang.String relativeSourceName, java.lang.String[] attrsToReturn, javax.naming.directory.Attribute identifier)
          Returns a list of associate objects specified by the identifier.
 java.util.Vector listReferringAssociates(javax.naming.Name relativeSourceName, java.lang.String[] attrsToReturn, javax.naming.directory.Attribute identifier)
          Returns a list of associate objects referred to or referred by the source object.
 java.util.Vector listReferringAssociates(java.lang.String relativeSourceName, java.lang.String[] attrsToReturn, javax.naming.directory.Attribute identifier)
          Returns a list of associate objects referred to or referred by the source object.
 java.lang.Object lookup(javax.naming.Name name, Persistable persistable)
          Loads a Persistable object from the BI Beans Catalog.
 java.lang.Object lookup(javax.naming.Name name, Persistable persistable, java.util.Hashtable args)
          Loads a Persistable object from the BI Beans Catalog.
 java.lang.Object lookup(java.lang.String name, Persistable persistable)
          Loads a Persistable object from the BI Beans Catalog.
 java.lang.Object lookup(java.lang.String name, Persistable persistable, java.util.Hashtable args)
          Loads a Persistable object from the BI Beans Catalog.
 java.lang.Object lookupDefinition(javax.naming.Name name)
          Retrieves the StateAgent of an object, without actually instantiating the object itself.
 java.lang.Object lookupDefinition(java.lang.String name)
          Retrieves the StateAgent of an object, without actually instantiating the object itself.
 void move(javax.naming.Name name, javax.naming.directory.DirContext context)
          Moves an object or a folder to another folder.
 void move(java.lang.String name, javax.naming.directory.DirContext context)
          Moves an object or a folder to another folder.
 void refresh()
          Refreshes the entries in the root folder.
 void removeErrorHandler()
          Removes a customized error handler for this initial persistence manager.
 javax.naming.NamingEnumeration search(javax.naming.Name name, javax.naming.directory.Attributes matchingAttributes, javax.naming.directory.SearchControls searchControls)
          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 searchControls)
          Searches a folder for objects that have specified attributes.
 void setLocale(java.util.Locale locale)
          Sets the locale used by this PersistenceManager.

 

Methods inherited from class javax.naming.directory.InitialDirContext
bind, bind, createSubcontext, createSubcontext, getAttributes, getAttributes, getAttributes, getAttributes, getSchema, getSchema, getSchemaClassDefinition, getSchemaClassDefinition, modifyAttributes, modifyAttributes, modifyAttributes, modifyAttributes, rebind, rebind, search, search, search, search, search, search, search, search

 

Methods inherited from class javax.naming.InitialContext
addToEnvironment, bind, bind, close, composeName, composeName, createSubcontext, createSubcontext, destroySubcontext, destroySubcontext, getEnvironment, getNameInNamespace, getNameParser, getNameParser, list, list, listBindings, listBindings, lookup, lookup, lookupLink, lookupLink, rebind, rebind, removeFromEnvironment, rename, rename, unbind, unbind

 

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

 

Methods inherited from interface javax.naming.directory.DirContext
bind, bind, createSubcontext, createSubcontext, getAttributes, getAttributes, getAttributes, getAttributes, getSchema, getSchema, getSchemaClassDefinition, getSchemaClassDefinition, modifyAttributes, modifyAttributes, modifyAttributes, modifyAttributes, rebind, rebind, search, search, search, search, search, search, search, search

 

Methods inherited from interface javax.naming.Context
addToEnvironment, bind, bind, close, composeName, composeName, createSubcontext, createSubcontext, destroySubcontext, destroySubcontext, getEnvironment, getNameInNamespace, getNameParser, getNameParser, list, list, listBindings, listBindings, lookup, lookup, lookupLink, lookupLink, rebind, rebind, removeFromEnvironment, rename, rename, unbind, unbind

 

Constructor Detail

InitialPersistenceManager

public InitialPersistenceManager()
                          throws javax.naming.NamingException
Constructor that does not specify environment properties.
Throws:
javax.naming.NamingException - If an error occurs during instantiation.

InitialPersistenceManager

public InitialPersistenceManager(java.util.Hashtable env)
                          throws javax.naming.NamingException
Constructor that specifies environment properties. Environment properties are defined in the Context interface in JNDI.
Parameters:
env - Environment properties.
Throws:
javax.naming.NamingException - If an error occurs during instantiation.
See Also:
Context
Method Detail

refresh

public void refresh()
             throws javax.naming.NamingException
Refreshes the entries in the root folder. This method has no effect, because the persistence service does not use a cache.
Specified by:
refresh in interface BIContext
Throws:
javax.naming.NamingException - If a naming error occurs.

lookup

public java.lang.Object lookup(java.lang.String name,
Persistable persistable)
                        throws javax.naming.NamingException
Loads a Persistable object from the BI Beans Catalog.
Specified by:
lookup in interface BIContext
Parameters:
name - The name of the object to load. Do not pass null.
persistable - The Persistable component to which the loaded XML should be applied. If you pass null, then a new Persistable is instantiated, and the XML is applied to it.
Returns:
The requested object. The object implements the Persistable interface. If you passed an existing object as the persistable parameter, then this method returns that Persistable.
Throws:
BIInvalidNameException - If name is null or empty.
BINameNotFoundException - If the object cannot be found.
BINamingException - If any other naming error occurs.
See Also:
lookup(Name, Persistable), Persistable

lookup

public java.lang.Object lookup(javax.naming.Name name,
Persistable persistable)
                        throws javax.naming.NamingException
Loads a Persistable object from the BI Beans Catalog.
Specified by:
lookup in interface BIContext
Parameters:
name - The name of the object to load. Do not pass null.
persistable - The Persistable component to which the loaded XML should be applied. If you pass null, then a new Persistable is instantiated, and the XML is applied to it.
Returns:
The requested object. The object implements the Persistable interface. If you passed an existing object as the persistable parameter, then this method returns that Persistable.
Throws:
BIInvalidNameException - If name is null or empty.
BINameNotFoundException - If the object cannot be found.
BINamingException - If any other naming error occurs.
See Also:
lookup(String, Persistable), Persistable

lookup

public java.lang.Object lookup(java.lang.String name,
Persistable persistable,
                               java.util.Hashtable args)
                        throws javax.naming.NamingException
Loads a Persistable object from the BI Beans Catalog.
Specified by:
lookup in interface BIContext
Parameters:
name - The name of the object to load. Do not pass null.
persistable - The Persistable component to which the loaded XML should be applied. If you pass null, then a new Persistable is instantiated, and the XML is applied to it.
args - 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 args hash table.
Returns:
The requested object. The object implements the Persistable interface. If you passed an existing object as the persistable parameter, then this method returns that Persistable.
Throws:
BIInvalidNameException - If name is null or empty.
BINameNotFoundException - If the object cannot be found.
BINamingException - If any other naming error occurs.
See Also:
lookup(Name, Persistable, Hashtable), Persistable, Query, QueryManager

lookup

public java.lang.Object lookup(javax.naming.Name name,
Persistable persistable,
                               java.util.Hashtable args)
                        throws javax.naming.NamingException
Loads a Persistable object from the BI Beans Catalog.
Specified by:
lookup in interface BIContext
Parameters:
name - The name of the object to load. Do not pass null.
persistable - The Persistable component to which the loaded XML should be applied. If you pass null, then a new Persistable is instantiated, and the XML is applied to it.
args - 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 args hash table.
Returns:
The requested object. The object implements the Persistable interface. If you passed an existing object as the persistable parameter, then this method returns that Persistable.
Throws:
BIInvalidNameException - If name is null or empty.
BINameNotFoundException - If the object cannot be found.
BINamingException - If any other naming error occurs.
See Also:
lookup(String, Persistable, Hashtable), Persistable, Query, QueryManager

lookupDefinition

public java.lang.Object lookupDefinition(javax.naming.Name name)
                                  throws javax.naming.NamingException
Retrieves the StateAgent of an object, without actually instantiating the object itself. The StateAgent contains the persisted state of the object.
Specified by:
lookupDefinition in interface PersistenceManager
Parameters:
name - The name of the object whose StateAgent you want.
Returns:
The StateAgent of the object.
Throws:
BIInvalidNameException - If name is null or empty.
BINoPermissionException - If the caller does not have appropriate permission to search in name.
BINamingException - If another naming error occurs.
BINameNotFoundException - If the object or folder cannot be found.
See Also:
lookupDefinition(String), StateAgent

lookupDefinition

public java.lang.Object lookupDefinition(java.lang.String name)
                                  throws javax.naming.NamingException
Retrieves the StateAgent of an object, without actually instantiating the object itself. The StateAgent contains the persisted state of the object.
Specified by:
lookupDefinition in interface PersistenceManager
Parameters:
name - The name of the object whose StateAgent you want.
Returns:
The StateAgent of the object.
Throws:
BIInvalidNameException - If name is null or empty.
BINoPermissionException - If the caller does not have appropriate permission to search in name.
BINamingException - If another naming error occurs.
BINameNotFoundException - If the object or folder cannot be found.
See Also:
lookupDefinition(Name), StateAgent

getAcl

public Acl getAcl()
           throws javax.naming.NamingException
Retrieves the access control list of this folder.
Specified by:
getAcl in interface BIContext
Returns:
The access control list.
Throws:
javax.naming.NamingException - If a naming error occurs.

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 object or a folder to another folder.
Specified by:
copy in interface BIContext
Parameters:
name - The name of the object or folder to copy. Must not be empty or null.
context - The folder into which to copy name. The folder must already exists.
newName - The new name assigned to the copy of the original object. If this value is null, then the new name is the same as the old name.
mode - The extent of the copy operations. Possible values are listed in the See Also section. They are defined in the PSRConstants interface.
Throws:
BIInvalidNameException - If name is null or empty.
BINamingException - If any other naming error occurs.
NameAlreadyBoundException - If another object in context is already bound to name.
NameNotFoundException - If the object to be copied cannot be found.
See Also:
copy(String, DirContext, String, int), 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 object or a folder to another folder.
Specified by:
copy in interface BIContext
Parameters:
name - The name of the object or folder to copy. Must not be empty or null.
context - The folder into which to copy name. The folder must already exists.
newName - The new name assigned to the copy of the original object. If this value is null, then the new name is the same as the old name.
mode - Specify the copy option. Possible values are listed in the See Also section. They are defined in the PSRConstants interface.
Throws:
BIInvalidNameException - If name is null or empty.
BINamingException - If any other naming error occurs.
NameAlreadyBoundException - If another object in context is already bound to name.
NameNotFoundException - If the object to be copied cannot be found.
See Also:
copy(Name, DirContext, Name, int), 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 object or a folder to another folder.
Specified by:
move in interface BIContext
Parameters:
name - The name of the object or folder to move. Must not be empty or null.
context - The folder into which to move name. The folder must already exists.
Throws:
BIInvalidNameException - If name is null or empty.
BINamingException - If any other naming error occurs.
NameAlreadyBoundException - If another object in context is already bound to name.
NameNotFoundException - If the object to be moved cannot be found.
See Also:
move(String, DirContext)

move

public void move(java.lang.String name,
                 javax.naming.directory.DirContext context)
          throws javax.naming.NamingException
Moves an object or a folder to another folder.
Specified by:
move in interface BIContext
Parameters:
name - The name of the object or folder to move. Must not be empty or null.
context - The folder into which to move name. The folder must already exists.
Throws:
BIInvalidNameException - If name is null or empty.
BINamingException - If any other naming error occurs.
NameAlreadyBoundException - If another object in context is already bound to name.
NameNotFoundException - If the object to be moved cannot be found.
See Also:
move(String, DirContext)

exportSubcontext

public boolean exportSubcontext(javax.naming.directory.Attributes filterAttrs,
                                java.lang.String exportFileName)
Exports the current folder to an external source. This method exports the current folder to a file. The export includes the StateAgent of each object in the folder, as well as subfolders and their contents. You can limit the export of the contents of this folder by specifying the attributes of the objects that should be exported, in filterAttrs.
Specified by:
exportSubcontext in interface PersistenceManager
Parameters:
filterAttrs - Attributes of objects that you want to export.
exportFileName - The name for the exported file.
Returns:
true if the operation is successful, false if it is not.

importSubcontext

public boolean importSubcontext(java.lang.String importFileName)
Imports a folder from an external source. This method imports a folder and its contents from a file. The file should be an XML file that defines the state of the folder and its contents.
Specified by:
importSubcontext in interface PersistenceManager
Parameters:
importFileName - The name of the file that contains the persisted state of the folder that you want to import.
Returns:
true if the operation is successful, false if it is not.

getObjectFactory

public ObjectFactory getObjectFactory(boolean remote)
Retrieves the object factory that this InitialPersistenceManager uses to create new objects when loading XML from the BI Beans Catalog.
Parameters:
remote - true to retrieve the middle-tier object factory, false to retrieve an object factory for the client.
Returns:
The object factory for the InitialPersistenceManager.

addErrorHandler

public void addErrorHandler(ErrorHandler eh)
Adds a single error handler to this InitialPersistenceManager. The error handler will be called when the persistence manager traps an error from another part of the system.

Use this method to install your own error handler.

Specified by:
addErrorHandler in interface ErrorHandlerCallback
Parameters:
eh - The error handler to use.

removeErrorHandler

public void removeErrorHandler()
Removes a customized error handler for this initial persistence manager. This method replaces the current error handler with a default error handler. The default error handler prints information to the console.
Specified by:
removeErrorHandler in interface ErrorHandlerCallback

search

public javax.naming.NamingEnumeration search(java.lang.String name,
                                             javax.naming.directory.Attributes matchingAttributes,
                                             javax.naming.directory.SearchControls searchControls)
                                      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 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 control the search. It 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:
javax.naming.directory.DirContext#search(Name, Attributes, SearchControls)

search

public javax.naming.NamingEnumeration search(javax.naming.Name name,
                                             javax.naming.directory.Attributes matchingAttributes,
                                             javax.naming.directory.SearchControls searchControls)
                                      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 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 control the search. It 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:
javax.naming.directory.DirContext#search(String, Attributes, SearchControls)

getLocale

public java.util.Locale getLocale()
Retrieves the locale for the persistence system.
Specified by:
getLocale in interface BIContext
Returns:
The locale setting for the persistence system.

setLocale

public void setLocale(java.util.Locale locale)
Sets the locale used by this PersistenceManager. All subfolders and subsystems will use the same locale.
Specified by:
setLocale in interface BIContext
Parameters:
locale - The locale to set on the entire persistence system.

associate

public void associate(java.lang.String relativeSourceName,
                      java.lang.String fullNameOfTarget,
                      javax.naming.directory.Attribute identifier)
               throws javax.naming.NamingException
Associates an object with another object.
Specified by:
associate in interface PersistenceManager
Parameters:
relativeSourceName - The name of the source object. Do not pass null or an empty String.
fullNameOfTarget - The name of the target object to associate with. Do not pass null or an empty String.
identifiers - An attribute which identifies the association.
Throws:
BIInvalidNameException - If relativeSourceName is null or empty.
BINameNotFoundException - If relativeSourceName or any of the target objects cannot be found.
BIInvalidAttributesException - If the mandatory attributes, such as the OBJECT_TYPE attribute, are not provided.
BINoPermissionException - If the user does not have sufficient permission to perform this operation.
BINamingException - If another naming error occurs.

associate

public void associate(javax.naming.Name relativeSourceName,
                      javax.naming.Name fullNameOfTarget,
                      javax.naming.directory.Attribute identifier)
               throws javax.naming.NamingException
Associates an object with another object.
Specified by:
associate in interface PersistenceManager
Parameters:
relativeSourceName - The name of the source object. Do not pass null or an empty Name.
fullNameOfTarget - The name of the target object to associate with. Do not pass null or an empty Name.
identifiers - An attribute which identifies the association.
Throws:
BIInvalidNameException - If relativeSourceName is null or empty.
BINameNotFoundException - If relativeSourceName or any of the target objects cannot be found.
BIInvalidAttributesException - If the mandatory attributes, such as the OBJECT_TYPE attribute, are not provided.
BINoPermissionException - If the user does not have sufficient permission to perform this operation.
BINamingException - If another naming error occurs.

associate

public void associate(java.lang.String relativeSourceName,
                      java.lang.String[] fullNameOfTarget,
                      javax.naming.directory.Attribute[] identifiers)
               throws javax.naming.NamingException
Associates an object with a set of objects.
Specified by:
associate in interface PersistenceManager
Parameters:
relativeSourceName - The name of the source object. Do not pass null or an empty String.
fullNameOfTarget - An array of the names of the target objects to associate with. Each name should not be null or an empty String.
identifiers - An array of attributes which identifies the associations.
Throws:
BIInvalidNameException - If relativeSourceName is null or empty.
BINameNotFoundException - If relativeSourceName or any of the target objects cannot be found.
BIInvalidAttributesException - If the mandatory attributes, such as the OBJECT_TYPE attribute, are not provided.
BINoPermissionException - If the user does not have sufficient permission to perform this operation.
BINamingException - If another naming error occurs.

associate

public void associate(javax.naming.Name relativeSourceName,
                      javax.naming.Name[] fullNameOfTarget,
                      javax.naming.directory.Attribute[] identifiers)
               throws javax.naming.NamingException
Associates an object with a set of objects.
Specified by:
associate in interface PersistenceManager
Parameters:
relativeSourceName - The name of the source object. Do not pass null or an empty Name.
fullNameOfTarget - An array of the names of the target objects to associate with. Each name should not be null or an empty Name.
identifiers - An array of attributes which identifies the associations.
Throws:
BIInvalidNameException - If relativeSourceName is null or empty.
BINameNotFoundException - If relativeSourceName or any of the target objects cannot be found.
BIInvalidAttributesException - If the mandatory attributes, such as the OBJECT_TYPE attribute, are not provided.
BINoPermissionException - If the user does not have sufficient permission to perform this operation.
BINamingException - If another naming error occurs.

dissociate

public void dissociate(java.lang.String relativeSourceName,
                       javax.naming.directory.Attribute identifier)
                throws javax.naming.NamingException
Dissociates an object from other objects.
Specified by:
dissociate in interface PersistenceManager
Parameters:
relativeSourceName - The name of the source object. Do not pass null or an empty String.
identifier - An attribute which identifies the association.
Throws:
BIInvalidNameException - If relativeSourceName is null or empty.
BINameNotFoundException - If relativeSourceName cannot be found.
BIInvalidAttributesException - If the mandatory attributes, such as the OBJECT_TYPE attribute, are not provided.
BINoPermissionException - If the user does not have sufficient permission to perform this operation.
BINamingException - If another naming error occurs.

dissociate

public void dissociate(javax.naming.Name relativeSourceName,
                       javax.naming.directory.Attribute identifier)
                throws javax.naming.NamingException
Dissociates an object from other objects.
Specified by:
dissociate in interface PersistenceManager
Parameters:
relativeSourceName - The name of the source object. Do not pass null or an empty Name.
identifier - An attribute which identifies the association.
Throws:
BIInvalidNameException - If relativeSourceName is null or empty.
BINameNotFoundException - If relativeSourceName cannot be found.
BIInvalidAttributesException - If the mandatory attributes, such as the OBJECT_TYPE attribute, are not provided.
BINoPermissionException - If the user does not have sufficient permission to perform this operation.
BINamingException - If another naming error occurs.

dissociate

public void dissociate(java.lang.String relativeSourceName,
                       javax.naming.directory.Attribute[] identifiers)
                throws javax.naming.NamingException
Dissociates an object from other objects.
Specified by:
dissociate in interface PersistenceManager
Parameters:
relativeSourceName - The name of the source object. Do not pass null or an empty String.
identifiers - An array of attributes which identifies the associations.
Throws:
BIInvalidNameException - If relativeSourceName is null or empty.
BINameNotFoundException - If relativeSourceName cannot be found.
BIInvalidAttributesException - If the mandatory attributes, such as the OBJECT_TYPE attribute, are not provided.
BINoPermissionException - If the user does not have sufficient permission to perform this operation.
BINamingException - If another naming error occurs.

dissociate

public void dissociate(javax.naming.Name relativeSourceName,
                       javax.naming.directory.Attribute[] identifiers)
                throws javax.naming.NamingException
Dissociates an object from other objects.
Specified by:
dissociate in interface PersistenceManager
Parameters:
relativeSourceName - The name of the source object. Do not pass null or an empty Name.
identifiers - An array of attributes which identifies the associations.
Throws:
BIInvalidNameException - If relativeSourceName is null or empty.
BINameNotFoundException - If relativeSourceName cannot be found.
BIInvalidAttributesException - If the mandatory attributes, such as the OBJECT_TYPE attribute, are not provided.
BINoPermissionException - If the user does not have sufficient permission to perform this operation.
BINamingException - If another naming error occurs.

listAssociates

public java.util.Vector listAssociates(java.lang.String relativeSourceName,
                                       java.lang.String[] attrsToReturn,
                                       javax.naming.directory.Attribute identifier)
                                throws javax.naming.NamingException
Returns a list of associate objects specified by the identifier.
Specified by:
listAssociates in interface PersistenceManager
Parameters:
relativeSourceName - The name of the source object. Do not pass null or an empty String.
attrsToReturn - A list of attributes to return.
identifier - The identifier of the association.
Returns:
A Vector of BIAssociate objects, one for each object in the folder. Each BIAssociate contains the name of an object, its class name, and the object itself.
Throws:
BIInvalidNameException - If relativeSourceName is null or empty.
BINameNotFoundException - If relativeSourceName cannot be found.
BIInvalidAttributesException - If the mandatory attributes, such as the OBJECT_TYPE attribute, are not provided.
BINoPermissionException - If the user does not have sufficient permission to perform this operation.
BINamingException - If another naming error occurs.

listAssociates

public java.util.Vector listAssociates(javax.naming.Name relativeSourceName,
                                       java.lang.String[] attrsToReturn,
                                       javax.naming.directory.Attribute identifier)
                                throws javax.naming.NamingException
Returns a list of associate objects specified by the identifier.
Specified by:
listAssociates in interface PersistenceManager
Parameters:
relativeSourceName - The name of the source object. Do not pass null or an empty Name.
attrsToReturn - A list of attributes to return.
identifier - The identifier of the association.
Returns:
A Vector of BIAssociate objects, one for each object in the folder. Each BIAssociate contains the name of an object, its class name, and the object itself.
Throws:
BIInvalidNameException - If relativeSourceName is null or empty.
BINameNotFoundException - If relativeSourceName cannot be found.
BIInvalidAttributesException - If the mandatory attributes, such as the OBJECT_TYPE attribute, are not provided.
BINoPermissionException - If the user does not have sufficient permission to perform this operation.
BINamingException - If another naming error occurs.

listReferringAssociates

public java.util.Vector listReferringAssociates(java.lang.String relativeSourceName,
                                                java.lang.String[] attrsToReturn,
                                                javax.naming.directory.Attribute identifier)
                                         throws javax.naming.NamingException
Returns a list of associate objects referred to or referred by the source object.
Specified by:
listReferringAssociates in interface PersistenceManager
Parameters:
relativeSourceName - The name of the source object. Do not pass null or an empty String.
attrsToReturn - A list of attributes to return.
identifier - The identifier of the association.
Returns:
A Vector of BIAssociate objects, one for each object in the folder. Each BIAssociate contains the name of an object, its class name, and the object itself.
Throws:
BIInvalidNameException - If relativeSourceName is null or empty.
BINameNotFoundException - If relativeSourceName cannot be found.
BIInvalidAttributesException - If the mandatory attributes, such as the OBJECT_TYPE attribute, are not provided.
BINoPermissionException - If the user does not have sufficient permission to perform this operation.
BINamingException - If another naming error occurs.

listReferringAssociates

public java.util.Vector listReferringAssociates(javax.naming.Name relativeSourceName,
                                                java.lang.String[] attrsToReturn,
                                                javax.naming.directory.Attribute identifier)
                                         throws javax.naming.NamingException
Returns a list of associate objects referred to or referred by the source object.
Specified by:
listReferringAssociates in interface PersistenceManager
Parameters:
relativeSourceName - The name of the source object. Do not pass null or an empty Name.
attrsToReturn - A list of attributes to return.
identifier - The identifier of the association.
Returns:
A Vector of BIAssociate objects, one for each object in the folder. Each BIAssociate contains the name of an object, its class name, and the object itself.
Throws:
BIInvalidNameException - If relativeSourceName is null or empty.
BINameNotFoundException - If relativeSourceName cannot be found.
BIInvalidAttributesException - If the mandatory attributes, such as the OBJECT_TYPE attribute, are not provided.
BINoPermissionException - If the user does not have sufficient permission to perform this operation.
BINamingException - If another naming error occurs.

getAssociateObject

public java.lang.Object getAssociateObject(java.lang.String relativeSourceName,
                                           javax.naming.directory.Attribute identifier)
                                    throws javax.naming.NamingException
Retrieve the associated object specified by the identifier.
Specified by:
getAssociateObject in interface PersistenceManager
Parameters:
relativeSourceName - The name of the source object. Do not pass null or an empty String.
identifier - The attribute that identifies the association.
Throws:
BIInvalidNameException - If relativeSourceName is null or empty.
BINameNotFoundException - If relativeSourceName cannot be found.
BIInvalidAttributesException - If the mandatory attributes, such as the OBJECT_TYPE attribute, are not provided.
BINoPermissionException - If the user does not have sufficient permission to perform this operation.
BINamingException - If another naming error occurs.

getAssociateObject

public java.lang.Object getAssociateObject(javax.naming.Name relativeSourceName,
                                           javax.naming.directory.Attribute identifier)
                                    throws javax.naming.NamingException
Retrieve the associated object specified by the identifier.
Specified by:
getAssociateObject in interface PersistenceManager
Parameters:
relativeSourceName - The name of the source object. Do not pass null or an empty Name.
identifier - The attribute that identifies the association.
Throws:
BIInvalidNameException - If relativeSourceName is null or empty.
BINameNotFoundException - If relativeSourceName cannot be found.
BIInvalidAttributesException - If the mandatory attributes, such as the OBJECT_TYPE attribute, are not provided.
BINoPermissionException - If the user does not have sufficient permission to perform this operation.
BINamingException - If another naming error occurs.

exportSubcontext

public boolean exportSubcontext(java.lang.String fileName,
TransferControl control)
                         throws javax.naming.NamingException
Exports contents of the current folder to a file. You can limit the export of the contents of this folder by specifying the TransferControl.
Specified by:
exportSubcontext in interface PersistenceManager
Parameters:
fileName - The local file in which the contents are exported to.
control - The TransferControl that provides fine grain control of the export function.
Returns:
true if the operation is successful, false if it is not.
Throws:
BINamingException - if an error has occurred.

importSubcontext

public boolean importSubcontext(java.lang.String fileName,
TransferControl control)
                         throws javax.naming.NamingException
Imports the content of a folder from a file. The file should be an XML file that defines the state of the folder and its contents.
Specified by:
importSubcontext in interface PersistenceManager
Parameters:
fileName - The name of the local file that contains the contents to import.
control - The TransferControl that provides fine grain control of the import function.
Returns:
true if the operation is successful, false if it is not.
Throws:
BINamingException - if an error has occurred.

Oracle™ Business Intelligence Beans Java API Reference
Release 10
g (9.0.4)
Part number B12159_01


Copyright © 2003, Oracle. All Rights Reserved.