public interface ObjectDetailsManager
An instance of this can be retrieved via a call to
ActivityStreamingService.getObjectDetailsManager()
.
Modifier and Type | Method and Description |
---|---|
ActivityObject |
getObjectDetail(ActivityObject objId)
Returns detail information about a specified WebCenter object.
|
java.util.List<ActivityObject> |
getObjectDetails(java.util.Collection<ActivityObject> objIds)
Returns detail information about a specified (arbitrary) collection
of WebCenter objects.
|
ActivityObject getObjectDetail(ActivityObject objId) throws ActivityException
objId
- Object carrying information identifying the WebCenter object
for which detail information is to be retreived.
The key properties needed to be specified on it are the service ID,
the object type, and the object ID. It can be constructed by
calling ActivityStreamingService.createObject(java.lang.String, oracle.webcenter.framework.service.ServiceObjectType, java.lang.String)
passing in the appropriate object ID and object type, and then
calling ActivityObject.setServiceID(java.lang.String)
on it. The display name
on the ActivityObject can be any non-null non-empty string, and need
not even be the correct display name of the actual WebCenter object
it represents.objId
argument), or null
if no details
could be found for the specified object.ActivityException
- If any error occurs retrieving information.java.util.List<ActivityObject> getObjectDetails(java.util.Collection<ActivityObject> objIds) throws ActivityException
objIds
- Collection of objects each identifying a WebCenter object
for which detail information is to be retreived.
The key properties needed to be specified on each element of the
collection are the service ID, the object type, and the object ID.
An element can be constructed by calling
ActivityStreamingService.createObject(java.lang.String, oracle.webcenter.framework.service.ServiceObjectType, java.lang.String)
passing in the appropriate object ID and object type, and then
calling ActivityObject.setServiceID(java.lang.String)
on it. The display name
on the ActivityObject can be any non-null non-empty string, and need
not even be the correct display name of the actual WebCenter object
it represents.o
in the
objIds
collection for which details could be found,
there will be a corresponding object in the resulting list
containing detail information about the WebCenter object it
identifies (in addition to the identification information provided
in o
). The sequence of elements in the returned list is
not guaranteed to correspond to the sequence of elements
in objIds
. So to identify which detail corresponds to which
object, one needs to examine the identification properties
(service ID, object type, object ID) in the elements of the
returned list.ActivityException
- If any error occurs retrieving information.