Package com.appiancorp.suiteapi.portal

Interface AdministrationService

All Superinterfaces:

com.appiancorp.services.ContextSensitiveService, Service

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

Deprecated.

The Portal functionality will be removed in a future release.

Defines service methods related to the configuration and runtime operation of the Portal application.

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.

See Also:

• NotificationService
• PageNavigationService
• PortalNotificationService
• PortalSearchService
• PortletService

Field Summary

Fields

Modifier and Type	Field	Description
static final boolean	activateUserSession$UPDATES	Deprecated, for removal: This API element is subject to removal in a future version.
static final boolean	commitUpdateUsernames$UPDATES	Deprecated, for removal: This API element is subject to removal in a future version.
static final boolean	findPortletTypes$UPDATES	Deprecated, for removal: This API element is subject to removal in a future version.
static final boolean	findPortletTypesPaging$UPDATES	Deprecated, for removal: This API element is subject to removal in a future version.
static final boolean	getApplicationName$UPDATES	Deprecated, for removal: This API element is subject to removal in a future version.
static final boolean	getMultiplePortletTypes$UPDATES	Deprecated, for removal: This API element is subject to removal in a future version.
static final boolean	getPortletType$UPDATES	Deprecated, for removal: This API element is subject to removal in a future version.
static final boolean	getPortletTypes$UPDATES	Deprecated, for removal: This API element is subject to removal in a future version.
static final boolean	getPortletTypesPaging$UPDATES	Deprecated, for removal: This API element is subject to removal in a future version.
static final boolean	getSiteCalendarSettings$UPDATES	Deprecated, for removal: This API element is subject to removal in a future version.
static final boolean	getSiteLocaleSettings$UPDATES	Deprecated, for removal: This API element is subject to removal in a future version.
static final boolean	getSiteTimeZoneSettings$UPDATES	Deprecated, for removal: This API element is subject to removal in a future version.
static final boolean	getSystemPageId$UPDATES	Deprecated, for removal: This API element is subject to removal in a future version.
static final boolean	getWorkspace$UPDATES	Deprecated, for removal: This API element is subject to removal in a future version.
static final boolean	getWSRPProducer$UPDATES	Deprecated, for removal: This API element is subject to removal in a future version.
static final boolean	getWSRPProducerFromURL$UPDATES	Deprecated, for removal: This API element is subject to removal in a future version.
static final boolean	getWSRPProducers$UPDATES	Deprecated, for removal: This API element is subject to removal in a future version.
static final boolean	getWSRPProducersPaging$UPDATES	Deprecated, for removal: This API element is subject to removal in a future version.
static final boolean	notifyGroupDeletion$UPDATES	Deprecated, for removal: This API element is subject to removal in a future version.
static final boolean	notifyGroupsDeletion$UPDATES	Deprecated, for removal: This API element is subject to removal in a future version.
static final boolean	notifyUserCreation$UPDATES	Deprecated, for removal: This API element is subject to removal in a future version.
static final boolean	notifyUsersCreation$UPDATES	Deprecated, for removal: This API element is subject to removal in a future version.
static final boolean	registerPortletType$UPDATES	Deprecated, for removal: This API element is subject to removal in a future version.
static final boolean	registerPortletTypes$UPDATES	Deprecated, for removal: This API element is subject to removal in a future version.
static final boolean	registerWSRPProducer$UPDATES	Deprecated, for removal: This API element is subject to removal in a future version.
static final boolean	reloadProperties$UPDATES	Deprecated, for removal: This API element is subject to removal in a future version.
static final boolean	rollbackUpdateUsernames$UPDATES	Deprecated, for removal: This API element is subject to removal in a future version.
static final boolean	setAdministratorGroup$UPDATES	Deprecated, for removal: This API element is subject to removal in a future version.
static final boolean	setSiteCalendarSettings$UPDATES	Deprecated, for removal: This API element is subject to removal in a future version.
static final boolean	setSiteLocaleSettings$UPDATES	Deprecated, for removal: This API element is subject to removal in a future version.
static final boolean	setSiteTimeZoneSettings$UPDATES	Deprecated, for removal: This API element is subject to removal in a future version.
static final boolean	updatePortletTypesState$UPDATES	Deprecated, for removal: This API element is subject to removal in a future version.
static final boolean	updatePortletTypeState$UPDATES	Deprecated, for removal: This API element is subject to removal in a future version.
static final boolean	updateUsernames$UPDATES	Deprecated, for removal: This API element is subject to removal in a future version.
static final boolean	validate$UPDATES	Deprecated, for removal: This API element is subject to removal in a future version.
static final boolean	validateGroupMembership$UPDATES	Deprecated, for removal: This API element is subject to removal in a future version.

Fields inherited from interface com.appiancorp.services.ContextSensitiveService

SET_SERVICE_CONTEXT_METHOD_NAME

Method Summary

Modifier and Type	Method	Description
Void	activateUserSession(Long[] membership_, Long[] administration_)	Deprecated.
void	commitUpdateUsernames()	Deprecated. instead use UserService.renameUsersByUuid(java.lang.String[], java.lang.String[])
PortletType[]	findPortletTypes(String filterMask_, String stateFilter_)	Deprecated. use findPortletTypesPaging(String, String, int, int, Integer, Integer) instead.
ResultPage	findPortletTypesPaging(String filterMask_, String stateFilter_, int startIndex_, int batchSize_, Integer sortProperty_, Integer sortOrder_)	Deprecated. JSR-168 and WSRP Portlets have been deprecated, and no portlets of those types will be returned by this method.
String	getApplicationName()	Deprecated. not used
PortletType[]	getMultiplePortletTypes(String[] portletTypeDefinitions_)	Deprecated. use findPortletTypesPaging(java.lang.String, java.lang.String, int, int, java.lang.Integer, java.lang.Integer) or getPortletTypesPaging(int, int, java.lang.Integer, java.lang.Integer) instead JSR-168 and WSRP Portlets have been deprecated, and calls to this method for those types will throw InvalidPortletTypeDefinitionException.
PortletType	getPortletType(String portletTypeDefinition_)	Deprecated. JSR-168 and WSRP Portlets have been deprecated, and calls to this method for those types will throw InvalidPortletTypeDefinitionException.
PortletType[]	getPortletTypes()	Deprecated. use getPortletTypesPaging(int, int, Integer, Integer) instead JSR-168 and WSRP Portlets have been deprecated, and no portlets of those types will be returned by this method
ResultPage	getPortletTypesPaging(int startIndex_, int batchSize_, Integer sortProperty_, Integer sortOrder_)	Deprecated. JSR-168 and WSRP Portlets have been deprecated, and no portlets of those types will be returned by this method.
SiteCalendarSettings	getSiteCalendarSettings()	Deprecated. Gets the calendar settings for the administration server Use GlobalizationService.getSiteCalendarSettings() to get the calendar settings of the entire site.
SiteLocaleSettings	getSiteLocaleSettings()	Deprecated. Returns the site locale settings for the administration server Use GlobalizationService.getSiteLocaleSettings() to get site locale setting for the entire site.
SiteTimeZoneSettings	getSiteTimeZoneSettings()	Deprecated. Gets the site timezone settings for the adminstration server Use GlobalizationService.getSiteTimeZoneSettings() to get the timezone settings of the entire site.
Long	getSystemPageId(String systemPageUuid)	Deprecated. Gets the system page id corresponding to the given UUID.
String[]	getWorkspace()	Deprecated. this information is no longer available
PersistedWSRPProducer	getWSRPProducer(Long producerId_)	Deprecated. WSRP Producers have been removed in Appian 22.2.
PersistedWSRPProducer	getWSRPProducerFromURL(String producerURL_)	Deprecated. WSRP Producers have been removed in Appian 22.2.
PersistedWSRPProducer[]	getWSRPProducers(Long[] producerIds_)	Deprecated. WSRP Producers have been removed in Appian 22.2.
ResultPage	getWSRPProducersPaging(int startIndex_, int batchSize_, Integer sortProperty_, Integer sortOrder_)	Deprecated. WSRP Producers have been removed in Appian 22.2.
void	notifyGroupDeletion(Long groupId_)	Deprecated. Notifies that the specified group has been deleted and no references to it should therefore exist in the portal application
void	notifyGroupsDeletion(Long[] groupIds_)	Deprecated. Notifies that the specified groups have been deleted and no references to them should therefore exist in the portal application
void	notifyUserCreation(String username_)	Deprecated. done automatically by UserService.createUser
void	notifyUsersCreation(String[] usernames_)	Deprecated. Notifies the portal application that these users have been created.
void	registerPortletType(PortletType portletType_)	Deprecated. JSR-168 and WSRP Portlets have been deprecated, and calls to this method for those types will be ignored.
void	registerPortletTypes(PortletType[] portletTypes_)	Deprecated. JSR-168 and WSRP Portlets have been deprecated, and calls to this method for those types will be ignored.
Long	registerWSRPProducer(PersistedWSRPProducer producer_)	Deprecated. WSRP Producers have been removed in Appian 22.2.
void	reloadProperties()	Deprecated. reloading properties is now automatic, so this call is now unnecessary and does nothing.
void	rollbackUpdateUsernames()	Deprecated. instead use UserService.renameUsersByUuid(java.lang.String[], java.lang.String[])
void	setAdministratorGroup(Long id_)	Deprecated. Sets the specified group as the administrative group for the Portal application.
void	setSiteCalendarSettings(SiteCalendarSettings settings_)	Deprecated. Registers the calendar setting for the administration server.
void	setSiteLocaleSettings(SiteLocaleSettings settings_)	Deprecated. Registers the site local settings for the administration server.
void	setSiteTimeZoneSettings(SiteTimeZoneSettings timezoneSettings_)	Deprecated. Registers the site timezone settings for the administration server.
void	updatePortletTypesState(String[] portletTypeDefinitions_, String newState_)	Deprecated. JSR-168 and WSRP Portlets have been deprecated, and calls for those PortletTypes will be ignored by this method
void	updatePortletTypeState(String portletTypeDefinition_, String newState_)	Deprecated. JSR-168 and WSRP Portlets have been deprecated, and calls for those PortletTypes will be ignored by this method
void	updateUsernames(String[] oldUsernames_, String[] newUsernames_, long maxExpirationTimeInSeconds_)	Deprecated. instead use UserService.renameUsersByUuid(java.lang.String[], java.lang.String[])
String	validate()	Deprecated. use the validate diagnostic script instead
boolean	validateGroupMembership(Long[] memGroupIds_, Long[] admGroupIds_)	Deprecated. No longer necessary with credential system

Methods inherited from interface com.appiancorp.services.ContextSensitiveService

setServiceContext

Field Details

registerPortletType$UPDATES

@Deprecated(forRemoval=true)
static final boolean registerPortletType$UPDATES

Deprecated, for removal: This API element is subject to removal in a future version.

See Also:

• Constant Field Values

registerPortletTypes$UPDATES

@Deprecated(forRemoval=true)
static final boolean registerPortletTypes$UPDATES

Deprecated, for removal: This API element is subject to removal in a future version.

See Also:

• Constant Field Values

getPortletType$UPDATES

@Deprecated(forRemoval=true)
static final boolean getPortletType$UPDATES

Deprecated, for removal: This API element is subject to removal in a future version.

See Also:

• Constant Field Values

getPortletTypes$UPDATES

@Deprecated(forRemoval=true)
static final boolean getPortletTypes$UPDATES

Deprecated, for removal: This API element is subject to removal in a future version.

See Also:

• Constant Field Values

getPortletTypesPaging$UPDATES

@Deprecated(forRemoval=true)
static final boolean getPortletTypesPaging$UPDATES

Deprecated, for removal: This API element is subject to removal in a future version.

See Also:

• Constant Field Values

getMultiplePortletTypes$UPDATES

@Deprecated(forRemoval=true)
static final boolean getMultiplePortletTypes$UPDATES

Deprecated, for removal: This API element is subject to removal in a future version.

See Also:

• Constant Field Values

findPortletTypes$UPDATES

@Deprecated(forRemoval=true)
static final boolean findPortletTypes$UPDATES

Deprecated, for removal: This API element is subject to removal in a future version.

See Also:

• Constant Field Values

findPortletTypesPaging$UPDATES

@Deprecated(forRemoval=true)
static final boolean findPortletTypesPaging$UPDATES

Deprecated, for removal: This API element is subject to removal in a future version.

See Also:

• Constant Field Values

updatePortletTypeState$UPDATES

@Deprecated(forRemoval=true)
static final boolean updatePortletTypeState$UPDATES

Deprecated, for removal: This API element is subject to removal in a future version.

See Also:

• Constant Field Values

updatePortletTypesState$UPDATES

@Deprecated(forRemoval=true)
static final boolean updatePortletTypesState$UPDATES

Deprecated, for removal: This API element is subject to removal in a future version.

See Also:

• Constant Field Values

registerWSRPProducer$UPDATES

@Deprecated(forRemoval=true)
static final boolean registerWSRPProducer$UPDATES

Deprecated, for removal: This API element is subject to removal in a future version.

See Also:

• Constant Field Values

getWSRPProducersPaging$UPDATES

@Deprecated(forRemoval=true)
static final boolean getWSRPProducersPaging$UPDATES

Deprecated, for removal: This API element is subject to removal in a future version.

See Also:

• Constant Field Values

getWSRPProducer$UPDATES

@Deprecated(forRemoval=true)
static final boolean getWSRPProducer$UPDATES

Deprecated, for removal: This API element is subject to removal in a future version.

See Also:

• Constant Field Values

getWSRPProducers$UPDATES

@Deprecated(forRemoval=true)
static final boolean getWSRPProducers$UPDATES

Deprecated, for removal: This API element is subject to removal in a future version.

See Also:

• Constant Field Values

getWSRPProducerFromURL$UPDATES

@Deprecated(forRemoval=true)
static final boolean getWSRPProducerFromURL$UPDATES

Deprecated, for removal: This API element is subject to removal in a future version.

See Also:

• Constant Field Values

notifyGroupDeletion$UPDATES

@Deprecated(forRemoval=true)
static final boolean notifyGroupDeletion$UPDATES

Deprecated, for removal: This API element is subject to removal in a future version.

See Also:

• Constant Field Values

notifyGroupsDeletion$UPDATES

@Deprecated(forRemoval=true)
static final boolean notifyGroupsDeletion$UPDATES

Deprecated, for removal: This API element is subject to removal in a future version.

See Also:

• Constant Field Values

setAdministratorGroup$UPDATES

@Deprecated(forRemoval=true)
static final boolean setAdministratorGroup$UPDATES

Deprecated, for removal: This API element is subject to removal in a future version.

See Also:

• Constant Field Values

activateUserSession$UPDATES

@Deprecated(forRemoval=true)
static final boolean activateUserSession$UPDATES

Deprecated, for removal: This API element is subject to removal in a future version.

See Also:

• Constant Field Values

notifyUserCreation$UPDATES

@Deprecated(forRemoval=true)
static final boolean notifyUserCreation$UPDATES

Deprecated, for removal: This API element is subject to removal in a future version.

See Also:

• Constant Field Values

notifyUsersCreation$UPDATES

@Deprecated(forRemoval=true)
static final boolean notifyUsersCreation$UPDATES

Deprecated, for removal: This API element is subject to removal in a future version.

See Also:

• Constant Field Values

getApplicationName$UPDATES

@Deprecated(forRemoval=true)
static final boolean getApplicationName$UPDATES

Deprecated, for removal: This API element is subject to removal in a future version.

See Also:

• Constant Field Values

getWorkspace$UPDATES

@Deprecated(forRemoval=true)
static final boolean getWorkspace$UPDATES

Deprecated, for removal: This API element is subject to removal in a future version.

See Also:

• Constant Field Values

validateGroupMembership$UPDATES

@Deprecated(forRemoval=true)
static final boolean validateGroupMembership$UPDATES

Deprecated, for removal: This API element is subject to removal in a future version.

See Also:

• Constant Field Values

updateUsernames$UPDATES

@Deprecated(forRemoval=true)
static final boolean updateUsernames$UPDATES

Deprecated, for removal: This API element is subject to removal in a future version.

See Also:

• Constant Field Values

commitUpdateUsernames$UPDATES

@Deprecated(forRemoval=true)
static final boolean commitUpdateUsernames$UPDATES

Deprecated, for removal: This API element is subject to removal in a future version.

See Also:

• Constant Field Values

rollbackUpdateUsernames$UPDATES

@Deprecated(forRemoval=true)
static final boolean rollbackUpdateUsernames$UPDATES

Deprecated, for removal: This API element is subject to removal in a future version.

See Also:

• Constant Field Values

reloadProperties$UPDATES

@Deprecated(forRemoval=true)
static final boolean reloadProperties$UPDATES

Deprecated, for removal: This API element is subject to removal in a future version.

See Also:

• Constant Field Values

validate$UPDATES

@Deprecated(forRemoval=true)
static final boolean validate$UPDATES

Deprecated, for removal: This API element is subject to removal in a future version.

See Also:

• Constant Field Values

getSiteLocaleSettings$UPDATES

@Deprecated(forRemoval=true)
static final boolean getSiteLocaleSettings$UPDATES

Deprecated, for removal: This API element is subject to removal in a future version.

See Also:

• Constant Field Values

setSiteLocaleSettings$UPDATES

@Deprecated(forRemoval=true)
static final boolean setSiteLocaleSettings$UPDATES

Deprecated, for removal: This API element is subject to removal in a future version.

See Also:

• Constant Field Values

getSiteTimeZoneSettings$UPDATES

@Deprecated(forRemoval=true)
static final boolean getSiteTimeZoneSettings$UPDATES

Deprecated, for removal: This API element is subject to removal in a future version.

See Also:

• Constant Field Values

setSiteTimeZoneSettings$UPDATES

@Deprecated(forRemoval=true)
static final boolean setSiteTimeZoneSettings$UPDATES

Deprecated, for removal: This API element is subject to removal in a future version.

See Also:

• Constant Field Values

getSiteCalendarSettings$UPDATES

@Deprecated(forRemoval=true)
static final boolean getSiteCalendarSettings$UPDATES

Deprecated, for removal: This API element is subject to removal in a future version.

See Also:

• Constant Field Values

setSiteCalendarSettings$UPDATES

@Deprecated(forRemoval=true)
static final boolean setSiteCalendarSettings$UPDATES

Deprecated, for removal: This API element is subject to removal in a future version.

See Also:

• Constant Field Values

getSystemPageId$UPDATES

@Deprecated(forRemoval=true)
static final boolean getSystemPageId$UPDATES

Deprecated, for removal: This API element is subject to removal in a future version.

See Also:

• Constant Field Values

Method Details

registerPortletType

@Deprecated
@Write(K_PORTAL)
void registerPortletType(PortletType portletType_)

Deprecated.

JSR-168 and WSRP Portlets have been deprecated, and calls to this method for those types will be ignored.

Register a new PortletType. If the PortletType is already registered (i.e. a PortletType with the same definition already exists) the properties of the specified PortletType are updated with the new values. The minimum properties which must be populated in order to register a PortletType are definition and state. The definition property should be a non empty string. The state property can only take one of the following values:

• PortletType.STATE_ACTIVE
• PortletType.STATE_INACTIVE

If these two properties fail to meet these requirements the respective portletType won't be registered or updated.

Additional constraints:

• If the name property is null, an empty string will be used instead.
• If the editable property is null, false will be used instead.
• All extensions must have a non null key. If one of the keys is null the PortletType will get registered or updated using an empty set of extensions.

Parameters:

portletType_ - the new PortletType or the PortletType to update

Throws:

NullPointerException - if portletType_ is null; this exception is not thrown if any of the properties is null

ServiceException - if any system-level error occurs

registerPortletTypes

@Deprecated
@Write(K_PORTAL)
void registerPortletTypes(PortletType[] portletTypes_)

Deprecated.

JSR-168 and WSRP Portlets have been deprecated, and calls to this method for those types will be ignored.

Register a list of new PortletType objects. If the PortletType is already registered (i.e. a PortletType with the same definition already exists) the properties of the specified PortletType are updated with the new values. The minimum properties which must be populated in order to register a PortletType are definition and state. The definition property should be a non empty string. The state property can only take one of the following values:

• PortletType.STATE_ACTIVE
• PortletType.STATE_INACTIVE

If these two properties fail to meet these requirements the respective PortletType won't be registered or updated. This won't prevent the other valid PortletType objects in the list from being registered or updated.

Additional constraints:

• If any name property is null, an empty string will be used instead.
• If any editable property is null, false will be used instead.
• All extensions must have a non null key. If one of the keys is null the PortletType will get registered or updated using an empty set of extensions.

Parameters:

portletTypes_ - the list of new PortletType objects or the PortletType objects to update

Throws:

NullPointerException - if portletTypes_ is null; this exception is not thrown if any of the properties is null

ServiceException - if any system-level error occurs or if the list contains a null value

See Also:

• PortletType

getPortletType

@Deprecated
@Read(K_PORTAL)
PortletType getPortletType(String portletTypeDefinition_)
                    throws InvalidPortletTypeDefinitionException

Deprecated.

JSR-168 and WSRP Portlets have been deprecated, and calls to this method for those types will throw InvalidPortletTypeDefinitionException.

Get the registered Portlet type for the requested portlet type definition

Parameters:

portletTypeDefinition_ - the definition of a portlet type

Returns:

the portlet type

Throws:

ServiceException - if any system-level error occurs

InvalidPortletTypeDefinitionException

getPortletTypes

@Deprecated
@Read(K_PORTAL)
PortletType[] getPortletTypes()

Deprecated.

use getPortletTypesPaging(int, int, Integer, Integer) instead JSR-168 and WSRP Portlets have been deprecated, and no portlets of those types will be returned by this method

Retrieves the list of registered portlet types

Returns:

the list of registered portlet types sorted by name

Throws:

ServiceException - if any system-level error occurs

See Also:

• registerPortletType(com.appiancorp.suiteapi.portal.PortletType)

getPortletTypesPaging

@Deprecated
@Read(K_PORTAL)
ResultPage getPortletTypesPaging(int startIndex_,
 int batchSize_,
 Integer sortProperty_,
 Integer sortOrder_)

Deprecated.

JSR-168 and WSRP Portlets have been deprecated, and no portlets of those types will be returned by this method.

Retrieves the list of registered portlet types

Parameters:

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 of Constants.COUNT_ALL 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 PortletType

sortOrder_ - Constants.SORT_ORDER_ASCENDING for sorting results in ascending order, Constants.SORT_ORDER_DESCENDING for sorting results in descending order

Returns:

a ResultPage containing the list of PortletType objects corresponding to the registered portlet types

Throws:

ServiceException - if any system-level error occurs

getMultiplePortletTypes

@Deprecated
@Read(K_PORTAL)
PortletType[] getMultiplePortletTypes(String[] portletTypeDefinitions_)
                               throws NullPointerException,
InvalidPortletTypeDefinitionException

Deprecated.

use findPortletTypesPaging(java.lang.String, java.lang.String, int, int, java.lang.Integer, java.lang.Integer) or getPortletTypesPaging(int, int, java.lang.Integer, java.lang.Integer) instead JSR-168 and WSRP Portlets have been deprecated, and calls to this method for those types will throw InvalidPortletTypeDefinitionException.

Get the registered Portlet types for the requested portlet type definitions

Parameters:

portletTypeDefinitions_ - the list of portlet type definitions to retrieve

Returns:

the portlet types, in the same order as the supplied definitions

Throws:

ServiceException - if any system-level error occurs

NullPointerException

InvalidPortletTypeDefinitionException

findPortletTypes

@Deprecated
@Read(K_PORTAL)
PortletType[] findPortletTypes(String filterMask_,
 String stateFilter_)
                        throws NullPointerException,
InvalidPortletTypeStateFilterException

Deprecated.

use findPortletTypesPaging(String, String, int, int, Integer, Integer) instead. JSR-168 and WSRP Portlets have been deprecated, and no portlets of those types will be returned by this method.

Parameters:

filterMask_ - the mask to use for the definition field, use one of the FILTER_* constants from PortletType

stateFilter_ - which state(s) to include - use one of the STATE_* constants from PortletType. A null means either.

Returns:

the list of filtered portlet types

Throws:

NullPointerException

InvalidPortletTypeStateFilterException

findPortletTypesPaging

@Deprecated
@Read(K_PORTAL)
ResultPage findPortletTypesPaging(String filterMask_,
 String stateFilter_,
 int startIndex_,
 int batchSize_,
 Integer sortProperty_,
 Integer sortOrder_)
                           throws NullPointerException,
InvalidPortletTypeStateFilterException

Deprecated.

JSR-168 and WSRP Portlets have been deprecated, and no portlets of those types will be returned by this method.

Parameters:

filterMask_ - the mask to use for the definition field, use one of the FILTER_* constants from PortletType

stateFilter_ - which state(s) to include - use one of the STATE_* constants from PortletType or null for either.

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 discouraged.

sortProperty_ - the property by which the results should be sorted. This should be one of the SORT_BY_XXX constants in PortletType.

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

Returns:

the list of filtered portlet types

Throws:

NullPointerException

InvalidPortletTypeStateFilterException

updatePortletTypeState

@Deprecated
@Write(K_PORTAL)
void updatePortletTypeState(String portletTypeDefinition_,
 String newState_)
                     throws NullPointerException,
InvalidPortletTypeDefinitionException,
InvalidPortletTypeStateException

Deprecated.

JSR-168 and WSRP Portlets have been deprecated, and calls for those PortletTypes will be ignored by this method

Update state of a registered portlet type

Parameters:

portletTypeDefinition_ - the Portlet type definition of the portlet type

newState_ - the new state - use one of the STATE_* constants from PortletType

Throws:

ServiceException - if any system-level error occurs

NullPointerException

InvalidPortletTypeDefinitionException

InvalidPortletTypeStateException

updatePortletTypesState

@Deprecated
@Write(K_PORTAL)
void updatePortletTypesState(String[] portletTypeDefinitions_,
 String newState_)
                      throws NullPointerException,
InvalidPortletTypeDefinitionException,
InvalidPortletTypeStateException

Deprecated.

JSR-168 and WSRP Portlets have been deprecated, and calls for those PortletTypes will be ignored by this method

Update the state of multiple registered portlet types

Parameters:

portletTypeDefinitions_ - the list of portlet type definitions to update

newState_ - the new state - use one of the STATE_* constants from PortletType

Throws:

ServiceException - if any system-level error occurs

NullPointerException

InvalidPortletTypeDefinitionException

InvalidPortletTypeStateException

registerWSRPProducer

@Deprecated
@Write(K_PORTAL)
Long registerWSRPProducer(PersistedWSRPProducer producer_)
                   throws DuplicateWSRPProducerURLException,
InvalidWSRPProducerException,
NullPointerException

Deprecated.

WSRP Producers have been removed in Appian 22.2. This method will be removed in a future release, and will now throw InvalidWSRPProducerException

Adds or updates a WSRP Producer in the system.

Parameters:

producer_ - The PersistedWSRPProducer object that will be created or updated

Returns:

the identifier of the created or updated Producer object

Throws:

DuplicateWSRPProducerURLException - if the Producer URL already exists in the system

InvalidWSRPProducerException - if the id of the producer object is invalid

NullPointerException - if the Producer URL is null or empty

getWSRPProducersPaging

@Deprecated
@Read(K_PORTAL)
ResultPage getWSRPProducersPaging(int startIndex_,
 int batchSize_,
 Integer sortProperty_,
 Integer sortOrder_)

Deprecated.

WSRP Producers have been removed in Appian 22.2. This method will be removed in a future release, and will now return an empty ResultPage.

Retrieves the list of registered Producers

Parameters:

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 discouraged.

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

sortOrder_ - Constants.SORT_ORDER_ASCENDING for sorting results in ascending order, Constants.SORT_ORDER_DESCENDING for sorting results in descending order

Returns:

A Result Page containing the requested PersistedWSRPProducer objects

getWSRPProducer

@Deprecated
@Read(K_PORTAL)
PersistedWSRPProducer getWSRPProducer(Long producerId_)
                               throws InvalidWSRPProducerException,
NullPointerException

Deprecated.

WSRP Producers have been removed in Appian 22.2. This method will be removed in a future release, and will now throw InvalidWSRPProducerException

Get a registered WSRP Producer

Parameters:

producerId_ - the id of the producer

Returns:

the producer object that has the specified id

Throws:

InvalidWSRPProducerException - if the specified Producer id is invalid

NullPointerException - if a null Producer id is specified

getWSRPProducers

@Deprecated
@Read(K_PORTAL)
PersistedWSRPProducer[] getWSRPProducers(Long[] producerIds_)
                                  throws InvalidWSRPProducerException,
NullPointerException

Deprecated.

WSRP Producers have been removed in Appian 22.2. This method will be removed in a future release, and will now throw InvalidWSRPProducerException

Gets the registered Producer objects that correspond to the specified ids

Parameters:

producerIds_ - the ids of the producers

Returns:

an array of PersistedWSRPProducer objects that match the specified id list

Throws:

InvalidWSRPProducerException - if any of the specified Producer ids are invalid

NullPointerException - if any of the specified Producer ids are null

getWSRPProducerFromURL

@Deprecated
@Read(K_PORTAL)
PersistedWSRPProducer getWSRPProducerFromURL(String producerURL_)
                                      throws InvalidWSRPProducerURLException,
NullPointerException

Deprecated.

WSRP Producers have been removed in Appian 22.2. This method will be removed in a future release, and will now throw InvalidWSRPProducerURLException

Get the registered producer for specified URL (URLs are unique)

Parameters:

producerURL_ - the URL that the producer should have

Returns:

the PersistedWSRPProducer object for the specified URL

Throws:

InvalidWSRPProducerURLException - if there are not Producers with the specified URL

NullPointerException - if an empty or null Producer URL is specified

notifyGroupDeletion

@Write(K_PORTAL)
void notifyGroupDeletion(Long groupId_)
                  throws NullPointerException,
PrivilegeException

Deprecated.

Notifies that the specified group has been deleted and no references to it should therefore exist in the portal application

Parameters:

groupId_ - the ID of the group that has been deleted

Throws:

PrivilegeException - if the specified group is the portal administrator group

NullPointerException - if groupId_ is null

ServiceException - if any system-level error occurs

See Also:

• setAdministratorGroup(java.lang.Long)

notifyGroupsDeletion

@Write(K_PORTAL)
void notifyGroupsDeletion(Long[] groupIds_)
                   throws PrivilegeException,
NullPointerException

Deprecated.

Notifies that the specified groups have been deleted and no references to them should therefore exist in the portal application

Parameters:

groupIds_ - the IDs of the groups that have been deleted

Throws:

PrivilegeException - if any of the specified groups is the portal administrator group

NullPointerException - if groupIds_ is null

ServiceException - if any system-level error occurs

See Also:

• setAdministratorGroup(java.lang.Long)

setAdministratorGroup

@Write(K_PORTAL)
void setAdministratorGroup(Long id_)
                    throws NullPointerException

Deprecated.

Sets the specified group as the administrative group for the Portal application. Users in the administrative group can perform any action on every object in the application, irrespective of the security settings.

Parameters:

id_ - the ID of the group to be set as administrator group

Throws:

NullPointerException - if id_ is null

ServiceException - if any system-level error occurs

activateUserSession

@Deprecated
@Write(K_PORTAL)
Void activateUserSession(Long[] membership_,
 Long[] administration_)
                  throws InvalidAnonymousUserException,
InvalidUserException,
NullPointerException

Deprecated.

Notifies the portal application that a new session has been created for the current user, and provides information about the current user's membership and administration rights to groups. In Portal, this call has no side-effect other than caching the passed groups, thus this method can also be used to simply update the membership/administration information for the current user. This call is necessary every time the group membership role is changed, a new group is created, or when the user is newly created

Parameters:

membership_ - the list of group IDs of groups of which the user is a member

administration_ - the list of group IDs of groups of which the user has administrative rights

Throws:

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

InvalidUserException - if the user calling this method does not exist

NullPointerException - if any of the input arrays are null

ServiceException - if any system-level error occurs

notifyUserCreation

@Deprecated
@Write(K_PORTAL)
void notifyUserCreation(String username_)
                 throws NullPointerException

Deprecated.

done automatically by UserService.createUser

Notifies the portal application that this user has been created. This should be called after a user has been created using UserService.createUser(com.appiancorp.suiteapi.personalization.User).

The caller should take care to only pass the valid username of a user that has been previously created in UserService.

Parameters:

username_ - the username of the created user

Throws:

NullPointerException - if username_ is null or empty

ServiceException - if any system-level error occurs

notifyUsersCreation

@Write(K_PORTAL)
void notifyUsersCreation(String[] usernames_)
                  throws NullPointerException

Deprecated.

Notifies the portal application that these users have been created. This should be called after users have been created using UserService.createUser(com.appiancorp.suiteapi.personalization.User) or UserService.createUsers(com.appiancorp.suiteapi.personalization.User[]).

The caller should take care to only pass the valid username of a user that has been previously created in UserService.

Parameters:

usernames_ - the usernames of the created users

Throws:

NullPointerException - if the passed usernames_ array or any of its elements is null or empty

ServiceException - if any system-level error occurs

getApplicationName

@Deprecated
@Read(K_PORTAL)
String getApplicationName()

Deprecated.

not used

Gets the name of the application on which this service is running.

Returns:

the name of the application

Throws:

ServiceException - if any system-level error occurs

getWorkspace

@Deprecated
@Read(K_PORTAL)
String[] getWorkspace()

Deprecated.

this information is no longer available

Gets the current memory profile for the workspace.

Returns:

array of Strings of length 4 describing memory usage:

• [0]Used - Memory Used by the Server so far for storage
• [1]Allocated - Memory allocated for use. Often if a large data item was allocated by a server and subsequently freed, this value will be large compared to "Used". If nearly all memory allocated is in use, this value will be close to (but always higher than) "Used"
• [2]Mapped - is the space used by memory-mapped files
• [3]Available - is the total available memory for the Server process

Note: All usage statistics are in Bytes.

Throws:

ServiceException - if any system-level error occurs

validateGroupMembership

@Deprecated
@Read(K_PORTAL)
boolean validateGroupMembership(Long[] memGroupIds_,
 Long[] admGroupIds_)
                         throws InvalidAnonymousUserException,
InvalidUserException

Deprecated.

No longer necessary with credential system

Validates if the association of a user as 'Member' and as an 'Administrator has changed or not.

Parameters:

memGroupIds_ - Groups for which the User is a member

admGroupIds_ - Groups for which the User is an administrator

Returns:

true if there is not change in the membership of the user

Throws:

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

InvalidUserException - if the user calling this method does not exist

NullPointerException - if any of the input arrays are null

ServiceException - if any system-level error occurs

updateUsernames

@Deprecated
@Write(K_PORTAL)
void updateUsernames(String[] oldUsernames_,
 String[] newUsernames_,
 long maxExpirationTimeInSeconds_)
              throws IllegalArgumentException,
PrivilegeException,
DuplicateNameException

Deprecated.

instead use UserService.renameUsersByUuid(java.lang.String[], java.lang.String[])

DEPRECATED: See UserService.renameUsersByUuid(java.lang.String[], java.lang.String[]) Updates a list of old usernames to new usernames.

If successful, this method must be followed by commitUpdateUsernames(). After commitUpdateUsernames has been called, the old usernames will still be active, but will expire after the interval specified by maxExpirationTimeInSeconds_; if updateUsernames is successful but commitUpdateUsernames is not called, the new usernames will not become active.

If unsuccessful, this method should be followed by rollbackUpdateUsernames(). This will simply free memory dedicated to mapping old usernames to new usernames.

Parameters:

oldUsernames_ - the usernames to be updated

newUsernames_ - the usernames to which the old usernames will be updated

maxExpirationTimeInSeconds_ - the interval, in seconds, after commitUpdateUsernames has been called, after which the old usernames will expire. If this parameter is zero or a negative value the old usernames will expire instantly. After expiration, the old usernames will no longer be valid.

Throws:

IllegalArgumentException - if the length of oldUsernames_ is not the same as the length of newUsernames_.

PrivilegeException - if the current user is not a system administrator

DuplicateNameException - if any oldUsernames_ or newUsernames_ contain any duplicates, or if an old username is being updated to a username that already exists

ServiceException - if any system-level error occurs

commitUpdateUsernames

@Deprecated
@Write(K_PORTAL)
void commitUpdateUsernames()

Deprecated.

instead use UserService.renameUsersByUuid(java.lang.String[], java.lang.String[])

DEPRECATED: See UserService.renameUsersByUuid(java.lang.String[], java.lang.String[]) Commits an update of usernames.

This method should be preceded by a call to updateUsernames(String[], String[], long). After the commit, the old usernames will be temporarily active, and will expire after the interval specified by maxExpirationTimeInSeconds_; if commitUpdateUsernames is not called, the new usernames will not become active.

Throws:

ServiceException - if any system-level error occurs

rollbackUpdateUsernames

@Deprecated
@Write(K_PORTAL)
void rollbackUpdateUsernames()

Deprecated.

instead use UserService.renameUsersByUuid(java.lang.String[], java.lang.String[])

DEPRECATED: See UserService.renameUsersByUuid(java.lang.String[], java.lang.String[]) Rolls back an update of usernames.

This method should be called if updateUsernames(String[], String[], long) is unsuccessful. The rollback will simply free memory dedicated to mapping old usernames to new usernames.

Throws:

ServiceException - if any system-level error occurs

reloadProperties

@Deprecated
@Read(K_PORTAL)
void reloadProperties()

Deprecated.

reloading properties is now automatic, so this call is now unnecessary and does nothing.

Reloads all database-level properties files (*.xml, *.properties) without interrupting API services

Throws:

ServiceException - if any system-level error occurs

validate

@Deprecated
@Read(K_PORTAL)
String validate()

Deprecated.

use the validate diagnostic script instead

Runs validation tests against the database to check whether it is corrupt, and returns a line-separated list of validation results

Returns:

the validation results

Throws:

ServiceException - if any system-level error occurs

getSiteLocaleSettings

@Read(K_PORTAL)
SiteLocaleSettings getSiteLocaleSettings()

Deprecated.

Returns the site locale settings for the administration server Use GlobalizationService.getSiteLocaleSettings() to get site locale setting for the entire site.

setSiteLocaleSettings

@Write(K_PORTAL)
void setSiteLocaleSettings(SiteLocaleSettings settings_)
                    throws PrivilegeException

Deprecated.

Registers the site local settings for the administration server. Use GlobalizationService.setSiteLocaleSettings(SiteLocaleSettings) to register site locale setting for entire site. All the properties in the SiteLocaleSettings parameter must be populated. The locale settings that have already been set are going to be preserved. It is required that the primary locale is present and enabled in the array of locale settings.

Throws:

PrivilegeException - if the current user is not a portal administrator

getSiteTimeZoneSettings

@Read(K_PORTAL)
SiteTimeZoneSettings getSiteTimeZoneSettings()

Deprecated.

Gets the site timezone settings for the adminstration server Use GlobalizationService.getSiteTimeZoneSettings() to get the timezone settings of the entire site.

setSiteTimeZoneSettings

@Write(K_PORTAL)
void setSiteTimeZoneSettings(SiteTimeZoneSettings timezoneSettings_)

Deprecated.

Registers the site timezone settings for the administration server. Use GlobalizationService.setSiteTimeZoneSettings(SiteTimeZoneSettings) to set the timezone settings for the entire site.

getSiteCalendarSettings

@Read(K_PORTAL)
SiteCalendarSettings getSiteCalendarSettings()

Deprecated.

Gets the calendar settings for the administration server Use GlobalizationService.getSiteCalendarSettings() to get the calendar settings of the entire site.

setSiteCalendarSettings

@Write(K_PORTAL)
void setSiteCalendarSettings(SiteCalendarSettings settings_)

Deprecated.

Registers the calendar setting for the administration server. Use GlobalizationService.setSiteCalendarSettings(SiteCalendarSettings) to set the calendar settings for the entire site.

getSystemPageId

@Read(K_PORTAL)
Long getSystemPageId(@ConvertWith(com.appiancorp.kougar.mapper.parameters.UuidParameterConverter.class)
 String systemPageUuid)

Deprecated.

Gets the system page id corresponding to the given UUID. System pages UUIDs include:

 "SYSTEM_PAGE_PORTAL_HOME"
 "SYSTEM_PAGE_PORTAL_LICENSE_ADMINISTRATION"
 "SYSTEM_PAGE_PORTAL_SERVICES"
 "SYSTEM_PAGE_PORTAL_PROCESS_KOUGAR_MONITOR"
 "SYSTEM_PAGE_PORTAL_REAL_TIME_MONITOR"
 "SYSTEM_PAGE_PORTAL_START_PAGE_SETTINGS"
 "SYSTEM_PAGE_PORTAL_CREATE_AN_ADMIN_PAGE"
 "SYSTEM_PAGE_PORTAL_SET_WORKING_TIME"
 "SYSTEM_PAGE_PORTAL_NAVIGATION_BUTTONS"
 "SYSTEM_PAGE_PORTAL_DATA_TYPES"
 "SYSTEM_PAGE_PROCESS_MODEL_DASHBOARD"
 "SYSTEM_PAGE_PROCESS_DASHBOARD"
 

Parameters:

systemPageUuid - one of the UUIDs listed above