com.ibm.portal.resolver.data
Interface UserContextDataSource

All Superinterfaces:
Addressable, DataSource, DataSourceFragment, Disposable, TimeStamped
All Known Implementing Classes:
AbstractDataSource, AbstractStaticDataSource, EarlyBindingDataSource

public interface UserContextDataSource
extends DataSource

Interface that may optionally be implemented by a DataSource to indicate if the content of the data source depends on the current user context.

Since:
7.0
Note:
This interface is designed to be implemented by clients.

Field Summary
static java.lang.Boolean USER_CONTEXT_UNKNOWN
          the user dependency is unknown, let the framework decide
 
Fields inherited from interface com.ibm.portal.resolver.data.DataSource
CONTENT_TYPE_UNKNOWN, CREATION_UNKNOWN, EXPIRATION_UNKNOWN, LAST_MODIFICATION_UNKNOWN, MAX_AGE_INFINITE, MAX_AGE_NONE, ROOT_DATE
 
Fields inherited from interface com.ibm.portal.resolver.data.Addressable
EMPTY_PARAMETERS
 
Method Summary
 java.lang.Boolean isPrivate()
          Indicates if the data source depends on the user context (if any).
 
Methods inherited from interface com.ibm.portal.resolver.data.DataSource
getContentType, getCreated, getExpiration, getLastModified
 
Methods inherited from interface com.ibm.portal.resolver.data.Addressable
getParameters, getURI
 
Methods inherited from interface com.ibm.portal.Disposable
dispose
 

Field Detail

USER_CONTEXT_UNKNOWN

static final java.lang.Boolean USER_CONTEXT_UNKNOWN
the user dependency is unknown, let the framework decide

Method Detail

isPrivate

java.lang.Boolean isPrivate()
Indicates if the data source depends on the user context (if any).

Returns:
Boolean.TRUE if the data source depends on the user context, Boolean.FALSE if the data source does not depend on the user context of USER_CONTEXT_UNKNOWN to leave the decision to the framework.