uPortal 2.4.1
API Documentation

Package org.jasig.portal.groups

Interface Summary
IComponentGroupService Defines a component group service that is part of a composite groups system.
IComponentGroupServiceFactory Factory interface for creating an IComponentGroupService.
ICompositeGroupService Defines an api for discovering entry points into a composite groups system consisting of component group services.
ICompositeGroupServiceFactory Factory interface for creating an ICompositeGroupService.
IEntity IEntity is the leaf sub-type of IGroupMember.
IEntityGroup An IEntityGroup is a composite, or non-leaf IGroupMember.
IEntityGroupStore Interface for finding and maintaining IEntityGroups.
IEntityGroupStoreFactory Factory interface for creating an IEntityGroupStore.
IEntityNameFinder Interface for finding the names of portal entities of a given type.
IEntityNameFinderFactory Factory interface for creating IEntityNameFinders.
IEntitySearcher Defines an api for searching for entities
IEntitySearcherFactory Factory interface for creating an IEntitySearcher.
IEntityStore An interface for retrieving IEntities.
IEntityStoreFactory Factory interface for creating an IEntityStore.
IGroupConstants Defines constants for Groups related classes
IGroupMember An IGroupMember defines common behavior for both the leaf IEntity and composite IEntityGroup sub-types that together make up a Groups structure.
IGroupService Defines an api for discovering an entry point into the groups system, represented by an IGroupMember.
IGroupServiceFactory Factory interface for creating an IGroupService.
IIndividualGroupService Defines a component group service that finds and maintains IGroupMembers within a composite group service.
ILockableEntityGroup Defines an IEntityGroup that can be locked for update.
ILockableGroupService Extends IGroupService with methods for finding and maintaining ILockableEntityGroups.
 

Class Summary
ComponentGroupServiceDescriptor A data holder for configuration information about a specific component group service.
CompositeEntityIdentifier A composite key and type that uniquely identify a portal entity.
CompositeServiceIdentifier A composite key that identifies a component group service.
EntityGroupImpl Reference implementation for IEntityGroup.
EntityGroupNameFinder Reference implementation of IEntityNameFinder for IEntityGroup.
EntityGroupNameFinderFactory Factory for creating EntityGroupNameFinder.
EntityImpl Reference implementation for IEntity.
GroupMemberImpl GroupMemberImpl summary first sentence goes here.
GroupServiceConfiguration Parses service descriptions found in the file found at SERVICES_XML.
LockableEntityGroupImpl Extends EntityGroupImpl to make it lockable for writing.
PersonDirNameFinder PersonDirectory implementation of IEntityNameFinder for IPersons.
PersonDirNameFinderFactory Factory for creating PersonDirNameFinders.
RDBMEntityGroupStore Store for EntityGroupImpl.
RDBMEntityStore Reference implementation for IEntityStore.
ReferenceChannelNameFinder Reference implementation of IEntityNameFinder for Channels.
ReferenceChannelNameFinderFactory Factory for creating ReferencePersonNameFinders.
ReferenceComponentGroupService Reference implementation of IComponentGroupService.
ReferenceCompositeGroupService  
ReferenceCompositeGroupServiceFactory Creates an instance of the reference ICompositeGroupService.
ReferenceEntityGroupStoreFactory Creates an instance of the reference IEntityGroupStore.
ReferenceEntitySearcherFactory Creates an instance of the reference IEntitySearcher.
ReferenceEntityStoreFactory Creates an instance of the reference IEntityStore.
ReferenceGroupService Reference group service.
ReferenceGroupServiceFactory Creates the reference implemetation of IGroupService.
ReferenceIndividualGroupService Reference individual, or leaf, group service.
ReferenceIndividualGroupServiceFactory Creates an instance of the reference IIndividualGroupService.
ReferencePersonNameFinder Reference implementation of IEntityNameFinder for IPersons.
ReferencePersonNameFinderFactory Factory for creating ReferencePersonNameFinders.
 

Exception Summary
GroupsException A GroupsException describes a problem in the groups structure or in the groups store.
 


uPortal 2.4.1
API Documentation