com.appiancorp.suiteapi.portal.portlets.links

Interface LinksService

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 LinksService
extends com.appiancorp.services.ContextSensitiveService

Defines methods for the creation and organization of links.
A Link is similar to but more general than a typical url link; it can store urls with name and description, but equally contain the information to point to other Appian objects such as

• documents (see Document)
• portal pages (see Page)
• folders (see Folder)
• knowledge centers (see KnowledgeCenter)
• communities (see Community)
• threads (see DiscussionThread)
• forums (see Forum)
• external pages through secure connection
• external pages through insecure connection
• emails.

The links can be organized into folders, or be associated with LocalObjects, using moveLinkToLocalObject(java.lang.Long, com.appiancorp.suiteapi.common.LocalObject) after the link is created. Currently the supported LocalObject types are:

• User
• Group
• Portlet

Folders can be organized into subfolders or be associated with LocalObjects by calling moveFolderToLocalObject(java.lang.Long, com.appiancorp.suiteapi.common.LocalObject) after the folder is created. Again only User, Group, and Portlet local objects are supported.

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:

Folder, Link

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	commitUpdateUsernames$UPDATES Deprecated.
static boolean	createFolder$UPDATES Deprecated.
static boolean	createLink$UPDATES Deprecated.
static boolean	createLinkType$UPDATES Deprecated.
static boolean	createRootFolder$UPDATES Deprecated.
static boolean	createRootLink$UPDATES Deprecated.
static boolean	deleteFolder$UPDATES Deprecated.
static boolean	deleteLink$UPDATES Deprecated.
static boolean	deleteLinkType$UPDATES Deprecated.
static boolean	findFoldersPaging$UPDATES Deprecated.
static boolean	findLinksPaging$UPDATES Deprecated.
static boolean	findLinkTypesPaging$UPDATES Deprecated.
static boolean	getChildFolders$UPDATES Deprecated.
static boolean	getChildLinks$UPDATES Deprecated.
static boolean	getFolder$UPDATES Deprecated.
static boolean	getFolderIdsByLocalObject$UPDATES Deprecated.
static boolean	getFoldersByLocalObject$UPDATES Deprecated.
static boolean	getLink$UPDATES Deprecated.
static boolean	getLinkIdsByLocalObject$UPDATES Deprecated.
static boolean	getLinksByLocalObject$UPDATES Deprecated.
static boolean	getLinkType$UPDATES Deprecated.
static boolean	getLinkTypes$UPDATES Deprecated.
static boolean	getLocalObjectForFolder$UPDATES Deprecated.
static boolean	getLocalObjectForLink$UPDATES Deprecated.
static boolean	getTreeAtFolder$UPDATES Deprecated.
static boolean	moveFolderToFolder$UPDATES Deprecated.
static boolean	moveFolderToLocalObject$UPDATES Deprecated.
static boolean	moveFolderWithinParent$UPDATES Deprecated.
static boolean	moveLinkToFolder$UPDATES Deprecated.
static boolean	moveLinkToLocalObject$UPDATES Deprecated.
static boolean	moveLinkWithinParent$UPDATES Deprecated.
static boolean	registerLinkType$UPDATES Deprecated.
static boolean	reloadProperties$UPDATES Deprecated.
static boolean	rollbackUpdateUsernames$UPDATES Deprecated.
static boolean	shiftFolderWithinParent$UPDATES Deprecated.
static boolean	shiftLinkWithinParent$UPDATES Deprecated.
static boolean	updateFolder$UPDATES Deprecated.
static boolean	updateLink$UPDATES Deprecated.
static boolean	updateLinkType$UPDATES Deprecated.
static boolean	updateUsernames$UPDATES Deprecated.
static boolean	validate$UPDATES Deprecated.
static boolean	validateDatabase$UPDATES Deprecated.

Fields inherited from interface com.appiancorp.services.ContextSensitiveService

SET_SERVICE_CONTEXT_METHOD_NAME

Method Summary

Modifier and Type	Method and Description
void	commitUpdateUsernames() Deprecated. instead use UserService.renameUsersByUuid(java.lang.String[], java.lang.String[])
java.lang.Long	createFolder(java.lang.Long parentFolderId_, Folder f_) Deprecated. Create a non-root Folder Minimum properties which must be populated on the Folder are: none
java.lang.Long	createLink(java.lang.Long parentFolderId_, Link l_) Deprecated. Create a Link within a Folder.
java.lang.Long	createLinkType(LinkType lt_) Deprecated. Create a LinkType. There may be a maximum of 255 link types. Note that this method, unlike registerLinkType(com.appiancorp.suiteapi.portal.portlets.links.LinkType) will create another link type even if there exists a link type with the same name. Minimum properties which must be populated on the LinkType are: none
java.lang.Long	createRootFolder(Folder f_) Deprecated. Create a root Folder.
java.lang.Long	createRootLink(Link link_) Deprecated. Create a root Link.
void	deleteFolder(java.lang.Long folderId_) Deprecated. Delete a Folder.
void	deleteLink(java.lang.Long linkId_) Deprecated. Delete a Link.
void	deleteLinkType(java.lang.Long linkTypeId_) Deprecated. Delete a LinkType.
ResultPage	findFoldersPaging(Folder searchFolder_, int index_, int count_) Deprecated. Searches through names of all created folders.
ResultPage	findLinksPaging(Link searchLink_, int index_, int count_) Deprecated. Searches through names and descriptions of all created links.
ResultPage	findLinkTypesPaging(LinkType searchLinkType_, int index_, int count_) Deprecated. Searches through names and descriptions of all link types.
Folder[]	getChildFolders(java.lang.Long folderId_) Deprecated. Get an array of direct child folders of a Folder
Link[]	getChildLinks(java.lang.Long folderId_) Deprecated. Get an array of direct child links of a Folder
Folder	getFolder(java.lang.Long folderId_) Deprecated. Get a Folder.
java.lang.Long[]	getFolderIdsByLocalObject(LocalObject parent_) Deprecated. Get IDs of all the folders whose parent is the specified LocalObject Only the IDs of folders that are the direct children of the local object will be returned; the IDs of their sub-folders will not.
Folder[]	getFoldersByLocalObject(LocalObject parent_) Deprecated. Get all the folders whose parent is the specified LocalObject.
Link	getLink(java.lang.Long linkId_) Deprecated. Retrieve a Link.
java.lang.Long[]	getLinkIdsByLocalObject(LocalObject parent_) Deprecated. Get the IDs of all the links whose parent is the specified LocalObject Only the IDs of links that are the direct children of the local object will be returned.
Link[]	getLinksByLocalObject(LocalObject parent_) Deprecated. Get all the links whose parent is the specified LocalObject Only links that are the direct children of the local object will be returned.
LinkType	getLinkType(java.lang.Long linkTypeId_) Deprecated. Get a single LinkType.
LinkType[]	getLinkTypes() Deprecated. Get all created link types
LocalObject	getLocalObjectForFolder(java.lang.Long folderId_) Deprecated. Get the LocalObject that is the parent of the Folder.
LocalObject	getLocalObjectForLink(java.lang.Long linkId_) Deprecated. Get the LocalObject that is the parent of the Link
TreePivot	getTreeAtFolder(java.lang.Long folderId_, int depth_) Deprecated. Get a TreePivot containing the Folder, the upward path to but not including the root Folder, and all the folder's descendants to the specified depth.
void	moveFolderToFolder(java.lang.Long folderToMoveId_, java.lang.Long newContainingFolderId_) Deprecated. Move a Folder so that it becomes a child of a specified Folder.
void	moveFolderToLocalObject(java.lang.Long folderId_, LocalObject parent_) Deprecated. Make a Folder a child of a LocalObject
void	moveFolderWithinParent(java.lang.Long folderId_, int newPosition_) Deprecated. Change a folder's position versus the other contents (both links and folders) of its parent.
void	moveLinkToFolder(java.lang.Long linkId_, java.lang.Long newContainingFolderId_) Deprecated. Move a Link so that its parent is a given Folder
void	moveLinkToLocalObject(java.lang.Long linkId_, LocalObject parent_) Deprecated. Make a Link a child of a LocalObject
void	moveLinkWithinParent(java.lang.Long linkId_, int newPosition_) Deprecated. Change a link's position versus the other contents (links and folders) of its parent.
java.lang.Long	registerLinkType(LinkType lt_) Deprecated. Create a LinkType if necessary, updating it instead if already present.
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	shiftFolderWithinParent(java.lang.Long folderId_, int relativeOffset_) Deprecated. Change a folder's position versus the other folders of its parent.
void	shiftLinkWithinParent(java.lang.Long linkId_, int relativeOffset_) Deprecated. Change a link's position versus the other links of its parent.
void	updateFolder(Folder f_) Deprecated. Update a Folder Minimum properties which must be populated on the Folder are: id
void	updateFolder(Folder[] fs_) Deprecated. Update folders Minimum properties which must be populated on the Folder are: id
void	updateLink(Link l_) Deprecated. Update a Link.
void	updateLink(Link[] ls_) Deprecated. Update links Minimum properties which must be populated on a Link are: id, newWindow, linkTypeId
void	updateLinkType(LinkType lt_) Deprecated. Update an existing LinkType.
void	updateLinkType(LinkType[] lts_) Deprecated. Update existing link types.
void	updateUsernames(java.lang.String[] oldUsernames_, java.lang.String[] newUsernames_, long maxExpirationTimeInSeconds_) Deprecated. instead use UserService.renameUsersByUuid(java.lang.String[], java.lang.String[])
java.lang.String	validate() Deprecated. Runs validation tests against the database to check whether it is corrupt, and returns a line-separated list of validation results
DatabaseStatus	validateDatabase(int thoroughness_) Deprecated. Performs validation on the database(s) associated with this service.

Methods inherited from interface com.appiancorp.services.ContextSensitiveService

setServiceContext

Field Detail

createRootFolder$UPDATES

static final boolean createRootFolder$UPDATES

Deprecated.

See Also:

Constant Field Values

createRootLink$UPDATES

static final boolean createRootLink$UPDATES

Deprecated.

See Also:

Constant Field Values

moveFolderToLocalObject$UPDATES

static final boolean moveFolderToLocalObject$UPDATES

Deprecated.

See Also:

Constant Field Values

moveLinkToLocalObject$UPDATES

static final boolean moveLinkToLocalObject$UPDATES

Deprecated.

See Also:

Constant Field Values

getLocalObjectForFolder$UPDATES

static final boolean getLocalObjectForFolder$UPDATES

Deprecated.

See Also:

Constant Field Values

getLocalObjectForLink$UPDATES

static final boolean getLocalObjectForLink$UPDATES

Deprecated.

See Also:

Constant Field Values

getFoldersByLocalObject$UPDATES

static final boolean getFoldersByLocalObject$UPDATES

Deprecated.

See Also:

Constant Field Values

getFolderIdsByLocalObject$UPDATES

static final boolean getFolderIdsByLocalObject$UPDATES

Deprecated.

See Also:

Constant Field Values

getLinksByLocalObject$UPDATES

static final boolean getLinksByLocalObject$UPDATES

Deprecated.

See Also:

Constant Field Values

getLinkIdsByLocalObject$UPDATES

static final boolean getLinkIdsByLocalObject$UPDATES

Deprecated.

See Also:

Constant Field Values

createFolder$UPDATES

static final boolean createFolder$UPDATES

Deprecated.

See Also:

Constant Field Values

updateFolder$UPDATES

static final boolean updateFolder$UPDATES

Deprecated.

See Also:

Constant Field Values

deleteFolder$UPDATES

static final boolean deleteFolder$UPDATES

Deprecated.

See Also:

Constant Field Values

getFolder$UPDATES

static final boolean getFolder$UPDATES

Deprecated.

See Also:

Constant Field Values

getChildFolders$UPDATES

static final boolean getChildFolders$UPDATES

Deprecated.

See Also:

Constant Field Values

getChildLinks$UPDATES

static final boolean getChildLinks$UPDATES

Deprecated.

See Also:

Constant Field Values

getTreeAtFolder$UPDATES

static final boolean getTreeAtFolder$UPDATES

Deprecated.

See Also:

Constant Field Values

moveFolderToFolder$UPDATES

static final boolean moveFolderToFolder$UPDATES

Deprecated.

See Also:

Constant Field Values

moveFolderWithinParent$UPDATES

static final boolean moveFolderWithinParent$UPDATES

Deprecated.

See Also:

Constant Field Values

shiftFolderWithinParent$UPDATES

static final boolean shiftFolderWithinParent$UPDATES

Deprecated.

See Also:

Constant Field Values

createLink$UPDATES

static final boolean createLink$UPDATES

Deprecated.

See Also:

Constant Field Values

updateLink$UPDATES

static final boolean updateLink$UPDATES

Deprecated.

See Also:

Constant Field Values

deleteLink$UPDATES

static final boolean deleteLink$UPDATES

Deprecated.

See Also:

Constant Field Values

getLink$UPDATES

static final boolean getLink$UPDATES

Deprecated.

See Also:

Constant Field Values

moveLinkToFolder$UPDATES

static final boolean moveLinkToFolder$UPDATES

Deprecated.

See Also:

Constant Field Values

moveLinkWithinParent$UPDATES

static final boolean moveLinkWithinParent$UPDATES

Deprecated.

See Also:

Constant Field Values

shiftLinkWithinParent$UPDATES

static final boolean shiftLinkWithinParent$UPDATES

Deprecated.

See Also:

Constant Field Values

registerLinkType$UPDATES

static final boolean registerLinkType$UPDATES

Deprecated.

See Also:

Constant Field Values

createLinkType$UPDATES

static final boolean createLinkType$UPDATES

Deprecated.

See Also:

Constant Field Values

updateLinkType$UPDATES

static final boolean updateLinkType$UPDATES

Deprecated.

See Also:

Constant Field Values

deleteLinkType$UPDATES

static final boolean deleteLinkType$UPDATES

Deprecated.

See Also:

Constant Field Values

getLinkType$UPDATES

static final boolean getLinkType$UPDATES

Deprecated.

See Also:

Constant Field Values

getLinkTypes$UPDATES

static final boolean getLinkTypes$UPDATES

Deprecated.

See Also:

Constant Field Values

findLinksPaging$UPDATES

static final boolean findLinksPaging$UPDATES

Deprecated.

See Also:

Constant Field Values

findLinkTypesPaging$UPDATES

static final boolean findLinkTypesPaging$UPDATES

Deprecated.

See Also:

Constant Field Values

findFoldersPaging$UPDATES

static final boolean findFoldersPaging$UPDATES

Deprecated.

See Also:

Constant Field Values

updateUsernames$UPDATES

static final boolean updateUsernames$UPDATES

Deprecated.

See Also:

Constant Field Values

commitUpdateUsernames$UPDATES

static final boolean commitUpdateUsernames$UPDATES

Deprecated.

See Also:

Constant Field Values

rollbackUpdateUsernames$UPDATES

static final boolean rollbackUpdateUsernames$UPDATES

Deprecated.

See Also:

Constant Field Values

reloadProperties$UPDATES

static final boolean reloadProperties$UPDATES

Deprecated.

See Also:

Constant Field Values

validate$UPDATES

static final boolean validate$UPDATES

Deprecated.

See Also:

Constant Field Values

validateDatabase$UPDATES

static final boolean validateDatabase$UPDATES

Deprecated.

See Also:

Constant Field Values

Method Detail

createRootFolder

java.lang.Long createRootFolder(Folder f_)

Deprecated.

Create a root Folder. This Folder is the ultimate ancestor of all folders and links Link within the tree of which it is the root. Minimum properties which must be populated on the Folder object are: none Note: A root folder is merely a normal folder with no parent Folder or parent LocalObject.

Parameters:

f_ - the Folder to be created. The ID field is ignored because it is assigned by the service.

Returns:

the ID for the new Folder.

Throws:

ServiceException - if any system-level error occurs

createRootLink

java.lang.Long createRootLink(Link link_)

Deprecated.

Create a root Link. Minimum properties which must be populated on the Link are: newWindow and linkTypeId

Parameters:

link_ - the Link to be created. The ID field is ignored because it is assigned by the service.

Returns:

the ID for the new Link.

Throws:

ServiceException - if any system-level error occurs

moveFolderToLocalObject

void moveFolderToLocalObject(java.lang.Long folderId_,
                             LocalObject parent_)
                      throws InvalidFolderException

Deprecated.

Make a Folder a child of a LocalObject

Parameters:

folderId_ - the ID of the Folder.

parent_ - the LocalObject representing the parent of the Folder

Throws:

InvalidFolderException - if the Folder with the given ID does not exist

ServiceException - if any system-level error occurs

See Also:

LocalObject

moveLinkToLocalObject

void moveLinkToLocalObject(java.lang.Long linkId_,
                           LocalObject parent_)
                    throws InvalidLinkException

Deprecated.

Make a Link a child of a LocalObject

Parameters:

linkId_ - the ID of the Link.

parent_ - the LocalObject representing the parent of the Link

Throws:

InvalidlLinkException - if no Link with the given ID exists

ServiceException - if any system-level error occurs

InvalidLinkException

See Also:

LocalObject

getLocalObjectForFolder

LocalObject getLocalObjectForFolder(java.lang.Long folderId_)
                             throws InvalidFolderException

Deprecated.

Get the LocalObject that is the parent of the Folder.

Parameters:

folderId_ - the ID of the Folder

Returns:

the LocalObject representing the parent of the Folder. If there is no related LocalObject, an InvalidFolderException is thrown.

Throws:

InvalidFolderException - if no Folder with the given ID exists or if the folder has no related LocalObject.

ServiceException - if any system-level error occurs

getLocalObjectForLink

LocalObject getLocalObjectForLink(java.lang.Long linkId_)
                           throws InvalidLinkException

Deprecated.

Get the LocalObject that is the parent of the Link

Parameters:

linkId_ - the ID of the Link

Returns:

the LocalObject representing the parent of the Link If there is no related LocalObject, an InvalidLinkException is thrown.

Throws:

InvalidLinkException - if the Link does not exist or when passing in a root Link which has no LocalObject parent as a parameter

ServiceException - if any system-level error occurs

getFoldersByLocalObject

Folder[] getFoldersByLocalObject(LocalObject parent_)
                          throws InvalidLocalObjectTypeException

Deprecated.

Get all the folders whose parent is the specified LocalObject. Only folders that are the direct children of the local object will be returned; their sub-folders will not.

Parameters:

parent_ - the LocalObject whose child folders are to be retrieved

Returns:

the child folders.

Throws:

ServiceException - if any system-level error occurs

InvalidLocalObjectTypeException - if the local object is invalid. LocalObject types that are supported are:

• User
• Group
• Portlet
• Folder

getFolderIdsByLocalObject

java.lang.Long[] getFolderIdsByLocalObject(LocalObject parent_)
                                    throws InvalidLocalObjectTypeException

Deprecated.

Get IDs of all the folders whose parent is the specified LocalObject Only the IDs of folders that are the direct children of the local object will be returned; the IDs of their sub-folders will not.

Parameters:

parent_ - the LocalObject whose child folder IDs are to be retrieved

Returns:

IDs for all the child folders.

Throws:

InvalidLocalObjectTypeException - if the local object is invalid. LocalObject types that are supported are:

• User
• Group
• Portlet
• Folder

ServiceException - if any system-level error occurs

getLinksByLocalObject

Link[] getLinksByLocalObject(LocalObject parent_)
                      throws InvalidLocalObjectTypeException

Deprecated.

Get all the links whose parent is the specified LocalObject Only links that are the direct children of the local object will be returned.

Parameters:

parent_ - the LocalObject whose child links are to be retrieved

Returns:

all the child links.

Throws:

ServiceException - if any system-level error occurs

InvalidLocalObjectTypeException - If the local object is invalid. LocalObject types that are supported are:

• User
• Group
• Portlet
• Folder

getLinkIdsByLocalObject

java.lang.Long[] getLinkIdsByLocalObject(LocalObject parent_)
                                  throws InvalidLocalObjectTypeException

Deprecated.

Get the IDs of all the links whose parent is the specified LocalObject Only the IDs of links that are the direct children of the local object will be returned.

Parameters:

parent_ - the LocalObject whose child link IDs are to be retrieved

Returns:

IDs for all the child links.

Throws:

InvalidLocalObjectTypeException - If the local object is invalid. LocalObject types that are supported are:

• User
• Group
• Portlet
• Folder

ServiceException - if any system-level error occurs

createFolder

java.lang.Long createFolder(java.lang.Long parentFolderId_,
                            Folder f_)
                     throws InvalidFolderException

Deprecated.

Create a non-root Folder Minimum properties which must be populated on the Folder are: none

Parameters:

parentFolderId_ - The ID of the parent Folder within which this Folder will be created.

f_ - The Folder to create. The id field is ignored.

Returns:

The ID for the new Folder.

Throws:

InvalidFolderException - if the parent folder ID does not correspond to a valid folder

ServiceException - if any system-level error occurs

updateFolder

void updateFolder(Folder f_)
           throws InvalidFolderException

Deprecated.

Update a Folder Minimum properties which must be populated on the Folder are: id

Parameters:

f_ - the new values for the Folder.

Throws:

InvalidFolderException - if the ID of the Folder object does not correspond to a valid folder

ServiceException - if any system-level error occurs

updateFolder

void updateFolder(Folder[] fs_)
           throws InvalidFolderException

Deprecated.

Update folders Minimum properties which must be populated on the Folder are: id

Parameters:

fs_ - the new values for the folders.

Throws:

InvalidFolderException - if the ID of any of the Folder objects does not correspond to a valid folder

ServiceException - if any system-level error occurs

deleteFolder

void deleteFolder(java.lang.Long folderId_)
           throws InvalidFolderException

Deprecated.

Delete a Folder.
When a Folder is deleted, all its descendent folders and links are also deleted.

Parameters:

folderId_ - the ID of the Folder to delete.

Throws:

InvalidFolderException - If the folder ID does not correspond to a valid folder

ServiceException - if any system-level error occurs

getFolder

Folder getFolder(java.lang.Long folderId_)
          throws InvalidFolderException

Deprecated.

Get a Folder.

Parameters:

folderId_ - the ID of the Folder to retrieve.

Returns:

the Folder.

Throws:

InvalidFolderException - if the Folder ID does not correspond to a valid folder

ServiceException - if any system-level error occurs

getChildFolders

Folder[] getChildFolders(java.lang.Long folderId_)
                  throws InvalidFolderException

Deprecated.

Get an array of direct child folders of a Folder

Parameters:

folderId_ - the ID of the Folder whose child folders are to be returned

Returns:

the direct child folders

Throws:

InvalidFolderException - if the folder ID does not correspond to a valid folder

ServiceException - if any system-level error occurs

getChildLinks

Link[] getChildLinks(java.lang.Long folderId_)
              throws InvalidFolderException

Deprecated.

Get an array of direct child links of a Folder

Parameters:

folderId_ - the ID of the Folder whose child links are to be returned

Returns:

the direct child links

Throws:

InvalidFolderException - if the folder ID does not correspond to a valid folder

ServiceException - if any system-level error occurs

getTreeAtFolder

TreePivot getTreeAtFolder(java.lang.Long folderId_,
                          int depth_)
                   throws InvalidFolderException

Deprecated.

Get a TreePivot containing the Folder, the upward path to but not including the root Folder, and all the folder's descendants to the specified depth. The tree pivot contains an array of TreeNodes which will either contain a Folder or Link in their data field

Parameters:

folderId_ - The Folder on which to pivot.

depth_ - The depth to which to return children. Zero returns no children, -1 returns all descendants.

Returns:

the TreePivot

Throws:

InvalidFolderException - if the folder ID does not correspond to a valid folder

ServiceException - if any system-level error occurs

moveFolderToFolder

void moveFolderToFolder(java.lang.Long folderToMoveId_,
                        java.lang.Long newContainingFolderId_)
                 throws InvalidFolderException,
                        RecursiveRelationshipException

Deprecated.

Move a Folder so that it becomes a child of a specified Folder.

Parameters:

folderToMoveId_ - the ID of the Folder to move.

newContainingFolderId_ - the ID of the new parent Folder.

Throws:

InvalidFolderException - if either folder ID does not correspond to a valid folder

RecursiveRelationshipException - if newContainingFolderId_ is equal to folderToMoveId_, or if newContainingFolderId_ is equal to any of the child folder IDs of the folder to be moved

ServiceException - if any system-level error occurs

moveFolderWithinParent

void moveFolderWithinParent(java.lang.Long folderId_,
                            int newPosition_)
                     throws InvalidFolderException

Deprecated.

Change a folder's position versus the other contents (both links and folders) of its parent. Its parent can be either a Folder or a LocalObject.

Parameters:

folderId_ - The ID of the Folder to move.

newPosition_ - The new position (0-based) for the Folder. If this value is equal to or greater than the number of content items, then the Folder is moved to the end. If newPosition is less than 0, then it will be normalized to be 0.

Throws:

InvalidFolderException - if the folder ID does not correspond to a valid folder

ServiceException - if any system-level error occurs

shiftFolderWithinParent

void shiftFolderWithinParent(java.lang.Long folderId_,
                             int relativeOffset_)
                      throws InvalidFolderException

Deprecated.

Change a folder's position versus the other folders of its parent. Its parent can be either a Folder or a LocalObject

Parameters:

folderId_ - the ID of the Folder to move.

relativeOffset_ - this should be positive to increase the folder's index in the folder array, and negative to decrease the folder's index in the folder array. If the offset would move the folder before the beginning or after the end of the folder array, the folder will be moved to the beginning or to the end respectively.

Throws:

InvalidFolderException - if the folder ID does not correspond to a valid folder

ServiceException - if any system-level error occurs

createLink

java.lang.Long createLink(java.lang.Long parentFolderId_,
                          Link l_)
                   throws InvalidFolderException

Deprecated.

Create a Link within a Folder. Minimum properties which must be populated on the Link are: newWindow, linkTypeId

Parameters:

parentFolderId_ - the ID of the Folder in which to place the new Link.

l_ - The new Link. The ID field will be ignored.

Returns:

the ID of the new link.

Throws:

InvalidFolderException - if the parent folder ID does not correspond to a valid folder

ServiceException - if any system-level error occurs

updateLink

void updateLink(Link l_)
         throws InvalidLinkException

Deprecated.

Update a Link. Minimum properties which must be populated on the Link are: id, newWindow, linkTypeId

Parameters:

l_ - the new values for the Link.

Throws:

InvalidLinkException - if the ID of the Link does not correnpond to a valid Link

ServiceException - if any system-level error occurs

updateLink

void updateLink(Link[] ls_)
         throws InvalidLinkException

Deprecated.

Update links Minimum properties which must be populated on a Link are: id, newWindow, linkTypeId

Parameters:

ls_ - The new values for the links.

Throws:

InvalidLinkException - If any of the IDs of the links does not correnpond to a valid Link

ServiceException - if any system-level error occurs

deleteLink

void deleteLink(java.lang.Long linkId_)
         throws InvalidLinkException

Deprecated.

Delete a Link.

Parameters:

linkId_ - the ID of the Link to be deleted.

Throws:

InvalidLinkException - if the ID does not correspond to a valid link

ServiceException - if any system-level error occurs

getLink

Link getLink(java.lang.Long linkId_)
      throws InvalidLinkException

Deprecated.

Retrieve a Link.

Parameters:

linkId_ - the ID of the Link to be returned.

Returns:

the link

Throws:

InvalidLinkException - If the ID does not correspond to a valid Link

ServiceException - if any system-level error occurs

moveLinkToFolder

void moveLinkToFolder(java.lang.Long linkId_,
                      java.lang.Long newContainingFolderId_)
               throws InvalidLinkException,
                      InvalidFolderException

Deprecated.

Move a Link so that its parent is a given Folder

Parameters:

linkId_ - the ID of the Link to move.

newContainingFolderId_ - the ID of the new parent Folder.

Throws:

InvalidLinkException - if the the link ID does not correspond to a valid Link

InvalidFolderException - if the folder id does not correspond to a valid Folder

ServiceException - if any system-level error occurs

moveLinkWithinParent

void moveLinkWithinParent(java.lang.Long linkId_,
                          int newPosition_)
                   throws InvalidLinkException

Deprecated.

Change a link's position versus the other contents (links and folders) of its parent. Its parent can be either a Folder or a LocalObject

Parameters:

linkId_ - the ID of the Link to move.

newPosition_ - the new position (0-based) for the Link. If this value is equal to or greater than the number of content items, then the Link is moved to the end. If newPosition is less than 0, then it will be normalized to be 0.

Throws:

InvalidLinkException - if the link ID does not correspond to a valid Link

ServiceException - if any system-level error occurs

shiftLinkWithinParent

void shiftLinkWithinParent(java.lang.Long linkId_,
                           int relativeOffset_)
                    throws InvalidLinkException

Deprecated.

Change a link's position versus the other links of its parent. Its parent can be either a Folder or a LocalObject

Parameters:

linkId_ - the ID of the Link to move.

relativeOffset_ - This should be positive to increase the link's index in the link array, and negative to decrease the links index in the link array. If the offset would move the link before the beginning or after the end of the link array, the link will be moved to the beginning or to the end respectively.

Throws:

InvalidLinkException - if the link ID does not correspond to a valid Link

ServiceException - if any system-level error occurs

registerLinkType

java.lang.Long registerLinkType(LinkType lt_)
                         throws OutOfLinkTypesException

Deprecated.

Create a LinkType if necessary, updating it instead if already present. The link type is primary-keyed on its name property for purposes of registration (ie if a link type already exists which has the same name as the link type which is being registered, then that link type will be updated) Minimum properties which must be populated on the LinkType are: none

Parameters:

lt_ - the link type to register. The ID field will be ignored.

Returns:

the ID for the new link type.

Throws:

OutOfLinkTypesException - if a new link type is being created, adn 255 link types have already been created before this one.

ServiceException - if any system-level error occurs

createLinkType

@Deprecated
java.lang.Long createLinkType(LinkType lt_)
                                   throws OutOfLinkTypesException

Deprecated. Create a LinkType. There may be a maximum of 255 link types. Note that this method, unlike registerLinkType(com.appiancorp.suiteapi.portal.portlets.links.LinkType) will create another link type even if there exists a link type with the same name. Minimum properties which must be populated on the LinkType are: none

Parameters:

lt_ - the link type to create. The ID field will be ignored.

Returns:

the ID for the new link type.

Throws:

OutOfLinkTypesException - if 255 link types have already been created before this one.

ServiceException - if any system-level error occurs

updateLinkType

void updateLinkType(LinkType lt_)
             throws InvalidLinkTypeException

Deprecated.

Update an existing LinkType. Minimum properties which must be populated on the LinkType are: id

Parameters:

lt_ - the link type to be updated

Throws:

InvalidLinkTypeException - if the id of the link type does not correspond to a valid link type

ServiceException - if any system-level error occurs

updateLinkType

void updateLinkType(LinkType[] lts_)
             throws InvalidLinkTypeException

Deprecated.

Update existing link types. Minimum properties which must be populated on each LinkType are: id

Parameters:

lts_ - The new values for the link types.

Throws:

InvalidLinkTypeException - If any of the link type IDs does not correspond to a valid link type

ServiceException - if any system-level error occurs

deleteLinkType

void deleteLinkType(java.lang.Long linkTypeId_)
             throws InvalidLinkTypeException

Deprecated.

Delete a LinkType.

Parameters:

linkTypeId_ - the ID of the link type to delete.

Throws:

InvalidLinkTypeException - if the link type ID does not correspond to a valid link type

ServiceException - if any system-level error occurs

getLinkType

LinkType getLinkType(java.lang.Long linkTypeId_)
              throws InvalidLinkTypeException

Deprecated.

Get a single LinkType.

Parameters:

linkTypeId_ - The ID of the link type to retrieve

Returns:

the link type.

Throws:

InvalidLinkTypeException - if the link type ID does not correspond to a valid link type

ServiceException - if any system-level error occurs

getLinkTypes

LinkType[] getLinkTypes()

Deprecated.

Get all created link types

Returns:

all the link types.

Throws:

ServiceException - if any system-level error occurs

findLinksPaging

ResultPage findLinksPaging(Link searchLink_,
                           int index_,
                           int count_)

Deprecated.

Searches through names and descriptions of all created links. The search bean contains nulls for match-all wildcards. java.lang.String items are matched using regular expressions (e.g., "ab*" matches those items beginning with "ab"); items of any other type are exact-matched.

Parameters:

searchLink_ - the Link used in the search

index_ - the index of the first Link that will be returned

count_ - the number of links to be returned in the ResultPage

Returns:

a ResultPage containing the list of Link objects matching the search terms

Throws:

ServiceException - if any system-level error occurs

findLinkTypesPaging

ResultPage findLinkTypesPaging(LinkType searchLinkType_,
                               int index_,
                               int count_)

Deprecated.

Searches through names and descriptions of all link types. The search bean contains nulls for match-all wildcards. java.lang.String items are matched using regular expressions (e.g., "ab*" matches those items beginning with "ab"); items of any other type are exact-matched.

Parameters:

searchLinkType_ - the LinkType used in the search

index_ - the index of the first LinkType that will be returned

count_ - the number of link types to be returned in the ResultPage

Returns:

a ResultPage containing the list of LinkType objects matching the search terms

Throws:

ServiceException - if any system-level error occurs

findFoldersPaging

ResultPage findFoldersPaging(Folder searchFolder_,
                             int index_,
                             int count_)

Deprecated.

Searches through names of all created folders. The search bean contains nulls for match-all wildcards. java.lang.String items are matched using regular expressions (e.g., "ab*" matches those items beginning with "ab"); items of any other type are exact-matched.

Parameters:

searchFolder_ - the Folder used in the search

index_ - the index of the first Folder that will be returned

count_ - the number of folders to be returned in the ResultPage

Returns:

a ResultPage containing the list of Folder objects matching the search terms

Throws:

ServiceException - if any system-level error occurs

updateUsernames

@Deprecated
void updateUsernames(java.lang.String[] oldUsernames_,
                                 java.lang.String[] newUsernames_,
                                 long maxExpirationTimeInSeconds_)
                          throws java.lang.IllegalArgumentException,
                                 DuplicateNameException

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

DEPRECATED: See UserService.renameUsersByUuid(java.lang.String[], java.lang.String[])

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:

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

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

java.lang.String validate()

Deprecated.

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

validateDatabase

DatabaseStatus validateDatabase(int thoroughness_)

Deprecated.

Performs validation on the database(s) associated with this service.

Parameters:

thoroughness_ - indicates the level of thoroughness of the query. Values are DatabaseStatus.QUICK and DatabaseStatus.SLOW

Returns:

a DatabaseStatus object encapsulating the results of the validation query.