|
Collaboration API Documentation | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Field Summary | |
static int |
TEAMSPACE_TEMPLATE_FILTER
Option to specify that objects are filtered out that are part of teamspaces that are templates. |
static int |
TEAMSPACE_TEMPLATE_IGNORE
Option to specify that teamspace template status is ignored, in other words it has no effect on the query results. |
static int |
TEAMSPACE_TEMPLATE_RETURN
Option to specify that teamspace template status is simply returned as part of the context of the query results. |
static int |
VERSION_CONTROL_ALL
Option to specify that all versions of documents that match the search criteria are to be returned. |
static int |
VERSION_CONTROL_ALLCHECKEDIN
Option to specify that all checked-in versions of documents are searched (all versions except reservations). |
static int |
VERSION_CONTROL_ALLMAJOR
Option to specify that all major versions of documents are searched. |
static int |
VERSION_CONTROL_CURRENT
Option to specify that only the current version of documents are to be searched. |
static int |
VERSION_CONTROL_RELEASED
Option to specify that only released versions of documents are to be searched. |
Method Summary | |
java.lang.String |
execute()
Executes the query and returns XML that represents the results. |
int |
getMaximumResults()
Returns the maximum specified with setMaximumResults() . |
java.lang.String |
getObjectStoreId()
Returns the object store to search. |
OrderBy[] |
getOrdering()
Returns the ordering options specified with setOrdering() . |
PropertyCriteriaNode |
getPropertyCriteria()
Gets the property based search criteria specified with setPropertyCriteria() . |
java.lang.String |
getUserID()
Returns the user ID specified with setUserID() . |
void |
setMaximumResults(int max)
Specifies the maximum number of results to return from the query. |
void |
setObjectStoreId(java.lang.String objStoreId)
Specifies what object store to search. |
void |
setOrdering(OrderBy[] ordering)
Sets ordering options. |
void |
setPropertyCriteria(PropertyCriteriaNode node)
Sets a property-based search criteria. |
void |
setUserID(java.lang.String userID)
Specifies the current user ID. |
Field Detail |
public static final int VERSION_CONTROL_RELEASED
public static final int VERSION_CONTROL_CURRENT
public static final int VERSION_CONTROL_ALL
public static final int VERSION_CONTROL_ALLCHECKEDIN
public static final int VERSION_CONTROL_ALLMAJOR
public static final int TEAMSPACE_TEMPLATE_IGNORE
public static final int TEAMSPACE_TEMPLATE_RETURN
public static final int TEAMSPACE_TEMPLATE_FILTER
Method Detail |
public java.lang.String execute()
public void setMaximumResults(int max)
public int getMaximumResults()
setMaximumResults()
.public void setObjectStoreId(java.lang.String objStoreId)
public java.lang.String getObjectStoreId()
public void setUserID(java.lang.String userID)
Poll.areResponsesHidden()
)
and whether the current user is the owner of the PollResponse.public java.lang.String getUserID()
setUserID()
.public void setOrdering(OrderBy[] ordering)
OrderBy
objects.
An object of this type is obtained through the CollaborationFactory method getOrderBy()
.public OrderBy[] getOrdering()
setOrdering()
.public void setPropertyCriteria(PropertyCriteriaNode node)
getPropertyCriteriaNode()
.public PropertyCriteriaNode getPropertyCriteria()
setPropertyCriteria()
.
|
Collaboration API Documentation | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |