Skip navigation links

oracle.webcenter.activitystreaming
Interface ObjectDetailsManager

public interface ObjectDetailsManager

Represents the access point for retrieving detail information about objects in WebCenter.

An instance of this can be retrieved via a call to ActivityStreamingService.getObjectDetailsManager().

Since:

release specific (what release of product did this appear in)

Method Summary

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.

Method Detail

getObjectDetail

ActivityObject getObjectDetail(ActivityObject objId)
                               throws ActivityException

Returns detail information about a specified WebCenter object.

Parameters:

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.

Returns:

Object carrying detail information about the specified WebCenter object (in addition to the identification information provided in the objId argument), or null if no details could be found for the specified object.

Throws:

ActivityException - If any error occurs retrieving information.

getObjectDetails

java.util.List<ActivityObject> getObjectDetails(java.util.Collection<ActivityObject> objIds)
                                                throws ActivityException

Returns detail information about a specified (arbitrary) collection of WebCenter objects.

Parameters:

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.

Returns:

List of objects carrying detail information about the specified WebCenter objects, such that, for each object 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.

Throws:

ActivityException - If any error occurs retrieving information.

Skip navigation links