com.businessobjects.dsws.bicatalog
Interface BICatalogObject

All Known Subinterfaces:

Category, Document, Folder

Deprecated. As of Business Objects XI Release 3.0. Use BIPlatform as a replacement.

public interface BICatalogObject

The BICatalogObject interface is a parent interface that can hold information about any object stored by the Web Services provider server.

BICatalogObjects can be of the following types:

• Documents
• Categories
• Folders
• Hyperlink
• Shortcut

Example: Return a sorted array of all BICatalogObject types from the root level folder with no ResourceRights or ObjectProperties included in the individual BICatalogObjects.

Session mySession = new Session(boConnection);
String[] strBOCatURL = boSession.getAssociatedServicesURL("BICatalog");
BICatalog boCatalog = BICatalog.getInstance(boSession,strBOCatURL[0]);
com.businessobjects.dsws.bicatalog.SortType[] mySort = new com.businessobjects.dsws.bicatalog.SortType[1];
mySort[0] = com.businessobjects.dsws.bicatalog.SortType.NAMEDESC;
BICatalogObject[] boCatObjects = boCatalog.getCatalog("", 0, mySort, null, null, null, InstanceRetrievalType.ALL);
BICatalogObject myBOCatObject = boCatObjects[0];
String strBOCatuid = myBOCatObject.getUID();


See Also:

Connection, AuthenticationCredential, Session, BICatalog, SortType, ResourceRight, ObjectProperty, InstanceRetrievalType

Nested Class Summary

static class

BICatalogObject.Factory Deprecated. As of Business Objects XI Release 3.0. Use BIPlatform as a replacement.

Field Summary

static org.apache.xmlbeans.SchemaType

type Deprecated. Internal Use Only.

Method Summary

BICatalogObject	addNewChildren() Deprecated. Internal Use Only.
ObjectProperty	addNewObjectProperties() Deprecated. Internal Use Only.
ResourceRight	addNewResourceRights() Deprecated. Internal Use Only.
WSResource	addNewWSResourceList() Deprecated. Internal Use Only.
java.lang.String	getAuthor() Deprecated. Returns the name of the author of this BICatalogObject.
BICatalogObject[]	getChildrenArray() Deprecated. Returns an array of this BICatalogObject's child BICatalogObject.
BICatalogObject	getChildrenArray(int i) Deprecated. Internal Use Only.
java.util.Calendar	getCreationDate() Deprecated. Returns the date on which this BICatalogObject was created.
java.lang.String	getDescription() Deprecated. Return a description of the BICatalogObject.
java.lang.String	getKeywords() Deprecated. Returns the keywords associated to the BICatalogObject.
java.lang.String	getName() Deprecated. Returns the Name attribute.
ObjectProperty[]	getObjectPropertiesArray() Deprecated. Returns an array of ObjectProperties assigned to the BICatalogObject.
ObjectProperty	getObjectPropertiesArray(int i) Deprecated. Returns an array of ObjectProperties assigned to the BICatalogObject at the specified indexed position.
java.lang.String	getObjectType() Deprecated. Returns a string showing the type of BICatalogObject.
ResourceRight[]	getResourceRightsArray() Deprecated. Returns an array of ResourceRight assigned to the BICatalogObject.
ResourceRight	getResourceRightsArray(int i) Deprecated. Returns an array of ResourceRight assigned to the BICatalogObject at the specified indexed position.
java.lang.String	getUID() Deprecated. Returns the system unique ID (UID) for this BICatalogObject.
WSResource[]	getWSResourceListArray() Deprecated. Returns an array of WSResource assigned to the BICatalogObject.
WSResource	getWSResourceListArray(int i) Deprecated. Returns a single WSResource assigned to this BICatalogObject at a specified indexed position.
BICatalogObject	insertNewChildren(int i) Deprecated. Internal Use Only.
ObjectProperty	insertNewObjectProperties(int i) Deprecated. Internal Use Only.
ResourceRight	insertNewResourceRights(int i) Deprecated. Internal Use Only.
WSResource	insertNewWSResourceList(int i) Deprecated. Internal Use Only.
boolean	isSetDescription() Deprecated. Checks if the Description element has been set.
boolean	isSetKeywords() Deprecated. Checks if the Keywords element has been set
void	removeChildren(int i) Deprecated. Internal Use Only.
void	removeObjectProperties(int i) Deprecated. Internal Use Only.
void	removeResourceRights(int i) Deprecated. Internal Use Only.
void	removeWSResourceList(int i) Deprecated. Internal Use Only.
void	setAuthor(java.lang.String author) Deprecated. Internal Use Only.
void	setChildrenArray(BICatalogObject[] childrenArray) Deprecated. Internal Use Only.
void	setChildrenArray(int i, BICatalogObject children) Deprecated. Internal Use Only.
void	setCreationDate(java.util.Calendar creationDate) Deprecated. Internal Use Only.
void	setDescription(java.lang.String description) Deprecated. Sets the Description element.
void	setKeywords(java.lang.String keywords) Deprecated. Internal Use Only.
void	setName(java.lang.String name) Deprecated. Internal Use Only.
void	setObjectPropertiesArray(int i, ObjectProperty objectProperties) Deprecated. Internal Use Only.
void	setObjectPropertiesArray(ObjectProperty[] objectPropertiesArray) Deprecated. Internal Use Only.
void	setObjectType(java.lang.String objectType) Deprecated. Internal Use Only.
void	setResourceRightsArray(int i, ResourceRight resourceRights) Deprecated. Internal Use Only.
void	setResourceRightsArray(ResourceRight[] resourceRightsArray) Deprecated. Internal Use Only.
void	setUID(java.lang.String uid) Deprecated. Sets the UID attribute.
void	setWSResourceListArray(int i, WSResource wsResourceList) Deprecated. Internal Use Only.
void	setWSResourceListArray(WSResource[] wsResourceListArray) Deprecated. Internal Use Only.
int	sizeOfChildrenArray() Deprecated. Returns size of the ChildrenArray
int	sizeOfObjectPropertiesArray() Deprecated. Returns the size of the ObjectPropertiesArray.
int	sizeOfResourceRightsArray() Deprecated. Returns size of the ResourceRightsArray.
int	sizeOfWSResourceListArray() Deprecated. Returns the size of the WSResourceListArray.
void	unsetDescription() Deprecated. Deletes or unsets the Description element.
void	unsetKeywords() Deprecated. Deletes or unsets the Keywords element
org.apache.xmlbeans.XmlString	xgetAuthor() Deprecated. Internal Use Only.
org.apache.xmlbeans.XmlDateTime	xgetCreationDate() Deprecated. Internal Use Only.
org.apache.xmlbeans.XmlString	xgetDescription() Deprecated. Internal Use Only.
org.apache.xmlbeans.XmlString	xgetKeywords() Deprecated. Internal Use Only.
org.apache.xmlbeans.XmlString	xgetName() Deprecated. Returns the name of this BICatalogObject.
org.apache.xmlbeans.XmlString	xgetObjectType() Deprecated. Internal Use Only.
org.apache.xmlbeans.XmlString	xgetUID() Deprecated. Internal Use Only.
void	xsetAuthor(org.apache.xmlbeans.XmlString author) Deprecated. Internal Use Only.
void	xsetCreationDate(org.apache.xmlbeans.XmlDateTime creationDate) Deprecated. Internal Use Only.
void	xsetDescription(org.apache.xmlbeans.XmlString description) Deprecated. Internal Use Only.
void	xsetKeywords(org.apache.xmlbeans.XmlString keywords) Deprecated. Internal Use Only.
void	xsetName(org.apache.xmlbeans.XmlString name) Deprecated. Internal Use Only.
void	xsetObjectType(org.apache.xmlbeans.XmlString objectType) Deprecated. Internal Use Only.
void	xsetUID(org.apache.xmlbeans.XmlString uid) Deprecated. Internal Use Only.

Field Detail

type

static final org.apache.xmlbeans.SchemaType type

Deprecated.

Internal Use Only.

Method Detail

getDescription

java.lang.String getDescription()

Deprecated.

Return a description of the BICatalogObject.
Note:This field is optional so the function may return null.

Returns:

A description of the BICatalogObject.

xgetDescription

org.apache.xmlbeans.XmlString xgetDescription()

Deprecated.

Internal Use Only.

isSetDescription

boolean isSetDescription()

Deprecated.

Checks if the Description element has been set.

Returns:

true if the Description element has been set,otherwise false.

setDescription

void setDescription(java.lang.String description)

Deprecated.

Sets the Description element.

Parameters:

description - A String containing the Description element.

xsetDescription

void xsetDescription(org.apache.xmlbeans.XmlString description)

Deprecated.

Internal Use Only.

unsetDescription

void unsetDescription()

Deprecated.

Deletes or unsets the Description element.

getKeywords

java.lang.String getKeywords()

Deprecated.

Returns the keywords associated to the BICatalogObject.
Note:This field is optional so the function may return null.

Returns:

The keywords associated to the BICatalogObject.

xgetKeywords

org.apache.xmlbeans.XmlString xgetKeywords()

Deprecated.

Internal Use Only.

isSetKeywords

boolean isSetKeywords()

Deprecated.

Checks if the Keywords element has been set

Returns:

true if the Keywords element has been set,otherwise false.

setKeywords

void setKeywords(java.lang.String keywords)

Deprecated.

Internal Use Only.

xsetKeywords

void xsetKeywords(org.apache.xmlbeans.XmlString keywords)

Deprecated.

Internal Use Only.

unsetKeywords

void unsetKeywords()

Deprecated.

Deletes or unsets the Keywords element

getResourceRightsArray

ResourceRight[] getResourceRightsArray()

Deprecated.

Returns an array of ResourceRight assigned to the BICatalogObject.
Note:The ResourceRights array in a BICatalogObject is empty unless explicitly demanded when BICatalog.getCatalog is called.

Returns:

an array of ResourceRight associated to this BICatalogObject.

See Also:

ResourceRight

getResourceRightsArray

ResourceRight getResourceRightsArray(int i)

Deprecated.

Returns an array of ResourceRight assigned to the BICatalogObject at the specified indexed position.
Note:The ResourceRights array in a BICatalogObject is empty unless explicitly demanded when BICatalog.getCatalog is called.

Parameters:

i - The index position.

Returns:

an array of ResourceRight associated to this BICatalogObject.

See Also:

ResourceRight

sizeOfResourceRightsArray

int sizeOfResourceRightsArray()

Deprecated.

Returns size of the ResourceRightsArray.

Returns:

An integer which is the size of the ResourceRightsArray.

setResourceRightsArray

void setResourceRightsArray(ResourceRight[] resourceRightsArray)

Deprecated.

Internal Use Only.

setResourceRightsArray

void setResourceRightsArray(int i,
                            ResourceRight resourceRights)

Deprecated.

Internal Use Only.

insertNewResourceRights

ResourceRight insertNewResourceRights(int i)

Deprecated.

Internal Use Only.

addNewResourceRights

ResourceRight addNewResourceRights()

Deprecated.

Internal Use Only.

removeResourceRights

void removeResourceRights(int i)

Deprecated.

Internal Use Only.

getObjectPropertiesArray

ObjectProperty[] getObjectPropertiesArray()

Deprecated.

Returns an array of ObjectProperties assigned to the BICatalogObject.

Returns:

An array of ObjectProperties associated to this BICatalogObject.

See Also:

ObjectProperty

getObjectPropertiesArray

ObjectProperty getObjectPropertiesArray(int i)

Deprecated.

Returns an array of ObjectProperties assigned to the BICatalogObject at the specified indexed position.

Returns:

An array of ObjectProperties associated to this BICatalogObject.

See Also:

ObjectProperty

sizeOfObjectPropertiesArray

int sizeOfObjectPropertiesArray()

Deprecated.

Returns the size of the ObjectPropertiesArray.

Returns:

An integer containing the size of the ObjectPropertiesArray.

setObjectPropertiesArray

void setObjectPropertiesArray(ObjectProperty[] objectPropertiesArray)

Deprecated.

Internal Use Only.

setObjectPropertiesArray

void setObjectPropertiesArray(int i,
                              ObjectProperty objectProperties)

Deprecated.

Internal Use Only.

insertNewObjectProperties

ObjectProperty insertNewObjectProperties(int i)

Deprecated.

Internal Use Only.

addNewObjectProperties

ObjectProperty addNewObjectProperties()

Deprecated.

Internal Use Only.

removeObjectProperties

void removeObjectProperties(int i)

Deprecated.

Internal Use Only.

getWSResourceListArray

WSResource[] getWSResourceListArray()

Deprecated.

Returns an array of WSResource assigned to the BICatalogObject.

Returns:

The array of WSResource associated to this BICatalogObject.

See Also:

WSResource

getWSResourceListArray

WSResource getWSResourceListArray(int i)

Deprecated.

Returns a single WSResource assigned to this BICatalogObject at a specified indexed position.

Parameters:

i - Index of the WSResource to be returned.

Returns:

A single ObjectProperty assigned to this BICatalogObject.

See Also:

com.businessobjects.dsws.bicatalog.WSResource.

sizeOfWSResourceListArray

int sizeOfWSResourceListArray()

Deprecated.

Returns the size of the WSResourceListArray.

Returns:

An integer containing the size of the WSResourceListArray.

setWSResourceListArray

void setWSResourceListArray(WSResource[] wsResourceListArray)

Deprecated.

Internal Use Only.

setWSResourceListArray

void setWSResourceListArray(int i,
                            WSResource wsResourceList)

Deprecated.

Internal Use Only.

insertNewWSResourceList

WSResource insertNewWSResourceList(int i)

Deprecated.

Internal Use Only.

addNewWSResourceList

WSResource addNewWSResourceList()

Deprecated.

Internal Use Only.

removeWSResourceList

void removeWSResourceList(int i)

Deprecated.

Internal Use Only.

getChildrenArray

BICatalogObject[] getChildrenArray()

Deprecated.

Returns an array of this BICatalogObject's child BICatalogObject.

Returns:

An array of BICatalogObjects.

getChildrenArray

BICatalogObject getChildrenArray(int i)

Deprecated.

Internal Use Only.

sizeOfChildrenArray

int sizeOfChildrenArray()

Deprecated.

Returns size of the ChildrenArray

Returns:

An integer containing the size of the ChildrenArray.

setChildrenArray

void setChildrenArray(BICatalogObject[] childrenArray)

Deprecated.

Internal Use Only.

setChildrenArray

void setChildrenArray(int i,
                      BICatalogObject children)

Deprecated.

Internal Use Only.

insertNewChildren

BICatalogObject insertNewChildren(int i)

Deprecated.

Internal Use Only.

addNewChildren

BICatalogObject addNewChildren()

Deprecated.

Internal Use Only.

removeChildren

void removeChildren(int i)

Deprecated.

Internal Use Only.

getObjectType

java.lang.String getObjectType()

Deprecated.

Returns a string showing the type of BICatalogObject. A BICatalogObject can be of the following type:

• Folders - all folder types
• Categories - all category types
• Documents -all document types
• Hyperlink
• Shortcut

Folders, Categories and Documents have the following subtypes.
Folders: Can be any of the following types:

Type	Details
Folder	Basic folder type
FavoriteFolder	Favorite folder type
ObjectPackage	ObjectPackage folder type

Categories: Can be any of the following types:

Type	Details
Category	Basic category type

Documents: Can be any of the following types:

Type	Details
CrystalReport	CrystalReport (rpt) type
WebIntelligence	WebIntelligence (wid) type
WebIntelligenceLegacy	WebIntelligence 2.x (wqy) type
BusinessQuery	BusinessQuery (bqy) type
BusinessObjects	BusinessObjects (rep) type
Excel	Excel (xls) type
Pdf	Adobe Pdf type
Rtf	Rtf type
Txt	Text type
Word	Microsoft Word (doc) type
PowerPoint	Microsoft PowerPoint (ppt) type
Program	Program type
Agnostic	All other types

Returns:

A String containing the name of the BICatalogObject type.

xgetObjectType

org.apache.xmlbeans.XmlString xgetObjectType()

Deprecated.

Internal Use Only.

setObjectType

void setObjectType(java.lang.String objectType)

Deprecated.

Internal Use Only.

xsetObjectType

void xsetObjectType(org.apache.xmlbeans.XmlString objectType)

Deprecated.

Internal Use Only.

getUID

java.lang.String getUID()

Deprecated.

Returns the system unique ID (UID) for this BICatalogObject.

Returns:

A String containing the UID for this object.

xgetUID

org.apache.xmlbeans.XmlString xgetUID()

Deprecated.

Internal Use Only.

setUID

void setUID(java.lang.String uid)

Deprecated.

Sets the UID attribute.

xsetUID

void xsetUID(org.apache.xmlbeans.XmlString uid)

Deprecated.

Internal Use Only.

getName

java.lang.String getName()

Deprecated.

Returns the Name attribute.

Returns:

String the Name.

xgetName

org.apache.xmlbeans.XmlString xgetName()

Deprecated.

Returns the name of this BICatalogObject. For example, if this object were of the Document object type, this would be the document name.

Returns:

A String containing the name of this object.

setName

void setName(java.lang.String name)

Deprecated.

Internal Use Only.

xsetName

void xsetName(org.apache.xmlbeans.XmlString name)

Deprecated.

Internal Use Only.

getAuthor

java.lang.String getAuthor()

Deprecated.

Returns the name of the author of this BICatalogObject. For example, if this object was of the Document object type, this would be the document's author.

Returns:

A String containing the name of the author of this object.

xgetAuthor

org.apache.xmlbeans.XmlString xgetAuthor()

Deprecated.

Internal Use Only.

setAuthor

void setAuthor(java.lang.String author)

Deprecated.

Internal Use Only.

xsetAuthor

void xsetAuthor(org.apache.xmlbeans.XmlString author)

Deprecated.

Internal Use Only.

getCreationDate

java.util.Calendar getCreationDate()

Deprecated.

Returns the date on which this BICatalogObject was created.

Returns:

A String containing the date this BICatalogObject was created.

xgetCreationDate

org.apache.xmlbeans.XmlDateTime xgetCreationDate()

Deprecated.

Internal Use Only.

setCreationDate

void setCreationDate(java.util.Calendar creationDate)

Deprecated.

Internal Use Only.

xsetCreationDate

void xsetCreationDate(org.apache.xmlbeans.XmlDateTime creationDate)

Deprecated.

Internal Use Only.