|
Oracle Fusion Middleware Java API for Oracle WebLogic Portal 10g Release 3 (10.3.4) E14255-03 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
@ControlInterface public interface CommunityManagerControl
Method Detail |
---|
void activateCommunity(Date date, CommunityDefinitionId communityId, ResourceContext context) throws ToolsException, NotEntitledException, ObjectNotFoundException, IllegalOperationException, CommunityCallbackException
date
- The expiration datecommunityId
- the community definition ID of the community to activate.context
- a resource context
ObjectNotFoundException
- If community to be activated does not exist
NotEntitledException
- Thrown if the user in the current thread is not entitled to perform
this action.
IllegalOperationException
- If this community is a template or if expirationDate
is in the past
ToolsException
CommunityCallbackException
void setPersonalPagesEnabled(boolean enabled, CommunityDefinitionId communityId, ResourceContext context) throws ToolsException, NotEntitledException, ObjectNotFoundException
enabled
- True if personal pages should be enabled.communityId
- the community definition ID of the communitycontext
- a resource context
NotEntitledException
- Thrown if the user in the current thread is not entitled to perform
this action.
ObjectNotFoundException
- If community to be deleted does not exist
ToolsException
void deactivateCommunity(CommunityDefinitionId communityId, ResourceContext context) throws ToolsException, NotEntitledException, ObjectNotFoundException, CommunityCallbackException
communityId
- the community definition ID of the communitycontext
- a resource context
ObjectNotFoundException
- If community to be deleted does not exist
NotEntitledException
- If current user does not have permission to delete this
community
ToolsException
CommunityCallbackException
CommunityDefinition createCommunity(CommunityInfo info, ResourceContext context) throws ToolsException, DuplicateObjectException, NotEntitledException, MissingDataException, ObjectNotFoundException, CommunityCallbackException
info
- The CommunityInfo object.context
- a resource context
DuplicateObjectException
NotEntitledException
- Thrown if the user in the current thread is not entitled to perform
this action.
MissingDataException
- Thrown if a resource required by this action does not exist.
ObjectNotFoundException
- Thrown if a resource required by this action is not valid.
ToolsException
CommunityCallbackException
void deleteCommunity(boolean cascade, CommunityDefinitionId communityId, ResourceContext context) throws ToolsException, NotEntitledException, ObjectNotFoundException, IllegalOperationException, ObjectInUseException, CommunityCallbackException
ResourceContext
via the setWebApp() method, otherwise
a NoWebAppFoundException
is thrown.
cascade
- True if the delete is a cascading delete.communityId
- the community definition IDcontext
- a resource context
NotEntitledException
- Thrown if the user in the current thread is not entitled to perform
this action.
ObjectNotFoundException
- Thrown if a resource required by this action is not valid.
IllegalOperationException
- If this community is a template
ObjectInUseException
- If community to be deleted is being used
by other (user customized) communities
ToolsException
CommunityCallbackException
SortableFilterablePagedResult<CommunityDefinition> getCommunities(int pageSize, CommunitySearchCriteria criteria, ResourceContext context) throws ToolsException
pageSize
- The size of a page of data.criteria
- the search criteria to use.context
- a resource context.
ToolsException
CommunityDefinition getCommunity(boolean localize, CommunityDefinitionId communityId, ResourceContext context) throws ToolsException
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
ToolsException
CommunityDefinition createCommunityFromTemplate(String communityTitle, String communityDescription, PortalPath portalPath, DesktopPath desktopPath, CommunityDefinitionId templateId, ResourceContext context) throws ToolsException, DuplicateObjectException, NotEntitledException, MissingDataException, ObjectNotFoundException, CommunityCallbackException
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
DuplicateObjectException
- Thrown when a unique key constraint is violated.
NotEntitledException
- Thrown if the user in the current thread is not entitled to perform
this action.
MissingDataException
- Thrown if a resource required by this action does not exist.
ObjectNotFoundException
- Thrown if a resource required by this action is not valid.
ToolsException
CommunityCallbackException
CommunityDefinition createCommunityTemplate(CommunityInfo info, ResourceContext context) throws ToolsException, DuplicateObjectException, NotEntitledException, MissingDataException, ObjectNotFoundException, CommunityCallbackException
info
- specifies information about the template to createcontext
- a resource context
DuplicateObjectException
NotEntitledException
MissingDataException
ObjectNotFoundException
CommunityCallbackException
ToolsException
CommunityDefinition getCommunity(String webApp, PortalPath portalPath, DesktopPath desktopPath, boolean localize, ResourceContext context) throws ToolsException
webApp
- the webApp of the community to retrieveportalPath
- the portal path for the community to retrievedesktopPath
- the desktop path for the community to retrievelocalize
- if false, the community definition is not localized when returnedcontext
- a resource context
ToolsException
void updateCommunity(CommunityInfo info, CommunityDefinitionId communityId, ResourceContext context) throws ToolsException, ObjectNotFoundException, NotEntitledException, IllegalOperationException, ObjectInUseException
updateCommunity(com.bea.netuix.application.communities.CommunityInfo, com.bea.netuix.application.identifier.CommunityDefinitionId, boolean, com.bea.portal.tools.common.ResourceContext)
instead.
info
- the new information to update the community definition withcommunityId
- the ID of the community to update.context
- a resource context
ObjectNotFoundException
NotEntitledException
IllegalOperationException
ObjectInUseException
ToolsException
void updateCommunity(CommunityInfo info, CommunityDefinitionId communityId, boolean invokeCallbackClass, ResourceContext context) throws ToolsException, ObjectNotFoundException, NotEntitledException, IllegalOperationException, CommunityCallbackException, ObjectInUseException
info
- the new information to update the community definition withcommunityId
- the ID of the community to update.invokeCallbackClass
- if true
and the community is activated
or deactivated by this call, invokes the appropriate
methods on the CommunityCallback object associated
with the community, if one exists. If false
,
no callback call is made.context
- a resource context
ObjectNotFoundException
NotEntitledException
IllegalOperationException
ObjectInUseException
ToolsException
CommunityCallbackException
@TransactionAttribute(value=REQUIRED) CommunityDefinition createCommunityFromTemplateAndUpdateInfo(CommunityInfo info, String communityTitle, String communityDescription, PortalPath portalPath, DesktopPath desktopPath, CommunityDefinitionId templateId, ResourceContext context) throws CommunityCallbackException, DuplicateObjectException, NotEntitledException, MissingDataException, ObjectNotFoundException, ToolsException, ObjectInUseException, IllegalOperationException
CommunityCallbackException
DuplicateObjectException
NotEntitledException
MissingDataException
ObjectNotFoundException
ToolsException
ObjectInUseException
IllegalOperationException
|
Oracle Fusion Middleware Java API for Oracle WebLogic Portal 10g Release 3 (10.3.4) E14255-03 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |