|
Oracle® Collaboration Suite Workspaces API Reference 10g (10.1.1.0.2) Part No. B16233-01 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object
oracle.workspaces.search.CwSearchContainer
A CwSearchContainer object specifies the container under which the search will take place - it scopes the search. Note that the query scope is a collection of search containers. The container consists of an entity type to search for: CwEntityType.WORKSPACE, CwEntityType.FILE, CwEntityType.DISCUSSION_MESSAGE, or CwEntityType.CALENDAR_EVENT. It also includes an entity descriptor, which specifies whether search occurs within a single workspace or across workspaces. The value CwSearchConstants.MY_WORKSPACES_DESCRIPTOR indicates a search across workspaces while CwSearchConstants.CW_ENTITY_DESCRIPTOR indicates a search within a single workspace. Note that CwSearchConstants.ALL_WORKSPACES_DESCRIPTOR is not supported in this release. Finally, the container may specify the CwUid of a specific entity in the case of a within-workspace search. It should be the CwUid of the workspace to search. The CwUid may be null if performing a cross-workspace search.
Constructor Summary | |
CwSearchContainer(CwEntityType searchEntityType, java.lang.String searchRootDescriptor, CwUid searchRootEntity) This constructs a Cw Search container object. |
Method Summary | |
boolean |
equals(CwSearchContainer obj) Compares a given object with this one. |
CwEntityType |
getSearchEntityType() Returns the entity type to search for, which was set in the constructor. |
java.lang.String |
getSearchRootDescriptor() Returns the type of search root |
CwUid |
getSearchRootEntity() The CwUid object reperesenting the workspace to search; may be null. |
static CwSearchContainer |
parseCwSearchContainer(java.lang.String containerAsString) Parses the string representation of CwSearchContainer into an instance of it. |
java.lang.String |
toString() Generate the string representation of this object. |
Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
public CwSearchContainer(CwEntityType searchEntityType, java.lang.String searchRootDescriptor, CwUid searchRootEntity)
searchEntityType
- this specifies what entity type to search for. Example of searchable entity types are CwEntityType.WORKSPACE, CwEntityType.FILE, CwEntityType.DISCUSSION_MESSAGE etc.searchRootDescriptor
- this is the root type under which the search will be executed. Valid root descriptors are: CwSearchConstants.MY_WORKSPACES_DESCRIPTOR, CwSearchConstants.CW_ENTITY_DESCRIPTOR. For the first case, the third parameter of the constructor will be ignored, so null can be specified for the third parameter. For CwSearchConstants.CW_ENTITY_DESCRIPTOR, the third parameter must be a valid CwUid object. The search will be performed under the entity specified by the CwUid object.searchRootEntity
- the CwUid representing the workspace to search. This is considered only if searchRootDescriptor is specified as CwSearchConstants.CW_ENTITY_DESCRIPTOR, else it is ignored.Method Detail |
public boolean equals(CwSearchContainer obj)
obj
- an instance of CwSearchContainer.public CwEntityType getSearchEntityType()
public java.lang.String getSearchRootDescriptor()
public CwUid getSearchRootEntity()
public static CwSearchContainer parseCwSearchContainer(java.lang.String containerAsString) throws CwException
containerAsString
- the string representation of the search container.CwException
public java.lang.String toString()
|
|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |