com.appiancorp.suiteapi.portal

Interface PortletService

All Superinterfaces:

com.appiancorp.services.ContextSensitiveService, Service

Deprecated.

The Portal functionality will be removed in a future release. Use the Tempo Interface for similar functionality.

@Deprecated
public interface PortletService
extends com.appiancorp.services.ContextSensitiveService

This interface defines methods for access to and modification of portlets.

Portlets may have their own security settings, or they may inherit the security settings of the page on which they exist. Portlets may also be shared, so that the same portlet can be placed on several different pages.

Methods of service classes can all throw the unchecked exception ServiceException if any system-level error (for example, server failure) occurs, and will in general throw a checked exception (InvalidXXXException) when an entity to be retrieved is inaccessible, instead of returning null. Exceptions to this paradigm (including the use of ResultList as described below) are noted. All checked exceptions extend AppianException.

It may be necessary to retrieve a subset of results as opposed to an entire collection, and also to sort the subset by some property of the returned object. "Paging" methods which return a ResultPage are provided in certain instances for this purpose. The ResultPage will contain the sorted subset of results (via Result.getResults()), and the total number of items in the available result set (via ResultPage.getAvailableItems()).

It may also be necessary to retrieve some results, even if all results cannot be retrieved (for instance, some of the entities corresponding to a list of entity IDs may no longer exist). Methods which return a ResultList are provided for this purpose. The Result.getResults() method in this case will return all results which can be retrieved. In addition, there will be a list of result codes (ResultList.getResultCodes()) that represent the successful retrieval of an entity, or, if the entity could not be retrieved, the reason for the failure. See the CODE_XXX constants in ResultList for details.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.Integer	ACTIVE_AND_DEACTIVATED_PORTLET Deprecated. A constant used to indicate both activated and deactivated portlets will be included from portlet searches
static java.lang.Integer	ACTIVE_PORTLET Deprecated. A constant used to indicate only activated portlets will be included from portlet searches
static boolean	createPortlet$UPDATES Deprecated.
static boolean	createPortlets$UPDATES Deprecated.
static java.lang.Integer	DEACTIVATED_PORTLET Deprecated. A constant used to indicate only deactivated portlets will be included from portlet searches
static boolean	findPortlets$UPDATES Deprecated.
static boolean	findPortletsPaging$UPDATES Deprecated.
static boolean	getAccessLevelForPortlet$UPDATES Deprecated.
static boolean	getAccessLevelForPortlets$UPDATES Deprecated.
static boolean	getInheritedRoleMapForPortlet$UPDATES Deprecated.
static boolean	getPortlet$UPDATES Deprecated.
static boolean	getPortlets$UPDATES Deprecated.
static boolean	getPortletsList$UPDATES Deprecated.
static boolean	getPortletsPaging$UPDATES Deprecated.
static boolean	getRoleMapForPortlet$UPDATES Deprecated.
static java.lang.Long	NO_PAGE Deprecated. A constant used to indicate that no pages will be excluded from portlet searches
static java.lang.Integer	PORTLET_LIST_CODE_ADMIN Deprecated. A constant used to indicate that the user can administer the requested portlet.
static java.lang.Integer	PORTLET_LIST_CODE_EDITOR Deprecated. A constant used to indicate that the user can edit the requested portlet.
static java.lang.Integer	PORTLET_LIST_CODE_INVALID Deprecated. A constant used to indicate that the requested portlet id was not valid.
static java.lang.Integer	PORTLET_LIST_CODE_NO_PERMISSIONS Deprecated. A constant used to indicate that the user does not have adequate privileges to retrieve the requested portlet.
static java.lang.Integer	PORTLET_LIST_CODE_VIEWER Deprecated. A constant used to indicate that the user can view the requested portlet.
static boolean	setRoleMapForPortlet$UPDATES Deprecated.
static java.lang.Integer	SHARED_AND_UNSHARED_PORTLET Deprecated. A constant used to indicate both shared and unshared portlets will be included from portlet searches
static java.lang.Integer	SHARED_PORTLET Deprecated. A constant used to indicate only shared portlets will be included from portlet searches
static java.lang.Integer	UNSHARED_PORTLET Deprecated. A constant used to indicate only unshared portlets will be included from portlet searches
static boolean	unsharePortlet$UPDATES Deprecated.
static boolean	updatePortlet$UPDATES Deprecated.
static boolean	updatePortletParameters$UPDATES Deprecated.
static boolean	updatePortlets$UPDATES Deprecated.
static boolean	updatePortletsParameters$UPDATES Deprecated.

Fields inherited from interface com.appiancorp.services.ContextSensitiveService

SET_SERVICE_CONTEXT_METHOD_NAME

Method Summary

Modifier and Type	Method and Description
java.lang.Long	createPortlet(Portlet p_) Deprecated. Creates a portlet.
java.lang.Long[]	createPortlets(Portlet[] ps_) Deprecated. Creates portlets in bulk.
Portlet[]	findPortlets(java.lang.String type_, java.lang.String searchTerms_, java.lang.Long p_, java.lang.Integer sharedType_, java.lang.Integer state_) Deprecated. use findPortletsPaging(java.lang.String, java.lang.String, java.lang.Long, java.lang.Integer, java.lang.Integer, int, int, java.lang.Integer, java.lang.Integer) instead
ResultPage	findPortletsPaging(java.lang.String type_, java.lang.String searchTerms_, java.lang.Long p_, java.lang.Integer sharedType_, java.lang.Integer state_, int startIndex_, int batchSize_, java.lang.Integer sortProperty_, java.lang.Integer sortOrder_) Deprecated. Gets a ResultPage containing a list of portlets of the given type obtained by searching for a string in name/description.
int	getAccessLevelForPortlet(java.lang.Long portletId_) Deprecated. Gets the current user's access level for the specified portlet.
int[]	getAccessLevelForPortlets(java.lang.Long[] portletIds_) Deprecated. Gets the current user's access level for the specified portlets.
PortalRoleMap	getInheritedRoleMapForPortlet(java.lang.Long portletId_, java.lang.Long pageId_) Deprecated. Returns the role map that the portlet inherits from its page.
Portlet	getPortlet(java.lang.Long portletId_) Deprecated. Gets a portlet
Portlet[]	getPortlets(java.lang.Long[] portletIds_) Deprecated. use getPortletsPaging(java.lang.Long[], int, int, java.lang.Integer, java.lang.Integer) instead
ResultList	getPortletsList(java.lang.Long[] portletIds_) Deprecated. Returns a ResultList containing Portlet instances for valid ids and result codes for all ids.
ResultPage	getPortletsPaging(java.lang.Long[] portletIds_, int startIndex_, int batchSize_, java.lang.Integer sortProperty_, java.lang.Integer sortOrder_) Deprecated. Gets a ResultPage containing a list of portlets as specified by the portlet ids
PortalRoleMap	getRoleMapForPortlet(java.lang.Long portletId_) Deprecated. Get the role map for a portlet NOTE: This should not be used to verify the access level that the current user has on the portlet because the access level can depend on other properties of the portlet such as inheritsSecurity and shareable.
void	setRoleMapForPortlet(java.lang.Long portletId_, PortalRoleMap map_) Deprecated. Set the role map for a portlet
void	unsharePortlet(java.lang.Long portletId_, java.lang.Long pageId_, boolean force_) Deprecated. Make a shared portlet non-shareable and clear it's uuid if it has one.
void	updatePortlet(Portlet portlet_) Deprecated. Update a portlet In order to update a portlet the fields following fields must be populated: id, shareable, inheritsSecurity, portletType, name, frame, public.
void	updatePortletParameters(java.lang.Long portletId_, java.util.Map parameterValueMap_) Deprecated. Update the portlet's name/value pairs of its parameters
void	updatePortlets(Portlet[] portlets_) Deprecated. Update portlets in bulk.
void	updatePortletsParameters(java.lang.Long[] portletIds_, java.util.Map[] parameterValueMaps_) Deprecated. Update the portlets' name/value pairs of their parameters

Methods inherited from interface com.appiancorp.services.ContextSensitiveService

setServiceContext

Field Detail

NO_PAGE

static final java.lang.Long NO_PAGE

Deprecated.

A constant used to indicate that no pages will be excluded from portlet searches

SHARED_AND_UNSHARED_PORTLET

static final java.lang.Integer SHARED_AND_UNSHARED_PORTLET

Deprecated.

A constant used to indicate both shared and unshared portlets will be included from portlet searches

SHARED_PORTLET

static final java.lang.Integer SHARED_PORTLET

Deprecated.

A constant used to indicate only shared portlets will be included from portlet searches

UNSHARED_PORTLET

static final java.lang.Integer UNSHARED_PORTLET

Deprecated.

A constant used to indicate only unshared portlets will be included from portlet searches

ACTIVE_AND_DEACTIVATED_PORTLET

static final java.lang.Integer ACTIVE_AND_DEACTIVATED_PORTLET

Deprecated.

A constant used to indicate both activated and deactivated portlets will be included from portlet searches

ACTIVE_PORTLET

static final java.lang.Integer ACTIVE_PORTLET

Deprecated.

A constant used to indicate only activated portlets will be included from portlet searches

DEACTIVATED_PORTLET

static final java.lang.Integer DEACTIVATED_PORTLET

Deprecated.

A constant used to indicate only deactivated portlets will be included from portlet searches

PORTLET_LIST_CODE_INVALID

static final java.lang.Integer PORTLET_LIST_CODE_INVALID

Deprecated.

A constant used to indicate that the requested portlet id was not valid.

PORTLET_LIST_CODE_NO_PERMISSIONS

static final java.lang.Integer PORTLET_LIST_CODE_NO_PERMISSIONS

Deprecated.

A constant used to indicate that the user does not have adequate privileges to retrieve the requested portlet.

PORTLET_LIST_CODE_VIEWER

static final java.lang.Integer PORTLET_LIST_CODE_VIEWER

Deprecated.

A constant used to indicate that the user can view the requested portlet.

PORTLET_LIST_CODE_EDITOR

static final java.lang.Integer PORTLET_LIST_CODE_EDITOR

Deprecated.

A constant used to indicate that the user can edit the requested portlet.

PORTLET_LIST_CODE_ADMIN

static final java.lang.Integer PORTLET_LIST_CODE_ADMIN

Deprecated.

A constant used to indicate that the user can administer the requested portlet.

getAccessLevelForPortlet$UPDATES

static final boolean getAccessLevelForPortlet$UPDATES

Deprecated.

See Also:

Constant Field Values

getAccessLevelForPortlets$UPDATES

static final boolean getAccessLevelForPortlets$UPDATES

Deprecated.

See Also:

Constant Field Values

createPortlet$UPDATES

static final boolean createPortlet$UPDATES

Deprecated.

See Also:

Constant Field Values

createPortlets$UPDATES

static final boolean createPortlets$UPDATES

Deprecated.

See Also:

Constant Field Values

getPortlet$UPDATES

static final boolean getPortlet$UPDATES

Deprecated.

See Also:

Constant Field Values

getPortletsPaging$UPDATES

static final boolean getPortletsPaging$UPDATES

Deprecated.

See Also:

Constant Field Values

getPortletsList$UPDATES

static final boolean getPortletsList$UPDATES

Deprecated.

See Also:

Constant Field Values

getPortlets$UPDATES

static final boolean getPortlets$UPDATES

Deprecated.

See Also:

Constant Field Values

findPortletsPaging$UPDATES

static final boolean findPortletsPaging$UPDATES

Deprecated.

See Also:

Constant Field Values

findPortlets$UPDATES

static final boolean findPortlets$UPDATES

Deprecated.

See Also:

Constant Field Values

updatePortlet$UPDATES

static final boolean updatePortlet$UPDATES

Deprecated.

See Also:

Constant Field Values

updatePortlets$UPDATES

static final boolean updatePortlets$UPDATES

Deprecated.

See Also:

Constant Field Values

updatePortletParameters$UPDATES

static final boolean updatePortletParameters$UPDATES

Deprecated.

See Also:

Constant Field Values

updatePortletsParameters$UPDATES

static final boolean updatePortletsParameters$UPDATES

Deprecated.

See Also:

Constant Field Values

unsharePortlet$UPDATES

static final boolean unsharePortlet$UPDATES

Deprecated.

See Also:

Constant Field Values

getRoleMapForPortlet$UPDATES

static final boolean getRoleMapForPortlet$UPDATES

Deprecated.

See Also:

Constant Field Values

setRoleMapForPortlet$UPDATES

static final boolean setRoleMapForPortlet$UPDATES

Deprecated.

See Also:

Constant Field Values

getInheritedRoleMapForPortlet$UPDATES

static final boolean getInheritedRoleMapForPortlet$UPDATES

Deprecated.

See Also:

Constant Field Values

Method Detail

getAccessLevelForPortlet

int getAccessLevelForPortlet(java.lang.Long portletId_)
                      throws InvalidAnonymousUserException,
                             InvalidUserException,
                             InvalidPortletException

Deprecated.

Gets the current user's access level for the specified portlet.

Parameters:

portletId_ - The id of the portlet for which the user's access level is to be determined.

Returns:

The access level. This is one of the PORTLET_ACCESS_LEVEL_XXX constants in Portlet

Throws:

InvalidAnonymousUserException - if the user is anonymous, but anonymous access has not been enabled

InvalidUserException - if the user calling this method is invalid

InvalidPortletException - if the specified portlet does not exist

ServiceException - if any system-level error occurs

getAccessLevelForPortlets

int[] getAccessLevelForPortlets(java.lang.Long[] portletIds_)
                         throws InvalidAnonymousUserException,
                                InvalidUserException,
                                InvalidPortletException

Deprecated.

Gets the current user's access level for the specified portlets.

Parameters:

portletIds_ - The ids of the portlets for which the user's access level is to be determined.

Returns:

The access levels. Each access level is one of the PORTLET_ACCESS_LEVEL_XXX constants in Portlet

Throws:

InvalidAnonymousUserException - if the user is anonymous, but anonymous access has not been enabled

InvalidUserException - if the user calling this method is invalid

InvalidPortletException - if any of the the specified portlets do not exist

ServiceException - if any system-level error occurs

createPortlet

java.lang.Long createPortlet(Portlet p_)
                      throws java.lang.IllegalArgumentException,
                             PortletSharingException,
                             InvalidPortletTypeException,
                             DuplicateUuidException

Deprecated.

Creates a portlet. In order to create a portlet the fields following fields must be populated: shareable, inheritsSecurity, portletType, name, frame, public. Portlet types can be retrieved from AdministrationService.getPortletTypes()

Parameters:

p_ - the new portlet

Returns:

the id of the newly created portlet

Throws:

PortletSharingException - if portlet to be created would be sharable and would also inherit security

InvalidPortletTypeException - if the portlet type specified is invalid

java.lang.IllegalArgumentException - if the parameters map of the portlet is not null, but does not meet the requirements specified by Portlet.getParameters()

ServiceException - if any system-level error occurs

DuplicateUuidException - if the UUID of the portlet already exists

createPortlets

java.lang.Long[] createPortlets(Portlet[] ps_)
                         throws java.lang.IllegalArgumentException,
                                PortletSharingException,
                                InvalidPortletTypeException,
                                DuplicateUuidException

Deprecated.

Creates portlets in bulk. See createPortlet(Portlet).

Parameters:

ps_ - the new portlets

Returns:

the ids of the newly created portlets

Throws:

PortletSharingException - if any portlet to be created would be sharable and would also inherit security

InvalidPortletTypeException - if any portlet type specified is invalid

java.lang.IllegalArgumentException - if the parameters map of any of the portlets is not null, but does not meet the requirements specified by Portlet.getParameters()

DuplicateUuidException - if the UUID of any of the portlets already exists or if the same UUID is passed in for several portlets

ServiceException - if any system-level error occurs

getPortlet

Portlet getPortlet(java.lang.Long portletId_)
            throws InvalidAnonymousUserException,
                   InvalidUserException,
                   InvalidPortletException,
                   PrivilegeException

Deprecated.

Gets a portlet

Parameters:

portletId_ - the id of the portlet

Returns:

the portlet

Throws:

InvalidAnonymousUserException - if the user is anonymous, but anonymous access has not been enabled

InvalidUserException - if the user calling this method is invalid

PrivilegeException - if the current user is anonymous, and portlets of this portlet type are denied to anonymous users. The portlet types that anonymous users cannot see are configurable. See application documentation for further details.

InvalidPortletException - if the portlet is invalid

ServiceException - if any system-level error occurs

getPortletsPaging

ResultPage getPortletsPaging(java.lang.Long[] portletIds_,
                             int startIndex_,
                             int batchSize_,
                             java.lang.Integer sortProperty_,
                             java.lang.Integer sortOrder_)
                      throws InvalidAnonymousUserException,
                             InvalidUserException,
                             InvalidPortletException,
                             PrivilegeException

Deprecated.

Gets a ResultPage containing a list of portlets as specified by the portlet ids

Parameters:

portletIds_ - the list of portlet ids

startIndex_ - the index into the collection of total results at which to start. Negative numbers are treated as zeros.

batchSize_ - the number of results to return. Use Constants.COUNT_ALL to return the entire collection, but this is STRONGLY discouraged.

sortProperty_ - the property by which the results will be sorted

sortOrder_ - The order in which to sort the results. This is either Constants.SORT_ORDER_ASCENDING or Constants.SORT_ORDER_DESCENDING

Returns:

a ResultPage containing a list of Portlet objects

Throws:

InvalidAnonymousUserException - if the user is anonymous, but anonymous access has not been enabled

InvalidUserException - if the user calling this method is invalid

PrivilegeException - if the current user is anonymous, and any of the portlets is of a type that is denied to anonymous users. The portlet types that anonymous users cannot see are configurable. See application documentation for further details.

InvalidPortletException - if the portlet is invalid

ServiceException - if any system-level error occurs

getPortletsList

ResultList getPortletsList(java.lang.Long[] portletIds_)

Deprecated.

Returns a ResultList containing Portlet instances for valid ids and result codes for all ids. The result codes will be one of the PORTLET_LIST_CODE_ constants on this interface.

Parameters:

portletIds_ - the ids of the portlets to retrieve

Returns:

ResultList containing Portlet objects

Throws:

ServiceException - if any system-level error occurs

getPortlets

@Deprecated
Portlet[] getPortlets(java.lang.Long[] portletIds_)
                           throws InvalidAnonymousUserException,
                                  InvalidUserException,
                                  InvalidPortletException,
                                  PrivilegeException

Deprecated. use getPortletsPaging(java.lang.Long[], int, int, java.lang.Integer, java.lang.Integer) instead

Gets a list of portlets as specified by the portlet ids

Parameters:

portletIds_ - the list of portlet ids

Returns:

an array of portlets

Throws:

InvalidAnonymousUserException - if the user is anonymous, but anonymous access has not been enabled

InvalidUserException - if the user calling this method is invalid

PrivilegeException - if the current user is anonymous, and any of the portlets is of a type that is denied to anonymous users. The portlet types that anonymous users cannot see are configurable. See application documentation for further details.

InvalidPortletException - if any of the portlets is invalid

ServiceException - if any system-level error occurs

findPortletsPaging

ResultPage findPortletsPaging(java.lang.String type_,
                              java.lang.String searchTerms_,
                              java.lang.Long p_,
                              java.lang.Integer sharedType_,
                              java.lang.Integer state_,
                              int startIndex_,
                              int batchSize_,
                              java.lang.Integer sortProperty_,
                              java.lang.Integer sortOrder_)
                       throws InvalidAnonymousUserException,
                              InvalidUserException,
                              InvalidPageException,
                              InvalidPortletTypeException

Deprecated.

Gets a ResultPage containing a list of portlets of the given type obtained by searching for a string in name/description. Only returns portlets that can be seen by the user calling the function. Portlets that are on page p_ are excluded from the results returned (p_ can be used to avoid returning portlets that could not be added to page p - since you can't put the same portlet on the same page twice). If p_ is NO_PAGE, results are not excluded.

Parameters:

type_ - the type of the portlet

searchTerms_ - the search string

p_ - exclude portlets that are on this page, unless the page is NO_PAGE

sharedType_ - whether portlet is shared or not. Valid values are:

• SHARED_AND_UNSHARED_PORTLET
• SHARED_PORTLET
• UNSHARED_PORTLET

state_ - state of portlets being searched. Valid values are:

• ACTIVE_AND_DEACTIVATED_PORTLET
• ACTIVE_PORTLET
• DEACTIVATED_PORTLET

startIndex_ - the index into the collection of total results at which to start. Negative numbers are treated as zeros.

batchSize_ - the number of results to return. Negative numbers will result in the entire collection being returned, but this is STRONGLY discouraged.

sortProperty_ - the property by which the results will be sorted. This is one of the SORT_BY_XXX constants in Portlet

sortOrder_ - The order in which to sort the results. This is either Constants.SORT_ORDER_ASCENDING or Constants.SORT_ORDER_DESCENDING

Returns:

a ResultPage containing a list of Portlet beans

Throws:

InvalidAnonymousUserException - if the user is anonymous, but anonymous access has not been enabled

InvalidUserException - if the user calling this method is invalid

InvalidPageException - if page p_ does not exist and p_ is not NO_PAGE

InvalidPortletTypeException - if portlet type does not exist

ServiceException - if any system-level error occurs

findPortlets

@Deprecated
Portlet[] findPortlets(java.lang.String type_,
                                   java.lang.String searchTerms_,
                                   java.lang.Long p_,
                                   java.lang.Integer sharedType_,
                                   java.lang.Integer state_)
                            throws InvalidAnonymousUserException,
                                   InvalidUserException,
                                   InvalidPageException,
                                   InvalidPortletTypeException

Deprecated. use findPortletsPaging(java.lang.String, java.lang.String, java.lang.Long, java.lang.Integer, java.lang.Integer, int, int, java.lang.Integer, java.lang.Integer) instead

Gets a list of shared portlets obtained by searching for a string in name/description. Only returns portlets that can be seen by the user calling the function. Portlets that are on page p_ are excluded from the results returned (p_ can be used to avoid returning portlets that could not be added to page p - since you can't put the same portlet on the same page twice). If p_ is NO_PAGE, results are not excluded.

Parameters:

type_ - the type of the portlet

searchTerms_ - the search string

p_ - exclude portlets that are on this page, unless the page is NO_PAGE

sharedType_ - whether portlet is shared or not. Valid values are:

• SHARED_AND_UNSHARED_PORTLET
• SHARED_PORTLET
• UNSHARED_PORTLET

state_ - state of portlets being searched. Valid values are:

• ACTIVE_AND_DEACTIVATED_PORTLET
• ACTIVE_PORTLET
• DEACTIVATED_PORTLET

Returns:

a list of portlet beans

Throws:

InvalidAnonymousUserException - if the user is anonymous, but anonymous access has not been enabled

InvalidUserException - if the user calling this method is invalid

InvalidPageException - if page p_ does not exist and p_ is not NO_PAGE

InvalidPortletTypeException - if portlet type does not exist

ServiceException - if any system-level error occurs

updatePortlet

void updatePortlet(Portlet portlet_)
            throws java.lang.IllegalArgumentException,
                   InvalidAnonymousUserException,
                   InvalidUserException,
                   PrivilegeException,
                   PortletSharingException,
                   InvalidPortletException,
                   InvalidPortletTypeException

Deprecated.

Update a portlet In order to update a portlet the fields following fields must be populated: id, shareable, inheritsSecurity, portletType, name, frame, public. Portlet types can be retrieved from AdministrationService.getPortletTypes()

Parameters:

portlet_ - the portlet to update

Throws:

InvalidAnonymousUserException - if the user is anonymous, but anonymous access has not been enabled

InvalidUserException - if the user calling this method is invalid

PrivilegeException - if the current user does not have editor privileges or greater for the portlet

PortletSharingException - if portlet to be updated would be sharable and would also inherit security

java.lang.IllegalArgumentException - if one attempts to unshare a sharable portlet from this method (use unsharePortlet(java.lang.Long, java.lang.Long, boolean) for this purpose) or if the parameters map of the portlet is not null, but does not meet the requirements specified by Portlet.getParameters()

InvalidPortletException - if the portlet is invalid

InvalidPortletTypeException - if the portlet type is invalid

ServiceException - if any system-level error occurs

updatePortlets

void updatePortlets(Portlet[] portlets_)
             throws java.lang.IllegalArgumentException,
                    InvalidAnonymousUserException,
                    InvalidUserException,
                    PrivilegeException,
                    PortletSharingException,
                    InvalidPortletException,
                    InvalidPortletTypeException

Deprecated.

Update portlets in bulk. See updatePortlet(Portlet)

Parameters:

portlets_ - the portlets to update

Throws:

InvalidAnonymousUserException - if the user is anonymous, but anonymous access has not been enabled

InvalidUserException - if the user calling this method is invalid

PrivilegeException - if the current user does not have editor privileges or greater for the portlet

PortletSharingException - if any portlet to be updated would be sharable and would also inherit security

java.lang.IllegalArgumentException - if one attempts to unshare a sharable portlet from this method (use unsharePortlet(java.lang.Long, java.lang.Long, boolean) for this purpose) or if the parameters map of any portlet is not null, but does not meet the requirements specified by Portlet.getParameters()

InvalidPortletException - if any portlet is invalid

InvalidPortletTypeException - if any portlet type is invalid

ServiceException - if any system-level error occurs

updatePortletParameters

void updatePortletParameters(java.lang.Long portletId_,
                             java.util.Map parameterValueMap_)
                      throws java.lang.IllegalArgumentException,
                             InvalidUserException,
                             PrivilegeException,
                             InvalidPortletException

Deprecated.

Update the portlet's name/value pairs of its parameters

Parameters:

portletId_ - the id of the portlet

parameterValueMap_ - a map containing name/value pairs. Names must be single words, starting with a letter and containing only _, numbers and letters in the basic US character set. Values should be of type String, though future implementations (and experimentally, the current one) may allow other datatypes.

Throws:

InvalidAnonymousUserException - if the user is anonymous, but anonymous access has not been enabled

InvalidUserException - if the user calling this method is invalid

PrivilegeException - if the current user does not have editor privileges or greater for the portlet

InvalidPortletException - if portlet does not exist

java.lang.IllegalArgumentException - if the parameters map of the portlet is not null, but does not meet the requirements specified by Portlet.getParameters()

ServiceException - if any system-level error occurs

updatePortletsParameters

void updatePortletsParameters(java.lang.Long[] portletIds_,
                              java.util.Map[] parameterValueMaps_)
                       throws java.lang.IllegalArgumentException,
                              InvalidUserException,
                              PrivilegeException,
                              InvalidPortletException

Deprecated.

Update the portlets' name/value pairs of their parameters

Parameters:

portletIds_ - the ids of the portlets

parameterValueMaps_ - maps containing name/value pairs. Names must be single words, starting with a letter and containing only _, numbers and letters in the basic US character set. Values should be of type String, though future implementations (and experimentally, the current one) may allow other datatypes.

Throws:

InvalidAnonymousUserException - if the user is anonymous, but anonymous access has not been enabled

InvalidUserException - if the user calling this method is invalid

PrivilegeException - if the current user does not have editor privileges or greater for the portlet

InvalidPortletException - if any portlet does not exist

java.lang.IllegalArgumentException - if the parameters map of any portlet is not null, but does not meet the requirements specified by Portlet.getParameters()

ServiceException - if any system-level error occurs

unsharePortlet

void unsharePortlet(java.lang.Long portletId_,
                    java.lang.Long pageId_,
                    boolean force_)
             throws java.lang.IllegalArgumentException,
                    InvalidAnonymousUserException,
                    InvalidUserException,
                    PrivilegeException,
                    PortletSharingException,
                    InvalidPortletException,
                    InvalidPageException

Deprecated.

Make a shared portlet non-shareable and clear it's uuid if it has one.

Parameters:

portletId_ - the id of the portlet to unshare

pageId_ - the id of the page to keep the portlet on (null means don't keep on any page)

force_ - if true, delete from all pages other than pageId_; otherwise, throw PortletSharingException if portlet is on pages other than pageId_

Throws:

InvalidAnonymousUserException - if the user is anonymous, but anonymous access has not been enabled

InvalidUserException - if the user calling this method is invalid

PrivilegeException - if the current user does not have editor privileges or greater for the portlet

java.lang.IllegalArgumentException - if pageId_ is not null, and the specified portlet is not on the specified page

PortletSharingException - if force_ is false and the specified portlet is on pages other than the specified page

InvalidPortletException - if portlet does not exist

InvalidPageException - if the page does not exist

ServiceException - if any system-level error occurs

getRoleMapForPortlet

PortalRoleMap getRoleMapForPortlet(java.lang.Long portletId_)
                            throws InvalidPortletException

Deprecated.

Get the role map for a portlet NOTE: This should not be used to verify the access level that the current user has on the portlet because the access level can depend on other properties of the portlet such as inheritsSecurity and shareable.

Parameters:

portletId_ - the id of the portlet

Returns:

rolemap for the portlet

Throws:

InvalidPortletException - if portlet does not exist

ServiceException - if any system-level error occurs

setRoleMapForPortlet

void setRoleMapForPortlet(java.lang.Long portletId_,
                          PortalRoleMap map_)
                   throws InvalidAnonymousUserException,
                          InvalidUserException,
                          InvalidPortletException,
                          PrivilegeException

Deprecated.

Set the role map for a portlet

Parameters:

portletId_ - the id of the portlet

map_ - the new rolemap of the portlet

Throws:

InvalidAnonymousUserException - if the user is anonymous, but anonymous access has not been enabled

InvalidUserException - if the user calling this method is invalid privileges or greater for the portlet

InvalidPortletException - if portlet does not exist

PrivilegeException - if the current user does not have admin privileges or greater for the portlet

ServiceException - if any system-level error occurs

getInheritedRoleMapForPortlet

PortalRoleMap getInheritedRoleMapForPortlet(java.lang.Long portletId_,
                                            java.lang.Long pageId_)
                                     throws InvalidPortletException

Deprecated.

Returns the role map that the portlet inherits from its page. If the portlet does not inherit security from its page, an empty role map is returned.

Parameters:

portletId_ - the id of the portlet

pageId_ - the id of the page

Returns:

The role map for the portlet specified by the given id

Throws:

InvalidPortletException - if portlet does not exist

ServiceException - if any system-level error occurs