Skip navigation links

Oracle Fusion Middleware Java API Reference for Oracle WebCenter Portal
11g Release 1 (11.1.1.6.0)
E15995-05


oracle.webcenter.activitystreaming
Interface QueryOptions

All Known Subinterfaces:
EvalQueryOptions

public interface QueryOptions

QueryOptions represents query criteria that needs to be interpreted or evaluated in a specific context by a extension handler.


Method Summary
 java.lang.String getAdvancedQuery()
          Returns the advanced query condition.
 QueryItem<java.util.List<java.lang.String>> getConnectionLists()
          Deprecated. 
 boolean getFollowEnforced()
          Get if the follow logic is enforced.
 QueryItem<java.util.List<oracle.webcenter.framework.service.Scope>> getGroupSpaces()
          Deprecated. 
 java.util.List<java.lang.String> getHiddenActors()
          Return a list of actors to be hidden
 java.util.List<java.lang.String> getHiddenObjects()
          Return the list of objects to be hidden
 java.util.List<java.lang.String> getHiddenScopes()
          Return a list of hidden scopes
 java.util.List<java.lang.String> getIncludeSelectedConnections()
          Whether to include personal activities of the selected connection lists
 java.util.List<ActivityObject> getIncludeSelectedFollowedObjects()
          Get the list of include selected followed objects.
 java.util.List<oracle.webcenter.framework.service.Scope> getIncludeSelectedGroupSpaces()
          Whether to include all activities in the selected group spaces
 boolean getObjectExtensionHandlerEnabled()
          Retrieve the flag that indicates if the object extension handler is enabled.
 boolean getObjectSecured()
          Retrieve the flag that indicates if the object security is enabled.
 java.lang.String getProfileUserGUID()
           
 java.lang.String getProfileUserID()
           
 QueryItem<java.lang.Boolean> getShowAllConnections()
          Deprecated. 
 QueryItem<java.lang.Boolean> getShowAllGroupSpaces()
          Deprecated. 
 QueryItem<java.lang.Boolean> getShowFollowedObjects()
          Deprecated. 
 QueryItem<java.lang.Boolean> getShowPersonal()
          Deprecated. 
 boolean isIncludeAllConnections()
          Whether to include personal activities of the profile user's connections
 boolean isIncludeAllFollowedObjects()
          Whether to include all activities on the objects that the user follow
 boolean isIncludeAllFollowedObjectsOnProfile()
          Whether to include the user's activities on the objects that the user follows
 boolean isIncludeAllGroupSpaces()
          Whether to include all activities in the user's spaces including public spaces.
 boolean isIncludeAllGroupSpacesOnProfile()
          Whether to include user's activities in the user's spaces including public spaces.
 boolean isIncludeMySpaces()
          Whether to include all activities in the user's group spaces.
 boolean isIncludeProfile()
          Whether to include personal activities of the profile user
 void setAdvancedQuery(java.lang.String advancedQuery)
          Sets the advanced query condition that should be used to fetch results.
 void setConnectionLists(QueryItem<java.util.List<java.lang.String>> connectionLists)
          Deprecated. 
 void setFollowEnforced(boolean enforced)
          Set if the follow logic is enforced.
 void setGroupSpaces(QueryItem<java.util.List<oracle.webcenter.framework.service.Scope>> scopes)
          Deprecated. 
 void setHiddenActors(java.util.List<java.lang.String> actors)
          To set actors to be hidden
 void setHiddenObjects(java.util.List<java.lang.String> objects)
          To set list of objects to be hidden
 void setHiddenScopes(java.util.List<java.lang.String> scopes)
          To set scopes to be hidden
 void setIncludeAllConnections(boolean allConnections)
          To set whether to include personal activities of the profile user's connections
 void setIncludeAllFollowedObjects(boolean allFollowedObjects)
          To set whether to include all activities on the objects that the user follow
 void setIncludeAllFollowedObjectsOnProfile(boolean allFollowedObjectsOnProfile)
          To set whether to include the user's activities on the objects that the user follows
 void setIncludeAllGroupSpaces(boolean allGroupSpaces)
          To set whether to include all activities in the user's spaces including public spaces.
 void setIncludeAllGroupSpacesOnProfile(boolean allGroupSpacesOnProfile)
          To set whether to include the user's activities in the user's spaces including public spaces.
 void setIncludeMySpaces(boolean mySpaces)
          To set whether to include all activities in the user's spaces.
 void setIncludeProfile(boolean profile)
          To set whether to include personal activities of the profile user
 void setIncludeSelectedConnections(java.util.List<java.lang.String> selectedConnections)
          To set whether to include personal activities of the selected connection lists
 void setIncludeSelectedFollowedObjects(java.util.List<ActivityObject> selectedFollowedObjects)
          To set whether to include activities of the selected followed objects.
 void setIncludeSelectedGroupSpaces(java.util.List<oracle.webcenter.framework.service.Scope> selectedGroupSpaces)
          To set whether to include all activities in the selected group spaces
 void setObjectExtensionHandlerEnabled(boolean enabled)
          Set the flag that indicates if the object extension handler is enabled.
 void setObjectSecured(boolean secured)
          Set the flag that indicates if the object security is enabled.
 void setProfileUserGUID(java.lang.String profileUserGUID)
          The profile user we want to see.
 void setShowAllConnections(QueryItem<java.lang.Boolean> showConnections)
          Deprecated. 
 void setShowAllGroupSpaces(QueryItem<java.lang.Boolean> showGroupSpaces)
          Deprecated. 
 void setShowFollowedObjects(QueryItem<java.lang.Boolean> showFollowedObjects)
          Deprecated. 
 void setShowPersonal(QueryItem<java.lang.Boolean> showPersonal)
          Deprecated. 

 

Method Detail

setProfileUserGUID

void setProfileUserGUID(java.lang.String profileUserGUID)
The profile user we want to see.

getProfileUserGUID

java.lang.String getProfileUserGUID()

getProfileUserID

java.lang.String getProfileUserID()

getShowPersonal

@Deprecated
QueryItem<java.lang.Boolean> getShowPersonal()
Deprecated. 
Whether to show profile user's personal activities

setShowPersonal

@Deprecated
void setShowPersonal(QueryItem<java.lang.Boolean> showPersonal)
Deprecated. 

setShowAllConnections

@Deprecated
void setShowAllConnections(QueryItem<java.lang.Boolean> showConnections)
Deprecated. 
Whether to show profile user's connections activities
Parameters:
showConnections -

getShowAllConnections

@Deprecated
QueryItem<java.lang.Boolean> getShowAllConnections()
Deprecated. 

setConnectionLists

@Deprecated
void setConnectionLists(QueryItem<java.util.List<java.lang.String>> connectionLists)
Deprecated. 
Connection List name whic we want to show the activities of
Parameters:
connectionLists -

getConnectionLists

@Deprecated
QueryItem<java.util.List<java.lang.String>> getConnectionLists()
Deprecated. 

setShowAllGroupSpaces

@Deprecated
void setShowAllGroupSpaces(QueryItem<java.lang.Boolean> showGroupSpaces)
Deprecated. 
Whether to show group space activities

getShowAllGroupSpaces

@Deprecated
QueryItem<java.lang.Boolean> getShowAllGroupSpaces()
Deprecated. 

setGroupSpaces

@Deprecated
void setGroupSpaces(QueryItem<java.util.List<oracle.webcenter.framework.service.Scope>> scopes)
Deprecated. 
Group space scope which we want to show the activities of
Parameters:
scopes -

getGroupSpaces

@Deprecated
QueryItem<java.util.List<oracle.webcenter.framework.service.Scope>> getGroupSpaces()
Deprecated. 

setShowFollowedObjects

@Deprecated
void setShowFollowedObjects(QueryItem<java.lang.Boolean> showFollowedObjects)
Deprecated. 
Whether we want to show activities on followed objects
Parameters:
showFollowedObjects - whether to show activities on followed objects

getShowFollowedObjects

@Deprecated
QueryItem<java.lang.Boolean> getShowFollowedObjects()
Deprecated. 

setIncludeProfile

void setIncludeProfile(boolean profile)
To set whether to include personal activities of the profile user
Parameters:
profile - whether to include personal activities of the profile user

isIncludeProfile

boolean isIncludeProfile()
Whether to include personal activities of the profile user
Returns:
whether to include personal activities of the profile user

setIncludeAllConnections

void setIncludeAllConnections(boolean allConnections)
To set whether to include personal activities of the profile user's connections
Parameters:
allConnections - whether to include personal activities of the profile user's connections

isIncludeAllConnections

boolean isIncludeAllConnections()
Whether to include personal activities of the profile user's connections
Returns:
whether to include personal activities of the profile user's connections

setIncludeSelectedConnections

void setIncludeSelectedConnections(java.util.List<java.lang.String> selectedConnections)
To set whether to include personal activities of the selected connection lists
Parameters:
selectedConnections - a connection lists names

getIncludeSelectedConnections

java.util.List<java.lang.String> getIncludeSelectedConnections()
Whether to include personal activities of the selected connection lists
Returns:
connection lists names

setIncludeAllGroupSpacesOnProfile

void setIncludeAllGroupSpacesOnProfile(boolean allGroupSpacesOnProfile)
To set whether to include the user's activities in the user's spaces including public spaces.
Parameters:
allGroupSpacesOnProfile - whether to include user's activities in the user's spaces.

isIncludeAllGroupSpacesOnProfile

boolean isIncludeAllGroupSpacesOnProfile()
Whether to include user's activities in the user's spaces including public spaces.
Returns:
whether to include user's activities in the user's spaces.

setIncludeAllGroupSpaces

void setIncludeAllGroupSpaces(boolean allGroupSpaces)
To set whether to include all activities in the user's spaces including public spaces.
Parameters:
allGroupSpaces - whether to include all activities in the user's spaces.

isIncludeAllGroupSpaces

boolean isIncludeAllGroupSpaces()
Whether to include all activities in the user's spaces including public spaces.
Returns:
whether to include all activities in the user's spaces

setIncludeMySpaces

void setIncludeMySpaces(boolean mySpaces)
To set whether to include all activities in the user's spaces.
Parameters:
mySpaces - whether to include all activities in the user's spaces.

isIncludeMySpaces

boolean isIncludeMySpaces()
Whether to include all activities in the user's group spaces.
Returns:
whether to include all activities in the user's spaces.

setIncludeSelectedGroupSpaces

void setIncludeSelectedGroupSpaces(java.util.List<oracle.webcenter.framework.service.Scope> selectedGroupSpaces)
To set whether to include all activities in the selected group spaces
Parameters:
selectedGroupSpaces - whether to include all activities in the selected group spaces

getIncludeSelectedGroupSpaces

java.util.List<oracle.webcenter.framework.service.Scope> getIncludeSelectedGroupSpaces()
Whether to include all activities in the selected group spaces
Returns:
whether to include all activities in the selected group spaces

setIncludeAllFollowedObjectsOnProfile

void setIncludeAllFollowedObjectsOnProfile(boolean allFollowedObjectsOnProfile)
To set whether to include the user's activities on the objects that the user follows
Parameters:
allFollowedObjectsOnProfile - whether to include the user's activities on the objects that the user follows

isIncludeAllFollowedObjectsOnProfile

boolean isIncludeAllFollowedObjectsOnProfile()
Whether to include the user's activities on the objects that the user follows
Returns:
whether to include the user's activities on the objects that the user follows

setIncludeAllFollowedObjects

void setIncludeAllFollowedObjects(boolean allFollowedObjects)
To set whether to include all activities on the objects that the user follow
Parameters:
allFollowedObjects - whether to include all activities on the objects that the user follow

isIncludeAllFollowedObjects

boolean isIncludeAllFollowedObjects()
Whether to include all activities on the objects that the user follow
Returns:
whether to include all activities on the objects that the user follow

setIncludeSelectedFollowedObjects

void setIncludeSelectedFollowedObjects(java.util.List<ActivityObject> selectedFollowedObjects)
To set whether to include activities of the selected followed objects.
Parameters:
selectedFollowedObjects - a list of the followed objects.

getIncludeSelectedFollowedObjects

java.util.List<ActivityObject> getIncludeSelectedFollowedObjects()
Get the list of include selected followed objects.
Returns:
The list of followed objects.

getFollowEnforced

boolean getFollowEnforced()
Get if the follow logic is enforced.
Returns:
true if follow logic is enforced, fause otherwise.

setFollowEnforced

void setFollowEnforced(boolean enforced)
Set if the follow logic is enforced.
Parameters:
enforced - The flog indicates if follow is enforced.

setHiddenActors

void setHiddenActors(java.util.List<java.lang.String> actors)
To set actors to be hidden
Parameters:
actors - actors to be hidden. The ID is the User GUID

getHiddenActors

java.util.List<java.lang.String> getHiddenActors()
Return a list of actors to be hidden
Returns:
list of actors to be hidden

setHiddenScopes

void setHiddenScopes(java.util.List<java.lang.String> scopes)
To set scopes to be hidden
Parameters:
scopes - list of scopes to be hidden. The ID is the Scope GUIDs

getHiddenScopes

java.util.List<java.lang.String> getHiddenScopes()
Return a list of hidden scopes
Returns:
a list of hidden scopes

setHiddenObjects

void setHiddenObjects(java.util.List<java.lang.String> objects)
To set list of objects to be hidden
Parameters:
objects - objects to be hidden. The ID is the Object Detail GUIDs

getHiddenObjects

java.util.List<java.lang.String> getHiddenObjects()
Return the list of objects to be hidden
Returns:
list of objects to be hidden

setObjectSecured

void setObjectSecured(boolean secured)
Set the flag that indicates if the object security is enabled. If the object security is enabled, a midtier security checked will be executed.
Parameters:
secured - the security flag.

getObjectSecured

boolean getObjectSecured()
Retrieve the flag that indicates if the object security is enabled.
Returns:
that indicates if the object security is enabled.

setObjectExtensionHandlerEnabled

void setObjectExtensionHandlerEnabled(boolean enabled)
Set the flag that indicates if the object extension handler is enabled.
Parameters:
enabled - the flag that indicates if the object extension handler is enabled.

getObjectExtensionHandlerEnabled

boolean getObjectExtensionHandlerEnabled()
Retrieve the flag that indicates if the object extension handler is enabled.
Returns:
the flag that indicates if the object extension handler is enabled.

setAdvancedQuery

void setAdvancedQuery(java.lang.String advancedQuery)
Sets the advanced query condition that should be used to fetch results.
Parameters:
clause - - the advanced query condition.

getAdvancedQuery

java.lang.String getAdvancedQuery()
Returns the advanced query condition.
Returns:
- the advanced query condition if set, null otherwise.

Skip navigation links

Oracle Fusion Middleware Java API Reference for Oracle WebCenter Portal
11g Release 1 (11.1.1.6.0)
E15995-05


Copyright © 2009, 2012, Oracle and/or its affiliates. All rights reserved.