Interface LinksService
- All Superinterfaces:
com.appiancorp.services.ContextSensitiveService
,Service
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
LocalObject
s, using
moveLinkToLocalObject(java.lang.Long, com.appiancorp.suiteapi.common.LocalObject)
after the link is
created.
Currently the supported LocalObject
types are:
Folders can be organized into subfolders or be associated with
LocalObject
s 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.
-
Field Summary
Modifier and TypeFieldDescriptionstatic final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.Fields inherited from interface com.appiancorp.services.ContextSensitiveService
SET_SERVICE_CONTEXT_METHOD_NAME
-
Method Summary
Modifier and TypeMethodDescriptionvoid
Deprecated.createFolder
(Long parentFolderId_, Folder f_) Deprecated.Create a non-rootFolder
Minimum properties which must be populated on theFolder
are: nonecreateLink
(Long parentFolderId_, Link l_) createLinkType
(LinkType lt_) Deprecated.Create aLinkType
.Deprecated.Create a rootFolder
.createRootLink
(Link link_) Deprecated.Create a rootLink
.void
deleteFolder
(Long folderId_) Deprecated.Delete aFolder
.void
deleteLink
(Long linkId_) Deprecated.Delete aLink
.void
deleteLinkType
(Long linkTypeId_) Deprecated.Delete aLinkType
.findFoldersPaging
(Folder searchFolder_, int index_, int count_) Deprecated.Searches through names of all created folders.findLinksPaging
(Link searchLink_, int index_, int count_) Deprecated.Searches through names and descriptions of all created links.findLinkTypesPaging
(LinkType searchLinkType_, int index_, int count_) Deprecated.Searches through names and descriptions of all link types.Folder[]
getChildFolders
(Long folderId_) Deprecated.Get an array of direct child folders of aFolder
Link[]
getChildLinks
(Long folderId_) Deprecated.Get an array of direct child links of aFolder
Deprecated.Get aFolder
.Long[]
getFolderIdsByLocalObject
(LocalObject parent_) Deprecated.Get IDs of all the folders whose parent is the specifiedLocalObject
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 specifiedLocalObject
.Deprecated.Retrieve aLink
.Long[]
getLinkIdsByLocalObject
(LocalObject parent_) Deprecated.Get the IDs of all the links whose parent is the specifiedLocalObject
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 specifiedLocalObject
Only links that are the direct children of the local object will be returned.getLinkType
(Long linkTypeId_) Deprecated.Get a singleLinkType
.LinkType[]
Deprecated.Get all created link typesgetLocalObjectForFolder
(Long folderId_) Deprecated.Get theLocalObject
that is the parent of theFolder
.getLocalObjectForLink
(Long linkId_) Deprecated.Get theLocalObject
that is the parent of theLink
getTreeAtFolder
(Long folderId_, int depth_) Deprecated.void
moveFolderToFolder
(Long folderToMoveId_, Long newContainingFolderId_) Deprecated.Move aFolder
so that it becomes a child of a specifiedFolder
.void
moveFolderToLocalObject
(Long folderId_, LocalObject parent_) Deprecated.Make aFolder
a child of aLocalObject
void
moveFolderWithinParent
(Long folderId_, int newPosition_) Deprecated.Change a folder's position versus the other contents (both links and folders) of its parent.void
moveLinkToFolder
(Long linkId_, Long newContainingFolderId_) void
moveLinkToLocalObject
(Long linkId_, LocalObject parent_) Deprecated.Make aLink
a child of aLocalObject
void
moveLinkWithinParent
(Long linkId_, int newPosition_) Deprecated.Change a link's position versus the other contents (links and folders) of its parent.registerLinkType
(LinkType lt_) Deprecated.Create aLinkType
if necessary, updating it instead if already present.void
Deprecated.reloading properties is now automatic, so this call is now unnecessary and does nothing.void
Deprecated.void
shiftFolderWithinParent
(Long folderId_, int relativeOffset_) Deprecated.Change a folder's position versus the other folders of its parent.void
shiftLinkWithinParent
(Long linkId_, int relativeOffset_) Deprecated.Change a link's position versus the other links of its parent.void
updateFolder
(Folder f_) Deprecated.void
updateFolder
(Folder[] fs_) Deprecated.Update folders Minimum properties which must be populated on theFolder
are:id
void
updateLink
(Link l_) Deprecated.Update aLink
.void
updateLink
(Link[] ls_) Deprecated.Update links Minimum properties which must be populated on aLink
are:id
,newWindow
,linkTypeId
void
updateLinkType
(LinkType lt_) Deprecated.Update an existingLinkType
.void
updateLinkType
(LinkType[] lts_) Deprecated.Update existing link types.void
updateUsernames
(String[] oldUsernames_, String[] newUsernames_, long maxExpirationTimeInSeconds_) Deprecated.validate()
Deprecated.Runs validation tests against the database to check whether it is corrupt, and returns a line-separated list of validation resultsvalidateDatabase
(int thoroughness_) Deprecated.Performs validation on the database(s) associated with this service.Methods inherited from interface com.appiancorp.services.ContextSensitiveService
setServiceContext
-
Field Details
-
createRootFolder$UPDATES
static final boolean createRootFolder$UPDATESDeprecated.- See Also:
-
createRootLink$UPDATES
static final boolean createRootLink$UPDATESDeprecated.- See Also:
-
moveFolderToLocalObject$UPDATES
static final boolean moveFolderToLocalObject$UPDATESDeprecated.- See Also:
-
moveLinkToLocalObject$UPDATES
static final boolean moveLinkToLocalObject$UPDATESDeprecated.- See Also:
-
getLocalObjectForFolder$UPDATES
static final boolean getLocalObjectForFolder$UPDATESDeprecated.- See Also:
-
getLocalObjectForLink$UPDATES
static final boolean getLocalObjectForLink$UPDATESDeprecated.- See Also:
-
getFoldersByLocalObject$UPDATES
static final boolean getFoldersByLocalObject$UPDATESDeprecated.- See Also:
-
getFolderIdsByLocalObject$UPDATES
static final boolean getFolderIdsByLocalObject$UPDATESDeprecated.- See Also:
-
getLinksByLocalObject$UPDATES
static final boolean getLinksByLocalObject$UPDATESDeprecated.- See Also:
-
getLinkIdsByLocalObject$UPDATES
static final boolean getLinkIdsByLocalObject$UPDATESDeprecated.- See Also:
-
createFolder$UPDATES
static final boolean createFolder$UPDATESDeprecated.- See Also:
-
updateFolder$UPDATES
static final boolean updateFolder$UPDATESDeprecated.- See Also:
-
deleteFolder$UPDATES
static final boolean deleteFolder$UPDATESDeprecated.- See Also:
-
getFolder$UPDATES
static final boolean getFolder$UPDATESDeprecated.- See Also:
-
getChildFolders$UPDATES
static final boolean getChildFolders$UPDATESDeprecated.- See Also:
-
getChildLinks$UPDATES
static final boolean getChildLinks$UPDATESDeprecated.- See Also:
-
getTreeAtFolder$UPDATES
static final boolean getTreeAtFolder$UPDATESDeprecated.- See Also:
-
moveFolderToFolder$UPDATES
static final boolean moveFolderToFolder$UPDATESDeprecated.- See Also:
-
moveFolderWithinParent$UPDATES
static final boolean moveFolderWithinParent$UPDATESDeprecated.- See Also:
-
shiftFolderWithinParent$UPDATES
static final boolean shiftFolderWithinParent$UPDATESDeprecated.- See Also:
-
createLink$UPDATES
static final boolean createLink$UPDATESDeprecated.- See Also:
-
updateLink$UPDATES
static final boolean updateLink$UPDATESDeprecated.- See Also:
-
deleteLink$UPDATES
static final boolean deleteLink$UPDATESDeprecated.- See Also:
-
getLink$UPDATES
static final boolean getLink$UPDATESDeprecated.- See Also:
-
moveLinkToFolder$UPDATES
static final boolean moveLinkToFolder$UPDATESDeprecated.- See Also:
-
moveLinkWithinParent$UPDATES
static final boolean moveLinkWithinParent$UPDATESDeprecated.- See Also:
-
shiftLinkWithinParent$UPDATES
static final boolean shiftLinkWithinParent$UPDATESDeprecated.- See Also:
-
registerLinkType$UPDATES
static final boolean registerLinkType$UPDATESDeprecated.- See Also:
-
createLinkType$UPDATES
static final boolean createLinkType$UPDATESDeprecated.- See Also:
-
updateLinkType$UPDATES
static final boolean updateLinkType$UPDATESDeprecated.- See Also:
-
deleteLinkType$UPDATES
static final boolean deleteLinkType$UPDATESDeprecated.- See Also:
-
getLinkType$UPDATES
static final boolean getLinkType$UPDATESDeprecated.- See Also:
-
getLinkTypes$UPDATES
static final boolean getLinkTypes$UPDATESDeprecated.- See Also:
-
findLinksPaging$UPDATES
static final boolean findLinksPaging$UPDATESDeprecated.- See Also:
-
findLinkTypesPaging$UPDATES
static final boolean findLinkTypesPaging$UPDATESDeprecated.- See Also:
-
findFoldersPaging$UPDATES
static final boolean findFoldersPaging$UPDATESDeprecated.- See Also:
-
updateUsernames$UPDATES
static final boolean updateUsernames$UPDATESDeprecated.- See Also:
-
commitUpdateUsernames$UPDATES
static final boolean commitUpdateUsernames$UPDATESDeprecated.- See Also:
-
rollbackUpdateUsernames$UPDATES
static final boolean rollbackUpdateUsernames$UPDATESDeprecated.- See Also:
-
reloadProperties$UPDATES
static final boolean reloadProperties$UPDATESDeprecated.- See Also:
-
validate$UPDATES
static final boolean validate$UPDATESDeprecated.- See Also:
-
validateDatabase$UPDATES
static final boolean validateDatabase$UPDATESDeprecated.- See Also:
-
-
Method Details
-
createRootFolder
Deprecated.Create a rootFolder
. ThisFolder
is the ultimate ancestor of all folders and linksLink
within the tree of which it is the root. Minimum properties which must be populated on theFolder
object are: none Note: A root folder is merely a normal folder with no parentFolder
or parentLocalObject
.- Parameters:
f_
- theFolder
to be created. TheID
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
Deprecated.Create a rootLink
. Minimum properties which must be populated on theLink
are:newWindow
andlinkTypeId
- Parameters:
link_
- theLink
to be created. TheID
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
Deprecated.Make aFolder
a child of aLocalObject
- Parameters:
folderId_
- the ID of theFolder
.parent_
- theLocalObject
representing the parent of theFolder
- Throws:
InvalidFolderException
- if theFolder
with the given ID does not existServiceException
- if any system-level error occurs- See Also:
-
moveLinkToLocalObject
Deprecated.Make aLink
a child of aLocalObject
- Parameters:
linkId_
- the ID of theLink
.parent_
- theLocalObject
representing the parent of theLink
- Throws:
InvalidlLinkException
- if noLink
with the given ID existsServiceException
- if any system-level error occursInvalidLinkException
- See Also:
-
getLocalObjectForFolder
Deprecated.Get theLocalObject
that is the parent of theFolder
.- Parameters:
folderId_
- the ID of theFolder
- Returns:
- the
LocalObject
representing the parent of theFolder
. If there is no relatedLocalObject
, anInvalidFolderException
is thrown. - Throws:
InvalidFolderException
- if noFolder
with the given ID exists or if the folder has no relatedLocalObject
.ServiceException
- if any system-level error occurs
-
getLocalObjectForLink
Deprecated.Get theLocalObject
that is the parent of theLink
- Parameters:
linkId_
- the ID of theLink
- Returns:
- the
LocalObject
representing the parent of theLink
If there is no relatedLocalObject
, anInvalidLinkException
is thrown. - Throws:
InvalidLinkException
- if theLink
does not exist or when passing in a rootLink
which has noLocalObject
parent as a parameterServiceException
- if any system-level error occurs
-
getFoldersByLocalObject
Deprecated.Get all the folders whose parent is the specifiedLocalObject
. Only folders that are the direct children of the local object will be returned; their sub-folders will not.- Parameters:
parent_
- theLocalObject
whose child folders are to be retrieved- Returns:
- the child folders.
- Throws:
ServiceException
- if any system-level error occursInvalidLocalObjectTypeException
- if the local object is invalid. LocalObject types that are supported are:
-
getFolderIdsByLocalObject
Deprecated.Get IDs of all the folders whose parent is the specifiedLocalObject
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_
- theLocalObject
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:ServiceException
- if any system-level error occurs
-
getLinksByLocalObject
Deprecated.Get all the links whose parent is the specifiedLocalObject
Only links that are the direct children of the local object will be returned.- Parameters:
parent_
- theLocalObject
whose child links are to be retrieved- Returns:
- all the child links.
- Throws:
ServiceException
- if any system-level error occursInvalidLocalObjectTypeException
- If the local object is invalid. LocalObject types that are supported are:
-
getLinkIdsByLocalObject
Deprecated.Get the IDs of all the links whose parent is the specifiedLocalObject
Only the IDs of links that are the direct children of the local object will be returned.- Parameters:
parent_
- theLocalObject
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:ServiceException
- if any system-level error occurs
-
createFolder
Deprecated.Create a non-rootFolder
Minimum properties which must be populated on theFolder
are: none- Parameters:
parentFolderId_
- The ID of the parentFolder
within which thisFolder
will be created.f_
- TheFolder
to create. Theid
field is ignored.- Returns:
- The ID for the new
Folder
. - Throws:
InvalidFolderException
- if the parent folder ID does not correspond to a valid folderServiceException
- if any system-level error occurs
-
updateFolder
Deprecated.- Parameters:
f_
- the new values for theFolder
.- Throws:
InvalidFolderException
- if the ID of theFolder
object does not correspond to a valid folderServiceException
- if any system-level error occurs
-
updateFolder
Deprecated.Update folders Minimum properties which must be populated on theFolder
are:id
- Parameters:
fs_
- the new values for the folders.- Throws:
InvalidFolderException
- if the ID of any of theFolder
objects does not correspond to a valid folderServiceException
- if any system-level error occurs
-
deleteFolder
Deprecated.- Parameters:
folderId_
- the ID of theFolder
to delete.- Throws:
InvalidFolderException
- If the folder ID does not correspond to a valid folderServiceException
- if any system-level error occurs
-
getFolder
Deprecated.Get aFolder
.- Parameters:
folderId_
- the ID of theFolder
to retrieve.- Returns:
- the
Folder
. - Throws:
InvalidFolderException
- if theFolder
ID does not correspond to a valid folderServiceException
- if any system-level error occurs
-
getChildFolders
Deprecated.Get an array of direct child folders of aFolder
- Parameters:
folderId_
- the ID of theFolder
whose child folders are to be returned- Returns:
- the direct child folders
- Throws:
InvalidFolderException
- if the folder ID does not correspond to a valid folderServiceException
- if any system-level error occurs
-
getChildLinks
Deprecated.Get an array of direct child links of aFolder
- Parameters:
folderId_
- the ID of theFolder
whose child links are to be returned- Returns:
- the direct child links
- Throws:
InvalidFolderException
- if the folder ID does not correspond to a valid folderServiceException
- if any system-level error occurs
-
getTreeAtFolder
Deprecated.Get aTreePivot
containing theFolder
, the upward path to but not including the rootFolder
, and all the folder's descendants to the specified depth. The tree pivot contains an array ofTreeNodes
which will either contain aFolder
orLink
in their data field- Parameters:
folderId_
- TheFolder
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 folderServiceException
- if any system-level error occurs
-
moveFolderToFolder
void moveFolderToFolder(Long folderToMoveId_, Long newContainingFolderId_) throws InvalidFolderException, RecursiveRelationshipException Deprecated.Move aFolder
so that it becomes a child of a specifiedFolder
.- Parameters:
folderToMoveId_
- the ID of theFolder
to move.newContainingFolderId_
- the ID of the new parentFolder
.- Throws:
InvalidFolderException
- if either folder ID does not correspond to a valid folderRecursiveRelationshipException
- ifnewContainingFolderId_
is equal tofolderToMoveId_
, or ifnewContainingFolderId_
is equal to any of the child folder IDs of the folder to be movedServiceException
- if any system-level error occurs
-
moveFolderWithinParent
Deprecated.Change a folder's position versus the other contents (both links and folders) of its parent. Its parent can be either aFolder
or aLocalObject
.- Parameters:
folderId_
- The ID of theFolder
to move.newPosition_
- The new position (0-based) for theFolder
. If this value is equal to or greater than the number of content items, then theFolder
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 folderServiceException
- if any system-level error occurs
-
shiftFolderWithinParent
Deprecated.Change a folder's position versus the other folders of its parent. Its parent can be either aFolder
or aLocalObject
- Parameters:
folderId_
- the ID of theFolder
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 folderServiceException
- if any system-level error occurs
-
createLink
Deprecated.Create aLink
within aFolder
. Minimum properties which must be populated on theLink
are:newWindow
,linkTypeId
- Parameters:
parentFolderId_
- the ID of theFolder
in which to place the newLink
.l_
- The newLink
. TheID
field will be ignored.- Returns:
- the ID of the new link.
- Throws:
InvalidFolderException
- if the parent folder ID does not correspond to a valid folderServiceException
- if any system-level error occurs
-
updateLink
Deprecated.Update aLink
. Minimum properties which must be populated on theLink
are:id
,newWindow
,linkTypeId
- Parameters:
l_
- the new values for theLink
.- Throws:
InvalidLinkException
- if the ID of theLink
does not correnpond to a validLink
ServiceException
- if any system-level error occurs
-
updateLink
Deprecated.Update links Minimum properties which must be populated on aLink
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 validLink
ServiceException
- if any system-level error occurs
-
deleteLink
Deprecated.Delete aLink
.- Parameters:
linkId_
- the ID of theLink
to be deleted.- Throws:
InvalidLinkException
- if the ID does not correspond to a valid linkServiceException
- if any system-level error occurs
-
getLink
Deprecated.Retrieve aLink
.- Parameters:
linkId_
- the ID of theLink
to be returned.- Returns:
- the link
- Throws:
InvalidLinkException
- If the ID does not correspond to a validLink
ServiceException
- if any system-level error occurs
-
moveLinkToFolder
void moveLinkToFolder(Long linkId_, Long newContainingFolderId_) throws InvalidLinkException, InvalidFolderException Deprecated.- Parameters:
linkId_
- the ID of theLink
to move.newContainingFolderId_
- the ID of the new parentFolder
.- Throws:
InvalidLinkException
- if the the link ID does not correspond to a validLink
InvalidFolderException
- if the folder id does not correspond to a validFolder
ServiceException
- if any system-level error occurs
-
moveLinkWithinParent
Deprecated.Change a link's position versus the other contents (links and folders) of its parent. Its parent can be either aFolder
or aLocalObject
- Parameters:
linkId_
- the ID of theLink
to move.newPosition_
- the new position (0-based) for theLink
. If this value is equal to or greater than the number of content items, then theLink
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 validLink
ServiceException
- if any system-level error occurs
-
shiftLinkWithinParent
Deprecated.Change a link's position versus the other links of its parent. Its parent can be either aFolder
or aLocalObject
- Parameters:
linkId_
- the ID of theLink
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 validLink
ServiceException
- if any system-level error occurs
-
registerLinkType
Deprecated.Create aLinkType
if necessary, updating it instead if already present. The link type is primary-keyed on itsname
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 theLinkType
are: none- Parameters:
lt_
- the link type to register. TheID
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.Create aLinkType
. There may be a maximum of 255 link types. Note that this method, unlikeregisterLinkType(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 theLinkType
are: none- Parameters:
lt_
- the link type to create. TheID
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
Deprecated.- Parameters:
lt_
- the link type to be updated- Throws:
InvalidLinkTypeException
- if theid
of the link type does not correspond to a valid link typeServiceException
- if any system-level error occurs
-
updateLinkType
Deprecated.Update existing link types. Minimum properties which must be populated on eachLinkType
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 typeServiceException
- if any system-level error occurs
-
deleteLinkType
Deprecated.Delete aLinkType
.- Parameters:
linkTypeId_
- the ID of the link type to delete.- Throws:
InvalidLinkTypeException
- if the link type ID does not correspond to a valid link typeServiceException
- if any system-level error occurs
-
getLinkType
Deprecated.Get a singleLinkType
.- 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 typeServiceException
- 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
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_
- theLink
used in the searchindex_
- the index of the firstLink
that will be returnedcount_
- the number of links to be returned in theResultPage
- Returns:
- a
ResultPage
containing the list ofLink
objects matching the search terms - Throws:
ServiceException
- if any system-level error occurs
-
findLinkTypesPaging
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_
- theLinkType
used in the searchindex_
- the index of the firstLinkType
that will be returnedcount_
- the number of link types to be returned in theResultPage
- Returns:
- a
ResultPage
containing the list ofLinkType
objects matching the search terms - Throws:
ServiceException
- if any system-level error occurs
-
findFoldersPaging
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_
- theFolder
used in the searchindex_
- the index of the firstFolder
that will be returnedcount_
- the number of folders to be returned in theResultPage
- Returns:
- a
ResultPage
containing the list ofFolder
objects matching the search terms - Throws:
ServiceException
- if any system-level error occurs
-
updateUsernames
@Deprecated void updateUsernames(String[] oldUsernames_, String[] newUsernames_, long maxExpirationTimeInSeconds_) throws IllegalArgumentException, DuplicateNameException Deprecated.DEPRECATED: SeeUserService.renameUsersByUuid(java.lang.String[], java.lang.String[])
If successful, this method must be followed by
commitUpdateUsernames()
. AftercommitUpdateUsernames
has been called, the old usernames will still be active, but will expire after the interval specified bymaxExpirationTimeInSeconds_
; ifupdateUsernames
is successful butcommitUpdateUsernames
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 updatednewUsernames_
- the usernames to which the old usernames will be updatedmaxExpirationTimeInSeconds_
- the interval, in seconds, aftercommitUpdateUsernames
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 ofoldUsernames_
is not the same as the length ofnewUsernames_
.DuplicateNameException
- if anyoldUsernames_
ornewUsernames_
contain any duplicates, or if an old username is being updated to a username that already existsServiceException
- if any system-level error occurs
-
commitUpdateUsernames
Deprecated.DEPRECATED: SeeUserService.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 bymaxExpirationTimeInSeconds_
; ifcommitUpdateUsernames
is not called, the new usernames will not become active.- Throws:
ServiceException
- if any system-level error occurs
-
rollbackUpdateUsernames
Deprecated.DEPRECATED: SeeUserService.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.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
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
Deprecated.Performs validation on the database(s) associated with this service.- Parameters:
thoroughness_
- indicates the level of thoroughness of the query. Values areDatabaseStatus.QUICK
andDatabaseStatus.SLOW
- Returns:
- a
DatabaseStatus
object encapsulating the results of the validation query.
-