com.businessobjects.dsws.bicatalog
Interface SimpleSearch

All Superinterfaces:

SearchPattern

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

public interface SimpleSearch
extends SearchPattern

SimpleSearch is a child of the SearchPattern interface. A SearchPattern object is passed to the BICatalog.search method to enable the current user to search through the list of BICatalogObjects retrieved by the BICatalog.
Using SimpleSearch a user can search on the creation date, name, author and ObjectType of the BICatalogObjects stored on a Business Objects server.

Example: Search for BICatalogObjects authored by user Administrator

String searchString = "Report";
com.businessobjects.dsws.bicatalog.SimpleSearch mySearch = com.businessobjects.dsws.bicatalog.SimpleSearch.Factory.newInstance();
mySearch.setInName(searchString);
mySearch.setObjectType("Folder");
out.println("firstDocInSearchResults");
BICatalogObject[] searchResults = boCatalog.search(mySearch, sortArr, null, null, InstanceRetrievalType.ALL);
if ((searchResults != null) && (searchResults.length > 0))
{
for (int i = 0; i < searchResults.length; i++)
{
out.println(searchResults[i].getUID() + "
");
}
}
else
{
out.println("No documents found.");
}


See Also:

SearchPattern, BICatalog, BICatalog.search(com.businessobjects.dsws.bicatalog.SearchPattern, com.businessobjects.dsws.bicatalog.SortType.Enum[], java.lang.String[], java.lang.String[], com.businessobjects.dsws.bicatalog.InstanceRetrievalType.Enum), BICatalogObject

Nested Class Summary

static class

SimpleSearch.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

java.util.Calendar	getBeginDate() Deprecated. Set the earliest CreationDate to be searched for in the list of BICatalogObject.
java.util.Calendar	getEndDate() Deprecated. Returns the EndDate element.
java.lang.String	getInAuthor() Deprecated. Returns the InAuthor attribute.
java.lang.String	getInName() Deprecated. Returns the InName attribute.
java.lang.String	getObjectType() Deprecated. Returns the ObjectType attribute.
boolean	isNilBeginDate() Deprecated. Checks if BeginDate is Nil.
boolean	isNilEndDate() Deprecated. Checks if the EndDate element is Nil.
boolean	isSetBeginDate() Deprecated. Checks if the BeginDate element has been set.
boolean	isSetEndDate() Deprecated. Checks if the EndDate element is set.
boolean	isSetInAuthor() Deprecated. Checks if the InAuthor attribute has been set.
boolean	isSetInName() Deprecated. Checks if the InName attribute is set.
boolean	isSetObjectType() Deprecated. Checks if the ObjectType attribute is set.
void	setBeginDate(java.util.Calendar beginDate) Deprecated. Sets the BeginDate element.
void	setEndDate(java.util.Calendar endDate) Deprecated. Set the latest CreationDate to be searched for in the list of BICatalogObject.
void	setInAuthor(java.lang.String inAuthor) Deprecated. Set the string being searched for in the author attribute of all BICatalogObjects.
void	setInName(java.lang.String inName) Deprecated. Set the string being searched for in the name attribute of all BICatalogObjects.
void	setNilBeginDate() Deprecated. Nils the BeginDate element.
void	setNilEndDate() Deprecated. Nils the EndDate element.
void	setObjectType(java.lang.String objectType) Deprecated. Set the string being searched for in the objectType attribute of all BICatalogObjects.
void	unsetBeginDate() Deprecated. Deletes or unsets the BeginDate element.
void	unsetEndDate() Deprecated. Deletes or unsets the EndDate element.
void	unsetInAuthor() Deprecated. Deletes or unsets the InAuthor attribute.
void	unsetInName() Deprecated. Deletes or unsets the InName attribute
void	unsetObjectType() Deprecated. Deletes or unsets the ObjectType attribute.
org.apache.xmlbeans.XmlDateTime	xgetBeginDate() Deprecated. Internal Use Only.
org.apache.xmlbeans.XmlDateTime	xgetEndDate() Deprecated. Internal Use Only.
org.apache.xmlbeans.XmlString	xgetInAuthor() Deprecated. Internal Use Only.
org.apache.xmlbeans.XmlString	xgetInName() Deprecated. Internal Use Only.
org.apache.xmlbeans.XmlString	xgetObjectType() Deprecated. Internal Use Only.
void	xsetBeginDate(org.apache.xmlbeans.XmlDateTime beginDate) Deprecated. Internal Use Only.
void	xsetEndDate(org.apache.xmlbeans.XmlDateTime endDate) Deprecated. Internal Use Only.
void	xsetInAuthor(org.apache.xmlbeans.XmlString inAuthor) Deprecated. Internal Use Only.
void	xsetInName(org.apache.xmlbeans.XmlString inName) Deprecated. Internal Use Only.
void	xsetObjectType(org.apache.xmlbeans.XmlString objectType) Deprecated. Internal Use Only.

Field Detail

type

static final org.apache.xmlbeans.SchemaType type

Deprecated.

Internal Use Only.

Method Detail

getBeginDate

java.util.Calendar getBeginDate()

Deprecated.

Set the earliest CreationDate to be searched for in the list of BICatalogObject. A BICatalogObjects' creationDate attribute marks the date on which the object was created.
SimpleSearch permits a search based on the CreationDate.

Parameters:

beginDate - a Calendar object containing the start date to search on.

See Also:

BICatalogObject.getCreationDate(), BICatalogObject.setCreationDate(java.util.Calendar)

xgetBeginDate

org.apache.xmlbeans.XmlDateTime xgetBeginDate()

Deprecated.

Internal Use Only.

isNilBeginDate

boolean isNilBeginDate()

Deprecated.

Checks if BeginDate is Nil.

Returns:

true if the BeginDate element is nil,otherwise false.

isSetBeginDate

boolean isSetBeginDate()

Deprecated.

Checks if the BeginDate element has been set.

Returns:

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

setBeginDate

void setBeginDate(java.util.Calendar beginDate)

Deprecated.

Sets the BeginDate element.

Parameters:

beginDate - a Calendar object containing the first date to search for.

xsetBeginDate

void xsetBeginDate(org.apache.xmlbeans.XmlDateTime beginDate)

Deprecated.

Internal Use Only.

setNilBeginDate

void setNilBeginDate()

Deprecated.

Nils the BeginDate element.

unsetBeginDate

void unsetBeginDate()

Deprecated.

Deletes or unsets the BeginDate element.

getEndDate

java.util.Calendar getEndDate()

Deprecated.

Returns the EndDate element.

Returns:

EndDate a Calendar object containing the latest date to search for.

xgetEndDate

org.apache.xmlbeans.XmlDateTime xgetEndDate()

Deprecated.

Internal Use Only.

isNilEndDate

boolean isNilEndDate()

Deprecated.

Checks if the EndDate element is Nil.

Returns:

true if the EndDate element is nil,otherwise false.

isSetEndDate

boolean isSetEndDate()

Deprecated.

Checks if the EndDate element is set.

Returns:

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

setEndDate

void setEndDate(java.util.Calendar endDate)

Deprecated.

Set the latest CreationDate to be searched for in the list of BICatalogObject. A BICatalogObjects' creationDate attribute marks the date on which the object was created.
SimpleSearch permits a search based on the CreationDate.

Parameters:

endDate - a Calendar object containing the latest date to search for.

See Also:

BICatalogObject.getCreationDate(), BICatalogObject.setCreationDate(java.util.Calendar)

xsetEndDate

void xsetEndDate(org.apache.xmlbeans.XmlDateTime endDate)

Deprecated.

Internal Use Only.

setNilEndDate

void setNilEndDate()

Deprecated.

Nils the EndDate element.

unsetEndDate

void unsetEndDate()

Deprecated.

Deletes or unsets the EndDate element.

getInName

java.lang.String getInName()

Deprecated.

Returns the InName attribute.

Returns:

String containing the InName.

xgetInName

org.apache.xmlbeans.XmlString xgetInName()

Deprecated.

Internal Use Only.

isSetInName

boolean isSetInName()

Deprecated.

Checks if the InName attribute is set.

Returns:

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

setInName

void setInName(java.lang.String inName)

Deprecated.

Set the string being searched for in the name attribute of all BICatalogObjects.

Parameters:

inName - a search string.

See Also:

BICatalogObject.getName(), BICatalogObject.setName(java.lang.String)

xsetInName

void xsetInName(org.apache.xmlbeans.XmlString inName)

Deprecated.

Internal Use Only.

unsetInName

void unsetInName()

Deprecated.

Deletes or unsets the InName attribute

getInAuthor

java.lang.String getInAuthor()

Deprecated.

Returns the InAuthor attribute.

Returns:

String InAuthor.

xgetInAuthor

org.apache.xmlbeans.XmlString xgetInAuthor()

Deprecated.

Internal Use Only.

isSetInAuthor

boolean isSetInAuthor()

Deprecated.

Checks if the InAuthor attribute has been set.

Returns:

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

setInAuthor

void setInAuthor(java.lang.String inAuthor)

Deprecated.

Set the string being searched for in the author attribute of all BICatalogObjects.

Parameters:

inAuthor - a search string.

See Also:

BICatalogObject.getAuthor(), BICatalogObject.setAuthor(java.lang.String)

xsetInAuthor

void xsetInAuthor(org.apache.xmlbeans.XmlString inAuthor)

Deprecated.

Internal Use Only.

unsetInAuthor

void unsetInAuthor()

Deprecated.

Deletes or unsets the InAuthor attribute.

getObjectType

java.lang.String getObjectType()

Deprecated.

Returns the ObjectType attribute.

Returns:

ObjectType.

xgetObjectType

org.apache.xmlbeans.XmlString xgetObjectType()

Deprecated.

Internal Use Only.

isSetObjectType

boolean isSetObjectType()

Deprecated.

Checks if the ObjectType attribute is set.

Returns:

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

setObjectType

void setObjectType(java.lang.String objectType)

Deprecated.

Set the string being searched for in the objectType attribute of all BICatalogObjects.
See here for a list of possible ObjectTypes.

Parameters:

objectType - a search string.

See Also:

BICatalogObject.getObjectType(), BICatalogObject.setObjectType(java.lang.String)

xsetObjectType

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

Deprecated.

Internal Use Only.

unsetObjectType

void unsetObjectType()

Deprecated.

Deletes or unsets the ObjectType attribute.