Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

com.businessobjects.dsws.bicatalog
Class BICatalog

java.lang.Object
  extended by com.businessobjects.dsws.Consumer
      extended by com.businessobjects.dsws.bicatalog.BICatalog
All Implemented Interfaces:
java.io.Externalizable, java.io.Serializable
Deprecated. As of Business Objects XI Release 3.0. Use BIPlatform as a replacement. 

public class BICatalog
extends Consumer
implements java.io.Externalizable

The BICatalog class is a proxy that can consume the BICatalog Web Service and that is mapped on its WSDL.
BICatalog provides service methods to list and search for categories, documents and folders either separately or simultaneously. Using BICatalog a user can also see ResourceRights and ObjectProperties.

Example: Initializing a BICatalog instance.
Connection connection;
URL boConURL = new URL("'http://:/dswsbobje/services/Session';");
connection = new com.businessobjects.dsws.Connection(boConURL);
Session boSession = new Session(connection);
EnterpriseCredential credential = EnterpriseCredential.Factory.newInstance();
credential.setLogin("username");
credential.setDomain("domain");
credential.setPassword("password");
SessionInfo boSI = boSession.login(credential);
String[] strBICatURL = boSession.getAssociatedServicesURL("BICatalog");
BICatalog boCat = BICatalog.getInstance(boSession,strBICatURL[0]);

See Also:
Connection, AuthenticationCredential, Session, SearchPattern, Serialized Form

Constructor Summary
BICatalog()
          Deprecated.  
BICatalog(Connection objConnection, ConnectionState objConnectionState)
          Deprecated. Instantiate a new BICatalog object using Connection and ConnectionState objects.
BICatalog(java.lang.String strImplementation, ConnectionState objConnectionState)
          Deprecated. Internal Use Only.
 
Method Summary
 BICatalogObject[] getCatalog(java.lang.String objectUID, int depth, SortType.Enum[] sort, java.lang.String[] bicatalogObjectType, java.lang.String[] resourceRightNames, java.lang.String[] objectPropertyNames, InstanceRetrievalType.Enum instanceRetrievalType)
          Deprecated. The getCatalog method returns an array of BICatalogObject, that is to say the documents, folders and categories available to the current users.
 Category[] getCategoryList(java.lang.String objectUID, int depth, SortType.Enum[] sort, java.lang.String[] resourceRightNames, java.lang.String[] objectPropertyNames)
          Deprecated. The getCategoryList method returns an array of Categories available to the current user.
 Document[] getDocumentList(java.lang.String objectUID, int depth, SortType.Enum[] sort, java.lang.String[] resourceRightNames, java.lang.String[] objectPropertyNames, InstanceRetrievalType.Enum instanceRetrievalType)
          Deprecated. The getDocumentList method returns an array of Documents available to the current user.
 Folder[] getFolderList(java.lang.String objectUID, int depth, SortType.Enum[] sort, java.lang.String[] resourceRightNames, java.lang.String[] objectPropertyNames)
          Deprecated. The getCategoryList method returns an array of Folders available to the current user.
static BICatalog getInstance(Consumer objConsumer, java.lang.String strURL)
          Deprecated. GetInstance static method returns a BICatalog by passing the Web Service URL and an already logged Consumer object.
 ObjectProperty[] getObjectProperties(java.lang.String objectUID)
          Deprecated. Return a complete list of ObjectProperty of a specific resources.
 ResourceRight[] getResourceRights(java.lang.String objectUID)
          Deprecated. Return a complete list of ResourceRight for a specific resource.
 void readExternal(java.io.ObjectInput in)
          Deprecated.  
 BICatalogObject[] search(SearchPattern searchPattern, SortType.Enum[] sort, java.lang.String[] resourceRightNames, java.lang.String[] objectPropertyNames, InstanceRetrievalType.Enum instanceRetrievalType)
          Deprecated. The Search method returns an array of BICatalogObject corresponding to a SearchPattern.
 void writeExternal(java.io.ObjectOutput out)
          Deprecated.  
 
Methods inherited from class com.businessobjects.dsws.Consumer
displayException, GetAxisFaultDetails, getConnection, getConnection, getConnectionState, getConsumer, getConsumer
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

BICatalog

public BICatalog(java.lang.String strImplementation,
                 ConnectionState objConnectionState)
          throws AxisFault
Deprecated. 

Internal Use Only.

Throws:
AxisFault

BICatalog

public BICatalog(Connection objConnection,
                 ConnectionState objConnectionState)
          throws AxisFault
Deprecated. 
Instantiate a new BICatalog object using Connection and ConnectionState objects.

Example: Initializing a BICatalog instance.
Connection connection = new Connection(boConURL);
SessionInfo boSI = boSession.login(credential);
String[] strBICatURL = boSession.getAssociatedServicesURL("BICatalog");
BICatalog boCat = BICatalog.getInstance(boSession,strBICatURL[0]);


Parameters:
objConnection - a valid Connection object with the URL set to the BICatalog service.
objConnectionState - the ConnectionState of the current user session.
Throws:
AxisFault
See Also:
Connection, ConnectionState

BICatalog

public BICatalog()
Deprecated. 
Method Detail

getInstance

public static BICatalog getInstance(Consumer objConsumer,
                                    java.lang.String strURL)
                             throws AxisFault
Deprecated. 
GetInstance static method returns a BICatalog by passing the Web Service URL and an already logged Consumer object.

Parameters:
objConsumer - one of the current user's consumer objects.
strURL - URL to connect to the BICatalog web service.
Returns:
An instance of BICatalog.
Throws:
com.businessobjects.dsws.AxisFault - Exception raised either as a Web Service SOAP Fault or as a Consumer side trapped exception.
Note:If the user is not logged in or the service name is unknown, NULL will be returned.

Example: Initializing a BICatalog instance.
Connection connection;
URL boConURL = new URL("'http://:/dswsbobje/services/session';");
connection = new com.businessobjects.dsws.Connection(boConURL);
Session boSession = new Session(connection);
EnterpriseCredential credential = EnterpriseCredential.Factory.newInstance();
credential.setLogin("username");
credential.setDomain("domain");
credential.setPassword("password");
SessionInfo boSI = boSession.login(credential);
String[] strBICatURL = boSession.getAssociatedServicesURL("BICatalog");
BICatalog boCat = BICatalog.getInstance(boSession,strBICatURL[0]);

AxisFault
See Also:
Connection, AuthenticationCredential, Session

getCatalog

public BICatalogObject[] getCatalog(java.lang.String objectUID,
                                    int depth,
                                    SortType.Enum[] sort,
                                    java.lang.String[] bicatalogObjectType,
                                    java.lang.String[] resourceRightNames,
                                    java.lang.String[] objectPropertyNames,
                                    InstanceRetrievalType.Enum instanceRetrievalType)
                             throws AxisFault
Deprecated. 
The getCatalog method returns an array of BICatalogObject, that is to say the documents, folders and categories available to the current users. Setting the depth > 0 will return this list as a flat structure
Note:Adding ResourceRights to be returned with each BICatalogObject can have a serious effect on performance.

Parameters:
objectUID - To recuperated a list of BICatalogObject from a specific folder or category set to the specific UID. To return all objects from the root directory set as an empty string.
depth - Number of levels to retrieve.
  • 0 returns the current level
  • 1 returns current plus child level
  • -1 returns get all levels recursively
sort - an array of SortType to sort the returned list of BICatalogObjects. Precedence of SortTypes follows the index of the sort array. Set this value to null if no sort is required.
bicatalogObjectType - an array of strings containing the name of the bicatalogObjectType you want to retrieve. Types can be either:
  • "documents"
  • "categories"
  • "folders"

Set to null to retrieve all object types.
resourceRightNames - an array of strings containing the name of the ResourceRights to be retrieved with each BICatalogObject. If you pass a non-handled ResourceRight name this method will ignore it. Pass null and no ResourceRights are returned.
objectPropertyNames - an array of strings containing the name of the ObjectProperties to be retrieved with each BICatalogObject. Pass a non-handled ObjectProperty name this method will ignore it. Pass null and no ObjectProperties are returned.
instanceRetrievalType - the Document instance type to filter on. The filter only impacts Document objects, and not Folders or Categories.
Returns:
an array of BICatalogObject. This function will return null if no BICatalogObject is to be returned.
Throws:
AxisFault
See Also:
Category, Folder, Document, BICatalogObject, SortType, ResourceRight, ObjectProperty, InstanceRetrievalType

getDocumentList

public Document[] getDocumentList(java.lang.String objectUID,
                                  int depth,
                                  SortType.Enum[] sort,
                                  java.lang.String[] resourceRightNames,
                                  java.lang.String[] objectPropertyNames,
                                  InstanceRetrievalType.Enum instanceRetrievalType)
                           throws AxisFault
Deprecated. 
The getDocumentList method returns an array of Documents available to the current user.
Note:Adding ResourceRights to be returned with each Document can have a serious effect on performance.

Parameters:
objectUID - To recuperated a list of Documents from a specific folder or category set to the specific UID. To return all objects from the root directory set as an empty string.
depth - Number of levels to retrieve.
  • 0 returns the current level
  • 1 returns current plus child level
  • -1 returns get all levels recursively
sort - an array of SortType to sort the returned list of BICatalogObjects. Precedence of SortTypes follows the index of the sort array. Set this value to null if no sort is required.
resourceRightNames - an array of strings containing the name of the ResourceRights to be retrieved with each BICatalogObject. If you pass a non-handled ResourceRight name this method will ignore it. Pass null and no ResourceRights are returned.
objectPropertyNames - an array of strings containing the name of the ObjectProperties to be retrieved with each BICatalogObject. Pass a non-handled ObjectProperty name this method will ignore it. Pass null and no ObjectProperties are returned.
instanceRetrievalType - Document instance type to filter on. The filter only impacts Document objects, and not Folders or Categories.
Returns:
an array of Document. This function will return null if no Document is to be returned.
Throws:
AxisFault
See Also:
Document, BICatalogObject, SortType, ResourceRight, ObjectProperty, InstanceRetrievalType

getCategoryList

public Category[] getCategoryList(java.lang.String objectUID,
                                  int depth,
                                  SortType.Enum[] sort,
                                  java.lang.String[] resourceRightNames,
                                  java.lang.String[] objectPropertyNames)
                           throws AxisFault
Deprecated. 
The getCategoryList method returns an array of Categories available to the current user.
Note:Adding ResourceRights to be returned with each Category can have a serious effect on performance.

Parameters:
objectUID - To recuperated a list of Categories from a specific folder or category set to the specific UID. To return all objects from the root directory set as an empty string.
depth - Number of levels to retrieve.
  • 0 returns the current level
  • 1 returns current plus child level
  • -1 returns get all levels recursively
sort - an array of SortType to sort the returned list of BICatalogObjects. Precedence of SortTypes follows the index of the sort array. Set this value to null if no sort is required.
resourceRightNames - an array of strings containing the name of the ResourceRights to be retrieved with each BICatalogObject. If you pass a non-handled ResourceRight name this method will ignore it. Pass null and no ResourceRights are returned.
objectPropertyNames - an array of strings containing the name of the ObjectProperties to be retrieved with each BICatalogObject. Pass a non-handled ObjectProperty name this method will ignore it. Pass null and no ObjectProperties are returned.
Returns:
an array of Categories. This function will return null if no Category is to be returned.
Throws:
AxisFault
See Also:
BICatalogObject, SortType, ResourceRight, ObjectProperty, InstanceRetrievalType

getFolderList

public Folder[] getFolderList(java.lang.String objectUID,
                              int depth,
                              SortType.Enum[] sort,
                              java.lang.String[] resourceRightNames,
                              java.lang.String[] objectPropertyNames)
                       throws AxisFault
Deprecated. 
The getCategoryList method returns an array of Folders available to the current user.
Note:Adding ResourceRights to be returned with each Folder can have a serious effect on performance.

Parameters:
objectUID - To recuperated a list of Categories from a specific folder or category set to the specific UID. To return all objects from the root directory set as an empty string.
depth - Number of levels to retrieve.
  • 0 returns the current level
  • 1 returns current plus child level
  • -1 returns get all levels recursively
sort - an array of SortType to sort the returned list of BICatalogObjects. Precedence of SortTypes follows the index of the sort array. Set this value to null if no sort is required.
resourceRightNames - an array of strings containing the name of the ResourceRights to be retrieved with each BICatalogObject. If you pass a non-handled ResourceRight name this method will ignore it. Pass null and no ResourceRights are returned.
objectPropertyNames - an array of strings containing the name of the ObjectProperties to be retrieved with each BICatalogObject. Pass a non-handled ObjectProperty name this method will ignore it. Pass null and no ObjectProperties are returned.
Returns:
an array of Folders. This function will return null if no Folder is to be returned.
Throws:
AxisFault
See Also:
BICatalogObject, SortType, ResourceRight, ObjectProperty, InstanceRetrievalType

search

public BICatalogObject[] search(SearchPattern searchPattern,
                                SortType.Enum[] sort,
                                java.lang.String[] resourceRightNames,
                                java.lang.String[] objectPropertyNames,
                                InstanceRetrievalType.Enum instanceRetrievalType)
                         throws AxisFault
Deprecated. 
The Search method returns an array of BICatalogObject corresponding to a SearchPattern.

Parameters:
searchPattern - a SearchPattern object correspond to your search request.
sort - an array of SortType to sort the returned list of BICatalogObjects. Precedence of SortTypes follows the index of the sort array. Set this value to null if no sort is required.
resourceRightNames - an array of strings containing the name of the ResourceRights to be retrieved with each BICatalogObject. If you pass a non-handled ResourceRight name this method will ignore it. Pass null and no ResourceRights are returned.
objectPropertyNames - an array of strings containing the name of the ObjectProperties to be retrieved with each BICatalogObject. Pass a non-handled ObjectProperty name this method will ignore it. Pass null and no ObjectProperties are returned.
instanceRetrievalType - the Document instance type to filter on. The filter only impacts Document objects, and not Folders or Catgeories.
Returns:
an array of BICatalogObject
Throws:
AxisFault
See Also:
SearchPattern, BICatalogObject, SortType, ResourceRight, ObjectProperty, InstanceRetrievalType, SimpleSearch

getResourceRights

public ResourceRight[] getResourceRights(java.lang.String objectUID)
                                  throws AxisFault
Deprecated. 
Return a complete list of ResourceRight for a specific resource.

Parameters:
objectUID - The specific ID of the BICatalogObject for which the user wishes to know the ResourceRights.
Returns:
an array of ResourceRights
Throws:
AxisFault
See Also:
ResourceRight

getObjectProperties

public ObjectProperty[] getObjectProperties(java.lang.String objectUID)
                                     throws AxisFault
Deprecated. 
Return a complete list of ObjectProperty of a specific resources.

Parameters:
objectUID - The specific ID of the BICatalogObject for which the user wishes to know the ObjectProperty.
Returns:
an array of ObjectProperty
Throws:
AxisFault
See Also:
ObjectProperty

writeExternal

public void writeExternal(java.io.ObjectOutput out)
                   throws java.io.IOException
Deprecated. 
Specified by:
writeExternal in interface java.io.Externalizable
Throws:
java.io.IOException

readExternal

public void readExternal(java.io.ObjectInput in)
                  throws java.io.IOException,
                         java.lang.ClassNotFoundException
Deprecated. 
Specified by:
readExternal in interface java.io.Externalizable
Throws:
java.io.IOException
java.lang.ClassNotFoundException
Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD