|
Oracle Fusion Middleware Java API for Oracle WebLogic Portal 10g Release 3 (10.3.2) E14255-01 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface ICommunityManager
This is the primary interface to perform operations on a community. All the methods on this interface are internationalized and entitled. <p/>The overview of community functionality contains a description of the community framework.
Method Summary | |
---|---|
void |
activateCommunity(CustomizationContext customizationContext, CommunityDefinitionId communityDefinitionId, Date expirationDate) Sets the state of a community to ACTIVE for specified time. |
void |
cleanupDanglingCommunityDesktops() Cleans up any desktops that are left dangling as a result of updates to the community that point the latter to a different desktop. |
CommunityDefinition |
createCommunity(CustomizationContext customizationContext, CommunityDefinition communityDefinition) Creates a community from a streamed desktop or template as specified by the CommunityDesktop member of the input CommunityDefinition . |
CommunityDefinition |
createCommunityFromTemplate(CustomizationContext customizationContext, CommunityDefinitionId communityDefinitionId, LocalizationResource communityLocalizationResource, PortalPath portalPath, DesktopPath desktopPath, LocalizationResource desktopLocalizationResource) Creates a community from a community template. |
CommunityDefinition |
createCommunityTemplate(CustomizationContext customizationContext, CommunityDefinition communityDefinition) Creates a community template from an existing streamed desktop or a template as specified by the CommunityDesktop member of the input CommunityDefinition . |
CommunityDefinition |
createCommunityTemplate(CustomizationContext customizationContext, CommunityDefinitionId communityDefinitionId, LocalizationResource templateLocalizationResource, PortalPath portalPath, DesktopPath desktopPath, boolean isGlobal) Creates a template from an existing community. |
void |
deactivateCommunity(CustomizationContext customizationContext, CommunityDefinitionId communityDefinitionId) Sets the state of a community to INACTIVE . |
void |
deleteCommunity(CustomizationContext customizationContext, CommunityDefinitionId communityDefinitionId, boolean deleteResources) Deletes a community. |
void |
deleteCommunityWithCascade(CustomizationContext customizationContext, CommunityDefinitionId communityDefinitionId) Deletes a community and all related non-customized and customized resources. |
void |
disablePersonalPages(CustomizationContext customizationContext, CommunityDefinitionId communityDefinitionId) Disables a community's ability to allow end users to add personal pages to it. |
void |
enablePersonalPages(CustomizationContext customizationContext, CommunityDefinitionId communityDefinitionId) Enables a community to allow end users to add personal pages to it. |
SortableFilterablePagedResult<CommunityDefinition> |
getCommunitiesPaged(CustomizationContext customizationContext, CommunitySearchCriteria searchCriteria, int pageSize) Returns a paginated list of CommunityDefinitions hosted in the web application. |
CommunityDefinition |
getCommunity(CustomizationContext customizationContext, CommunityDefinitionId communityDefinitionId, boolean localize) Returns a CommunityDefinition given a CommunityDefinitionId . |
CommunityDefinition |
getCommunity(CustomizationContext customizationContext, String webAppName, PortalPath portalPath, DesktopPath desktopPath, boolean localize) Returns the community with a given webapp, portal path and desktop path combination. |
void |
setCommunityExpirationDate(CustomizationContext customizationContext, CommunityDefinitionId communityDefinitionId, Date expirationDate) * Sets the expiration date for a community. |
CommunityDefinition |
updateCommunity(CustomizationContext customizationContext, CommunityDefinitionId communityDefinitionId, CommunityDefinition communityDefinition) Deprecated This method does not invoke CommunityCallback classes registered with the community if the community is activated or deactivated through this call. Use updateCommunity(com.bea.netuix.application.manager.CustomizationContext, com.bea.netuix.application.identifier.CommunityDefinitionId, com.bea.netuix.application.definition.CommunityDefinition, boolean) instead. |
CommunityDefinition |
updateCommunity(CustomizationContext customizationContext, CommunityDefinitionId communityDefinitionId, CommunityDefinition communityDefinition, boolean invokeCallbackClass) Updates a community. |
Method Detail |
---|
CommunityDefinition getCommunity(CustomizationContext customizationContext, CommunityDefinitionId communityDefinitionId, boolean localize) throws RemoteException
CommunityDefinition
given a CommunityDefinitionId
. Returns null
if no community exists that matches CommunityDefinitionId
.customizationContext
- customization information such as preferred locales. If null, no localization can be performed.communityDefinitionId
- unique CommunityDefinitionId
localize
- if true
returns the localized portions of the CommunityDefinition
like title and description that match locale specified in CustomizationContext
else just returns a CommunityDefinition
populated with the LocalizationIntersectionId
which may be later used to get localized versions of title and descriptionCommunityDefinition
matching locale and CommunityDefinitionId
RemoteException
CommunityDefinition getCommunity(CustomizationContext customizationContext, String webAppName, PortalPath portalPath, DesktopPath desktopPath, boolean localize) throws RemoteException
null
if no community exists that matches the combination.customizationContext
- customization information such as preferred localeswebAppName
- name of the web application that hosts the desktopportalPath
- portal path for the desktopdesktopPath
- desktop path for the desktoplocalize
- if true
returns the localized portions of the CommunityDefinition
like title and description that match locale specified in CustomizationContext
else just returns a CommunityDefinition
populated with the LocalizationIntersectionId
which may be later used to get localized versions of title and descriptionCommunityDefinition
for the specified webAppName, portalPath and desktopPathRemoteException
SortableFilterablePagedResult<CommunityDefinition> getCommunitiesPaged(CustomizationContext customizationContext, CommunitySearchCriteria searchCriteria, int pageSize) throws RemoteException
visitor
user, CustomizationContext.setVisitorMode(boolean)
should be called with a true
argument otherwise some or all communities may not be accessible. The returned PagedResult is sortable on "DESCRIPTION", "TEMPLATE_ID" and "COMMUNITY_DEFINITION_ID". Additionally, the PagedResult is also sortable on "TITLE" if localize is set to true on the input SearchCriteria. The returned PagedResult is filterable on "TITLE" and "DESCRIPTION", using these filter methods:
customizationContext
- customization information such as preferred localessearchCriteria
- a SearchCriteria
to narrow down the search. If the SearchCriteria is of type WebAppSearchCriteria
, the webapp name is used as the search parameter. In this case retrieved CommunityDefinition
s will always be localized. If the type is CommunitySearchCriteria
then template, global template or localize may also be used as search criteria if true
returns the localized portions of the CommunityDefinition
s like title and description that match locale specified in CustomizationContext
else just returns CommunityDefinition
s populated with the LocalizationIntersectionId
s which may be later used to get localized versions of title and descriptionpageSize
- number of CommunityDefinition
s to be returned per pagePagedResult
of CommunityDefinition
s hosted in the web applicationRemoteException
CommunityDefinition createCommunity(CustomizationContext customizationContext, CommunityDefinition communityDefinition) throws IllegalArgumentException, ObjectNotFoundException, NotEntitledException, MissingDataException, DuplicateObjectException, UnsupportedOperationException, CommunityCallbackException, RemoteException
CommunityDesktop
member of the input CommunityDefinition
. If the template specifies a community an UnSupportedOperationException
is thrown directing the user to use createCommunityFromTemplate
. This is to avoid confusion between what specification to use for the new community - the one in the input CommunityDefinition
or the one in the community that the template points to.customizationContext
- customization information such as preferred localescommunityDefinition
- a CommunityDefinition
object that holds all information about the community to be created except for the CommunityDefinitionId
CommunityDefinition
with CommunityDefinitionId
populatedIllegalArgumentException
- if input CommunityDefinition
has incorrect informationObjectNotFoundException
- if desktop specified by input arguments does not existNotEntitledException
- if current user does not have permission to create a new communityMissingDataException
- if input CommunityDefinition
or the desktop it points to is missing informationDuplicateObjectException
- if desktop matching portal path and desktop path in CommunityDefinition already existsUnsupportedOperationException
- see method doc aboveCommunityCallbackException
- if an error occurs while making a callbackRemoteException
CommunityDefinition createCommunityFromTemplate(CustomizationContext customizationContext, CommunityDefinitionId communityDefinitionId, LocalizationResource communityLocalizationResource, PortalPath portalPath, DesktopPath desktopPath, LocalizationResource desktopLocalizationResource) throws ObjectNotFoundException, IllegalArgumentException, NotEntitledException, MissingDataException, DuplicateObjectException, CommunityCallbackException, RemoteException
customizationContext
- customization information such as preferred localescommunityDefinitionId
- CommunityDefinitionId
of the community templatecommunityLocalizationResource
- optional LocalizationResource
for the community being created. If null
LocalizationResource
from the template will be usedportalPath
- portal path for the new desktop to be createddesktopPath
- desktop path for the new desktop to be createddesktopLocalizationResource
- optional LocalizationResource
for the desktop being created for the community. If null
LocalizationResource
from the template will be usedCommunityDefinition
ObjectNotFoundException
- if specified community template does not existIllegalArgumentException
- if community specified is not a community templateNotEntitledException
- if current user does not have permission to create a new communityMissingDataException
- if input CommunityDefinition
or the desktop it points to is missing informationDuplicateObjectException
- if desktop matching input portal path and desktop path already existsCommunityCallbackException
- if an error occurs while making a callbackRemoteException
CommunityDefinition createCommunityTemplate(CustomizationContext customizationContext, CommunityDefinition communityDefinition) throws ObjectNotFoundException, NotEntitledException, MissingDataException, DuplicateObjectException, UnsupportedOperationException, CommunityCallbackException, RemoteException
CommunityDesktop
member of the input CommunityDefinition
.customizationContext
- customization information such as preferred localescommunityDefinition
- a CommunityDefinition
object that holds all information about the community template to be created except for the CommunityDefinitionId
CommunityDefition
template with a populated CommunityDefinitionId
ObjectNotFoundException
- if input desktop or template does not existNotEntitledException
- if current user does not have permission to create a templateMissingDataException
- if input CommunityDefinition
or the desktop it points to is missing informationDuplicateObjectException
- if desktop matching input portal path and desktop path already existsCommunityCallbackException
- if an error occurs while making a callbackUnsupportedOperationException
RemoteException
CommunityDefinition createCommunityTemplate(CustomizationContext customizationContext, CommunityDefinitionId communityDefinitionId, LocalizationResource templateLocalizationResource, PortalPath portalPath, DesktopPath desktopPath, boolean isGlobal) throws ObjectNotFoundException, NotEntitledException, MissingDataException, DuplicateObjectException, CommunityCallbackException, RemoteException
customizationContext
- customization information such as preferred localescommunityDefinitionId
- CommunityDefinitionId
of the community to use to create a templatetemplateLocalizationResource
- optional LocalizationResource
for the template being created. If null
LocalizationResource
from the underlying community will be usedportalPath
- portal path for the new desktop to be createddesktopPath
- desktop path for the new desktop to be createdisGlobal
- true
if this template is globalCommunityDefinition
with the isTemplate attribute set to trueObjectNotFoundException
- if a CommunityDefinition
matching input CommunityDefinitionId
does not existNotEntitledException
- if current user does not have permission to create a community templateMissingDataException
- if input CommunityDefinition
or the desktop it points to is missing informationDuplicateObjectException
- if desktop matching input portal path and desktop path already existsCommunityCallbackException
- if an error occurs while making a callbackRemoteException
@Deprecated
CommunityDefinition updateCommunity(CustomizationContext customizationContext,
CommunityDefinitionId communityDefinitionId,
CommunityDefinition communityDefinition)
throws ObjectNotFoundException,
NotEntitledException,
IllegalOperationException,
ObjectInUseException,
RemoteException
updateCommunity(com.bea.netuix.application.manager.CustomizationContext, com.bea.netuix.application.identifier.CommunityDefinitionId, com.bea.netuix.application.definition.CommunityDefinition, boolean)
instead.customizationContext
- customization information such as preferred localescommunityDefinitionId
- CommunityDefinitionId
of community to be updatedcommunityDefinition
- community definition with updated attributesCommunityDefinition
with CommunityContext
not populatedObjectNotFoundException
- if community to be updated does not existNotEntitledException
- if current user does not have permission to update this communityIllegalOperationException
- if part of or all the update is illegal based on the current state of the community for e.g. if the update tries to set expirationDate on or activate a community that is marked as a templateObjectInUseException
- if the update tries to point the community to a desktop that is already in use by another communityRemoteException
CommunityDefinition updateCommunity(CustomizationContext customizationContext, CommunityDefinitionId communityDefinitionId, CommunityDefinition communityDefinition, boolean invokeCallbackClass) throws ObjectNotFoundException, NotEntitledException, IllegalOperationException, ObjectInUseException, CommunityCallbackException, RemoteException
customizationContext
- customization information such as preferred localescommunityDefinitionId
- the CommunityDefinitionId
of the community to be updatedcommunityDefinition
- community definition with updated attributesinvokeCallbackClass
- 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.CommunityDefinition
with CommunityContext
not populatedObjectNotFoundException
- if community to be updated does not existNotEntitledException
- if current user does not have permission to update this communityIllegalOperationException
- if part of or all the update is illegal based on the current state of the community for e.g. if the update tries to set expirationDate on or activate a community that is marked as a templateObjectInUseException
- if the update tries to point the community to a desktop that is already in use by another communityCommunityCallbackException
- if an error occurs while making a callbackRemoteException
void activateCommunity(CustomizationContext customizationContext, CommunityDefinitionId communityDefinitionId, Date expirationDate) throws ObjectNotFoundException, NotEntitledException, IllegalOperationException, CommunityCallbackException, RemoteException
ACTIVE
for specified time. A community in the ACTIVE
state can accept new members, supports updates and addition of new content.customizationContext
- customization information such as preferred localescommunityDefinitionId
- CommunityDefinitionId
of the community to be activatedexpirationDate
- expirationDate for community time zoneObjectNotFoundException
- if community to be activated does not existNotEntitledException
- if current user does not have permission to activate this communityIllegalOperationException
- if this community is a template or if expirationDate is in the pastCommunityCallbackException
- if an error occurs while making a callbackRemoteException
void deactivateCommunity(CustomizationContext customizationContext, CommunityDefinitionId communityDefinitionId) throws IllegalArgumentException, ObjectNotFoundException, NotEntitledException, CommunityCallbackException, RemoteException
INACTIVE
. A community in the INACTIVE
state does not support any interaction excepting that with certain priviledged users.customizationContext
- customization information such as preferred localescommunityDefinitionId
- CommunityDefinitionId
of the community to be deactivatedObjectNotFoundException
- if community to be deactivated does not existNotEntitledException
- if current user does not have permission to deactivate this communityCommunityCallbackException
- if an error occurs while making a callbackIllegalArgumentException
RemoteException
void deleteCommunity(CustomizationContext customizationContext, CommunityDefinitionId communityDefinitionId, boolean deleteResources) throws ObjectNotFoundException, NotEntitledException, RemoteException, IllegalOperationException, CommunityCallbackException, ObjectInUseException
customizationContext
- customization information such as preferred localescommunityDefinitionId
- CommunityDefinitionId
of the community to be deleteddeleteResources
- if true
deletes resources related to the community if the community is the only one using them, if false
- deletes the community only. If this is set to true
and there exist other users of underlying resources, this method only deletes the communityObjectNotFoundException
- if community to be deleted does not existNotEntitledException
- if current user does not have permission to delete this communityIllegalOperationException
- if this community is a templateCommunityCallbackException
- if an error occurs while making a callbackRemoteException
ObjectInUseException
void deleteCommunityWithCascade(CustomizationContext customizationContext, CommunityDefinitionId communityDefinitionId) throws ObjectNotFoundException, NotEntitledException, IllegalOperationException, CommunityCallbackException, RemoteException
customizationContext
- customization information such as preferred localescommunityDefinitionId
- CommunityDefinitionId
of the community to be deletedObjectNotFoundException
- if community to be deleted does not existNotEntitledException
- if current user does not have permission to delete this communityIllegalOperationException
- if this community is a templateCommunityCallbackException
- if an error occurs while making a callbackRemoteException
void setCommunityExpirationDate(CustomizationContext customizationContext, CommunityDefinitionId communityDefinitionId, Date expirationDate) throws IllegalArgumentException, ObjectNotFoundException, NotEntitledException, IllegalOperationException, RemoteException
INACTIVE
once this date has passed. Setting a new expiration date on a community resets the clock and the community stays active until the new expiration date.customizationContext
- customization information such as preferred localescommunityDefinitionId
- CommunityDefinitionId
of the communityexpirationDate
- expirationDateIllegalArgumentException
- if the expirationDate
is before current dateObjectNotFoundException
- if specified community does not existNotEntitledException
- if current user does not have permission to set the expirationDate for this communityIllegalOperationException
- if this community is a templateRemoteException
void enablePersonalPages(CustomizationContext customizationContext, CommunityDefinitionId communityDefinitionId) throws ObjectNotFoundException, NotEntitledException, RemoteException
customizationContext
- customization information such as preferred localescommunityDefinitionId
- CommunityDefinitionId
of the communityObjectNotFoundException
- if specified community does not existNotEntitledException
- if current user does not have permission to perform this operationRemoteException
void disablePersonalPages(CustomizationContext customizationContext, CommunityDefinitionId communityDefinitionId) throws ObjectNotFoundException, NotEntitledException, RemoteException
customizationContext
- customization information such as preferred localescommunityDefinitionId
- CommunityDefinitionId
of the communityObjectNotFoundException
- if specified community does not existNotEntitledException
- if current user does not have permission to perform this operationRemoteException
void cleanupDanglingCommunityDesktops() throws RemoteException
RemoteException
|
Oracle Fusion Middleware Java API for Oracle WebLogic Portal 10g Release 3 (10.3.2) E14255-01 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Copyright © 2010, Oracle. All rights reserved.