org.jasig.portal.layout.dlm.remoting
Interface IGroupListHelper

All Known Implementing Classes:

GroupListHelperImpl

public interface IGroupListHelper

Helper methods for retrieving portal entities.

Author:

Drew Mazurek, Jen Bourey

Method Summary

JsonEntityBean	getEntity(String entityType, String entityId, boolean populateChildren) Retrieve an individual entity matching the specified type and id.
List<JsonEntityBean>	getEntityBeans(List<String> params) Get a list of JsonEntityBeans for a supplied list of string identifiers, where an identifier consists of a colon-separated pairing of entity type and entity ID.
String	getEntityType(IGroupMember entity) Return the string representation of the type of a specified entity object.
String	lookupEntityName(JsonEntityBean entityBean) Find the name of a specified entity.
Set<JsonEntityBean>	search(String entityType, String searchTerm) Search for entities of a specified entity type using a search string.

Method Detail

search

Set<JsonEntityBean> search(String entityType,
                           String searchTerm)

Search for entities of a specified entity type using a search string.

Parameters:

entityType - entity type to search for

searchTerm - search string

Returns:

set of matching JsonEntityBeans

getEntityType

String getEntityType(IGroupMember entity)

Return the string representation of the type of a specified entity object.

Parameters:

entity - Entity whose type needs to be determined

Returns:

One of the possible EntityEnum string representations

lookupEntityName

String lookupEntityName(JsonEntityBean entityBean)

Find the name of a specified entity.

Parameters:

entityBean - JsonEntityBean representation of an entity

Returns:

Entity name, or null if none is found

getEntity

JsonEntityBean getEntity(String entityType,
                         String entityId,
                         boolean populateChildren)

Retrieve an individual entity matching the specified type and id. If populateChildren is set to true populate the entity bean with the entity's children before returning it. This argument will be ignored entirely if the entity is not of a group type, since non-group entities may not have children.

Parameters:

entityType - type of the entity to be returned

entityId - ID of the entity to be returned

populateChildren - true to populate the bean with children

Returns:

JsonEntityBean representation or null

getEntityBeans

List<JsonEntityBean> getEntityBeans(List<String> params)

Get a list of JsonEntityBeans for a supplied list of string identifiers, where an identifier consists of a colon-separated pairing of entity type and entity ID. For example, a Person Group entity with they key local.0 would be indicated by the identifier string "group:local.0".

Parameters:

params - List of string identifiers

Returns:

List of matching JsonEntityBeans