com.ibm.portal.portlet.service.model
Interface ClientListProvider

All Superinterfaces:
PortletService

public interface ClientListProvider
extends PortletService

An interface for a provider of client lists.

PortletServiceHome psh;
javax.naming.Context ctx = new javax.naming.InitialContext();
boolean serviceAvailable = false;

try {
psh = (PortletServiceHome) ctx.lookup("portletservice/com.ibm.portal.portlet.service.model.ClientListProvider");
serviceAvailable = true;
} catch(javax.naming.NameNotFoundException ex) {
... error handling ...
}
...
if (serviceAvailable) {
ClientListProvider provider = (ClientListProvider) psh.getPortletService(ClientListProvider.class);
ClientList list = provider.getClientList(aRequest);
...
}

Since:
7.0

Field Summary
static java.lang.String JNDI_NAME
           
 
Method Summary
<T extends java.lang.Object & Client>
ClientList<T>
getClientList(javax.portlet.PortletRequest aRequest)
          Returns the portal client list.
 

Field Detail

JNDI_NAME

static final java.lang.String JNDI_NAME
Since:
8.5
See Also:
Constant Field Values
Method Detail

getClientList

<T extends java.lang.Object & Client> ClientList<T> getClientList(javax.portlet.PortletRequest aRequest)
                                                             throws ModelException
Returns the portal client list.

Parameters:
aRequest - the current request
Returns:
the client list valid in the current request
Throws:
ModelException