oracle.webcenter.portal.api

Interface DiscoveredPortal

All Superinterfaces:

PortalObject<DiscoveredPortalPropertyBean>, Subscribable

public interface DiscoveredPortal
extends PortalObject<DiscoveredPortalPropertyBean>, Subscribable

Represents a view of a Portal instance within the Portal server that has been discovered PortalDiscovered objects are normally created by performing a query

Since:

12.2.1.0.0

Method Summary

Modifier and Type	Method and Description
void	addToMembers(java.lang.String identity, boolean isEntrRole, java.lang.String roleName) Creates and adds a member/role to the Portal using the information passed in by the parameters.
java.util.Map<java.lang.String,java.lang.String>	getCustomAttributes() Get the map of custom attributes.
PortalDeviceGroup	getDeviceGroup(java.lang.String name) Gets the device group with the specified name.
java.util.List<PortalDeviceGroup>	getDeviceGroups() Gets the device groups.
PortalObjectHolder<DiscoveredPortal>	getHolder() Returns a Serializable holder object for the current DiscoveredPortal instance.
java.util.List<Member>	getMembers() Returns a list of the Members added to the Portal.
boolean	isDefault() Whether the portal is the default portal
boolean	isSubscriptionEnabled() Whether subscription is enabled for the portal

Methods inherited from interface oracle.webcenter.portal.api.PortalObject

getId, getProperties, getProperties

Methods inherited from interface oracle.webcenter.portal.api.Subscribable

getSubscriptionApproval, getUnsubscriptionApproval

Method Detail

addToMembers

void addToMembers(java.lang.String identity,
                  boolean isEntrRole,
                  java.lang.String roleName)
           throws MemberOperationException

Creates and adds a member/role to the Portal using the information passed in by the parameters.

Parameters:

identity - The users identity.

isEntrRole - Whether or not this is an enterprise role.

roleName - The role name.

Throws:

MemberOperationException - if there is an error adding the member.

isDefault

boolean isDefault()

Whether the portal is the default portal

Returns:

true if the portal is the default portal

isSubscriptionEnabled

boolean isSubscriptionEnabled()

Whether subscription is enabled for the portal

Returns:

true if subscription is enabled, otherwise false

getDeviceGroups

java.util.List<PortalDeviceGroup> getDeviceGroups()

Gets the device groups. Note that regardless of which portal this method is called on, it will always return the device groups for the default portal.

Returns:

the list of device groups

getMembers

java.util.List<Member> getMembers()

Returns a list of the Members added to the Portal. Note Member is a combination of unique User Id and role, hence there will be a Member per role and user, as a result the count can be larger than the distinct user identies added to the Portal, when some users have multiple roles.

Returns:

the list of members.

getCustomAttributes

java.util.Map<java.lang.String,java.lang.String> getCustomAttributes()

Get the map of custom attributes.

Returns:

the map of custom attributes.

getDeviceGroup

PortalDeviceGroup getDeviceGroup(java.lang.String name)

Gets the device group with the specified name. Note that regardless of which portal this method is called on, it will always return the device group from the default portal.

Parameters:

name - of the device group

Returns:

the device group or null if no match found

getHolder

PortalObjectHolder<DiscoveredPortal> getHolder()

Returns a Serializable holder object for the current DiscoveredPortal instance.

Returns:

a holder object for the current instance.

See Also:

PortalObjectHolder