objects representing the
groups that the specified user belongs to. This will not include the
default group (user group "everyone").
Parameters
-
identity
- the identity of the user.
-
portalId
- an identifier for the current portal.
Returns
- a
List of groups that the user belongs to.
Exceptions
-
PortalException
- on an error within the portal framework.
Related Topics
GroupPortal
getGroupPortalPersonalizations(PortalIdentifier) Method
public List getGroupPortalPersonalizations(PortalIdentifier portalId)
throws PortalException
Exceptions
-
PortalException
getMutablePortalPersonalization(ProfileIdentity, PortalIdentifier) Method
public MutablePortalPersonalization getMutablePortalPersonalization(ProfileIdentity client,
PortalIdentifier portalId)
throws PortalException
Retrieves a PortalPersonalization for the specified
identity within the specified portal. This object is guarenteed to
also implement MutablePortalPersonalization and will
need to be cast to that interface to allow updates.
Note: Updates to the object returned will NOT be persisted or
have any effects on the portal server unless this object is send back
to the portal server using the method
setMutablePortalPersonalization on this interface.
Parameters
-
client
- the identity for which the personalization is required.
-
portalId
- an identifier for the current portal.
Returns
- an editable personalization defined at the appropriate scope.
Exceptions
-
PortalException
- on an error within the portal framework.
getPortal(PortalIdentifier) Method
public Portal getPortal(PortalIdentifier portalId)
throws PortalException
Retrieves a Portal object corresponding to the
PortalIdentifier specified. The object returned represents
the global configuration of a portal as defined in the EBCC.
Parameters
-
portalId
- an identifier for the portal required.
Returns
- the global configuration of the portal.
Exceptions
-
PortalException
- on an error within the portal framework.
getPortalPersonalization(ProfileIdentity, PortalIdentifier) Method
public PortalPersonalization getPortalPersonalization(ProfileIdentity client,
PortalIdentifier portalId)
throws PortalException
Retrieves a PortalPersonalization for the specified
identity within the specified portal. This identity can either be
a group or a user within a group. The object returned represents
the personalizations defined at either user or group scope. It
should be considered to be immutable and therefore not edited.
Parameters
-
client
- the identity for which the personalization is required.
-
portalId
- an identifier for the current portal.
Returns
- an editable personalization defined at the appropriate scope.
Exceptions
-
PortalException
- on an error within the portal framework.
getUserPortalState(ProfileIdentity, PortalIdentifier, PageIdentifier, EntitlementRequest) Method
public UserPortalState getUserPortalState(ProfileIdentity client,
PortalIdentifier portalId,
PageIdentifier pageId,
EntitlementRequest entitlementRequest)
throws PortalException
Retrieves a UserPortalState object for the identity
specified (which must be a user as a member of a group) in the portal
specified for the page specified.
The object returned represents the personalization of the users view
of this page within this portal. It is intended to be the minimal set of
personalization data that is required to render the page and is expected
to have already taken into account all the interactions of group
personalizations, user personalizations and entitlements.
Parameters
-
client
- the identity for which the rendering state is required.
-
portalId
- an identifier for the current portal.
-
pageId
- an identifier for the current page being viewed.
-
entitlementRequest
- a valid entitlement request fo this user.
Returns
- the personalized state of the page to be rendered.
Exceptions
-
PortalException
- on an error within the portal framework.
removeDeletedLayoutsForGroupPageP13n(List, PagePersonalization, PortalPersonalization) Method
public void removeDeletedLayoutsForGroupPageP13n(List availableLayouts,
PagePersonalization pageP13n,
PortalPersonalization groupPortalP13n)
throws PortalException
Exceptions
-
PortalException
removeGroupPortal(PortalPersonalizationIdentifier) Method
public void removeGroupPortal(PortalPersonalizationIdentifier groupPortalId)
throws PortalException
Exceptions
-
PortalException
removeGroupPortalP13nSkin(SkinIdentifier, PortalPersonalization) Method
public void removeGroupPortalP13nSkin(SkinIdentifier skinId,
PortalPersonalization groupPortalP13n)
throws PortalException
Exceptions
-
PortalException
removePortalPersonalization(ProfileIdentity, PortalIdentifier) Method
public void removePortalPersonalization(ProfileIdentity client,
PortalIdentifier portalId)
throws PortalException
Deletes a personalization from the persistent store.
Parameters
-
client
- the identity for which the personalization is to be removed.
-
portalId
- an identifier for the current portal.
Exceptions
-
PortalException
- on an error within the portal framework.
setMutablePortalPersonalization(ProfileIdentity, PortalPersonalization) Method
public void setMutablePortalPersonalization(ProfileIdentity client,
PortalPersonalization portalPersonalization)
throws PortalException
Persists a PortalPersonalization for the specified
identity. This method can be used to update both group and user
personalizations.
Parameters
-
client
- the identity for which the personalization is to be saved.
-
portalPersonalization
- a personalization to persist.
Exceptions
-
PortalException
- on an error within the portal framework.