com.bea.portal.tools.portal.controls
Interface CommunityManagerControl


public interface CommunityManagerControl


Method Summary
 void activateCommunity(Date date, com.bea.netuix.application.identifier.CommunityDefinitionId communityId, com.bea.portal.tools.common.ResourceContext context)
          Sets a community active until a specified expiration date.
 com.bea.netuix.application.definition.CommunityDefinition createCommunity(com.bea.netuix.application.communities.CommunityInfo info, com.bea.portal.tools.common.ResourceContext context)
          Creates a new community.
 com.bea.netuix.application.definition.CommunityDefinition createCommunityFromTemplate(String communityTitle, String communityDescription, com.bea.netuix.application.identifier.PortalPath portalPath, com.bea.netuix.application.identifier.DesktopPath desktopPath, com.bea.netuix.application.identifier.CommunityDefinitionId templateId, com.bea.portal.tools.common.ResourceContext context)
          Creates a new community from a template.
 com.bea.netuix.application.definition.CommunityDefinition createCommunityFromTemplateAndUpdateInfo(com.bea.netuix.application.communities.CommunityInfo info, String communityTitle, String communityDescription, com.bea.netuix.application.identifier.PortalPath portalPath, com.bea.netuix.application.identifier.DesktopPath desktopPath, com.bea.netuix.application.identifier.CommunityDefinitionId templateId, com.bea.portal.tools.common.ResourceContext context)
           
 com.bea.netuix.application.definition.CommunityDefinition createCommunityTemplate(com.bea.netuix.application.communities.CommunityInfo info, com.bea.portal.tools.common.ResourceContext context)
           
 void deactivateCommunity(com.bea.netuix.application.identifier.CommunityDefinitionId communityId, com.bea.portal.tools.common.ResourceContext context)
          Deactivates a community.
 void deleteCommunity(boolean cascade, com.bea.netuix.application.identifier.CommunityDefinitionId communityId, com.bea.portal.tools.common.ResourceContext context)
          Deletes a community definition.
 com.bea.p13n.pagination.SortableFilterablePagedResult<com.bea.netuix.application.definition.CommunityDefinition> getCommunities(int pageSize, com.bea.netuix.application.communities.CommunitySearchCriteria criteria, com.bea.portal.tools.common.ResourceContext context)
          Does a paginated communities get.
 com.bea.netuix.application.definition.CommunityDefinition getCommunity(boolean localize, com.bea.netuix.application.identifier.CommunityDefinitionId communityId, com.bea.portal.tools.common.ResourceContext context)
          Gets a single CommunityDefintion.
 com.bea.netuix.application.definition.CommunityDefinition getCommunity(String webApp, com.bea.netuix.application.identifier.PortalPath portalPath, com.bea.netuix.application.identifier.DesktopPath desktopPath, boolean localize, com.bea.portal.tools.common.ResourceContext context)
           
 void setPersonalPagesEnabled(boolean enabled, com.bea.netuix.application.identifier.CommunityDefinitionId communityId, com.bea.portal.tools.common.ResourceContext context)
          Enabled Personal Pages.
 void updateCommunity(com.bea.netuix.application.communities.CommunityInfo info, com.bea.netuix.application.identifier.CommunityDefinitionId communityId, com.bea.portal.tools.common.ResourceContext context)
          Updates a Community
 

Method Detail

activateCommunity

void activateCommunity(Date date,
                       com.bea.netuix.application.identifier.CommunityDefinitionId communityId,
                       com.bea.portal.tools.common.ResourceContext context)
                       throws com.bea.portal.tools.common.exceptions.ToolsException,
                              com.bea.netuix.application.exception.NotEntitledException,
                              com.bea.netuix.application.exception.ObjectNotFoundException,
                              com.bea.netuix.application.exception.IllegalOperationException,
                              com.bea.netuix.application.communities.exception.CommunityCallbackException
Sets a community active until a specified expiration date.

Parameters
date - The expiration date
communityId - the community definition ID of the community to activate.
context - a resource context
Throws
com.bea.netuix.application.exception.ObjectNotFoundException - If community to be activated does not exist
com.bea.netuix.application.exception.NotEntitledException - Thrown if the user in the current thread is not entitled to perform this action.
com.bea.netuix.application.exception.IllegalOperationException - If this community is a template or if expirationDate is in the past
com.bea.portal.tools.common.exceptions.ToolsException
com.bea.netuix.application.communities.exception.CommunityCallbackException

setPersonalPagesEnabled

void setPersonalPagesEnabled(boolean enabled,
                             com.bea.netuix.application.identifier.CommunityDefinitionId communityId,
                             com.bea.portal.tools.common.ResourceContext context)
                             throws com.bea.portal.tools.common.exceptions.ToolsException,
                                    com.bea.netuix.application.exception.NotEntitledException,
                                    com.bea.netuix.application.exception.ObjectNotFoundException
Enabled Personal Pages.

Parameters
enabled - True if personal pages should be enabled.
communityId - the community definition ID of the community
context - a resource context
Throws
com.bea.netuix.application.exception.NotEntitledException - Thrown if the user in the current thread is not entitled to perform this action.
com.bea.netuix.application.exception.ObjectNotFoundException - If community to be deleted does not exist
com.bea.portal.tools.common.exceptions.ToolsException

deactivateCommunity

void deactivateCommunity(com.bea.netuix.application.identifier.CommunityDefinitionId communityId,
                         com.bea.portal.tools.common.ResourceContext context)
                         throws com.bea.portal.tools.common.exceptions.ToolsException,
                                com.bea.netuix.application.exception.NotEntitledException,
                                com.bea.netuix.application.exception.ObjectNotFoundException,
                                com.bea.netuix.application.communities.exception.CommunityCallbackException
Deactivates a community.

Parameters
communityId - the community definition ID of the community
context - a resource context
Throws
com.bea.netuix.application.exception.ObjectNotFoundException - If community to be deleted does not exist
com.bea.netuix.application.exception.NotEntitledException - If current user does not have permission to delete this community
com.bea.portal.tools.common.exceptions.ToolsException
com.bea.netuix.application.communities.exception.CommunityCallbackException

createCommunity

com.bea.netuix.application.definition.CommunityDefinition createCommunity(com.bea.netuix.application.communities.CommunityInfo info,
                                                                          com.bea.portal.tools.common.ResourceContext context)
                                                                          throws com.bea.portal.tools.common.exceptions.ToolsException,
                                                                                 com.bea.netuix.application.exception.DuplicateObjectException,
                                                                                 com.bea.netuix.application.exception.NotEntitledException,
                                                                                 com.bea.netuix.application.exception.MissingDataException,
                                                                                 com.bea.netuix.application.exception.ObjectNotFoundException,
                                                                                 com.bea.netuix.application.communities.exception.CommunityCallbackException
Creates a new community.

Parameters
info - The CommunityInfo object.
context - a resource context
visitorMode - true if called from the visitor tools
Returns
The CommunityDefinition definition object just created.
Throws
com.bea.netuix.application.exception.DuplicateObjectException
com.bea.netuix.application.exception.NotEntitledException - Thrown if the user in the current thread is not entitled to perform this action.
com.bea.netuix.application.exception.MissingDataException - Thrown if a resource required by this action does not exist.
com.bea.netuix.application.exception.ObjectNotFoundException - Thrown if a resource required by this action is not valid.
com.bea.portal.tools.common.exceptions.ToolsException
com.bea.netuix.application.communities.exception.CommunityCallbackException

deleteCommunity

void deleteCommunity(boolean cascade,
                     com.bea.netuix.application.identifier.CommunityDefinitionId communityId,
                     com.bea.portal.tools.common.ResourceContext context)
                     throws com.bea.portal.tools.common.exceptions.ToolsException,
                            com.bea.netuix.application.exception.NotEntitledException,
                            com.bea.netuix.application.exception.ObjectNotFoundException,
                            com.bea.netuix.application.exception.IllegalOperationException,
                            com.bea.netuix.application.exception.ObjectInUseException,
                            com.bea.netuix.application.communities.exception.CommunityCallbackException
Deletes a community definition. This method attempts to clean up all related security policies on the deleted Community. To achieve this, the current web app MUST be set in the ResourceContext via the setWebApp() method, otherwise a NoWebAppFoundException is thrown.

Parameters
cascade - True if the delete is a cascading delete.
communityId - the community definition ID
context - a resource context
Throws
com.bea.netuix.application.exception.NotEntitledException - Thrown if the user in the current thread is not entitled to perform this action.
com.bea.netuix.application.exception.ObjectNotFoundException - Thrown if a resource required by this action is not valid.
com.bea.netuix.application.exception.IllegalOperationException - If this community is a template
com.bea.netuix.application.exception.ObjectInUseException - If community to be deleted is being used by other (user customized) communities
com.bea.portal.tools.common.exceptions.ToolsException
com.bea.netuix.application.communities.exception.CommunityCallbackException

getCommunities

com.bea.p13n.pagination.SortableFilterablePagedResult<com.bea.netuix.application.definition.CommunityDefinition> getCommunities(int pageSize,
                                                                                                                                com.bea.netuix.application.communities.CommunitySearchCriteria criteria,
                                                                                                                                com.bea.portal.tools.common.ResourceContext context)
                                                                                                                                throws com.bea.portal.tools.common.exceptions.ToolsException
Does a paginated communities get.

Parameters
pageSize - The size of a page of data.
criteria - the search criteria to use.
context - a resource context.
Returns
A paged result of community definitions matching the specified search criteria.
Throws
com.bea.portal.tools.common.exceptions.ToolsException

getCommunity

com.bea.netuix.application.definition.CommunityDefinition getCommunity(boolean localize,
                                                                       com.bea.netuix.application.identifier.CommunityDefinitionId communityId,
                                                                       com.bea.portal.tools.common.ResourceContext context)
                                                                       throws com.bea.portal.tools.common.exceptions.ToolsException
Gets a single CommunityDefintion.

Parameters
localize - If false the localization object is not retrieved in the definition.
communityId - the community definition ID of the community to retrieve.
context - a resource context
Returns
A specified community definition.
Throws
com.bea.portal.tools.common.exceptions.ToolsException

createCommunityFromTemplate

com.bea.netuix.application.definition.CommunityDefinition createCommunityFromTemplate(String communityTitle,
                                                                                      String communityDescription,
                                                                                      com.bea.netuix.application.identifier.PortalPath portalPath,
                                                                                      com.bea.netuix.application.identifier.DesktopPath desktopPath,
                                                                                      com.bea.netuix.application.identifier.CommunityDefinitionId templateId,
                                                                                      com.bea.portal.tools.common.ResourceContext context)
                                                                                      throws com.bea.portal.tools.common.exceptions.ToolsException,
                                                                                             com.bea.netuix.application.exception.DuplicateObjectException,
                                                                                             com.bea.netuix.application.exception.NotEntitledException,
                                                                                             com.bea.netuix.application.exception.MissingDataException,
                                                                                             com.bea.netuix.application.exception.ObjectNotFoundException,
                                                                                             com.bea.netuix.application.communities.exception.CommunityCallbackException
Creates a new community from a template.

Parameters
communityTitle - The title for the community.
communityDescription - The description for the community.
portalPath - The portal path the template is located in.
desktopPath - The desktop path associated with this community.
templateId - the CommunityDefinitionId of the template to create a community from.
context - a resource context
Throws
com.bea.netuix.application.exception.DuplicateObjectException - Thrown when a unique key constraint is violated.
com.bea.netuix.application.exception.NotEntitledException - Thrown if the user in the current thread is not entitled to perform this action.
com.bea.netuix.application.exception.MissingDataException - Thrown if a resource required by this action does not exist.
com.bea.netuix.application.exception.ObjectNotFoundException - Thrown if a resource required by this action is not valid.
com.bea.portal.tools.common.exceptions.ToolsException
com.bea.netuix.application.communities.exception.CommunityCallbackException

createCommunityTemplate

com.bea.netuix.application.definition.CommunityDefinition createCommunityTemplate(com.bea.netuix.application.communities.CommunityInfo info,
                                                                                  com.bea.portal.tools.common.ResourceContext context)
                                                                                  throws com.bea.portal.tools.common.exceptions.ToolsException,
                                                                                         com.bea.netuix.application.exception.DuplicateObjectException,
                                                                                         com.bea.netuix.application.exception.NotEntitledException,
                                                                                         com.bea.netuix.application.exception.MissingDataException,
                                                                                         com.bea.netuix.application.exception.ObjectNotFoundException,
                                                                                         com.bea.netuix.application.communities.exception.CommunityCallbackException
Parameters
info - specifies information about the template to create
context - a resource context
Returns
the created CommunityDefinition
Throws
com.bea.netuix.application.exception.DuplicateObjectException
com.bea.netuix.application.exception.NotEntitledException
com.bea.netuix.application.exception.MissingDataException
com.bea.netuix.application.exception.ObjectNotFoundException
com.bea.netuix.application.communities.exception.CommunityCallbackException
com.bea.portal.tools.common.exceptions.ToolsException

getCommunity

com.bea.netuix.application.definition.CommunityDefinition getCommunity(String webApp,
                                                                       com.bea.netuix.application.identifier.PortalPath portalPath,
                                                                       com.bea.netuix.application.identifier.DesktopPath desktopPath,
                                                                       boolean localize,
                                                                       com.bea.portal.tools.common.ResourceContext context)
                                                                       throws com.bea.portal.tools.common.exceptions.ToolsException
Parameters
webApp - the webApp of the community to retrieve
portalPath - the portal path for the community to retrieve
desktopPath - the desktop path for the community to retrieve
localize - if false, the community definition is not localized when returned
context - a resource context
Returns
the requested community definition object.
Throws
com.bea.portal.tools.common.exceptions.ToolsException

updateCommunity

void updateCommunity(com.bea.netuix.application.communities.CommunityInfo info,
                     com.bea.netuix.application.identifier.CommunityDefinitionId communityId,
                     com.bea.portal.tools.common.ResourceContext context)
                     throws com.bea.portal.tools.common.exceptions.ToolsException,
                            com.bea.netuix.application.exception.ObjectNotFoundException,
                            com.bea.netuix.application.exception.NotEntitledException,
                            com.bea.netuix.application.exception.IllegalOperationException,
                            com.bea.netuix.application.exception.ObjectInUseException
Updates a Community

Parameters
info - the new information to update the community definition with
communityId - the ID of the community to update.
context - a resource context
Throws
com.bea.netuix.application.exception.ObjectNotFoundException
com.bea.netuix.application.exception.NotEntitledException
com.bea.netuix.application.exception.IllegalOperationException
com.bea.netuix.application.exception.ObjectInUseException
com.bea.portal.tools.common.exceptions.ToolsException

createCommunityFromTemplateAndUpdateInfo

Throws
com.bea.netuix.application.communities.exception.CommunityCallbackException
com.bea.netuix.application.exception.DuplicateObjectException
com.bea.netuix.application.exception.NotEntitledException
com.bea.netuix.application.exception.MissingDataException
com.bea.netuix.application.exception.ObjectNotFoundException
com.bea.portal.tools.common.exceptions.ToolsException
com.bea.netuix.application.exception.ObjectInUseException
com.bea.netuix.application.exception.IllegalOperationException


Copyright © 2006 BEA Systems, Inc. All Rights Reserved