public interface ContentService
extends com.appiancorp.services.ContextSensitiveService
This interface provides access to the Content service (formerly the Collaboration
service). Whereas previously there were separate services to deal with different
types of content (e.g., FolderService),
all content can now be manipulated through this interface. The content service comes
with an entirely new API and bean hierarchy, which cannot be used with the old
Collaboration services. Inversely, the old beans cannot be used with the new
Content service.
The methods in this service that check whether a user can act on a content item,
such as canUserView(java.lang.Long, java.lang.String), only permit checking whether the user whose context was
used to obtain the service can act on that item. To check whether another user has
a certain role for the item, use getRoleMap(java.lang.Long, java.lang.Boolean) and check whether the user is
listed for the desired role or is a member of a group in the desired role.
There is also an associated service, the
ContentStatisticsService, which can be used
to get various statistics on content (such as the number of content items fitting
specific criteria).
Type Masks:
Types in Content are all powers of 2. This means that you can specify a filter of
multiple types by using the bitwise or operator |. For instance, if you want to both
documents and folders, you can set your typemask filter to:
ContentConstants.TYPE_FOLDER | ContentConstants.TYPE_DOCUMENT
Some of these combination filters are already defined as additional type constants
at ContentConstants.TYPE_XXX
To obtain the root IDs for Rules and Document Management hierarchies:
getIdByUuid(String) and pass
com.appiancorp.suiteapi.content.ContentConstants.UUID_RULES_ROOT_FOLDER getIdByUuid(String) and pass
com.appiancorp.suiteapi.content.ContentConstants.UUID_COMMUNITY_ROOTServiceLocator and
ServiceContext):
ServiceContext sc = ServiceLocator.getAdministratorServiceContext();
ContentService cs = ServiceLocator.getContentService(sc);
Long rulesRootId = cs.getIdByUuid(ContentConstants.UUID_RULES_ROOT_FOLDER);
| Modifier and Type | Method and Description |
|---|---|
void |
activateUserSession(java.lang.Long[] memberOfGroups_,
java.lang.Long[] adminOfGroups_,
java.lang.Integer userTypeSysAdmin_)
Deprecated.
|
PendingAccess |
addFavorite(java.lang.Long id_)
Deprecated.
|
void |
addFavoriteForUsers(java.lang.Long id,
java.lang.String[] usernames)
Deprecated.
|
PendingAccess |
addFavorites(java.lang.Long[] ids_)
Deprecated.
|
void |
addGroupInRole(java.lang.Long id,
java.lang.String role,
java.lang.Long groupId)
Add group to content in given role.
|
void |
addGroupsInRole(java.lang.Long id,
java.lang.String role,
java.lang.Long[] groupId)
Add groups to content in given role.
|
void |
addLinks(java.lang.Long id_,
java.lang.Long[] links_)
Deprecated.
|
void |
addUserInRole(java.lang.Long id_,
java.lang.String role_,
java.lang.String username_)
Add user to content in given role.
|
void |
addUsersInRole(java.lang.Long id,
java.lang.String role,
java.lang.String[] username)
Add users to content in given role.
|
java.lang.Double |
adjustCounter(java.lang.Long id_,
java.lang.Double value)
Adjust a rules based constant (counter) of type integer or double by the given adjustment value.
|
java.lang.Integer |
adjustCounter(java.lang.Long id_,
java.lang.Integer value)
Adjust a rules based constant (counter) of type integer or double by the given adjustment value.
|
Approved |
approve(java.lang.Long id_)
Deprecated.
|
Approved[] |
approve(java.lang.Long[] ids_)
Deprecated.
|
java.lang.String[] |
approveUsers(java.lang.Long id_,
java.lang.String[] users_)
Approve access to the specified content item for a set of users.
|
Approved |
approveVersion(java.lang.Long id_,
java.lang.Integer versionNumber_)
Deprecated.
|
java.lang.Boolean[] |
areFavorites(Content[] contents_)
Deprecated.
|
java.lang.Boolean[] |
areFavorites(java.lang.Long[] ids_)
Deprecated.
|
java.lang.Long[] |
breakLock(java.lang.Long id_)
Deprecated.
|
java.lang.Long[] |
breakLock(java.lang.Long[] ids_)
Deprecated.
|
Content[] |
browse(java.lang.Long root,
ContentFilter filter)
Deprecated.
|
java.lang.Long[] |
browseIds(java.lang.Long root,
ContentFilter filter)
Browse includes:
what the user may see via group permissions,
including favorites,
no personal content items,
including advertised content items not visible,
but not already in favorites.
|
ResultPage |
browsePaging(java.lang.Long root,
ContentFilter filter,
int startIndex_,
int batchSize_,
java.lang.Integer sortProperty_,
java.lang.Integer sortOrder_)
Browse includes:
what the user may see via group permissions,
including favorites,
no personal content items,
including advertised content items not visible,
but not already in favorites.
|
java.lang.Boolean[] |
canAdministrate(Content[] content)
Can current user Administrate?
|
java.lang.Boolean |
canAdministrate(java.lang.Long id)
Can current user Administrate?
|
java.lang.Boolean[] |
canAdministrate(java.lang.Long[] ids)
Can current user Administrate?
|
java.lang.Boolean[] |
canEdit(Content[] content_)
Can current user Edit?
|
java.lang.Boolean |
canEdit(java.lang.Long id)
Can current user Edit?
|
java.lang.Boolean[] |
canEdit(java.lang.Long[] ids)
Can current user Edit?
|
java.lang.Boolean[] |
canGroupAdministrate(java.lang.Long[] ids,
java.lang.Long groupId)
Can given Group Administrate?
|
java.lang.Boolean |
canGroupAdministrate(java.lang.Long id,
java.lang.Long groupId)
Can given Group Administrate?
|
java.lang.Boolean[] |
canGroupEdit(java.lang.Long[] ids,
java.lang.Long groupId)
Can given Group Edit?
|
java.lang.Boolean |
canGroupEdit(java.lang.Long id,
java.lang.Long groupId)
Can given Group Edit?
|
java.lang.Boolean[] |
canGroupView(java.lang.Long[] ids,
java.lang.Long groupId)
Can given Group View?
|
java.lang.Boolean |
canGroupView(java.lang.Long id,
java.lang.Long groupId)
Can given Group View?
|
java.lang.Boolean[] |
canUserAdministrate(java.lang.Long[] ids,
java.lang.String username)
Can given User Administrate?
|
java.lang.Boolean |
canUserAdministrate(java.lang.Long id,
java.lang.String username)
Can given User Administrate?
|
java.lang.Boolean[] |
canUserEdit(java.lang.Long[] ids,
java.lang.String username)
Can given User Edit?
|
java.lang.Boolean |
canUserEdit(java.lang.Long id,
java.lang.String username)
Can given User Edit?
|
java.lang.Boolean[] |
canUserView(java.lang.Long[] ids,
java.lang.String username)
Can given User View?
|
java.lang.Boolean |
canUserView(java.lang.Long id,
java.lang.String username)
Can given User View?
|
java.lang.Boolean[] |
canView(Content[] content)
Can current user View?
|
java.lang.Boolean |
canView(java.lang.Long id)
Can current user View?
|
java.lang.Boolean[] |
canView(java.lang.Long[] ids)
Can current user View?
|
java.lang.Integer |
checkAccess(java.lang.Long id_)
Returns the current user access to a content item.
|
java.lang.Integer[] |
checkAccess(java.lang.Long[] ids_)
Returns the current user access to a content items.
|
void |
cleanseApprovals()
Deprecated.
|
java.lang.Long[] |
cleanseFavorites()
Deprecated.
|
void |
commitUpdateUsernames()
Deprecated.
|
CopyReference[] |
copy(CopySource[] source,
java.lang.Long target)
This copies Content item from one location to another.
|
CopyReference[] |
copy(java.lang.Long[] source,
java.lang.Long target)
This copies Content item from one location to another.
|
CopyReference[] |
copy(java.lang.Long source,
java.lang.Long target)
This copies Content item from one location to another.
|
java.lang.Long[] |
create(Content[] contents_,
java.lang.Integer unique_)
Creates content.
|
java.lang.Long |
create(Content content_,
java.lang.Integer unique_)
Creates a content object.
|
Approval |
createApproval(Content[] contents_,
java.lang.Integer unique_)
Attempts to create content, and gets the approval statuses back in an
Approval bean. |
Approval |
createApproval(Content content_,
java.lang.Integer unique_)
Attempts to create content, and gets the approval status back in an
Approval bean. |
Approval |
createVersion(Content[] contents_,
java.lang.Integer unique_)
Deprecated.
|
Approval |
createVersion(Content content_,
java.lang.Integer unique_)
Creates a new version of content.
|
Approval |
deactivate(java.lang.Long[] ids_,
java.lang.Boolean deactivateChildren_)
Deactivates all versions of the given content items.
|
Approval |
deactivate(java.lang.Long id_,
java.lang.Boolean deactivateChildren_)
Deactivates all versions of the given content item.
|
Approval |
deactivateVersion(java.lang.Long id_,
java.lang.Integer versionNumber_,
java.lang.Boolean deactivateChildren_)
Deactivates specified version of the given content item.
|
Approval |
deactivateVersions(java.lang.Long id_,
java.lang.Integer[] versionNumbers_,
java.lang.Boolean deactivateChildren_)
Deactivates specified version(s) of the given content item.
|
Approval |
delete(java.lang.Long[] ids_,
java.lang.Boolean deleteChildren_)
Deletes all versions of the given content item.
|
Approval |
delete(java.lang.Long id_,
java.lang.Boolean deleteChildren_)
Deletes all versions of the given content item.
|
Approval |
deleteContent(java.lang.Long[] ids_,
java.lang.Boolean deleteChildren_)
Deletes the given content items.
|
java.lang.Integer |
deleteMyInactive()
This is an 'empty Recycle Bin/Trashcan' method.
|
Approval |
deleteVersion(java.lang.Long id_,
java.lang.Integer versionNumber_,
java.lang.Boolean children_)
Deletes specified version(s) of the given content item.
|
Approval |
deleteVersions(java.lang.Long id_,
java.lang.Integer[] versionNumbers_,
java.lang.Boolean children_)
Deletes specified version(s) of the given content item.
|
Document[] |
download(java.lang.Long id_,
java.lang.Integer versionNumber_,
java.lang.Boolean includeExpired_)
Gets a piece of content and log the transaction if logging is enabled.
|
java.lang.String |
generateSearchIndex(java.sql.Timestamp timestamp_)
Generates search index text file bodies for: "content".
|
java.lang.Integer[] |
getAccessLevel(java.lang.Long[] ids_,
int typemask_)
Get the Access Level for the current user for a list of content items.
|
java.lang.Integer[] |
getAccessLevel(java.lang.Long[] ids_,
java.lang.Integer typemask_)
Get the Access Level for the current user for a list of content items.
|
java.lang.Integer |
getAccessLevel(java.lang.Long id_,
int typemask_)
Get the Access Level for the current user for a content item.
|
java.lang.Integer |
getAccessLevel(java.lang.Long id_,
java.lang.Integer typemask_)
Get the Access Level for the current user for a content item.
|
java.lang.Integer[] |
getAccessLevelForUser(java.lang.Long[] ids_,
java.lang.Integer typemask_,
java.lang.String username_)
Get the Access Level for the given user for a list of content items.
|
java.lang.Integer |
getAccessLevelForUser(java.lang.Long id_,
java.lang.Integer typemask_,
java.lang.String username_)
Get the Access Level for the given user for a content item.
|
java.lang.Long[] |
getAdministratable(java.lang.Long root,
ContentFilter filter)
Deprecated.
|
java.lang.Long[] |
getAdministratableByUser(java.lang.Long root,
ContentFilter filter,
java.lang.String username)
Get all active, non-expired ids off the root, where administratable role held by user.
|
ResultPage |
getAdministratablePaging(java.lang.Long rootId_,
ContentFilter filter_,
int startIndex_,
int batchSize_,
java.lang.Integer sortProperty_,
java.lang.Integer sortOrder_)
Get Administratable Content objects paging.
|
java.lang.Long |
getAdministratorGroup()
Members of this group will be considered administrators for all content (appadmins).
|
Content[] |
getAdvertisedChildren(java.lang.Long containerId_,
ContentFilter filter_,
java.lang.Integer modifiers_)
Deprecated.
|
java.lang.Long[] |
getAdvertisedChildrenIds(java.lang.Long containerId_,
ContentFilter filter_,
java.lang.Integer modifiers_) |
ResultPage |
getAdvertisedChildrenPaging(java.lang.Long containerId_,
ContentFilter filter_,
java.lang.Integer modifiers_,
int startIndex_,
int batchSize_,
java.lang.Integer sortProperty_,
java.lang.Integer sortOrder_) |
Content[] |
getAllChildren(java.lang.Long containerId_,
ContentFilter filter_,
java.lang.Integer modifiers_)
Deprecated.
|
java.lang.Long[] |
getAllChildrenAndVersionIds(java.lang.Long containerId_,
ContentFilter filter_)
Get ids of all versions of all children in a given container.
|
Content[] |
getAllChildrenAndVersions(java.lang.Long containerId_,
ContentFilter filter_)
Deprecated.
|
ResultPage |
getAllChildrenAndVersionsPaging(java.lang.Long containerId_,
ContentFilter filter_,
int startIndex_,
int batchSize_,
java.lang.Integer sortProperty_,
java.lang.Integer sortOrder_)
Get all versions of all children in a given container.
|
java.lang.Long[] |
getAllChildrenIds(java.lang.Long containerId_,
ContentFilter filter_,
java.lang.Integer modifiers_)
Returns all descendant ids in a recursive descent from root.
|
ResultPage |
getAllChildrenPaging(java.lang.Long containerId_,
ContentFilter filter_,
java.lang.Integer modifiers_,
int startIndex_,
int batchSize_,
java.lang.Integer sortProperty_,
java.lang.Integer sortOrder_)
Returns all descendants in a recursive descent from root.
|
java.lang.Long[] |
getAllVersionIds(java.lang.Long id_)
Gets the IDs of all of the versions of a particular versioned content
item.
|
Content[] |
getAllVersions(java.lang.Long id_)
Deprecated.
|
ResultPage |
getAllVersionsPaging(java.lang.Long id_,
int startIndex_,
int batchSize_,
java.lang.Integer sortProperty_,
java.lang.Integer sortOrder_)
Gets all of the versions of a particular versioned content item.
|
java.lang.String |
getApplicationName()
Get the application name (in this case, "Appian Collaboration").
|
Content |
getByPath(java.lang.Long root_,
java.lang.String path_)
Gets the content at the specified path relative to the given root.
|
Content[] |
getChildren(java.lang.Long containerId_,
ContentFilter filter_,
java.lang.Integer modifiers_)
Deprecated.
|
java.lang.Long[] |
getChildrenIds(java.lang.Long containerId_,
ContentFilter filter_,
java.lang.Integer modifiers_)
Returns the ids of the children of a container.
|
ResultPage |
getChildrenPaging(java.lang.Long containerId_,
ContentFilter filter_,
java.lang.Integer modifiers_,
int startIndex_,
int batchSize_,
java.lang.Integer sortProperty_,
java.lang.Integer sortOrder_)
Returns the children of a container.
|
java.lang.Integer[] |
getChildrenTypes(Content[] containers_)
Returns typemasks of all children types found within each container.
|
java.lang.Integer |
getChildrenTypes(java.lang.Long containerId_)
Returns a typemask of all children types found within a container.
|
java.lang.Integer[] |
getChildrenTypes(java.lang.Long[] containerIds_)
Returns typemasks of all children types found within each container.
|
java.lang.Integer[] |
getChildrenTypesOfType(java.lang.Long[] containerIds_,
java.lang.Integer typemask_)
Returns typemasks of all children types found within each container.
|
java.lang.Integer |
getChildrenTypesOfType(java.lang.Long containerId_,
java.lang.Integer typemask_)
Returns a typemask of all children types found within a container.
|
Content |
getContent(java.lang.Long id_)
Deprecated.
use
getVersion(Long, Integer) instead |
Content[] |
getContent(java.lang.Long[] ids_)
Deprecated.
|
java.lang.Long[] |
getContentIdsWhereViewable(java.lang.Long[] ids_)
Gets the specified content IDs where viewable, rather than giving an error that
the content is not viewable.
|
ResultList |
getContentList(java.lang.Long[] ids_,
java.lang.Integer typemask_)
Does the same thing as
getContent(Long[]), except it takes a type
mask and returns error codes instead of throwing exceptions. |
ResultPage |
getContentPaging(java.lang.Long[] ids_,
int startIndex_,
int batchSize_,
java.lang.Integer sortProperty_,
java.lang.Integer sortOrder_)
Deprecated.
|
Content[] |
getContentTree(java.lang.Long rootContentId_,
java.lang.Integer maxDepth_,
java.lang.Integer typemask_,
java.lang.Integer accessLevel_)
Deprecated.
|
ResultPage |
getContentTreePaging(java.lang.Long rootContentId_,
java.lang.Integer maxDepth_,
java.lang.Integer typemask_,
java.lang.Integer accessLevel_,
int startIndex_,
int batchSize_,
java.lang.Integer sortProperty_,
java.lang.Integer sortOrder_)
Get the content tree, and page the results.
|
java.lang.String |
getContentUrl(long contentId)
Gets the URL for a given content.
|
Content[] |
getContentWhereViewable(java.lang.Long[] ids_)
Deprecated.
|
ResultPage |
getContentWhereViewablePaging(java.lang.Long[] ids_,
int startIndex_,
int batchSize_,
java.lang.Integer sortProperty_,
java.lang.Integer sortOrder_)
Gets the specified content where viewable, rather than giving an error that
the content is not viewable.
|
java.lang.Long[] |
getDatatypeIds(java.lang.Long... contentIds)
Gets the datatype ids that content ids map to.
|
DocumentInputStream |
getDocumentInputStream(long id_)
Opens a stream to a Document allowing for the caller to read its contents.
|
DocumentInputStream[] |
getDocumentInputStream(long[] ids_)
Opens streams to multiple Documents allowing the caller to read their contents.
|
java.lang.Integer |
getDownloadLogType()
Gets the download log type.
|
java.lang.Long[] |
getEditable(java.lang.Long root,
ContentFilter filter)
Deprecated.
|
java.lang.Long[] |
getEditableByUser(java.lang.Long root_,
ContentFilter filter_,
java.lang.String username_)
Get all active, non-expired ids off the root, where editor role held by user.
|
ResultPage |
getEditablePaging(java.lang.Long rootId_,
ContentFilter filter_,
int startIndex_,
int batchSize_,
java.lang.Integer sortProperty_,
java.lang.Integer sortOrder_)
Get Editable Content objects paging.
|
Content[] |
getExpired(java.lang.Long root_,
java.lang.Integer days_,
ContentFilter filter_)
Deprecated.
|
java.lang.Long[] |
getExpiredIds(java.lang.Long root_,
java.lang.Integer days_,
ContentFilter filter_)
Deprecated.
|
ResultPage |
getExpiredPaging(java.lang.Long root_,
java.lang.Integer days_,
ContentFilter filter_,
int startIndex_,
int batchSize_,
java.lang.Integer sortProperty_,
java.lang.Integer sortOrder_)
Deprecated.
|
java.lang.String |
getExternalFilename(java.lang.Long id_)
Gets the external filename (the name that the file would be saved as by the
client, or the name within a .zip file) of a document.
|
java.lang.String[] |
getExternalFilenames(java.lang.Long[] ids_)
Gets the external filenames (the name that the file would be saved as by the
client, or the name within a .zip file) of a set of document.
|
java.lang.Long[] |
getFavoriteByRootIds(java.lang.Long rootId_,
ContentFilter filter_,
java.lang.Boolean includeExpiredContent_)
Deprecated.
|
Content[] |
getFavoritesByRoot(java.lang.Long rootId_,
ContentFilter filter_,
java.lang.Boolean includeExpiredContent_)
Deprecated.
|
ResultPage |
getFavoritesByRootPaging(java.lang.Long rootId_,
ContentFilter filter_,
java.lang.Boolean includeExpiredContent_,
int startIndex_,
int batchSize_,
java.lang.Integer sortProperty_,
java.lang.Integer sortOrder_)
Deprecated.
|
java.lang.Long |
getIdByPath(java.lang.Long root_,
java.lang.String path_)
Gets the ID of the content at the specified path relative to the given root.
|
java.lang.Long |
getIdByUuid(java.lang.String uuid)
Gets a content id by UUID.
|
java.lang.Long[] |
getIdsByUuid(java.lang.String[] uuids)
Gets content ids by UUID.
|
java.lang.Long[] |
getImageIdsForUsers(java.lang.String[] usernames)
Get the image document ids for the given users.
|
Content[] |
getInactive(java.lang.Long root_,
ContentFilter filter_)
Deprecated.
|
java.lang.Long[] |
getInactiveIds(java.lang.Long root_,
ContentFilter filter_)
Gets all inactive content ids within the specified root.
|
java.lang.Long[] |
getInactiveIdsNoSystem(java.lang.Long root_,
ContentFilter filter_)
Gets all inactive content ids within the specified root but filters out system ids.
|
ResultPage |
getInactivePaging(java.lang.Long root_,
ContentFilter filter_,
int startIndex_,
int batchSize_,
java.lang.Integer sortProperty_,
java.lang.Integer sortOrder_)
Gets all inactive content items within the specified root.
|
java.lang.String |
getInternalFilename(java.lang.Long id_)
Deprecated.
since 23.2. Use
getDocumentInputStream(long) for reads and
uploadDocument(Document, Integer) for writes,
or call #download(Long, Integer, Boolean) and use supported APIs on {@link com.appiancorp.suiteapi.knowledge.Document} |
java.lang.String[] |
getInternalFilenames(java.lang.Long[] ids_)
Deprecated.
since 23.2. Use
getDocumentInputStream(long[]) |
java.lang.Long[] |
getLinkedBy(java.lang.Long id_)
Returns the ids of those content items that link to the given id.
|
java.lang.Long[] |
getLinkIds(java.lang.Long id_)
Returns all link ids to a given content id.
|
java.lang.Long[] |
getLinkIdsOfType(java.lang.Long id_,
java.lang.Integer typemask_)
Returns all links to a given content id.
|
Content[] |
getLinks(java.lang.Long id_)
Returns all links to a given content id.
|
Content[] |
getLinksOfType(java.lang.Long id_,
java.lang.Integer typemask_)
Returns all links to a given content id.
|
Content[] |
getMyInactive()
Deprecated.
use
getMyInactivePaging(int, int, Integer, Integer) instead |
java.lang.Long[] |
getMyInactiveIds()
This retrieves the content ids in the 'Recycle Bin/Trashcan' of the current user.
|
ResultPage |
getMyInactivePaging(int startIndex_,
int batchSize_,
java.lang.Integer sortProperty_,
java.lang.Integer sortOrder_)
This retrieves the content items in the 'Recycle Bin/Trashcan' of the current user.
|
java.lang.Integer[] |
getNumberOfChildren(java.lang.Long[] containerIds_,
java.lang.Integer typemask_)
This returns the number of children matching the typemask
for each root id specified.
|
java.lang.Integer |
getNumberOfChildren(java.lang.Long containerId_,
java.lang.Integer typemask_)
This returns the number of children matching the typemask.
|
java.lang.Integer |
getNumberOfRequests()
This returns the count of the requests returned by getRequests.
|
java.lang.String |
getOpaqueContentUri(long contentId)
Gets the opaque id for a given content.
|
Content |
getParent(java.lang.Long id_)
Gets the parent of the specified content.
|
java.lang.Long |
getParentId(java.lang.Long id_)
Gets the parents of the specified content items.
|
java.lang.Long[] |
getParentIds(java.lang.Long[] ids_)
Gets the IDs of the parents of the specified content items.
|
Content[] |
getParents(java.lang.Long[] ids_)
Gets the parents of the specified content items.
|
Content[] |
getParentsFromRoot(java.lang.Long id_,
java.lang.Integer typemask_)
This returns all of direct ancestors of a node, starting with
the root and tracing down to the node's parent.
|
java.lang.Long[] |
getParentsFromRootIds(java.lang.Long id_,
java.lang.Integer typemask_)
This return ids of all of direct ancestors of a node, starting with
the root and tracing down to the node's parent.
|
Content[] |
getParentsToRoot(java.lang.Long id_,
java.lang.Integer typemask_)
This returns all of direct ancestors of a node, starting with
the node's parent and tracing up to the root.
|
java.lang.Long[] |
getParentsToRootIds(java.lang.Long id_,
java.lang.Integer typemask_)
This returns ids of all of direct ancestors of a node, starting with
the node's parent and tracing up to the root.
|
Content[] |
getPending(java.lang.Long id,
ContentFilter filter)
Deprecated.
|
ResultPage |
getPendingPaging(java.lang.Long id,
ContentFilter filter,
int startIndex_,
int batchSize_,
java.lang.Integer sortProperty_,
java.lang.Integer sortOrder_)
Deprecated.
|
java.lang.Integer |
getPendingReview(java.lang.Long id_)
Deprecated.
|
java.lang.Integer[] |
getPendingReviews(java.lang.Long[] ids_)
Deprecated.
|
java.lang.String[] |
getPendingUsers(java.lang.Long id_)
This accumulates all users pending for the given content item,
returning only the unique names.
|
Content |
getPersonal()
Get your Personal content item.
|
Content[] |
getPersonalAndTeams(ContentFilter filter_)
Deprecated.
|
java.lang.Long[] |
getPersonalAndTeamsIds(ContentFilter filter_)
Get children of 'Personal and Teams'.
|
ResultPage |
getPersonalAndTeamsPaging(ContentFilter filter_,
int startIndex_,
int batchSize_,
java.lang.Integer sortProperty_,
java.lang.Integer sortOrder_)
Get children of 'Personal and Teams'.
|
java.lang.Long |
getPersonalId()
Get the id for your Personal content item.
|
Content[] |
getRequests()
Once a user requests an action on a Content item that requires approval,
that request is stored with the Content item.
|
RoleMap |
getRestrictionMap(java.lang.Long id_)
Deprecated.
|
ContentRoleMap |
getRoleMap(java.lang.Long id_,
java.lang.Boolean includeAggregate_)
Get the role map for a content item.
|
ContentRoleSet |
getRoleSet(java.lang.Long id_)
Get the
ContentRoleSet associated with the content with the ID provided. |
ContentRoleSet |
getRoleSetForGroup(java.lang.Long groupId_,
java.lang.Long id_)
Get the
ContentRoleSet associated with the given content for
a specific group. |
ContentRoleSet |
getRoleSetForUser(java.lang.String username_,
java.lang.Long id_)
Deprecated.
Requires two sets of credentials.
|
ContentRoleSet[] |
getRoleSets(Content[] contents_)
Get the
ContentRoleSets associated with the given contents. |
ContentRoleSet[] |
getRoleSets(java.lang.Long[] ids_)
Get the
ContentRoleSets associated with the given content ids. |
ContentRoleSet[] |
getRoleSetsForGroup(java.lang.Long groupId_,
java.lang.Long[] ids_)
Get the
ContentRoleSets associated with the given contents for
a specific group. |
ContentRoleSet[] |
getRoleSetsForUser(java.lang.String username_,
java.lang.Long[] ids_)
Deprecated.
Requires two sets of credentials.
|
java.lang.Long |
getSystemId(java.lang.String name_)
Deprecated.
use
getIdByUuid(String) instead. This method will be removed
in a future release |
java.lang.Long[] |
getSystemIds(java.lang.String[] names_)
Deprecated.
use
getIdsByUuid(String[]) instead. This method will be removed
in a future release |
java.lang.String[] |
getSystemNames()
Deprecated.
|
java.lang.Long[] |
getThumbnailIdsForUsers(java.lang.String[] usernames,
int size)
Get the document ids of the thumbnail images of the given size for the given users.
|
java.lang.Long |
getUserSpaceAvailable()
Deprecated.
User quotas have been removed. This method will always return
- 1 |
java.lang.Long |
getUserSpaceAvailableForUser(java.lang.String username)
Deprecated.
User quotas have been removed. This method will always return
- 1 |
java.lang.Long |
getUserSpaceUsage()
Deprecated.
User quotas have been removed. This method will always return 0
|
Content |
getVersion(java.lang.Long id_,
java.lang.Integer versionNumber_)
Gets the specified version of the content.
|
Content |
getVersion(java.lang.String uuid,
java.lang.Integer versionNumber)
Gets the specified version of the content.
|
java.lang.Long |
getVersionId(java.lang.Long id_,
java.lang.Integer versionNumber_)
Gets the ID of the specified version of the content.
|
java.lang.Long |
getVersionId(java.lang.String uuid,
java.lang.Integer versionNumber)
Gets the ID of the specified version of the content.
|
java.lang.Long[] |
getVersionIds(java.lang.Long[] ids_,
java.lang.Integer versionNumber_)
Gets the specified version of a bunch of pieces of content.
|
java.lang.Long[] |
getVersionIds(java.lang.Long id_,
java.lang.Integer[] versionNumbers_)
Gets the specified versions of a particular piece of content.
|
Content[] |
getVersions(java.lang.Long[] ids_,
java.lang.Integer versionNumber_)
Deprecated.
|
Content[] |
getVersions(java.lang.Long id_,
java.lang.Integer[] versionNumbers_)
Gets the specified versions of a particular piece of content.
|
ResultList |
getVersionsList(java.lang.Long[] ids,
java.lang.Integer versionNumber,
java.lang.Integer typemask)
Retrieves the specified version of the content objects identified by the given
ids and of the given type.
|
ResultPage |
getVersionsPaging(java.lang.Long[] ids_,
java.lang.Integer versionNumber_,
int startIndex_,
int batchSize_,
java.lang.Integer sortProperty_,
java.lang.Integer sortOrder_)
Gets the specified version of a bunch of pieces of content.
|
ResultPage |
getVersionsPaging(java.lang.Long id_,
java.lang.Integer[] versionNumbers_,
int startIndex_,
int batchSize_,
java.lang.Integer sortProperty_,
java.lang.Integer sortOrder_)
Gets the specified versions of a particular piece of content.
|
java.lang.Long[] |
getViewable(java.lang.Long root,
ContentFilter filter)
Deprecated.
|
java.lang.Long[] |
getViewableByUser(java.lang.Long root,
ContentFilter filter,
java.lang.String username)
Get all active, non-expired ids off the root, where view role held by user.
|
ResultPage |
getViewablePaging(java.lang.Long rootId_,
ContentFilter filter_,
int startIndex_,
int batchSize_,
java.lang.Integer sortProperty_,
java.lang.Integer sortOrder_)
Get Viewable Content objects paging.
|
Content[] |
getWhatsNew(java.lang.Long root_,
java.lang.Integer maxResults_,
ContentFilter filter_)
Deprecated.
|
java.lang.Long[] |
getWhatsNewIds(java.lang.Long root_,
java.lang.Integer maxResults_,
ContentFilter filter_)
Returns id list of most recently modified content items within the specified root.
|
ResultPage |
getWhatsNewPaging(java.lang.Long root_,
java.lang.Integer maxResults_,
ContentFilter filter_,
int startIndex_,
int batchSize_,
java.lang.Integer sortProperty_,
java.lang.Integer sortOrder_)
Returns list of most recently modified content items within the specified root.
|
java.lang.Boolean |
hasChildren(java.lang.Long containerId_)
Checks whether the specified container has children.
|
java.lang.Boolean |
hasChildrenOfType(java.lang.Long containerId_,
java.lang.Integer typemask_)
Checks whether the specified container has children of a the specified type(s).
|
java.lang.Boolean |
hasNoChildren(java.lang.Long containerId_)
Checks whether the specified container has no children.
|
java.lang.Boolean |
hasNoChildrenOfType(java.lang.Long containerId_,
java.lang.Integer typemask_)
Checks whether the specified container has no children of the specified type(s).
|
java.lang.Boolean[] |
haveChildren(Content[] containers_)
Checks whether each of the specified containers has children.
|
java.lang.Boolean[] |
haveChildren(java.lang.Long[] containerIds_)
Checks whether each of the specified containers has children.
|
java.lang.Boolean[] |
haveChildrenOfType(java.lang.Long[] containerIds_,
java.lang.Integer typemask_)
Checks whether the specified container has children of a the specified type(s).
|
java.lang.Boolean[] |
haveNoChildren(java.lang.Long[] containerIds_)
Checks whether each of the specified containers has no children.
|
java.lang.Boolean[] |
haveNoChildrenOfType(java.lang.Long[] containerIds_,
java.lang.Integer typemask_)
Checks whether each of the specified containers has no children of the
specified type(s).
|
java.lang.Long[] |
importContent(Content[] contents_,
java.lang.Integer unique_)
Deprecated.
This API is no longer supported and will be removed in the next release. Only
objects that are exported using the Applications import/export will be importable in the next release.
|
java.lang.Integer[] |
importValidate(Content[] contents_)
Checks the validity of the Content items for import, returning
an import status for each.
|
java.lang.Boolean |
isAdministrateNotRestricted(java.lang.Long id_)
Is administrate privilege restricted?
|
java.lang.Boolean |
isEditNotRestricted(java.lang.Long id_)
Is edit privilege restricted?
|
java.lang.Boolean |
isFavorite(java.lang.Long id_)
Returns true if content is marked as a favorite for the current user.
|
java.lang.Boolean |
isViewNotRestricted(java.lang.Long id_)
Is view privilege restricted?
|
void |
localize(Content content_)
Localizes the name, description, and parent name for the given content(s).
|
void |
localize(Content[] contents_)
Localizes the name, description, and parent name for the given content(s).
|
void |
localize(Content[] contents_,
java.util.Locale locale_)
Localizes the name, description, and parent name for the given content(s).
|
void |
localize(Content content_,
java.util.Locale locale_)
Localizes the name, description, and parent name for the given content(s).
|
void |
lock(java.lang.Long id_)
Deprecated.
|
void |
lock(java.lang.Long[] ids_)
Deprecated.
|
void |
move(java.lang.Long[] ids_,
java.lang.Long destinationParent_)
This moves Content items from one location to another, cutting connection from current parent,
setting connection to new parent, updating bytes used in parents.
|
void |
move(java.lang.Long id_,
java.lang.Long destinationParent_)
This moves a Content item from one location to another, cutting connection from current parent,
setting connection to new parent, updating bytes used in parents.
|
void |
moveKnowledgeCenter(java.lang.Long kcId_,
java.lang.Long communityId_)
Move a KC to a community.
|
void |
moveKnowledgeCenters(java.lang.Long[] kcIds_,
java.lang.Long communityId_)
Moves KCs to a community.
|
void |
notifyApproved(Approved... approved)
Deprecated.
|
void |
notifyGroupDeletion(java.lang.Long groupId_)
Notify the server that a group was deleted so any new group with the same
id will not assume the same permissions.
|
void |
notifyGroupsDeletion(java.lang.Long[] groupIds_)
Notify the server that groups were deleted so any new group with the same
id will not assume the same permissions.
|
void |
notifyUserCreation(java.lang.String userName_)
Deprecated.
done automatically by UserService.createUser
|
void |
notifyUsersCreation(java.lang.String[] userNames_)
Deprecated.
done automatically by UserService.createUser
|
void |
populateExtensionInfo(Content[] contents_)
Populates the extensionInfo field in the document beans you pass in.
|
void |
populateFavorites(Content[] contents_)
Deprecated.
|
void |
populateRoleSets(Content[] contents_)
Populates the roleSet field in the content beans you pass in.
|
void |
populateTypesOfChildren(Content[] containers_)
Populate the typesOfChildren field in the content beans you pass in.
|
Content[] |
queryByRoot(java.lang.Long root_,
java.lang.String queryText_,
ContentFilter filter_)
Deprecated.
|
ResultPage |
queryByRootPaging(java.lang.Long root_,
java.lang.String queryText_,
ContentFilter filter_,
int startIndex_,
int batchSize_,
java.lang.Integer sortProperty_,
java.lang.Integer sortOrder_)
This is more advanced search, accepting special keywords.
|
java.lang.Long[] |
queryIdsByRoot(java.lang.Long root_,
java.lang.String queryText_,
ContentFilter filter_)
This is more advanced search, accepting special keywords.
|
void |
reactivate(java.lang.Long id_)
Reactivates the given content item.
|
void |
reactivate(java.lang.Long[] ids_)
Reactivates the given content items.
|
Approved |
reject(java.lang.Long id_)
Deprecated.
|
Approved[] |
reject(java.lang.Long[] ids_)
Deprecated.
|
java.lang.String[] |
rejectUsers(java.lang.Long id_,
java.lang.String[] users_)
Reject access to the specified content item for a set of users.
|
Approved |
rejectVersion(java.lang.Long id_,
java.lang.Integer versionNumber_)
Deprecated.
|
void |
removeFavorite(java.lang.Long id_)
Deprecated.
|
void |
removeFavoriteForUsers(java.lang.Long id_,
java.lang.String[] username_)
Deprecated.
|
void |
removeFavorites(java.lang.Long[] ids_)
Deprecated.
|
void |
removeGroupFromRole(java.lang.Long id,
java.lang.String role,
java.lang.Long groupId)
Remove group from content in given role.
|
void |
removeGroupsFromRole(java.lang.Long id,
java.lang.String role,
java.lang.Long[] groupId)
Remove groups from content in given role.
|
void |
removeLinks(java.lang.Long id_,
java.lang.Long[] links_)
Deprecated.
|
void |
removeUserFromRole(java.lang.Long id,
java.lang.String role,
java.lang.String username)
Remove user from content in given role.
|
void |
removeUsersFromRole(java.lang.Long id,
java.lang.String role,
java.lang.String[] username)
Remove users from content in given role.
|
void |
requestAccess(java.lang.Long id_)
Deprecated.
|
void |
requestAccess(java.lang.Long[] ids_)
Deprecated.
|
void |
resetGroupMembership(java.sql.Timestamp timestamp_)
Deprecated.
No longer necessary with credential system
|
void |
rollbackUpdateUsernames()
Deprecated.
|
Content[] |
searchByRoot(java.lang.Long rootId_,
java.lang.String regex_,
ContentFilter filter_)
Deprecated.
|
ResultPage |
searchByRootPaging(java.lang.Long rootId_,
java.lang.String regex_,
ContentFilter filter_,
int startIndex_,
int batchSize_,
java.lang.Integer sortProperty_,
java.lang.Integer sortOrder_)
Searches for content from a given root.
|
java.lang.Long[] |
searchIdsByRoot(java.lang.Long rootId_,
java.lang.String regex_,
ContentFilter filter_)
Searches for content from a given root.
|
java.lang.Long[] |
searchIdsWithin(java.lang.String regex,
java.lang.Long[] ids_)
Search for content within the given containers.
|
Content[] |
searchWithin(java.lang.String regex,
java.lang.Long[] ids_)
Deprecated.
|
ResultPage |
searchWithinPaging(java.lang.String regex_,
java.lang.Long[] ids_,
int startIndex_,
int batchSize_,
java.lang.Integer sortProperty_,
java.lang.Integer sortOrder_)
Search for content within the given containers.
|
void |
setActorsInRoles(java.lang.Long id_,
java.lang.String[] users_,
java.lang.String[][] userRoles_,
java.lang.Long[] groups_,
java.lang.String[][] groupRoles_)
Set security roles for a content item by users and groups.
|
void |
setAdministratorGroup(java.lang.Long groupId_)
Set the group that will be considered administrators for all content (appadmins).
|
void |
setAsRoot(java.lang.Long id)
Sets the given id as its own root, splitting it from its existing hierarchy.
|
void |
setPersonalId(java.lang.Long id_)
Set the id for your Personal content item.
|
void |
setRestrictionMap(java.lang.Long id_,
RoleMap roleMap_)
Deprecated.
|
RoleMapChanges |
setRoleMap(java.lang.Long id_,
ContentRoleMap rolemap_,
java.lang.Boolean contract_)
Set the role map for a content item.
|
void |
setRoleMapForAllVersions(java.lang.Long id_,
ContentRoleMap rolemap_,
java.lang.Boolean contract_)
Sets the role map for all the versions of a content item.
|
void |
setRoot(java.lang.String name_,
java.lang.Long id_)
Deprecated.
use
setAsRoot(Long) |
int |
setSizeOfDocumentVersion(java.lang.Long documentContentId)
Deprecated.
since 23.2. Writing to a Document via
DocumentOutputStream or
ContentUploadOutputStream will update the Document size metadata automatically upon
closing the stream. |
void |
setSystemId(java.lang.String name_,
java.lang.Long id_)
Deprecated.
Use
create(Content, Integer) with a pre-populated UUID and the flag
ContentConstants.VIS_SYSTEM. |
void |
setSystemIds(java.lang.String[] names_,
java.lang.Long[] ids_)
Deprecated.
Use
create(Content[], Integer) with pre-populated UUIDs and the flag
ContentConstants.VIS_SYSTEM. |
void |
setUserSpaceAvailable(java.lang.String username_,
java.lang.Long bytes_)
Deprecated.
User quotas have been removed. Calls to this method will be ignored.
|
void |
setUserSpaceUsage(java.lang.String username_,
java.lang.Long bytesUsed_)
Deprecated.
User quotas have been removed. Calls to this method will be ignored.
|
java.lang.String |
suggest(java.lang.String query_,
int maxItems_,
SuggestParam[] params_,
java.lang.Boolean groupResults_)
Queries for content and returns a JSON formatted string to be used by autocomplete.
|
java.lang.String |
suggest(java.lang.String query_,
int maxItems_,
SuggestParam[] params_,
java.lang.Boolean groupResults_,
java.lang.Long[] allowList)
Queries for content and returns a JSON formatted string to be used by autocomplete.
|
void |
unexpire(java.lang.Long id_)
Deprecated.
|
void |
unexpire(java.lang.Long[] ids_)
Deprecated.
|
java.lang.Long[] |
unlock(java.lang.Long id_)
Deprecated.
|
java.lang.Long[] |
unlock(java.lang.Long[] ids_)
Deprecated.
|
void |
updateAllChildrenAndVersionsExpiration(java.lang.Long id,
java.lang.Integer expirationDays)
Update the expiration days for all children and versions of the given id (including the
content with the given id).
|
void |
updateAllChildrenAndVersionsVisibility(java.lang.Long id,
boolean maskType,
int bitmask)
Update the visibility bitmask for all children and versions of the given id.
|
void |
updateFields(Content[] contents_,
java.lang.Integer[] fields_,
java.lang.Integer unique_)
Updates the specified fields of the content items.
|
void |
updateFields(Content content_,
java.lang.Integer[] fields_,
java.lang.Integer unique_)
Updates the specified fields of a content item's LATEST version.
|
void |
updateUsernames(java.lang.String[] oldUsernames_,
java.lang.String[] newUsernames_,
long maxExpirationTimeInSeconds_)
Deprecated.
|
void |
updateVersionFields(Content content_,
java.lang.Integer versionNumber,
java.lang.Integer[] fields_,
java.lang.Integer unique_)
Updates the specified fields of a content item's specific version.
|
ContentOutputStream |
upload(Document doc,
java.lang.Integer unique)
Deprecated.
since 23.2. Use
uploadDocument(Document, Integer) instead |
ContentUploadOutputStream |
uploadDocument(Document doc,
java.lang.Integer unique)
Creates a document and provides an output stream to which the document's content should be
written.
|
java.lang.Integer |
validate(java.lang.Long id_)
Gets the type of the content specified.
|
java.lang.Integer[] |
validate(java.lang.Long[] ids_)
Gets the types of the content specified.
|
java.lang.Boolean |
validateGroupMembership(java.lang.Long[] memberOfGroups_,
java.lang.Long[] adminOfGroups_)
Deprecated.
No longer necessary with credential system
|
boolean |
validateTypedValues(TypedValue[] typedValues)
Validates given TypedValues.
|
static final boolean getApplicationName$UPDATES
static final boolean generateSearchIndex$UPDATES
static final boolean setAdministratorGroup$UPDATES
static final boolean getAdministratorGroup$UPDATES
static final boolean activateUserSession$UPDATES
static final boolean validateGroupMembership$UPDATES
static final boolean resetGroupMembership$UPDATES
static final boolean notifyUserCreation$UPDATES
static final boolean notifyUsersCreation$UPDATES
static final boolean notifyGroupDeletion$UPDATES
static final boolean notifyGroupsDeletion$UPDATES
static final boolean setUserSpaceUsage$UPDATES
static final boolean getUserSpaceUsage$UPDATES
static final boolean setUserSpaceAvailable$UPDATES
static final boolean getUserSpaceAvailable$UPDATES
static final boolean getUserSpaceAvailableForUser$UPDATES
static final boolean getImageIdsForUsers$UPDATES
static final boolean getThumbnailIdsForUsers$UPDATES
static final boolean validate$UPDATES
static final boolean createApproval$UPDATES
static final boolean create$UPDATES
static final boolean createVersion$UPDATES
static final boolean upload$UPDATES
static final boolean importContent$UPDATES
static final boolean importValidate$UPDATES
static final boolean getContent$UPDATES
static final boolean getContentList$UPDATES
static final boolean getContentPaging$UPDATES
static final boolean getContentTree$UPDATES
static final boolean getContentTreePaging$UPDATES
static final boolean getContentWhereViewable$UPDATES
static final boolean getContentIdsWhereViewable$UPDATES
static final boolean getContentWhereViewablePaging$UPDATES
static final boolean getContentUrl$UPDATES
static final boolean getOpaqueContentUri$UPDATES
static final boolean getVersion$UPDATES
static final boolean getVersions$UPDATES
static final boolean getVersionsList$UPDATES
static final boolean getVersionId$UPDATES
static final boolean getVersionsPaging$UPDATES
static final boolean getVersionIds$UPDATES
static final boolean getAllVersions$UPDATES
static final boolean getAllVersionsPaging$UPDATES
static final boolean getAllVersionIds$UPDATES
static final boolean download$UPDATES
static final boolean getInternalFilename$UPDATES
static final boolean getInternalFilenames$UPDATES
static final boolean getExternalFilename$UPDATES
static final boolean getExternalFilenames$UPDATES
static final boolean getByPath$UPDATES
static final boolean getIdByPath$UPDATES
static final boolean getParent$UPDATES
static final boolean getParents$UPDATES
static final boolean getParentId$UPDATES
static final boolean getParentIds$UPDATES
static final boolean hasNoChildren$UPDATES
static final boolean haveNoChildren$UPDATES
static final boolean hasNoChildrenOfType$UPDATES
static final boolean haveNoChildrenOfType$UPDATES
static final boolean hasChildren$UPDATES
static final boolean haveChildren$UPDATES
static final boolean hasChildrenOfType$UPDATES
static final boolean haveChildrenOfType$UPDATES
static final boolean getChildrenTypesOfType$UPDATES
static final boolean getChildrenTypes$UPDATES
static final boolean populateTypesOfChildren$UPDATES
static final boolean getChildren$UPDATES
static final boolean getChildrenIds$UPDATES
static final boolean getChildrenPaging$UPDATES
static final boolean getAdvertisedChildren$UPDATES
static final boolean getAdvertisedChildrenIds$UPDATES
static final boolean getAdvertisedChildrenPaging$UPDATES
static final boolean getEditablePaging$UPDATES
static final boolean getAdministratablePaging$UPDATES
static final boolean getViewablePaging$UPDATES
static final boolean getAllChildren$UPDATES
static final boolean getAllChildrenIds$UPDATES
static final boolean getAllChildrenPaging$UPDATES
static final boolean getAllChildrenAndVersions$UPDATES
static final boolean getAllChildrenAndVersionIds$UPDATES
static final boolean getAllChildrenAndVersionsPaging$UPDATES
static final boolean getNumberOfChildren$UPDATES
static final boolean getParentsToRoot$UPDATES
static final boolean getParentsToRootIds$UPDATES
static final boolean getParentsFromRoot$UPDATES
static final boolean getParentsFromRootIds$UPDATES
static final boolean updateVersionFields$UPDATES
static final boolean updateFields$UPDATES
static final boolean setSizeOfDocumentVersion$UPDATES
static final boolean updateAllChildrenAndVersionsVisibility$UPDATES
static final boolean updateAllChildrenAndVersionsExpiration$UPDATES
static final boolean move$UPDATES
static final boolean copy$UPDATES
static final boolean delete$UPDATES
static final boolean deleteContent$UPDATES
static final boolean deleteVersion$UPDATES
static final boolean deleteVersions$UPDATES
static final boolean deactivate$UPDATES
static final boolean deactivateVersion$UPDATES
static final boolean deactivateVersions$UPDATES
static final boolean reactivate$UPDATES
static final boolean getInactive$UPDATES
static final boolean getInactiveIds$UPDATES
static final boolean getInactiveIdsNoSystem$UPDATES
static final boolean getInactivePaging$UPDATES
static final boolean getMyInactiveIds$UPDATES
static final boolean getMyInactive$UPDATES
static final boolean getMyInactivePaging$UPDATES
static final boolean deleteMyInactive$UPDATES
static final boolean getLinks$UPDATES
static final boolean getLinkIds$UPDATES
static final boolean getLinksOfType$UPDATES
static final boolean getLinkIdsOfType$UPDATES
static final boolean addLinks$UPDATES
static final boolean removeLinks$UPDATES
static final boolean getLinkedBy$UPDATES
static final boolean searchByRoot$UPDATES
static final boolean searchIdsByRoot$UPDATES
static final boolean searchByRootPaging$UPDATES
static final boolean searchWithin$UPDATES
static final boolean searchIdsWithin$UPDATES
static final boolean searchWithinPaging$UPDATES
static final boolean queryByRoot$UPDATES
static final boolean queryIdsByRoot$UPDATES
static final boolean queryByRootPaging$UPDATES
static final boolean getExpired$UPDATES
static final boolean getExpiredIds$UPDATES
static final boolean getExpiredPaging$UPDATES
static final boolean unexpire$UPDATES
static final boolean lock$UPDATES
static final boolean unlock$UPDATES
static final boolean breakLock$UPDATES
static final boolean approve$UPDATES
static final boolean approveVersion$UPDATES
static final boolean reject$UPDATES
static final boolean rejectVersion$UPDATES
static final boolean notifyApproved$UPDATES
static final boolean requestAccess$UPDATES
static final boolean checkAccess$UPDATES
static final boolean approveUsers$UPDATES
static final boolean rejectUsers$UPDATES
static final boolean getPending$UPDATES
static final boolean getPendingPaging$UPDATES
static final boolean getNumberOfRequests$UPDATES
static final boolean getRequests$UPDATES
static final boolean getPendingUsers$UPDATES
static final boolean getPendingReview$UPDATES
static final boolean getPendingReviews$UPDATES
static final boolean getFavoritesByRoot$UPDATES
static final boolean getFavoriteByRootIds$UPDATES
static final boolean getFavoritesByRootPaging$UPDATES
static final boolean isFavorite$UPDATES
static final boolean areFavorites$UPDATES
static final boolean populateFavorites$UPDATES
static final boolean addFavorite$UPDATES
static final boolean addFavoriteForUsers$UPDATES
static final boolean addFavorites$UPDATES
static final boolean removeFavorite$UPDATES
static final boolean removeFavorites$UPDATES
static final boolean removeFavoriteForUsers$UPDATES
static final boolean cleanseFavorites$UPDATES
static final boolean cleanseApprovals$UPDATES
static final boolean getRoleMap$UPDATES
static final boolean setRoleMap$UPDATES
static final boolean setRoleMapForAllVersions$UPDATES
static final boolean getRestrictionMap$UPDATES
static final boolean setRestrictionMap$UPDATES
static final boolean setActorsInRoles$UPDATES
static final boolean getRoleSet$UPDATES
static final boolean getRoleSets$UPDATES
static final boolean getRoleSetForUser$UPDATES
static final boolean getRoleSetsForUser$UPDATES
static final boolean getRoleSetForGroup$UPDATES
static final boolean getRoleSetsForGroup$UPDATES
static final boolean populateRoleSets$UPDATES
static final boolean populateExtensionInfo$UPDATES
static final boolean localize$UPDATES
static final boolean addUserInRole$UPDATES
static final boolean addUsersInRole$UPDATES
static final boolean removeUserFromRole$UPDATES
static final boolean removeUsersFromRole$UPDATES
static final boolean addGroupInRole$UPDATES
static final boolean addGroupsInRole$UPDATES
static final boolean removeGroupFromRole$UPDATES
static final boolean removeGroupsFromRole$UPDATES
static final boolean getViewable$UPDATES
static final boolean getViewableByUser$UPDATES
static final boolean getEditable$UPDATES
static final boolean getEditableByUser$UPDATES
static final boolean getAdministratable$UPDATES
static final boolean getAdministratableByUser$UPDATES
static final boolean canAdministrate$UPDATES
static final boolean canUserAdministrate$UPDATES
static final boolean canGroupAdministrate$UPDATES
static final boolean isViewNotRestricted$UPDATES
static final boolean isEditNotRestricted$UPDATES
static final boolean isAdministrateNotRestricted$UPDATES
static final boolean canEdit$UPDATES
static final boolean canUserEdit$UPDATES
static final boolean canGroupEdit$UPDATES
static final boolean canView$UPDATES
static final boolean canUserView$UPDATES
static final boolean canGroupView$UPDATES
static final boolean getAccessLevel$UPDATES
static final boolean getAccessLevelForUser$UPDATES
static final boolean getWhatsNew$UPDATES
static final boolean getWhatsNewIds$UPDATES
static final boolean getWhatsNewPaging$UPDATES
static final boolean setPersonalId$UPDATES
static final boolean getPersonalId$UPDATES
static final boolean getPersonal$UPDATES
static final boolean getPersonalAndTeamsIds$UPDATES
static final boolean getPersonalAndTeams$UPDATES
static final boolean getPersonalAndTeamsPaging$UPDATES
static final boolean browse$UPDATES
static final boolean browseIds$UPDATES
static final boolean browsePaging$UPDATES
static final boolean getDownloadLogType$UPDATES
static final boolean updateUsernames$UPDATES
static final boolean rollbackUpdateUsernames$UPDATES
static final boolean commitUpdateUsernames$UPDATES
static final boolean getSystemId$UPDATES
static final boolean getSystemIds$UPDATES
static final boolean getSystemNames$UPDATES
static final boolean setSystemId$UPDATES
static final boolean setSystemIds$UPDATES
static final boolean setRoot$UPDATES
static final boolean setAsRoot$UPDATES
static final boolean suggest$UPDATES
static final boolean adjustCounter$UPDATES
static final boolean moveKnowledgeCenter$UPDATES
static final boolean moveKnowledgeCenters$UPDATES
static final boolean validateTypedValues$UPDATES
static final boolean getIdByUuid$UPDATES
static final boolean getIdsByUuid$UPDATES
static final boolean getDatatypeIds$UPDATES
static final boolean getDocumentInputStream$UPDATES
static final boolean uploadDocument$UPDATES
java.lang.String getApplicationName()
java.lang.String generateSearchIndex(java.sql.Timestamp timestamp_)
timestamp_ - only include content modified since timestamp (may be null for all)void setAdministratorGroup(java.lang.Long groupId_)
groupId_ - the ID of the group to set as administratorsgetAdministratorGroup()java.lang.Long getAdministratorGroup()
setAdministratorGroup(Long)@Deprecated
void activateUserSession(java.lang.Long[] memberOfGroups_,
java.lang.Long[] adminOfGroups_,
java.lang.Integer userTypeSysAdmin_)
memberOfGroups_ - ID(s) of groups for which the current user is a memberadminOfGroups_ - ID(s) of groups for which the current user is an adminuserTypeSysAdmin_ - user type (0 basic; 1 sysadmin)@Deprecated
java.lang.Boolean validateGroupMembership(java.lang.Long[] memberOfGroups_,
java.lang.Long[] adminOfGroups_)
throws InvalidUserException
memberOfGroups_ - ID(s) of groups for which the current user is a memberadminOfGroups_ - ID(s) of groups for which the current user is an adminInvalidUserException - if an invalid user is referenced@Deprecated void resetGroupMembership(java.sql.Timestamp timestamp_)
timestamp_ - group membership will be cleared for users who have not logged
in since this timestamp@Deprecated void notifyUserCreation(java.lang.String userName_)
userName_ - username of the user that was created@Deprecated void notifyUsersCreation(java.lang.String[] userNames_)
userNames_ - usernames of the users that were createdvoid notifyGroupDeletion(java.lang.Long groupId_)
groupId_ - the ID of the group that was deletedvoid notifyGroupsDeletion(java.lang.Long[] groupIds_)
groupIds_ - the IDs of the groups that were deleted@Deprecated
void setUserSpaceUsage(java.lang.String username_,
java.lang.Long bytesUsed_)
throws InvalidUserException,
StorageLimitException
username_ - the username of the user for which to set the space usagebytesUsed_ - the number of bytes that user has used. Passing a
negative value will throw an IllegalArgumentException.InvalidUserException - if an invalid user is referencedStorageLimitException - if there is no more available spacegetUserSpaceUsage()@Deprecated java.lang.Long getUserSpaceUsage()
setUserSpaceUsage(String, Long)@Deprecated
void setUserSpaceAvailable(java.lang.String username_,
java.lang.Long bytes_)
throws InvalidUserException
username_ - the username of the user for which to set the quotabytes_ - the number of bytes to set the quota to. Passing 0 will cause it to use
the value set for server.conf.collaboration.DEFAULTSPACE in custom.properties. Passing a
negative value will throw an IllegalArgumentException.InvalidUserException - if an invalid user is referencedgetUserSpaceAvailable()@Deprecated java.lang.Long getUserSpaceAvailable()
- 1
Long availableSpace = contentService.getUserSpaceAvailable() - contentService.getUserSpaceUsage();
setUserSpaceAvailable(String, Long)@Deprecated java.lang.Long getUserSpaceAvailableForUser(java.lang.String username)
- 1username - the username of the user for which to get the quotagetUserSpaceAvailable(),
setUserSpaceAvailable(String, Long)java.lang.Long[] getImageIdsForUsers(java.lang.String[] usernames)
usernames - the usernames for which to queryjava.lang.Long[] getThumbnailIdsForUsers(java.lang.String[] usernames,
int size)
usernames - the usernames for which to querysize - the thumbnail size (width in pixels)java.lang.Integer validate(java.lang.Long id_)
id_ - the ID of the contentjava.lang.Integer[] validate(java.lang.Long[] ids_)
ids_ - the IDs of the contentApproval createApproval(Content content_, java.lang.Integer unique_) throws InvalidContentException, StorageLimitException, PrivilegeException, InsufficientNameUniquenessException, DuplicateUuidException
Approval bean.
See create(Content[], Integer).content_ - the content to createunique_ - how unique the name must be (one of
ContentConstants.UNIQUE_NONE, ContentConstants.UNIQUE_FOR_TYPE,
ContentConstants.UNIQUE_FOR_PARENT, or ContentConstants.UNIQUE_FOR_ALL)Approval beanInvalidContentException - if an invalid content item is referencedStorageLimitException - if there is no more available spacePrivilegeException - if the user does not have permission to take this actionInsufficientNameUniquenessException - if the content name is not unique according to the unique_ parameterDuplicateUuidException - if a content item with the same uuid already existsApproval createApproval(Content[] contents_, java.lang.Integer unique_) throws InvalidContentException, StorageLimitException, PrivilegeException, InsufficientNameUniquenessException, DuplicateUuidException
Approval bean.contents_ - the content to createunique_ - how unique the name must be (one of
ContentConstants.UNIQUE_NONE, ContentConstants.UNIQUE_FOR_TYPE,
ContentConstants.UNIQUE_FOR_PARENT, or ContentConstants.UNIQUE_FOR_ALL)Approval beanInvalidContentException - if an invalid content item is referencedStorageLimitException - if there is no more available spacePrivilegeException - if the user does not have permission to take this actionInsufficientNameUniquenessException - if the content name is not unique according to the unique_ parameterDuplicateUuidException - if a content item with the same uuid already existsjava.lang.Long create(Content content_, java.lang.Integer unique_) throws InvalidContentException, StorageLimitException, PrivilegeException, InsufficientNameUniquenessException, DuplicateUuidException
ContentConstants.TYPE_DOCUMENT, you must separately
create the actual file on disk in the path specified by the internalFileName property
of the object. This method does not create the file on disk.
create(Content[], Integer)content_ - the content to createunique_ - how unique the name must be (one of
ContentConstants.UNIQUE_NONE, ContentConstants.UNIQUE_FOR_TYPE,
ContentConstants.UNIQUE_FOR_PARENT, or ContentConstants.UNIQUE_FOR_ALL)InvalidContentException - if an invalid content item is referencedStorageLimitException - if there is no more available spacePrivilegeException - if the user does not have permission to take this actionInsufficientNameUniquenessException - if the content name is not unique according to the unique_ parameterDuplicateUuidException - if a content item with the same uuid already existsjava.lang.Long[] create(Content[] contents_, java.lang.Integer unique_) throws InvalidContentException, StorageLimitException, PrivilegeException, InsufficientNameUniquenessException, DuplicateUuidException
contents_ - an array of Content objectsunique_ - how unique the name must be (one of
ContentConstants.UNIQUE_NONE, ContentConstants.UNIQUE_FOR_TYPE,
ContentConstants.UNIQUE_FOR_PARENT, or ContentConstants.UNIQUE_FOR_ALL)InvalidContentException - if an invalid content item is referencedStorageLimitException - if there is no more available spacePrivilegeException - if the user does not have permission to take this actionInsufficientNameUniquenessException - if the content name is not unique according to the unique_ parameterDuplicateUuidException - if a content item with the same uuid already existsApproval createVersion(Content content_, java.lang.Integer unique_) throws InvalidContentException, NotLockOwnerException, PendingApprovalException, ContentExpiredException, StorageLimitException, PrivilegeException, InsufficientNameUniquenessException
move(Long, Long).
The new version will have the same security role map as its parent, even if the content is not
otherwise set to inherit security. For content that should not inherit security from its parent, call
setRoleMap(java.lang.Long, com.appiancorp.suiteapi.content.ContentRoleMap, java.lang.Boolean) after creating the new version.
When creating a new version of a Document, set the file system id on the document to be
auto-allocated before passing it to createVersion. The following code example demonstrates
using this method:
Document doc = contentService.getVersion(docId, ContentConstants.VERSION_CURRENT);
// prepare the document, indicating the service to assign a new file path
// to the new version of the document
doc.setFileSystemId(ContentConstants.ALLOCATE_FSID);
// create a new version
Approval a = contentService.createVersion(doc, unique);
// get the file path of the new version
Long newVersionContentId = a.getId()[0];
Document newDocumentVersion = cs.download(newVersionContentId, VERSION_CURRENT, false);
try (OutputStream outStream = newDocumentVersion.getOutputStream()) {
IOUtils.copy(inStream, outStream);
}
content_ - a Content objectunique_ - how unique the name must be (one of
ContentConstants.UNIQUE_NONE, ContentConstants.UNIQUE_FOR_TYPE,
ContentConstants.UNIQUE_FOR_PARENT, or ContentConstants.UNIQUE_FOR_ALL)Approval beanInvalidContentException - if an invalid content item is referencedNotLockOwnerException - if the content is locked and the current user is not the ownerPendingApprovalException - if the content is pending approvalContentExpiredException - if the content you reference is expiredStorageLimitException - if there is no more available spacePrivilegeException - if the user does not have permission to take this actionInsufficientNameUniquenessException - if the content name is not unique according to the unique_ parameter@Deprecated Approval createVersion(Content[] contents_, java.lang.Integer unique_) throws InvalidContentException, NotLockOwnerException, PendingApprovalException, ContentExpiredException, StorageLimitException, PrivilegeException, InsufficientNameUniquenessException
createVersion(Content, Integer)move(Long[], Long) for bulk move or move(Long, Long)
individually if each has a different parent.contents_ - the content to create as new versionsunique_ - how unique the name must be (one of
ContentConstants.UNIQUE_NONE, ContentConstants.UNIQUE_FOR_TYPE,
ContentConstants.UNIQUE_FOR_PARENT, or ContentConstants.UNIQUE_FOR_ALL)Approval beanInvalidContentException - if an invalid content item is referencedNotLockOwnerException - if the content is locked and the current user is not the ownerPendingApprovalException - if the content is pending approvalContentExpiredException - if the content you reference is expiredStorageLimitException - if there is no more available spacePrivilegeException - if the user does not have permission to take this actionInsufficientNameUniquenessException - if the content name is not unique according to the unique_ parameter@Deprecated ContentOutputStream upload(Document doc, java.lang.Integer unique) throws InvalidContentException, StorageLimitException, PrivilegeException, InsufficientNameUniquenessException, DuplicateUuidException
uploadDocument(Document, Integer) insteadcreateApproval(Content, Integer) API.
The caller must write the document's data to the returned output stream and complete the upload by
calling ContentOutputStream.close(). Invoking the stream's close method will calculate the size
of the data written to the stream and save it as metadata for the document.doc - The Document to create.unique - How unique the name must be.InvalidContentExceptionStorageLimitExceptionPrivilegeExceptionInsufficientNameUniquenessExceptionDuplicateUuidException@Deprecated java.lang.Long[] importContent(Content[] contents_, java.lang.Integer unique_) throws InvalidContentException, NotLockOwnerException, PendingApprovalException, ContentExpiredException, StorageLimitException, PrivilegeException, InsufficientNameUniquenessException, DuplicateUuidException
createVersion(Content[], Integer). Otherwise, it calls
create(Content[], Integer)
This does a create or createVersion, as necessary.contents_ - an array of Content objects to importunique_ - how unique the name must be (one of
ContentConstants.UNIQUE_NONE, ContentConstants.UNIQUE_FOR_TYPE,
ContentConstants.UNIQUE_FOR_PARENT, or ContentConstants.UNIQUE_FOR_ALL)InvalidContentException - if an invalid content item is referencedNotLockOwnerException - if the content is locked and the current user is not the ownerPendingApprovalException - if the content is pending approvalContentExpiredException - if the content you reference is expiredStorageLimitException - if there is no more available spacePrivilegeException - if the user does not have permission to take this actionInsufficientNameUniquenessException - if the content name is not unique according to the unique_ parameterDuplicateUuidException - if the UUID of any of the content items already
exists or if the same UUID is passed in for several content itemsjava.lang.Integer[] importValidate(Content[] contents_) throws InvalidContentException, NotLockOwnerException, PendingApprovalException, ContentExpiredException, StorageLimitException, PrivilegeException
contents_ - an array of Content objects to validateContentConstants.IMPORT_VALID,
ContentConstants.IMPORT_INVALID_PRIVILEGE,
ContentConstants.IMPORT_UUID_EXISTS_ELSEWHERE,
ContentConstants.IMPORT_INVALID_PRIVILEGE,
ContentConstants.IMPORT_NAME_EXISTS_WITHIN_TYPE, or
ContentConstants.IMPORT_NAME_EXISTS_WITHIN_PARENTInvalidContentException - if an invalid content item is referencedNotLockOwnerException - if the content is locked and the current user is not the ownerPendingApprovalException - if the content is pending approvalContentExpiredException - if the content you reference is expiredStorageLimitException - if there is no more available spacePrivilegeException - if the user does not have permission to take this actionInsufficientNameUniquenessException - if the content name is not unique according to the unique_ parameter@Deprecated Content getContent(java.lang.Long id_) throws InvalidContentException, PrivilegeException
getVersion(Long, Integer) insteadid_ - the ID of the contentContent beanInvalidContentException - if an invalid content item is referencedPrivilegeException - if the user does not have permission to take this action@Deprecated Content[] getContent(java.lang.Long[] ids_) throws InvalidContentException
getVersionsPaging(Long, Integer[], int, int, Integer, Integer) insteadgetVersion(Long, Integer) with version number ContentConstants.VERSION_CURRENT
instead. If retrieving a Document the internalFilename property won't be
populated; use download(Long, Integer, Boolean) instead.ids_ - the IDs of the contentContent beansInvalidContentException - if an invalid content item is referencedgetContentPaging(Long[], int, int, Integer, Integer)ResultList getContentList(java.lang.Long[] ids_, java.lang.Integer typemask_) throws InvalidTypeMaskException
getContent(Long[]), except it takes a type
mask and returns error codes instead of throwing exceptions.ids_ - the IDs of the contenttypemask_ - the types of content to returnResultList of Content beans.InvalidTypeMaskException - if an invalid typemask was passed in@Deprecated ResultPage getContentPaging(java.lang.Long[] ids_, int startIndex_, int batchSize_, java.lang.Integer sortProperty_, java.lang.Integer sortOrder_) throws InvalidContentException
getVersionsPaging(Long[], Integer, int, int, Integer, Integer) insteadgetContent(Long[]), except it pages and
returns error codes instead of throwing exceptions.ids_ - the IDs of the contentstartIndex_ - the index into the collection of total results at which
to start. Negative numbers are treated as zeros.batchSize_ - the number of results to return.
Use Constants.COUNT_ALL
to return the entire collection, but this is STRONGLY discouraged.sortProperty_ - the property by which the results will be sorted.
This is one of the COLUMN_XXX constants in ContentConstants.sortOrder_ - the order in which to sort the results.This is one of
Constants.SORT_ORDER_ASCENDING
or Constants.SORT_ORDER_DESCENDINGContent objectsInvalidContentException - if an invalid content item is referencedgetContent(Long[])@Deprecated Content[] getContentTree(java.lang.Long rootContentId_, java.lang.Integer maxDepth_, java.lang.Integer typemask_, java.lang.Integer accessLevel_) throws InvalidContentException, InvalidTypeMaskException
getContentTreePaging(Long, Integer, Integer, Integer, int, int, Integer, Integer) insteadContent beans.rootContentId_ - (atomic efficient)maxDepth_ - the maximum depth to traverse the treetypemask_ - only return contents that match this typemaskaccessLevel_ - the minimum access level required (one of
ContentConstants.AL_NONE, ContentConstants.AL_VIEWER,
ContentConstants.AL_EDITOR, and ContentConstants.AL_ADMINInvalidContentException - if an invalid content item is referencedInvalidTypeMaskException - if an invalid typemask was passed ingetContentTreePaging(Long, Integer, Integer, Integer, int, int, Integer, Integer)ResultPage getContentTreePaging(java.lang.Long rootContentId_, java.lang.Integer maxDepth_, java.lang.Integer typemask_, java.lang.Integer accessLevel_, int startIndex_, int batchSize_, java.lang.Integer sortProperty_, java.lang.Integer sortOrder_) throws InvalidContentException, InvalidTypeMaskException
Content beans.rootContentId_ - (atomic efficient)maxDepth_ - the maximum depth to traverse the treetypemask_ - only return contents that match this typemaskaccessLevel_ - (0 is view, 1 is edit, 2 is admin)startIndex_ - the index into the collection of total results at which
to start. Negative numbers are treated as zeros.batchSize_ - the number of results to return.
Use Constants.COUNT_ALL
to return the entire collection, but this is STRONGLY discouraged.sortProperty_ - the property by which the results will be sorted.
This is one of the COLUMN_XXX constants in ContentConstants.sortOrder_ - the order in which to sort the results.This is one of
Constants.SORT_ORDER_ASCENDING
or Constants.SORT_ORDER_DESCENDINGInvalidContentException - if an invalid content item is referencedInvalidTypeMaskException - if an invalid typemask was passed ingetContentTree(Long, Integer, Integer, Integer)@Deprecated Content[] getContentWhereViewable(java.lang.Long[] ids_) throws InvalidContentException
getContentWhereViewablePaging(Long[], int, int, Integer, Integer) insteadContent beans returned may not
be the same length as the array of IDs passed in.ids_ - the IDs of the contentContent beans that are viewableInvalidContentExceptiongetContentWhereViewablePaging(Long[], int, int, Integer, Integer)java.lang.Long[] getContentIdsWhereViewable(java.lang.Long[] ids_)
throws InvalidContentException
ids_ - the IDs of the contentInvalidContentExceptionResultPage getContentWhereViewablePaging(java.lang.Long[] ids_, int startIndex_, int batchSize_, java.lang.Integer sortProperty_, java.lang.Integer sortOrder_) throws InvalidContentException
ids_ - the IDs of the contentstartIndex_ - the index into the collection of total results at which
to start. Negative numbers are treated as zeros.batchSize_ - the number of results to return.
Use Constants.COUNT_ALL
to return the entire collection, but this is STRONGLY discouraged.sortProperty_ - the property by which the results will be sorted.
This is one of the COLUMN_XXX constants in ContentConstants.sortOrder_ - the order in which to sort the results.This is one of
Constants.SORT_ORDER_ASCENDING
or Constants.SORT_ORDER_DESCENDINGContent beans that are viewableInvalidContentExceptiongetContentWhereViewable(Long[])java.lang.String getContentUrl(long contentId)
contentId - the internal identifier of the contentjava.lang.String getOpaqueContentUri(long contentId)
contentId - the internal identifier of the contentContent getVersion(java.lang.Long id_, java.lang.Integer versionNumber_) throws InvalidContentException, InvalidVersionException, PrivilegeException
Document the
internalFilename property won't be populated; use
download(Long, Integer, Boolean) instead.id_ - the content id (any id within a version chain will do)versionNumber_ - the version number of content to get (use
ContentConstants.VERSION_ORIGINAL to get the first version of the content and
ContentConstants.VERSION_CURRENT to get the current version of the content)Content beanInvalidContentException - if an invalid content item is referencedInvalidVersionException - if an invalid version is referencedPrivilegeException - if the user does not have permission to take this actionContent getVersion(@ConvertWith(value=com.appiancorp.kougar.mapper.parameters.UuidParameterConverter.class) java.lang.String uuid, java.lang.Integer versionNumber) throws InvalidContentException, InvalidVersionException, PrivilegeException
Document the
internalFilename property won't be populated; use
download(Long, Integer, Boolean) instead.uuid - the content UUID (any UUID within a version chain will do), as if by getIdByUuidversionNumber - the version number of content to get (use
ContentConstants.VERSION_ORIGINAL to get the first version of the content and
ContentConstants.VERSION_CURRENT to get the current version of the content)Content beanInvalidContentException - if an invalid content item is referencedInvalidVersionException - if an invalid version is referencedPrivilegeException - if the user does not have permission to take this action@Deprecated Content[] getVersions(java.lang.Long[] ids_, java.lang.Integer versionNumber_) throws InvalidContentException, InvalidVersionException, PrivilegeException
getVersionsPaging(Long, Integer[], int, int, Integer, Integer) insteadids_ - the content ids (any id within a version chain will do)versionNumber_ - the version number of content to get (use
ContentConstants.VERSION_ORIGINAL to get the first version of the content and
ContentConstants.VERSION_CURRENT to get the current version of the content)Content beansInvalidContentException - if an invalid content item is referencedInvalidVersionException - if an invalid version is referencedPrivilegeException - if the user does not have permission to take this actiongetVersionsPaging(Long[], Integer, int, int, Integer, Integer)Content[] getVersions(java.lang.Long id_, java.lang.Integer[] versionNumbers_) throws InvalidContentException, InvalidVersionException, PrivilegeException
id_ - the content id (any id within a version chain will do)versionNumbers_ - the version numbers of content to get (use
ContentConstants.VERSION_ORIGINAL to get the first version of the content and
ContentConstants.VERSION_CURRENT to get the current version of the content)Content beansInvalidContentException - if an invalid content item is referencedInvalidVersionException - if an invalid version is referencedPrivilegeException - if the user does not have permission to take this actiongetVersionsPaging(Long, Integer[], int, int, Integer, Integer)ResultPage getVersionsPaging(java.lang.Long[] ids_, java.lang.Integer versionNumber_, int startIndex_, int batchSize_, java.lang.Integer sortProperty_, java.lang.Integer sortOrder_) throws InvalidContentException, InvalidVersionException, PrivilegeException
ids_ - the content ids (any id within a version chain will do)versionNumber_ - the version number of content to get (use
ContentConstants.VERSION_ORIGINAL to get the first version of the content and
ContentConstants.VERSION_CURRENT to get the current version of the content)startIndex_ - the index into the collection of total results at which
to start. Negative numbers are treated as zeros.batchSize_ - the number of results to return.
Use Constants.COUNT_ALL
to return the entire collection, but this is STRONGLY discouraged.sortProperty_ - the property by which the results will be sorted.
This is one of the COLUMN_XXX constants in ContentConstants.sortOrder_ - the order in which to sort the results.This is one of
Constants.SORT_ORDER_ASCENDING
or Constants.SORT_ORDER_DESCENDINGContent objectsInvalidContentException - if an invalid content item is referencedInvalidVersionException - if an invalid version is referencedPrivilegeException - if the user does not have permission to take this actionResultPage getVersionsPaging(java.lang.Long id_, java.lang.Integer[] versionNumbers_, int startIndex_, int batchSize_, java.lang.Integer sortProperty_, java.lang.Integer sortOrder_) throws InvalidContentException, InvalidVersionException, PrivilegeException
id_ - the content id (any id within a version chain will do)versionNumbers_ - the version numbers of content to get (use
ContentConstants.VERSION_ORIGINAL to get the first version of the content and
ContentConstants.VERSION_CURRENT to get the current version of the content)startIndex_ - the index into the collection of total results at which
to start. Negative numbers are treated as zeros.batchSize_ - the number of results to return.
Use Constants.COUNT_ALL
to return the entire collection, but this is STRONGLY discouraged.sortProperty_ - the property by which the results will be sorted.
This is one of the COLUMN_XXX constants in ContentConstants.sortOrder_ - the order in which to sort the results.This is one of
Constants.SORT_ORDER_ASCENDING
or Constants.SORT_ORDER_DESCENDINGResultList of Content objects. In the case
where there is an exception (such as access restriction) the ResultList.getResultCodes() will have an
entry for every id passed to it, but the Result.getResults() will
only have an entry for every valid result returned. i.e. ResultList.getResultCodes().length does not
always equal Result.getResults().length. They are equal only when *all* items in the ResultList array
are >= ResultList.CODE_VALID.InvalidContentException - if an invalid content item is referencedInvalidVersionException - if an invalid version is referencedPrivilegeException - if the user does not have permission to take this actionResultList getVersionsList(java.lang.Long[] ids, java.lang.Integer versionNumber, java.lang.Integer typemask) throws InvalidTypeMaskException, InvalidVersionException
ResultList APIs, this method returns
error codes instead of throwing exceptions. Note that the result array is not castable
to something other than Content[]. The results should then be cast individually.ids - The ids of the content objects to retrieve.versionNumber - The version of the content objects to retrieve.typemask - The type of content objects to retrieve.ResultList of Content objects. In the case
where there is an exception (such as access restriction) the ResultList.getResultCodes() will have an
entry for every id passed to it, but the Result.getResults() will
only have an entry for every valid result returned. i.e. ResultList.getResultCodes().length does not
always equal Result.getResults().length. They are equal only when all items in the ResultList array are
>= ResultList.CODE_VALID.InvalidTypeMaskException - if an invalid type is passed inInvalidVersionException - if an invalid version number is passed injava.lang.Long getVersionId(java.lang.Long id_,
java.lang.Integer versionNumber_)
throws InvalidContentException,
InvalidVersionException,
PrivilegeException
id_ - the content id (any id within a version chain will do)versionNumber_ - the version number of content to get (use
ContentConstants.VERSION_ORIGINAL to get the first version of the content and
ContentConstants.VERSION_CURRENT to get the current version of the content)InvalidContentException - if an invalid content item is referencedInvalidVersionException - if an invalid version is referencedPrivilegeException - if the user does not have permission to take this actionjava.lang.Long getVersionId(@ConvertWith(value=com.appiancorp.kougar.mapper.parameters.UuidParameterConverter.class)
java.lang.String uuid,
java.lang.Integer versionNumber)
throws InvalidContentException,
InvalidVersionException,
PrivilegeException
uuid - the content UUID (any UUID within a version chain will do), as if by getIdByUuidversionNumber - the version number of content to get (use
ContentConstants.VERSION_ORIGINAL to get the first version of the content and
ContentConstants.VERSION_CURRENT to get the current version of the content)InvalidContentException - if an invalid content item is referencedInvalidVersionException - if an invalid version is referencedPrivilegeException - if the user does not have permission to take this actionjava.lang.Long[] getVersionIds(java.lang.Long[] ids_,
java.lang.Integer versionNumber_)
throws InvalidContentException,
InvalidVersionException,
PrivilegeException
ids_ - the content id (any id within a version chain will do)versionNumber_ - the version number of content to get (use
ContentConstants.VERSION_ORIGINAL to get the first version of the content and
ContentConstants.VERSION_CURRENT to get the current version of the content)InvalidContentException - if an invalid content item is referencedInvalidVersionException - if an invalid version is referencedPrivilegeException - if the user does not have permission to take this actionjava.lang.Long[] getVersionIds(java.lang.Long id_,
java.lang.Integer[] versionNumbers_)
throws InvalidContentException,
InvalidVersionException,
PrivilegeException
id_ - the content id (any id within a version chain will do)versionNumbers_ - the version number of content to get (use
ContentConstants.VERSION_ORIGINAL to get the first version of the content and
ContentConstants.VERSION_CURRENT to get the current version of the content)InvalidContentException - if an invalid content item is referencedInvalidVersionException - if an invalid version is referencedPrivilegeException - if the user does not have permission to take this action@Deprecated Content[] getAllVersions(java.lang.Long id_) throws InvalidContentException
getAllVersionsPaging(Long, int, int, Integer, Integer) insteadid_ - the content id (any id within a version chain will do)InvalidContentException - if an invalid content item is referencedgetAllVersionsPaging(Long, int, int, Integer, Integer)ResultPage getAllVersionsPaging(java.lang.Long id_, int startIndex_, int batchSize_, java.lang.Integer sortProperty_, java.lang.Integer sortOrder_) throws InvalidContentException
id_ - the content id (any id within a version chain will do)startIndex_ - the index into the collection of total results at which
to start. Negative numbers are treated as zeros.batchSize_ - the number of results to return.
Use Constants.COUNT_ALL
to return the entire collection, but this is STRONGLY discouraged.sortProperty_ - the property by which the results will be sorted.
This is one of the COLUMN_XXX constants in ContentConstants.sortOrder_ - the order in which to sort the results.This is one of
Constants.SORT_ORDER_ASCENDING
or Constants.SORT_ORDER_DESCENDINGContent objectsInvalidContentException - if an invalid content item is referencedgetAllVersions(Long)java.lang.Long[] getAllVersionIds(java.lang.Long id_)
throws InvalidContentException
id_ - the content id (any id within a version chain will do)InvalidContentException - if an invalid content item is referencedDocument[] download(java.lang.Long id_, java.lang.Integer versionNumber_, java.lang.Boolean includeExpired_) throws InvalidContentException, InvalidVersionException, PrivilegeException
getVersion(java.lang.Long, java.lang.Integer), but the download is logged if
logging is enabled.
If the content passed in is a container (e.g., a folder), all documents inside
the container will be returned, and each document obtained is logged if
logging is enabled.
This function will only be used for Knowledge content.id_ - the id of content to downloadversionNumber_ - the version number of content to downloadincludeExpired_ - whether to include expired contentInvalidContentException - if an invalid content item is referencedInvalidVersionException - if an invalid version is referencedPrivilegeException - if the user does not have permission to take this action@Deprecated
java.lang.String getInternalFilename(java.lang.Long id_)
throws InvalidContentException
getDocumentInputStream(long) for reads and
uploadDocument(Document, Integer) for writes,
or call #download(Long, Integer, Boolean) and use supported APIs on {@link com.appiancorp.suiteapi.knowledge.Document}getVersionId(Long, Integer) with ContentConstants.VERSION_CURRENT to get the most
current Id.id_ - the content ID of the version of the document;
use getVersionId(Long, Integer) to obtain the id of the version of the documentInvalidContentException - if an invalid content item is referenced@Deprecated
java.lang.String[] getInternalFilenames(java.lang.Long[] ids_)
throws InvalidContentException
getDocumentInputStream(long[])ids_ - the content IDs of the versions of the documents;
use getVersionIds(Long, Integer[]) to obtain the ids of the versions of the documentInvalidContentException - if an invalid content item is referencedjava.lang.String getExternalFilename(java.lang.Long id_)
throws InvalidContentException
id_ - the content IDInvalidContentException - if an invalid content item is referencedjava.lang.String[] getExternalFilenames(java.lang.Long[] ids_)
throws InvalidContentException
ids_ - the content IDsInvalidContentException - if an invalid content item is referencedContent getByPath(java.lang.Long root_, java.lang.String path_) throws InvalidContentException
root_ - the id of the root Content itempath_ - the path relative to the root. containers are separated by "/"Content beanInvalidContentException - if an invalid content item is referencedjava.lang.Long getIdByPath(java.lang.Long root_,
java.lang.String path_)
throws InvalidContentException
root_ - the id of the root Content itempath_ - the path relative to the root. containers are separated by "/"InvalidContentException - if an invalid content item is referencedContent getParent(java.lang.Long id_) throws InvalidContentException
id_ - the id of the Content itemContent beanInvalidContentException - if an invalid content item is referencedContent[] getParents(java.lang.Long[] ids_) throws InvalidContentException
ids_ - the id of the Content itemsContent beansInvalidContentException - if an invalid content item is referencedjava.lang.Long getParentId(java.lang.Long id_)
throws InvalidContentException
id_ - the id of the Content itemInvalidContentException - if an invalid content item is referencedjava.lang.Long[] getParentIds(java.lang.Long[] ids_)
throws InvalidContentException
ids_ - the ids of the Content itemsInvalidContentException - if an invalid content item is referencedjava.lang.Boolean hasNoChildren(java.lang.Long containerId_)
throws InvalidContentException
hasChildren(Long).containerId_ - the ID of the containerInvalidContentException - if an invalid content item is referencedjava.lang.Boolean[] haveNoChildren(java.lang.Long[] containerIds_)
throws InvalidContentException
haveChildren(Long[]).containerIds_ - the IDs of the containersInvalidContentException - if an invalid content item is referencedjava.lang.Boolean hasNoChildrenOfType(java.lang.Long containerId_,
java.lang.Integer typemask_)
throws InvalidTypeMaskException
containerId_ - the ID of the containertypemask_ - specifies which content types to look forInvalidTypeMaskException - if an invalid typemask was passed injava.lang.Boolean[] haveNoChildrenOfType(java.lang.Long[] containerIds_,
java.lang.Integer typemask_)
throws InvalidTypeMaskException
containerIds_ - the IDs of the containerstypemask_ - specifies which content types to look forInvalidTypeMaskException - if an invalid typemask was passed injava.lang.Boolean hasChildren(java.lang.Long containerId_)
throws InvalidContentException
hasNoChildren(Long)containerId_ - the ID of the containerInvalidContentException - if an invalid content item is referencedjava.lang.Boolean[] haveChildren(java.lang.Long[] containerIds_)
throws InvalidContentException
haveNoChildren(Long[]).containerIds_ - the IDs of the containersInvalidContentException - if an invalid content item is referencedjava.lang.Boolean[] haveChildren(Content[] containers_) throws InvalidContentException
Content beans passed
in, and calls haveChildren(Long[]) with those IDs.containers_ - the containers to checkInvalidContentException - if an invalid content item is referencedjava.lang.Boolean hasChildrenOfType(java.lang.Long containerId_,
java.lang.Integer typemask_)
throws InvalidContentException,
InvalidTypeMaskException
containerId_ - the ID of the containertypemask_ - children types to look forInvalidContentException - if an invalid content item is referencedInvalidTypeMaskException - if an invalid typemask was passed injava.lang.Boolean[] haveChildrenOfType(java.lang.Long[] containerIds_,
java.lang.Integer typemask_)
throws InvalidContentException,
InvalidTypeMaskException
containerIds_ - the IDs of the containerstypemask_ - children types to look forInvalidContentException - if an invalid content item is referencedInvalidTypeMaskException - if an invalid typemask was passed injava.lang.Integer getChildrenTypesOfType(java.lang.Long containerId_,
java.lang.Integer typemask_)
throws InvalidContentException,
InvalidTypeMaskException
containerId_ - container idtypemask_ - children types to look forInvalidContentException - if an invalid content item is referencedInvalidTypeMaskException - if an invalid typemask was passed injava.lang.Integer[] getChildrenTypesOfType(java.lang.Long[] containerIds_,
java.lang.Integer typemask_)
throws InvalidContentException,
InvalidTypeMaskException
containerIds_ - container idstypemask_ - children types to look forInvalidContentException - if an invalid content item is referencedInvalidTypeMaskException - if an invalid typemask was passed injava.lang.Integer getChildrenTypes(java.lang.Long containerId_)
throws InvalidContentException
containerId_ - container idInvalidContentException - if an invalid content item is referencedjava.lang.Integer[] getChildrenTypes(java.lang.Long[] containerIds_)
throws InvalidContentException
containerIds_ - container idsInvalidContentException - if an invalid content item is referencedjava.lang.Integer[] getChildrenTypes(Content[] containers_) throws InvalidContentException
containers_ - containersInvalidContentException - if an invalid content item is referencedvoid populateTypesOfChildren(Content[] containers_) throws InvalidContentException
containers_ - list of containersInvalidContentException - if an invalid content item is referenced@Deprecated Content[] getChildren(java.lang.Long containerId_, ContentFilter filter_, java.lang.Integer modifiers_) throws InvalidContentException, InvalidTypeMaskException
getChildrenPaging(Long, ContentFilter, Integer, int, int, Integer, Integer) insteadcontainerId_ - root content idfilter_ - applies to what children are returnedmodifiers_ - one of ContentConstants.GC_MOD_DRAFT,
ContentConstants.GC_MOD_LINKS, ContentConstants.GC_MOD_NORMAL, or
ContentConstants.GC_MOD_POPULATE_TYPES_OF_CHILDRENInvalidContentException - if an invalid content item is referencedInvalidTypeMaskException - if the filter contains an invalid typemaskgetChildrenPaging(Long, ContentFilter, Integer, int, int, Integer, Integer)java.lang.Long[] getChildrenIds(java.lang.Long containerId_,
ContentFilter filter_,
java.lang.Integer modifiers_)
throws InvalidContentException,
InvalidTypeMaskException
containerId_ - root content idfilter_ - applies to what children are returnedmodifiers_ - one of ContentConstants.GC_MOD_DRAFT,
ContentConstants.GC_MOD_LINKS, ContentConstants.GC_MOD_NORMAL, or
ContentConstants.GC_MOD_POPULATE_TYPES_OF_CHILDRENInvalidContentException - if an invalid content item is referencedInvalidTypeMaskException - if the filter contains an invalid typemaskResultPage getChildrenPaging(java.lang.Long containerId_, ContentFilter filter_, java.lang.Integer modifiers_, int startIndex_, int batchSize_, java.lang.Integer sortProperty_, java.lang.Integer sortOrder_) throws InvalidContentException, InvalidTypeMaskException
containerId_ - root content idfilter_ - applies to what children are returnedmodifiers_ - one of ContentConstants.GC_MOD_DRAFT,
ContentConstants.GC_MOD_LINKS, ContentConstants.GC_MOD_NORMAL, or
ContentConstants.GC_MOD_POPULATE_TYPES_OF_CHILDRENstartIndex_ - the index into the collection of total results at which
to start. Negative numbers are treated as zeros.batchSize_ - the number of results to return.
Use Constants.COUNT_ALL
to return the entire collection, but this is STRONGLY discouraged.sortProperty_ - the property by which the results will be sorted.
This is one of the COLUMN_XXX constants in ContentConstants.sortOrder_ - the order in which to sort the results.This is one of
Constants.SORT_ORDER_ASCENDING
or Constants.SORT_ORDER_DESCENDINGInvalidContentException - if an invalid content item is referencedInvalidTypeMaskException - if the filter contains an invalid typemaskgetChildren(Long, ContentFilter, Integer)@Deprecated Content[] getAdvertisedChildren(java.lang.Long containerId_, ContentFilter filter_, java.lang.Integer modifiers_) throws InvalidContentException, InvalidTypeMaskException
getAdvertisedChildrenPaging(Long, ContentFilter, Integer, int, int, Integer, Integer) insteadcontainerId_ - root content idfilter_ - applies to what children are returnedmodifiers_ - one of ContentConstants.GC_MOD_DRAFT,
ContentConstants.GC_MOD_LINKS, ContentConstants.GC_MOD_NORMAL, or
ContentConstants.GC_MOD_POPULATE_TYPES_OF_CHILDRENInvalidContentException - if an invalid content item is referencedInvalidTypeMaskException - if the filter contains an invalid typemaskgetAdvertisedChildrenPaging(Long, ContentFilter, Integer, int, int, Integer, Integer)java.lang.Long[] getAdvertisedChildrenIds(java.lang.Long containerId_,
ContentFilter filter_,
java.lang.Integer modifiers_)
throws InvalidContentException,
InvalidTypeMaskException
ResultPage getAdvertisedChildrenPaging(java.lang.Long containerId_, ContentFilter filter_, java.lang.Integer modifiers_, int startIndex_, int batchSize_, java.lang.Integer sortProperty_, java.lang.Integer sortOrder_) throws InvalidContentException, InvalidTypeMaskException
ResultPage getEditablePaging(java.lang.Long rootId_, ContentFilter filter_, int startIndex_, int batchSize_, java.lang.Integer sortProperty_, java.lang.Integer sortOrder_) throws InvalidContentException, InvalidTypeMaskException
rootId_ - root content id: atomicfilter_ - applies to what children are returnedstartIndex_ - the index into the collection of total results at which
to start. Negative numbers are treated as zeros.batchSize_ - the number of results to return.
Use Constants.COUNT_ALL
to return the entire collection, but this is STRONGLY discouraged.sortProperty_ - the property by which the results will be sorted.
This is one of the COLUMN_XXX constants in ContentConstants.sortOrder_ - the order in which to sort the results.This is one of
Constants.SORT_ORDER_ASCENDING
or Constants.SORT_ORDER_DESCENDINGInvalidContentException - if an invalid content item is referencedInvalidTypeMaskException - if the filter contains an invalid typemaskgetEditable(Long, ContentFilter)ResultPage getAdministratablePaging(java.lang.Long rootId_, ContentFilter filter_, int startIndex_, int batchSize_, java.lang.Integer sortProperty_, java.lang.Integer sortOrder_) throws InvalidContentException, InvalidTypeMaskException
rootId_ - root content id: atomicfilter_ - applies to what children are returnedstartIndex_ - the index into the collection of total results at which
to start. Negative numbers are treated as zeros.batchSize_ - the number of results to return.
Use Constants.COUNT_ALL
to return the entire collection, but this is STRONGLY discouraged.sortProperty_ - the property by which the results will be sorted.
This is one of the COLUMN_XXX constants in ContentConstants.sortOrder_ - the order in which to sort the results.This is one of
Constants.SORT_ORDER_ASCENDING
or Constants.SORT_ORDER_DESCENDINGInvalidContentException - if an invalid content item is referencedInvalidTypeMaskException - if the filter contains an invalid typemaskgetAdministratable(Long, ContentFilter)ResultPage getViewablePaging(java.lang.Long rootId_, ContentFilter filter_, int startIndex_, int batchSize_, java.lang.Integer sortProperty_, java.lang.Integer sortOrder_) throws InvalidContentException, InvalidTypeMaskException
rootId_ - root content id: atomicfilter_ - applies to what children are returnedstartIndex_ - the index into the collection of total results at which
to start. Negative numbers are treated as zeros.batchSize_ - the number of results to return.
Use Constants.COUNT_ALL
to return the entire collection, but this is STRONGLY discouraged.sortProperty_ - the property by which the results will be sorted.
This is one of the COLUMN_XXX constants in ContentConstants.sortOrder_ - the order in which to sort the results.This is one of
Constants.SORT_ORDER_ASCENDING
or Constants.SORT_ORDER_DESCENDINGInvalidContentException - if an invalid content item is referencedInvalidTypeMaskException - if the filter contains an invalid typemaskgetViewable(Long, ContentFilter)@Deprecated Content[] getAllChildren(java.lang.Long containerId_, ContentFilter filter_, java.lang.Integer modifiers_) throws InvalidContentException, InvalidTypeMaskException
getAllChildrenPaging(Long, ContentFilter, Integer, int, int, Integer, Integer) insteadcontainerId_ - root content idfilter_ - applies to what children are returnedmodifiers_ - one of ContentConstants.GC_MOD_DRAFT,
ContentConstants.GC_MOD_LINKS, ContentConstants.GC_MOD_NORMAL, or
ContentConstants.GC_MOD_POPULATE_TYPES_OF_CHILDRENInvalidContentException - if an invalid content item is referencedInvalidTypeMaskException - if the filter contains an invalid typemaskgetAllChildrenPaging(Long, ContentFilter, Integer, int, int, Integer, Integer)java.lang.Long[] getAllChildrenIds(java.lang.Long containerId_,
ContentFilter filter_,
java.lang.Integer modifiers_)
throws InvalidContentException,
InvalidTypeMaskException
containerId_ - root content idfilter_ - applies to what children are returnedmodifiers_ - ContentConstants.GC_MOD_DRAFTInvalidContentException - if an invalid content item is referencedInvalidTypeMaskException - if the filter contains an invalid typemaskResultPage getAllChildrenPaging(java.lang.Long containerId_, ContentFilter filter_, java.lang.Integer modifiers_, int startIndex_, int batchSize_, java.lang.Integer sortProperty_, java.lang.Integer sortOrder_) throws InvalidContentException, InvalidTypeMaskException
containerId_ - root content idfilter_ - applies to what children are returnedmodifiers_ - ContentConstants.GC_MOD_DRAFTstartIndex_ - the index into the collection of total results at which
to start. Negative numbers are treated as zeros.batchSize_ - the number of results to return.
Use Constants.COUNT_ALL
to return the entire collection, but this is STRONGLY discouraged.sortProperty_ - the property by which the results will be sorted.
This is one of the COLUMN_XXX constants in ContentConstants.sortOrder_ - the order in which to sort the results.This is one of
Constants.SORT_ORDER_ASCENDING
or Constants.SORT_ORDER_DESCENDINGInvalidContentException - if an invalid content item is referencedInvalidTypeMaskException - if the filter contains an invalid typemaskgetAllChildren(Long, ContentFilter, Integer)@Deprecated Content[] getAllChildrenAndVersions(java.lang.Long containerId_, ContentFilter filter_) throws InvalidContentException, InvalidTypeMaskException
getAllChildrenAndVersionsPaging(Long, ContentFilter, int, int, Integer, Integer) insteadcontainerId_ - root content idfilter_ - applies to what children are returnedInvalidContentException - if an invalid content item is referencedInvalidTypeMaskException - if the filter contains an invalid typemaskgetAllChildrenAndVersionsPaging(Long, ContentFilter, int, int, Integer, Integer)java.lang.Long[] getAllChildrenAndVersionIds(java.lang.Long containerId_,
ContentFilter filter_)
throws InvalidContentException,
InvalidTypeMaskException
containerId_ - root content idfilter_ - applies to what children are returnedInvalidContentException - if an invalid content item is referencedInvalidTypeMaskException - if the filter contains an invalid typemaskResultPage getAllChildrenAndVersionsPaging(java.lang.Long containerId_, ContentFilter filter_, int startIndex_, int batchSize_, java.lang.Integer sortProperty_, java.lang.Integer sortOrder_) throws InvalidContentException, InvalidTypeMaskException
containerId_ - root content idfilter_ - applies to what children are returnedstartIndex_ - the index into the collection of total results at which
to start. Negative numbers are treated as zeros.batchSize_ - the number of results to return.
Use Constants.COUNT_ALL
to return the entire collection, but this is STRONGLY discouraged.sortProperty_ - the property by which the results will be sorted.
This is one of the COLUMN_XXX constants in ContentConstants.sortOrder_ - the order in which to sort the results.This is one of
Constants.SORT_ORDER_ASCENDING
or Constants.SORT_ORDER_DESCENDINGInvalidContentException - if an invalid content item is referencedInvalidTypeMaskException - if the filter contains an invalid typemaskgetAllChildrenAndVersions(Long, ContentFilter)java.lang.Integer getNumberOfChildren(java.lang.Long containerId_,
java.lang.Integer typemask_)
throws InvalidContentException,
InvalidTypeMaskException
containerId_ - root content id(s)typemask_ - specifies which content types to look forInvalidContentException - if an invalid content item is referencedInvalidTypeMaskException - if an invalid typemask was passed injava.lang.Integer[] getNumberOfChildren(java.lang.Long[] containerIds_,
java.lang.Integer typemask_)
throws InvalidContentException,
InvalidTypeMaskException
containerIds_ - root content id(s)typemask_ - specifies which content types to look forInvalidContentException - if an invalid content item is referencedInvalidTypeMaskException - if an invalid typemask was passed inContent[] getParentsToRoot(java.lang.Long id_, java.lang.Integer typemask_) throws InvalidContentException, InvalidTypeMaskException, PrivilegeException
id_ - content idtypemask_ - specifies which content types to returnInvalidContentException - if an invalid content item is referencedInvalidTypeMaskException - if an invalid typemask was passed inPrivilegeException - if the user does not have permission to take this actionjava.lang.Long[] getParentsToRootIds(java.lang.Long id_,
java.lang.Integer typemask_)
throws InvalidContentException,
InvalidTypeMaskException,
PrivilegeException
id_ - content idtypemask_ - specifies which content types to returnInvalidContentException - if an invalid content item is referencedInvalidTypeMaskException - if an invalid typemask was passed inPrivilegeException - if the user does not have permission to take this actionContent[] getParentsFromRoot(java.lang.Long id_, java.lang.Integer typemask_) throws InvalidContentException, InvalidTypeMaskException
id_ - content idtypemask_ - specifies which content types to returnInvalidContentException - if an invalid content item is referencedInvalidTypeMaskException - if an invalid typemask was passed injava.lang.Long[] getParentsFromRootIds(java.lang.Long id_,
java.lang.Integer typemask_)
throws InvalidContentException,
InvalidTypeMaskException
id_ - content idtypemask_ - specifies which content types to returnInvalidContentException - if an invalid content item is referencedInvalidTypeMaskException - if an invalid typemask was passed invoid updateFields(Content content_, java.lang.Integer[] fields_, java.lang.Integer unique_) throws InvalidContentException, InvalidUserException, IllegalRecursionException, DuplicateUuidException, PrivilegeException, InsufficientNameUniquenessException
move(Long, Long)content_ - Content object to updatefields_ - Integer[] of field names to update; others except id ignored.unique_ - how unique the name must be (one of
ContentConstants.UNIQUE_NONE,
ContentConstants.UNIQUE_FOR_TYPE,
ContentConstants.UNIQUE_FOR_PARENT, or
ContentConstants.UNIQUE_FOR_ALL)InvalidContentException - if an invalid content item is referencedInvalidUserException - if an invalid user is referencedIllegalRecursionException - if parent refers to selfDuplicateUuidException - if a content item with the same uuid already existsPrivilegeException - if the user does not have the permissions to update the
contentInsufficientNameUniquenessException - if the content name is not unique
according to the unique_ parametervoid updateVersionFields(Content content_, java.lang.Integer versionNumber, java.lang.Integer[] fields_, java.lang.Integer unique_) throws InvalidContentException, InvalidUserException, IllegalRecursionException, DuplicateUuidException, PrivilegeException, InsufficientNameUniquenessException
move(Long, Long)content_ - The content object whose data should be used for the update. The id field
must be populated to indicate which persisted content object should be updated.versionNumber - The version of the target content that should be updated.fields_ - The fields to update (other fields in the passed content object will be ignored).unique_ - How unique the name must be, if it's one of the fields being updated (the value
must be one of ContentConstants.UNIQUE_NONE, ContentConstants.UNIQUE_FOR_TYPE,
ContentConstants.UNIQUE_FOR_PARENT, or ContentConstants.UNIQUE_FOR_ALL).InvalidContentException - if an invalid content item is referencedInvalidUserException - if an invalid user is referenced (if creator is updated and invalid)IllegalRecursionException - if parent refers to selfDuplicateUuidException - if a content item with the same uuid already existsPrivilegeException - if the user does not have the permissions to update the contentInsufficientNameUniquenessException - if the content name is not unique according to the
unique_ parametervoid updateFields(Content[] contents_, java.lang.Integer[] fields_, java.lang.Integer unique_) throws InvalidContentException, InvalidUserException, IllegalRecursionException, DuplicateUuidException, PrivilegeException, InsufficientNameUniquenessException
move(Long[], Long)contents_ - Content objects to updatefields_ - Integer[] of field names to update; others except id ignored.unique_ - how unique the name must be (one of
ContentConstants.UNIQUE_NONE,
ContentConstants.UNIQUE_FOR_TYPE,
ContentConstants.UNIQUE_FOR_PARENT, or
ContentConstants.UNIQUE_FOR_ALL)InvalidContentException - if an invalid content item is referencedInvalidUserException - if an invalid user is referencedIllegalRecursionException - if parent refers to selfDuplicateUuidException - if a content item with the same uuid already existsPrivilegeException - if the user does not have the permissions to update the
contentInsufficientNameUniquenessException - if the content name is not unique
according to the unique_ parameterint setSizeOfDocumentVersion(java.lang.Long documentContentId)
throws InvalidContentException,
PrivilegeException
DocumentOutputStream or
ContentUploadOutputStream will update the Document size metadata automatically upon
closing the stream.size field).documentContentId - The id of the target Document. This id must be the content
id of the specific version for which the size should be set.InvalidContentException - If there is no content object with the given id.PrivilegeException - If the user does not have sufficient privileges to update the
Document's metadata.void updateAllChildrenAndVersionsVisibility(java.lang.Long id,
boolean maskType,
int bitmask)
throws InvalidContentException,
PrivilegeException
id - maskType - false for bitwise AND, true for bitwise ORbitmask - (0...255) value that will be AND'd or OR'd against visibility flagPrivilegeException - if no edit privilege on idInvalidContentException - if id is invalid, deleted or deactivatedupdateIsSearchableForKnowledgeCentervoid updateAllChildrenAndVersionsExpiration(java.lang.Long id,
java.lang.Integer expirationDays)
throws InvalidContentException,
PrivilegeException
id - expirationDays - the number of days after which documents in the knowledge centers
will expire. If null, the logid's (typically knowledge center id's) expiration days
will be used.PrivilegeException - if no edit privilege on idInvalidContentException - if id is invalid, deleted or deactivatedupdateExpirationDaysForKnowledgeCentervoid move(java.lang.Long id_,
java.lang.Long destinationParent_)
throws InvalidContentException,
PrivilegeException,
IllegalRecursionException
updateFields(Content, Integer[], Integer), it moves all
the versions of the content, that supports versioning, i.e. Document,
FreeformRule, Constant and QueryRule.id_ - content id(s) to movedestinationParent_ - parent under which to move the id: atomicInvalidContentException - if an invalid content item is referencedPrivilegeException - if the user does not have permission to take this actionIllegalRecursionException - if the destination is a descendant of the item you are movingvoid move(java.lang.Long[] ids_,
java.lang.Long destinationParent_)
throws InvalidContentException,
PrivilegeException,
IllegalRecursionException
updateFields(Content[], Integer[], Integer), it moves all
the versions of the contents, that support versioning, i.e. Document,
FreeformRule, Constant and QueryRule.ids_ - content id(s) to movedestinationParent_ - parent under which to move the id: atomicInvalidContentException - if an invalid content item is referencedPrivilegeException - if the user does not have permission to take this actionIllegalRecursionException - if the destination is a descendant of the item you are movingCopyReference[] copy(java.lang.Long source, java.lang.Long target) throws InvalidContentException, PrivilegeException
CopyReference.copyContents() API
in order to complete the copy.source - content id(s) to movetarget - parent under which to copy the idInvalidContentException - if an invalid content item is referencedPrivilegeException - if the user does not have permission to take this actionCopyReference[] copy(java.lang.Long[] source, java.lang.Long target) throws InvalidContentException, PrivilegeException
CopyReference.copyContents() API
in order to complete the copy.
All sources are processed, forming the desired list to copy, before any
action is taken.source - content id(s) to movetarget - parent under which to copy the idInvalidContentException - if an invalid content item is referencedPrivilegeException - if the user does not have permission to take this actionCopyReference[] copy(CopySource[] source, java.lang.Long target) throws InvalidContentException, PrivilegeException
CopyReference.copyContents() API
in order to complete the copy.
All CopySources are processed, forming the desired list to copy, before any
action is taken.source - content id(s) to movetarget - parent under which to copy the idInvalidContentException - if an invalid content item is referencedPrivilegeException - if the user does not have permission to take this actionApproval delete(java.lang.Long id_, java.lang.Boolean deleteChildren_) throws InvalidContentException, HasChildrenException, PrivilegeException
id_ - content id(s), may be inactivedeleteChildren_ - delete children (1 is do so, 0 is give exception if children)InvalidContentException - if an invalid content item is referencedHasChildrenException - if the content item has childrenPrivilegeException - if the user does not have permission to take this actionApproval delete(java.lang.Long[] ids_, java.lang.Boolean deleteChildren_) throws InvalidContentException, HasChildrenException, PrivilegeException
ids_ - content id(s), may be inactivedeleteChildren_ - delete children (1 is do so, 0 is give exception if children)InvalidContentException - if an invalid content item is referencedHasChildrenException - if the content item has childrenPrivilegeException - if the user does not have permission to take this actionApproval deleteContent(java.lang.Long[] ids_, java.lang.Boolean deleteChildren_) throws InvalidContentException, HasChildrenException, PrivilegeException
ids_ - content id(s), may be inactivedeleteChildren_ - delete children (1 is do so, 0 is give exception if children)InvalidContentException - if an invalid content item is referencedHasChildrenException - if the content item has childrenPrivilegeException - if the user does not have permission to take this actionApproval deleteVersion(java.lang.Long id_, java.lang.Integer versionNumber_, java.lang.Boolean children_) throws InvalidContentException, HasChildrenException, InvalidVersionException, PrivilegeException
id_ - content id(s), may be inactiveversionNumber_ - version number to deletechildren_ - delete children (1 is do so, 0 is give exception if children)InvalidContentException - if an invalid content item is referencedHasChildrenException - if the content item has childrenInvalidVersionException - if an invalid version is referencedPrivilegeException - if the user does not have permission to take this actionApproval deleteVersions(java.lang.Long id_, java.lang.Integer[] versionNumbers_, java.lang.Boolean children_) throws InvalidContentException, HasChildrenException, InvalidVersionException, PrivilegeException
id_ - content id(s), may be inactiveversionNumbers_ - version numbers to deletechildren_ - delete children (1 is do so, 0 is give exception if children)InvalidContentException - if an invalid content item is referencedHasChildrenException - if the content item has childrenInvalidVersionException - if an invalid version is referencedPrivilegeException - if the user does not have permission to take this actionApproval deactivate(java.lang.Long id_, java.lang.Boolean deactivateChildren_) throws InvalidContentException, HasChildrenException
id_ - content id(s), may be inactivedeactivateChildren_ - deactivate children (1 is do so, 0 is give exception if children)InvalidContentException - if an invalid content item is referencedHasChildrenException - if the content item has childrenApproval deactivate(java.lang.Long[] ids_, java.lang.Boolean deactivateChildren_) throws InvalidContentException, HasChildrenException
ids_ - content id(s), may be inactivedeactivateChildren_ - deactivate children (1 is do so, 0 is give exception if children)InvalidContentException - if an invalid content item is referencedHasChildrenException - if the content item has childrenApproval deactivateVersion(java.lang.Long id_, java.lang.Integer versionNumber_, java.lang.Boolean deactivateChildren_) throws InvalidContentException, HasChildrenException, InvalidVersionException
id_ - content id(s), may be inactiveversionNumber_ - version number to deactivatedeactivateChildren_ - deactivate children (1 is do so, 0 is give exception if children)InvalidContentException - if an invalid content item is referencedHasChildrenException - if the content item has childrenInvalidVersionException - if an invalid version is referencedApproval deactivateVersions(java.lang.Long id_, java.lang.Integer[] versionNumbers_, java.lang.Boolean deactivateChildren_) throws InvalidContentException, HasChildrenException, InvalidVersionException, PrivilegeException
id_ - content id(s), may be inactiveversionNumbers_ - version numbers to deactivatedeactivateChildren_ - deactivate children (1 is do so, 0 is give exception if children)InvalidContentException - if an invalid content item is referencedHasChildrenException - if the content item has childrenInvalidVersionException - if an invalid version is referencedPrivilegeExceptionvoid reactivate(java.lang.Long id_)
throws InvalidContentException
id_ - content id(s), may be inactiveInvalidContentException - if an invalid content item is referencedvoid reactivate(java.lang.Long[] ids_)
throws InvalidContentException
ids_ - content id(s), may be inactiveInvalidContentException - if an invalid content item is referenced@Deprecated Content[] getInactive(java.lang.Long root_, ContentFilter filter_) throws InvalidContentException, InvalidTypeMaskException
getInactivePaging(Long, ContentFilter, int, int, Integer, Integer) insteadroot_ - content id: atomicfilter_ - only content matching the filter will be returnedInvalidContentException - if an invalid content item is referencedInvalidTypeMaskException - if the filter contains an invalid typemaskgetInactivePaging(Long, ContentFilter, int, int, Integer, Integer)java.lang.Long[] getInactiveIds(java.lang.Long root_,
ContentFilter filter_)
throws InvalidContentException,
InvalidTypeMaskException
root_ - content id: atomicfilter_ - only content matching the filter will be returnedInvalidContentException - if an invalid content item is referencedInvalidTypeMaskException - if the filter contains an invalid typemaskjava.lang.Long[] getInactiveIdsNoSystem(java.lang.Long root_,
ContentFilter filter_)
throws InvalidContentException,
InvalidTypeMaskException
root_ - content id: atomicfilter_ - only content matching the filter will be returnedInvalidContentException - if an invalid content item is referencedInvalidTypeMaskException - if the filter contains an invalid typemaskResultPage getInactivePaging(java.lang.Long root_, ContentFilter filter_, int startIndex_, int batchSize_, java.lang.Integer sortProperty_, java.lang.Integer sortOrder_) throws InvalidContentException, InvalidTypeMaskException
root_ - content id: atomicfilter_ - only content matching the filter will be returnedstartIndex_ - the index into the collection of total results at which
to start. Negative numbers are treated as zeros.batchSize_ - the number of results to return.
Use Constants.COUNT_ALL
to return the entire collection, but this is STRONGLY discouraged.sortProperty_ - the property by which the results will be sorted.
This is one of the COLUMN_XXX constants in ContentConstants.sortOrder_ - the order in which to sort the results.This is one of
Constants.SORT_ORDER_ASCENDING
or Constants.SORT_ORDER_DESCENDINGInvalidContentException - if an invalid content item is referencedInvalidTypeMaskException - if the filter contains an invalid typemaskgetInactive(Long, ContentFilter)java.lang.Long[] getMyInactiveIds()
@Deprecated Content[] getMyInactive()
getMyInactivePaging(int, int, Integer, Integer) insteadgetMyInactivePaging(int, int, Integer, Integer)ResultPage getMyInactivePaging(int startIndex_, int batchSize_, java.lang.Integer sortProperty_, java.lang.Integer sortOrder_)
startIndex_ - the index into the collection of total results at which
to start. Negative numbers are treated as zeros.batchSize_ - the number of results to return.
Use Constants.COUNT_ALL
to return the entire collection, but this is STRONGLY discouraged.sortProperty_ - the property by which the results will be sorted.
This is one of the COLUMN_XXX constants in ContentConstants.sortOrder_ - the order in which to sort the results.This is one of
Constants.SORT_ORDER_ASCENDING
or Constants.SORT_ORDER_DESCENDINGgetMyInactive()java.lang.Integer deleteMyInactive()
Content[] getLinks(java.lang.Long id_) throws InvalidContentException
id_ - content id(s) from which links will be returnedInvalidContentException - if an invalid content item is referencedjava.lang.Long[] getLinkIds(java.lang.Long id_)
throws InvalidContentException
id_ - content id(s) from which links will be returnedInvalidContentException - if an invalid content item is referencedContent[] getLinksOfType(java.lang.Long id_, java.lang.Integer typemask_) throws InvalidContentException, InvalidTypeMaskException
id_ - content id(s) from which links will be returnedtypemask_ - the types of content to returnInvalidContentException - if an invalid content item is referencedInvalidTypeMaskException - if an invalid typemask was passed injava.lang.Long[] getLinkIdsOfType(java.lang.Long id_,
java.lang.Integer typemask_)
throws InvalidContentException,
InvalidTypeMaskException
id_ - content id(s) from which links will be returnedtypemask_ - the types of content to returnInvalidContentException - if an invalid content item is referencedInvalidTypeMaskException - if an invalid typemask was passed in@Deprecated
void addLinks(java.lang.Long id_,
java.lang.Long[] links_)
throws InvalidContentException
id_ - content id to which links will be added: atomiclinks_ - content ids which will be added as links to first parameter content idInvalidContentException - if an invalid content item is referenced@Deprecated
void removeLinks(java.lang.Long id_,
java.lang.Long[] links_)
throws InvalidContentException
id_ - content id from which links will be removed: atomiclinks_ - ids which will be removed from links of first parameter content idInvalidContentException - if an invalid content item is referencedjava.lang.Long[] getLinkedBy(java.lang.Long id_)
throws InvalidContentException
id_ - content id to which returned ids linkInvalidContentException - if an invalid content item is referenced@Deprecated Content[] searchByRoot(java.lang.Long rootId_, java.lang.String regex_, ContentFilter filter_) throws InvalidTypeMaskException
searchByRootPaging(Long, String, ContentFilter, int, int, Integer, Integer) insteadrootId_ - The root to search inregex_ - A regular expression to match against name and description.
The regex "*text*" will be used.filter_ - A filter for the search resultsInvalidTypeMaskException - if the filter contains an invalid typemasksearchByRootPaging(Long, String, ContentFilter, int, int, Integer, Integer)java.lang.Long[] searchIdsByRoot(java.lang.Long rootId_,
java.lang.String regex_,
ContentFilter filter_)
throws InvalidTypeMaskException
rootId_ - The root to search inregex_ - A regular expression to match against name and description.
The regex "*text*" will be used.filter_ - A filter for the search resultsInvalidTypeMaskException - if the filter contains an invalid typemaskResultPage searchByRootPaging(java.lang.Long rootId_, java.lang.String regex_, ContentFilter filter_, int startIndex_, int batchSize_, java.lang.Integer sortProperty_, java.lang.Integer sortOrder_) throws InvalidTypeMaskException
rootId_ - The root to search inregex_ - A regular expression to match against name and description.
The regex "*text*" will be used.filter_ - A filter for the search resultsstartIndex_ - the index into the collection of total results at which
to start. Negative numbers are treated as zeros.batchSize_ - the number of results to return.
Use Constants.COUNT_ALL
to return the entire collection, but this is STRONGLY discouraged.sortProperty_ - the property by which the results will be sorted.
This is one of the COLUMN_XXX constants in ContentConstants.sortOrder_ - the order in which to sort the results.This is one of
Constants.SORT_ORDER_ASCENDING
or Constants.SORT_ORDER_DESCENDINGInvalidTypeMaskException - if the filter contains an invalid typemasksearchByRoot(Long, String, ContentFilter)@Deprecated Content[] searchWithin(java.lang.String regex, java.lang.Long[] ids_) throws InvalidContentException
searchWithinPaging(String, Long[], int, int, Integer, Integer) insteadregex - A regular expression to match against name and description.
The regex "*contains*" will be used.ids_ - The ids of the containers within which to searchInvalidContentException - if an invalid content item is referencedsearchWithinPaging(String, Long[], int, int, Integer, Integer)java.lang.Long[] searchIdsWithin(java.lang.String regex,
java.lang.Long[] ids_)
throws InvalidContentException
regex - A regular expression to match against name and description.
The regex "*contains*" will be used.ids_ - The ids of the containers within which to searchInvalidContentException - if an invalid content item is referencedResultPage searchWithinPaging(java.lang.String regex_, java.lang.Long[] ids_, int startIndex_, int batchSize_, java.lang.Integer sortProperty_, java.lang.Integer sortOrder_) throws InvalidContentException
regex_ - A regular expression to match against name and description.
The regex "*contains*" will be used.ids_ - The ids of the containers within which to searchstartIndex_ - the index into the collection of total results at which
to start. Negative numbers are treated as zeros.batchSize_ - the number of results to return.
Use Constants.COUNT_ALL
to return the entire collection, but this is STRONGLY discouraged.sortProperty_ - the property by which the results will be sorted.
This is one of the COLUMN_XXX constants in ContentConstants.sortOrder_ - the order in which to sort the results.This is one of
Constants.SORT_ORDER_ASCENDING
or Constants.SORT_ORDER_DESCENDINGInvalidContentException - if an invalid content item is referencedsearchWithin(String, Long[])@Deprecated Content[] queryByRoot(java.lang.Long root_, java.lang.String queryText_, ContentFilter filter_) throws InvalidTypeMaskException
queryByRootPaging(Long, String, ContentFilter, int, int, Integer, Integer) instead| Reserved Keyword | Notes |
|---|---|
| active | By default, only active is searched. |
| inactive or nonactiv | This is the only way to search inactive. |
| hierarchy | This limits to those ids visible in hierarchy. |
| onhierarchy | This limits to those ids NOT visible in hierarchy. |
| quota | This limits to those ids that are quota constrained. |
| nonquota | This limits to those ids that are NOT quota constrained. |
| logged | This limits to those ids that are logged. |
| unlogged or nonlogged | This limits to those ids that are NOT logged. |
| indexable | This limits to those ids that are indexable. |
| nonindexable | This limits to those ids that are NOT indexable. |
| author:name | This is a case-sensitive contains for the creator's username. |
| author (current) | This limits to content created by current user. |
| name:text | |
| description:text | |
| starts:text | This is name and description text*, case-insensitive. |
| ends:text | This is name and description *text, case-insensitive. |
| contains:text | This is name and description *text*, case-insensitive. |
| subscribed | This limits to current user's subscriptions. |
| unsubscribed or nonsubscribed | This limits to current user's subscriptions. |
| bytes:number | |
| approved | |
| unapproved | |
| created:time | |
| modified:time | |
| expiration:days | |
| extension:ext |
root_ - The root from which to searchqueryText_ - This is the query to perform.filter_ - A filter for the search resultsInvalidTypeMaskException - if the filter contains an invalid typemasksearchByRootPaging(Long, String, ContentFilter, int, int, Integer, Integer)java.lang.Long[] queryIdsByRoot(java.lang.Long root_,
java.lang.String queryText_,
ContentFilter filter_)
throws InvalidTypeMaskException
queryByRoot(Long root,String queryText,ContentFilter filter)root_ - The root from which to searchqueryText_ - This is the query to perform.filter_ - A filter for the search resultsInvalidTypeMaskException - if the filter contains an invalid typemaskResultPage queryByRootPaging(java.lang.Long root_, java.lang.String queryText_, ContentFilter filter_, int startIndex_, int batchSize_, java.lang.Integer sortProperty_, java.lang.Integer sortOrder_) throws InvalidTypeMaskException
queryByRoot(Long root,String queryText,ContentFilter filter)root_ - The root from which to searchqueryText_ - This is the query to perform.filter_ - A filter for the search resultsstartIndex_ - the index into the collection of total results at which
to start. Negative numbers are treated as zeros.batchSize_ - the number of results to return.
Use Constants.COUNT_ALL
to return the entire collection, but this is STRONGLY discouraged.sortProperty_ - the property by which the results will be sorted.
This is one of the COLUMN_XXX constants in ContentConstants.sortOrder_ - the order in which to sort the results.This is one of
Constants.SORT_ORDER_ASCENDING
or Constants.SORT_ORDER_DESCENDINGInvalidTypeMaskException - if the filter contains an invalid typemaskqueryByRoot(Long, String, ContentFilter)@Deprecated Content[] getExpired(java.lang.Long root_, java.lang.Integer days_, ContentFilter filter_) throws InvalidContentException, InvalidTypeMaskException
getExpiredPaging(Long, Integer, ContentFilter, int, int, Integer, Integer) insteadroot_ - content id: only content under root will be returneddays_ - Days in the future to check for expirationfilter_ - Only content matching the filter will be returnedInvalidContentException - if an invalid content item is referencedInvalidTypeMaskException - if the filter contains an invalid typemaskgetExpiredPaging(Long, Integer, ContentFilter, int, int, Integer, Integer)@Deprecated
java.lang.Long[] getExpiredIds(java.lang.Long root_,
java.lang.Integer days_,
ContentFilter filter_)
throws InvalidContentException,
InvalidTypeMaskException
root_ - content id: only content under root will be returneddays_ - Days in the future to check for expirationfilter_ - Only content matching the filter will be returnedInvalidContentException - if an invalid content item is referencedInvalidTypeMaskException - if the filter contains an invalid typemask@Deprecated ResultPage getExpiredPaging(java.lang.Long root_, java.lang.Integer days_, ContentFilter filter_, int startIndex_, int batchSize_, java.lang.Integer sortProperty_, java.lang.Integer sortOrder_) throws InvalidContentException, InvalidTypeMaskException
root_ - content id: only content under root will be returneddays_ - Days in the future to check for expirationfilter_ - Only content matching the filter will be returnedstartIndex_ - the index into the collection of total results at which
to start. Negative numbers are treated as zeros.batchSize_ - the number of results to return.
Use Constants.COUNT_ALL
to return the entire collection, but this is STRONGLY discouraged.sortProperty_ - the property by which the results will be sorted.
This is one of the COLUMN_XXX constants in ContentConstants.sortOrder_ - the order in which to sort the results.This is one of
Constants.SORT_ORDER_ASCENDING
or Constants.SORT_ORDER_DESCENDINGInvalidContentException - if an invalid content item is referencedInvalidTypeMaskException - if the filter contains an invalid typemaskgetExpired(Long, Integer, ContentFilter)@Deprecated
void unexpire(java.lang.Long id_)
throws InvalidContentException
id_ - content idInvalidContentException - if an invalid content item is referenced@Deprecated
void unexpire(java.lang.Long[] ids_)
throws InvalidContentException
ids_ - content idsInvalidContentException - if an invalid content item is referenced@Deprecated
void lock(java.lang.Long id_)
throws InvalidContentException,
PendingApprovalException,
ContentExpiredException,
NotLockOwnerException,
PrivilegeException
id_ - content id to lockInvalidContentException - if an invalid content item is referencedPendingApprovalException - if the content is pending approvalContentExpiredException - if the content you reference is expiredNotLockOwnerException - if the content is locked and the current user is not the ownerPrivilegeException@Deprecated
void lock(java.lang.Long[] ids_)
throws InvalidContentException,
PendingApprovalException,
ContentExpiredException,
NotLockOwnerException,
PrivilegeException
ids_ - content ids to lockInvalidContentException - if an invalid content item is referencedPendingApprovalException - if the content is pending approvalContentExpiredException - if the content you reference is expiredNotLockOwnerException - if the content is locked and the current user is not the ownerPrivilegeException@Deprecated
java.lang.Long[] unlock(java.lang.Long id_)
throws InvalidContentException
id_ - id to unlockInvalidContentException - if an invalid content item is referenced@Deprecated
java.lang.Long[] unlock(java.lang.Long[] ids_)
throws InvalidContentException
ids_ - ids to unlockInvalidContentException - if an invalid content item is referenced@Deprecated
java.lang.Long[] breakLock(java.lang.Long id_)
throws InvalidContentException
id_ - content id of lock to breakInvalidContentException - if an invalid content item is referenced@Deprecated
java.lang.Long[] breakLock(java.lang.Long[] ids_)
throws InvalidContentException
ids_ - content id of lock to breakInvalidContentException - if an invalid content item is referenced@Deprecated Approved approve(java.lang.Long id_) throws InvalidContentException
id_ - content id(s)InvalidContentException - if an invalid content item is referenced@Deprecated Approved[] approve(java.lang.Long[] ids_) throws InvalidContentException
ids_ - content id(s)InvalidContentException - if an invalid content item is referenced@Deprecated Approved approveVersion(java.lang.Long id_, java.lang.Integer versionNumber_) throws InvalidContentException, InvalidVersionException, InvalidApprovalStateException
id_ - content idversionNumber_ - version numberInvalidContentException - if an invalid content item is referencedInvalidVersionException - if an invalid version is referencedInvalidApprovalStateException - if there is an invalid content's state@Deprecated Approved reject(java.lang.Long id_) throws InvalidContentException
id_ - content id(s)InvalidContentException - if an invalid content item is referenced@Deprecated Approved[] reject(java.lang.Long[] ids_) throws InvalidContentException
ids_ - content id(s)InvalidContentException - if an invalid content item is referenced@Deprecated Approved rejectVersion(java.lang.Long id_, java.lang.Integer versionNumber_) throws InvalidContentException, InvalidVersionException, InvalidRejectionStateException
id_ - content idversionNumber_ - version numberInvalidContentException - if an invalid content item is referencedInvalidVersionException - if an invalid version is referencedInvalidRejectionStateException@Deprecated void notifyApproved(Approved... approved) throws InvalidContentException
accept and reject
service methods.approved - approved beanInvalidContentException - if an invalid content item is referenced@Deprecated
void requestAccess(java.lang.Long id_)
throws InvalidContentException
id_ - content idInvalidContentException - if an invalid content item is referenced@Deprecated
void requestAccess(java.lang.Long[] ids_)
throws InvalidContentException
ids_ - content idsInvalidContentException - if an invalid content item is referencedjava.lang.Integer checkAccess(java.lang.Long id_)
throws InvalidContentException
id_ - content idInvalidContentException - if an invalid content item is referencedjava.lang.Integer[] checkAccess(java.lang.Long[] ids_)
throws InvalidContentException
ids_ - content idsInvalidContentException - if an invalid content item is referencedjava.lang.String[] approveUsers(java.lang.Long id_,
java.lang.String[] users_)
throws InvalidUserException,
InvalidContentException
id_ - content idusers_ - set of users to approveInvalidUserException - if an invalid user is referencedInvalidContentException - if an invalid content item is referencedjava.lang.String[] rejectUsers(java.lang.Long id_,
java.lang.String[] users_)
throws InvalidUserException,
InvalidContentException
id_ - content idusers_ - set of users to rejectInvalidUserException - if an invalid user is referencedInvalidContentException - if an invalid content item is referenced@Deprecated Content[] getPending(java.lang.Long id, ContentFilter filter) throws InvalidContentException, InvalidTypeMaskException
getPendingPaging(Long, ContentFilter, int, int, Integer, Integer) insteadid - filter - InvalidContentExceptionInvalidTypeMaskException@Deprecated ResultPage getPendingPaging(java.lang.Long id, ContentFilter filter, int startIndex_, int batchSize_, java.lang.Integer sortProperty_, java.lang.Integer sortOrder_) throws InvalidContentException, InvalidTypeMaskException
id - root content idfilter - applies to what children are returnedstartIndex_ - the index into the collection of total results at which
to start. Negative numbers are treated as zeros.batchSize_ - the number of results to return.
Use Constants.COUNT_ALL
to return the entire collection, but this is STRONGLY discouraged.sortProperty_ - the property by which the results will be sorted.
This is one of the COLUMN_XXX constants in ContentConstants.sortOrder_ - the order in which to sort the results.This is one of
Constants.SORT_ORDER_ASCENDING
or Constants.SORT_ORDER_DESCENDINGInvalidContentException - if an invalid content item is referencedInvalidTypeMaskException - if the filter contains an invalid typemaskgetPending(Long, ContentFilter)java.lang.Integer getNumberOfRequests()
Content[] getRequests()
java.lang.String[] getPendingUsers(java.lang.Long id_)
throws InvalidContentException
id_ - content idInvalidContentException - if an invalid content item is referenced@Deprecated
java.lang.Integer getPendingReview(java.lang.Long id_)
throws InvalidContentException
id_ - content idInvalidContentException - if an invalid content item is referenced@Deprecated
java.lang.Integer[] getPendingReviews(java.lang.Long[] ids_)
throws InvalidContentException
ids_ - content idsInvalidContentException - if an invalid content item is referenced@Deprecated Content[] getFavoritesByRoot(java.lang.Long rootId_, ContentFilter filter_, java.lang.Boolean includeExpiredContent_) throws InvalidTypeMaskException
getFavoritesByRootPaging(Long, ContentFilter, Boolean, int, int, Integer, Integer) insteadrootId_ - root within which to get favoritesfilter_ - Only content matching the filter will be returnedincludeExpiredContent_ - set to true to include expired contentInvalidTypeMaskException - if the filter contains an invalid typemaskgetFavoritesByRootPaging(Long, ContentFilter, Boolean, int, int, Integer, Integer)@Deprecated
java.lang.Long[] getFavoriteByRootIds(java.lang.Long rootId_,
ContentFilter filter_,
java.lang.Boolean includeExpiredContent_)
throws InvalidTypeMaskException
rootId_ - root within which to get favoritesfilter_ - Only content matching the filter will be returnedincludeExpiredContent_ - set to true to include expired contentInvalidTypeMaskException - if the filter contains an invalid typemask@Deprecated ResultPage getFavoritesByRootPaging(java.lang.Long rootId_, ContentFilter filter_, java.lang.Boolean includeExpiredContent_, int startIndex_, int batchSize_, java.lang.Integer sortProperty_, java.lang.Integer sortOrder_) throws InvalidTypeMaskException
rootId_ - root within which to get favoritesfilter_ - Only content matching the filter will be returnedincludeExpiredContent_ - set to true to include expired contentstartIndex_ - the index into the collection of total results at which
to start. Negative numbers are treated as zeros.batchSize_ - the number of results to return.
Use Constants.COUNT_ALL
to return the entire collection, but this is STRONGLY discouraged.sortProperty_ - the property by which the results will be sorted.
This is one of the COLUMN_XXX constants in ContentConstants.sortOrder_ - the order in which to sort the results.This is one of
Constants.SORT_ORDER_ASCENDING
or Constants.SORT_ORDER_DESCENDINGInvalidTypeMaskException - if the filter contains an invalid typemaskgetFavoritesByRoot(Long, ContentFilter, Boolean)java.lang.Boolean isFavorite(java.lang.Long id_)
throws InvalidContentException
id_ - content idInvalidContentException - if an invalid content item is referenced@Deprecated
java.lang.Boolean[] areFavorites(java.lang.Long[] ids_)
throws InvalidContentException
ids_ - content idsInvalidContentException - if an invalid content item is referenced@Deprecated java.lang.Boolean[] areFavorites(Content[] contents_) throws InvalidContentException
contents_ - content itemsInvalidContentException - if an invalid content item is referenced@Deprecated void populateFavorites(Content[] contents_) throws InvalidContentException
contents_ - an array of Content objectsInvalidContentException - if an invalid content item is referenced@Deprecated PendingAccess addFavorite(java.lang.Long id_) throws InvalidContentException
id_ - content idInvalidContentException - if an invalid content item is referenced@Deprecated
void addFavoriteForUsers(java.lang.Long id,
java.lang.String[] usernames)
throws InvalidContentException,
PrivilegeException
id - content idInvalidContentException - if an invalid content item is referencedPrivilegeException - if the user does not have permission to take this action@Deprecated PendingAccess addFavorites(java.lang.Long[] ids_) throws InvalidContentException
ids_ - content idsInvalidContentException - if an invalid content item is referenced@Deprecated
void removeFavorite(java.lang.Long id_)
throws InvalidContentException
id_ - content idInvalidContentException - if an invalid content item is referenced@Deprecated
void removeFavorites(java.lang.Long[] ids_)
throws InvalidContentException
ids_ - content idsInvalidContentException - if an invalid content item is referenced@Deprecated
void removeFavoriteForUsers(java.lang.Long id_,
java.lang.String[] username_)
throws InvalidContentException,
PrivilegeException
id_ - content idusername_ - list of usernamesInvalidContentException - if an invalid content item is referencedPrivilegeException - if the user does not have permission to take this action@Deprecated java.lang.Long[] cleanseFavorites()
@Deprecated void cleanseApprovals()
ContentRoleMap getRoleMap(java.lang.Long id_, java.lang.Boolean includeAggregate_) throws InvalidContentException
id_ - singularincludeAggregate_ - include aggregate
(ContentConstants.RM_AGGREGATE or ContentConstants.RM_EXPLICIT)InvalidContentException - if an invalid content item is referencedsetRoleMap(Long, ContentRoleMap, Boolean)RoleMapChanges setRoleMap(java.lang.Long id_, ContentRoleMap rolemap_, java.lang.Boolean contract_) throws InvalidContentException, InvalidUserException, PrivilegeException
id_ - singularrolemap_ - singularcontract_ - if true will remove users lower in the hierarchy who are removed from all access in this rolemapInvalidContentException - if an invalid content item is referencedInvalidUserException - if an invalid user is referencedPrivilegeException - if the user does not have permission to take this actiongetRoleMap(Long, Boolean)void setRoleMapForAllVersions(java.lang.Long id_,
ContentRoleMap rolemap_,
java.lang.Boolean contract_)
throws InvalidContentException,
InvalidUserException,
PrivilegeException
id_ - The id of the content item whose role map should be set.rolemap_ - The role map to set.contract_ - if true will remove users lower in the hierarchy who are removed from all access in this rolemapInvalidContentException - if an invalid content id is specifiedInvalidUserException - if an invalid user is referencedPrivilegeException - if the user does not have permission to take this action@Deprecated RoleMap getRestrictionMap(java.lang.Long id_) throws InvalidContentException, PrivilegeException
Content object.id_ - Restriction map will be returned for the object specified by
this id.InvalidContentException - if an invalid content item is referencedPrivilegeException - if the user does not have permission to take this actionsetRestrictionMap(Long, RoleMap)@Deprecated
void setRestrictionMap(java.lang.Long id_,
RoleMap roleMap_)
throws InvalidContentException,
PrivilegeException,
InvalidUserException
Content object.id_ - Restriction map will be set for the object specified by
this id.roleMap_ - RoleMap with the same roles as a ContentRoleMap,
indicating the restrictions on this object.InvalidContentException - if an invalid content item is referencedPrivilegeException - if the user does not have permission to take this actionInvalidUserException - if an invalid user is referencedgetRestrictionMap(Long)void setActorsInRoles(java.lang.Long id_,
java.lang.String[] users_,
java.lang.String[][] userRoles_,
java.lang.Long[] groups_,
java.lang.String[][] groupRoles_)
throws InvalidRoleException,
InvalidContentException,
PrivilegeException,
InvalidUserException
id_ - content idusers_ - users to set security foruserRoles_ - contains an array of security roles for each corresponding
entry in the users_ array. It is legal to have null within this array.groups_ - groups to set security forgroupRoles_ - contains an array of security roles for each corresponding
entry in the groups_ array. It is legal to have null within this array.InvalidRoleException - if an invalid role is passed inInvalidContentException - if an invalid content item is referencedPrivilegeException - if the user does not have permission to take this actionInvalidUserException - if an invalid user is referencedContentRoleSet getRoleSet(java.lang.Long id_) throws InvalidContentException
ContentRoleSet associated with the content with the ID provided.id_ - content idInvalidContentException - if an invalid content item is referencedContentRoleSet[] getRoleSets(Content[] contents_) throws InvalidContentException
ContentRoleSets associated with the given contents.contents_ - list of content itemsInvalidContentException - if an invalid content item is referencedContentRoleSet[] getRoleSets(java.lang.Long[] ids_) throws InvalidContentException
ContentRoleSets associated with the given content ids.ids_ - content idInvalidContentException - if an invalid content item is referenced@Deprecated ContentRoleSet getRoleSetForUser(java.lang.String username_, java.lang.Long id_) throws InvalidContentException, PrivilegeException, InvalidUserException, DeprecatedException
ContentRoleSet associated with the given content for
a specific user.username_ - user to retrieve role set for (must match current user, or will throw DeprecatedException)id_ - content idInvalidContentException - if an invalid content item is referencedPrivilegeException - if the user does not have permission to take this actionInvalidUserException - if an invalid user is referencedDeprecatedException@Deprecated ContentRoleSet[] getRoleSetsForUser(java.lang.String username_, java.lang.Long[] ids_) throws InvalidContentException, PrivilegeException, InvalidUserException, DeprecatedException
ContentRoleSets associated with the given contents for
a specific user.username_ - user to retrieve role set for (must match current user, or will throw DeprecatedException)ids_ - content idsPrivilegeException - if the user does not have permission to take this actionInvalidContentException - if an invalid content item is referencedInvalidUserException - if an invalid user is referencedDeprecatedExceptionContentRoleSet getRoleSetForGroup(java.lang.Long groupId_, java.lang.Long id_) throws InvalidContentException, PrivilegeException
ContentRoleSet associated with the given content for
a specific group.groupId_ - group to retrieve role set forid_ - content idInvalidContentException - if an invalid content item is referencedPrivilegeException - if the user does not have permission to take this actionContentRoleSet[] getRoleSetsForGroup(java.lang.Long groupId_, java.lang.Long[] ids_) throws InvalidContentException, PrivilegeException
ContentRoleSets associated with the given contents for
a specific group.groupId_ - group to retrieve role set forids_ - content idInvalidContentException - if an invalid content item is referencedPrivilegeException - if the user does not have permission to take this actionvoid populateRoleSets(Content[] contents_) throws InvalidContentException, PrivilegeException
contents_ - an array of Content objectsInvalidContentException - if an invalid content item is referencedPrivilegeException - if the user does not have permission to take this actionvoid populateExtensionInfo(Content[] contents_) throws InvalidContentException, PrivilegeException
contents_ - an array of Document objectsInvalidContentException - if an invalid content item is referencedPrivilegeException - if the user does not have permission to take this actionvoid localize(Content content_)
content_ - content to localizevoid localize(Content[] contents_)
contents_ - content to localizevoid localize(Content content_, java.util.Locale locale_)
content_ - content to localizelocale_ - localize according to this localvoid localize(Content[] contents_, java.util.Locale locale_)
contents_ - content to localizelocale_ - localize according to this localvoid addUserInRole(java.lang.Long id_,
java.lang.String role_,
java.lang.String username_)
throws InvalidUserException,
InvalidContentException,
InvalidRoleException
id_ - content idrole_ - from ContentConstants (e.g. ContentConstants.ROLE_READERS)username_ - usernameInvalidUserException - if an invalid user is referencedInvalidContentException - if an invalid content item is referencedInvalidRoleException - if an invalid role is passed invoid addUsersInRole(java.lang.Long id,
java.lang.String role,
java.lang.String[] username)
throws InvalidUserException,
InvalidContentException,
InvalidRoleException
id - content idrole - from ContentConstants (e.g. ContentConstants.ROLE_READERS)username - list of usernames to add roleInvalidUserException - if an invalid user is referencedInvalidContentException - if an invalid content item is referencedInvalidRoleException - if an invalid role is passed invoid removeUserFromRole(java.lang.Long id,
java.lang.String role,
java.lang.String username)
throws InvalidUserException,
InvalidContentException,
InvalidRoleException
id - content idrole - from ContentConstants (e.g. ContentConstants.ROLE_READERS)username - user to remove role fromInvalidUserException - if an invalid user is referencedInvalidContentException - if an invalid content item is referencedInvalidRoleException - if an invalid role is passed invoid removeUsersFromRole(java.lang.Long id,
java.lang.String role,
java.lang.String[] username)
throws InvalidUserException,
InvalidContentException,
InvalidRoleException
id - content idrole - from ContentConstants (e.g. ContentConstants.ROLE_READERS)username - list of usernames to remove role fromInvalidUserException - if an invalid user is referencedInvalidContentException - if an invalid content item is referencedInvalidRoleException - if an invalid role is passed invoid addGroupInRole(java.lang.Long id,
java.lang.String role,
java.lang.Long groupId)
throws InvalidContentException,
InvalidRoleException
id - content idrole - from ContentConstants (e.g. ContentConstants.ROLE_READERS)groupId - group to add role toInvalidContentException - if an invalid content item is referencedInvalidRoleException - if an invalid role is passed invoid addGroupsInRole(java.lang.Long id,
java.lang.String role,
java.lang.Long[] groupId)
throws InvalidContentException,
InvalidRoleException
id - content idrole - from ContentConstants (e.g. ContentConstants.ROLE_READERS)groupId - list of groups to add role toInvalidContentException - if an invalid content item is referencedInvalidRoleException - if an invalid role is passed invoid removeGroupFromRole(java.lang.Long id,
java.lang.String role,
java.lang.Long groupId)
throws InvalidContentException,
InvalidRoleException
id - content idrole - from ContentConstants (e.g. ContentConstants.ROLE_READERS)groupId - group to remove role fromInvalidContentException - if an invalid content item is referencedInvalidRoleException - if an invalid role is passed invoid removeGroupsFromRole(java.lang.Long id,
java.lang.String role,
java.lang.Long[] groupId)
throws InvalidContentException,
InvalidRoleException
id - content idrole - from ContentConstants (e.g. ContentConstants.ROLE_READERS)groupId - list of groups to remove role fromInvalidContentException - if an invalid content item is referencedInvalidRoleException - if an invalid role is passed in@Deprecated
java.lang.Long[] getViewable(java.lang.Long root,
ContentFilter filter)
throws InvalidContentException,
InvalidTypeMaskException
getViewablePaging(Long, ContentFilter, int, int, Integer, Integer) insteadroot - content idfilter - Only content matching the filter will be returnedInvalidContentException - if an invalid content item is referencedInvalidTypeMaskException - if the filter contains an invalid typemaskgetViewablePaging(Long, ContentFilter, int, int, Integer, Integer)java.lang.Long[] getViewableByUser(java.lang.Long root,
ContentFilter filter,
java.lang.String username)
throws InvalidUserException,
InvalidContentException,
InvalidTypeMaskException,
DeprecatedException
root - content idfilter - Only content matching the filter will be returnedusername - user (must match current user, or will throw DeprecatedException)InvalidUserException - if an invalid user is referencedInvalidContentException - if an invalid content item is referencedInvalidTypeMaskException - if the filter contains an invalid typemaskDeprecatedException@Deprecated
java.lang.Long[] getEditable(java.lang.Long root,
ContentFilter filter)
throws InvalidContentException,
InvalidTypeMaskException
getEditablePaging(Long, ContentFilter, int, int, Integer, Integer) insteadroot - content idfilter - Only content matching the filter will be returnedInvalidContentException - if an invalid content item is referencedInvalidTypeMaskException - if the filter contains an invalid typemaskgetEditablePaging(Long, ContentFilter, int, int, Integer, Integer)java.lang.Long[] getEditableByUser(java.lang.Long root_,
ContentFilter filter_,
java.lang.String username_)
throws InvalidUserException,
InvalidContentException,
InvalidTypeMaskException,
DeprecatedException
root_ - content idfilter_ - Only content matching the filter will be returnedusername_ - username (must match current user, or will throw DeprecatedException)InvalidUserException - if an invalid user is referencedInvalidContentException - if an invalid content item is referencedInvalidTypeMaskException - if the filter contains an invalid typemaskDeprecatedException@Deprecated
java.lang.Long[] getAdministratable(java.lang.Long root,
ContentFilter filter)
throws InvalidContentException,
InvalidTypeMaskException
getAdministratablePaging(Long, ContentFilter, int, int, Integer, Integer) insteadroot - content idfilter - Only content matching the filter will be returnedInvalidContentException - if an invalid content item is referencedInvalidTypeMaskException - if the filter contains an invalid typemaskgetAdministratablePaging(Long, ContentFilter, int, int, Integer, Integer)java.lang.Long[] getAdministratableByUser(java.lang.Long root,
ContentFilter filter,
java.lang.String username)
throws InvalidUserException,
InvalidContentException,
InvalidTypeMaskException,
DeprecatedException
root - content idfilter - only content matching the filter will be returnedusername - username (must match current user, or will throw DeprecatedException)InvalidUserException - if an invalid user is referencedInvalidContentException - if an invalid content item is referencedInvalidTypeMaskException - if the filter contains an invalid typemaskDeprecatedExceptionjava.lang.Boolean canAdministrate(java.lang.Long id)
throws InvalidContentException
id - content idInvalidContentException - if an invalid content item is referencedjava.lang.Boolean[] canAdministrate(java.lang.Long[] ids)
throws InvalidContentException
ids - content idsInvalidContentException - if an invalid content item is referencedjava.lang.Boolean[] canAdministrate(Content[] content) throws InvalidContentException
content - content arrayInvalidContentException - if an invalid content item is referencedjava.lang.Boolean canUserAdministrate(java.lang.Long id,
java.lang.String username)
throws InvalidUserException,
InvalidContentException,
DeprecatedException
id - content idusername - username (must match current user, or will throw DeprecatedException)InvalidUserException - if an invalid user is referencedInvalidContentException - if an invalid content item is referencedDeprecatedExceptionjava.lang.Boolean[] canUserAdministrate(java.lang.Long[] ids,
java.lang.String username)
throws InvalidUserException,
InvalidContentException
ids - content idsusername - username (must match current user, or will throw DeprecatedException)InvalidUserException - if an invalid user is referencedInvalidContentException - if an invalid content item is referencedjava.lang.Boolean canGroupAdministrate(java.lang.Long id,
java.lang.Long groupId)
throws InvalidContentException
id - content idgroupId - group idInvalidContentException - if an invalid content item is referencedjava.lang.Boolean[] canGroupAdministrate(java.lang.Long[] ids,
java.lang.Long groupId)
throws InvalidContentException
ids - content idsgroupId - group idInvalidContentException - if an invalid content item is referencedjava.lang.Boolean isViewNotRestricted(java.lang.Long id_)
throws InvalidContentException
id_ - content idInvalidContentException - if an invalid content item is referencedjava.lang.Boolean isEditNotRestricted(java.lang.Long id_)
throws InvalidContentException
id_ - content idInvalidContentException - if an invalid content item is referencedjava.lang.Boolean isAdministrateNotRestricted(java.lang.Long id_)
throws InvalidContentException
id_ - content idInvalidContentException - if an invalid content item is referencedjava.lang.Boolean canEdit(java.lang.Long id)
throws InvalidContentException
id - content idInvalidContentException - if an invalid content item is referencedjava.lang.Boolean[] canEdit(java.lang.Long[] ids)
throws InvalidContentException
ids - content idsInvalidContentException - if an invalid content item is referencedjava.lang.Boolean[] canEdit(Content[] content_) throws InvalidContentException
content_ - content listInvalidContentException - if an invalid content item is referencedjava.lang.Boolean canUserEdit(java.lang.Long id,
java.lang.String username)
throws InvalidUserException,
InvalidContentException,
DeprecatedException
id - content idusername - username (must match current user, or will throw DeprecatedException)InvalidUserException - if an invalid user is referencedInvalidContentException - if an invalid content item is referencedDeprecatedExceptionjava.lang.Boolean[] canUserEdit(java.lang.Long[] ids,
java.lang.String username)
throws InvalidUserException,
InvalidContentException
ids - content idusername - username (must match current user, or will throw DeprecatedException)InvalidUserException - if an invalid user is referencedInvalidContentException - if an invalid content item is referencedjava.lang.Boolean canGroupEdit(java.lang.Long id,
java.lang.Long groupId)
throws InvalidContentException
id - content idgroupId - group idInvalidContentException - if an invalid content item is referencedjava.lang.Boolean[] canGroupEdit(java.lang.Long[] ids,
java.lang.Long groupId)
throws InvalidContentException
ids - content idsgroupId - group idInvalidContentException - if an invalid content item is referencedjava.lang.Boolean canView(java.lang.Long id)
throws InvalidContentException
id - content idInvalidContentException - if an invalid content item is referencedjava.lang.Boolean[] canView(java.lang.Long[] ids)
throws InvalidContentException
ids - content idsInvalidContentException - if an invalid content item is referencedjava.lang.Boolean[] canView(Content[] content) throws InvalidContentException
content - content listInvalidContentException - if an invalid content item is referencedjava.lang.Boolean canUserView(java.lang.Long id,
java.lang.String username)
throws InvalidUserException,
InvalidContentException,
DeprecatedException
id - content idusername - username (must match current user, or will throw DeprecatedException)InvalidUserException - if an invalid user is referencedInvalidContentException - if an invalid content item is referencedDeprecatedExceptionjava.lang.Boolean[] canUserView(java.lang.Long[] ids,
java.lang.String username)
throws InvalidUserException,
InvalidContentException
ids - content idsusername - username (must match current user, or will throw DeprecatedException)InvalidUserException - if an invalid user is referencedInvalidContentException - if an invalid content item is referencedjava.lang.Boolean canGroupView(java.lang.Long id,
java.lang.Long groupId)
throws InvalidContentException
id - content idgroupId - group idInvalidContentException - if an invalid content item is referencedjava.lang.Boolean[] canGroupView(java.lang.Long[] ids,
java.lang.Long groupId)
throws InvalidContentException
ids - content idsgroupId - group idInvalidContentException - if an invalid content item is referencedjava.lang.Integer getAccessLevel(java.lang.Long id_,
java.lang.Integer typemask_)
throws InvalidContentException,
InvalidTypeMaskException
id_ - content idtypemask_ - specifies the content typeContentConstants.AL_ADMIN,
ContentConstants.AL_EDITOR, ContentConstants.AL_INVALID_ID,
ContentConstants.AL_NONE, ContentConstants.AL_VIEWERInvalidContentException - if an invalid content item is referencedInvalidTypeMaskException - if an invalid typemask was passed injava.lang.Integer getAccessLevel(java.lang.Long id_,
int typemask_)
throws InvalidContentException,
InvalidTypeMaskException
id_ - content idtypemask_ - specifies the content typeContentConstants.AL_ADMIN,
ContentConstants.AL_EDITOR, ContentConstants.AL_INVALID_ID,
ContentConstants.AL_NONE, ContentConstants.AL_VIEWERInvalidContentException - if an invalid content item is referencedInvalidTypeMaskException - if an invalid typemask was passed injava.lang.Integer[] getAccessLevel(java.lang.Long[] ids_,
java.lang.Integer typemask_)
throws InvalidContentException,
InvalidTypeMaskException
ids_ - content idtypemask_ - specifies the content typeContentConstants.AL_ADMIN,
ContentConstants.AL_EDITOR, ContentConstants.AL_INVALID_ID,
ContentConstants.AL_NONE, ContentConstants.AL_VIEWERInvalidContentException - if an invalid content item is referencedInvalidTypeMaskException - if an invalid typemask was passed injava.lang.Integer[] getAccessLevel(java.lang.Long[] ids_,
int typemask_)
throws InvalidContentException,
InvalidTypeMaskException
ids_ - content idtypemask_ - specifies the content typeContentConstants.AL_ADMIN,
ContentConstants.AL_EDITOR, ContentConstants.AL_INVALID_ID,
ContentConstants.AL_NONE, ContentConstants.AL_VIEWERInvalidContentException - if an invalid content item is referencedInvalidTypeMaskException - if an invalid typemask was passed injava.lang.Integer getAccessLevelForUser(java.lang.Long id_,
java.lang.Integer typemask_,
java.lang.String username_)
throws InvalidUserException,
InvalidContentException,
InvalidTypeMaskException,
DeprecatedException
id_ - content idtypemask_ - specifies the content typeusername_ - username (must match current user, or will throw DeprecatedException)ContentConstants.AL_ADMIN,
ContentConstants.AL_EDITOR, ContentConstants.AL_INVALID_ID,
ContentConstants.AL_NONE, ContentConstants.AL_VIEWERInvalidUserException - if an invalid user is referencedInvalidContentException - if an invalid content item is referencedInvalidTypeMaskException - if an invalid typemask was passed inDeprecatedExceptionjava.lang.Integer[] getAccessLevelForUser(java.lang.Long[] ids_,
java.lang.Integer typemask_,
java.lang.String username_)
throws InvalidUserException,
InvalidContentException,
InvalidTypeMaskException,
DeprecatedException
ids_ - content idtypemask_ - specifies the content typeusername_ - username (must match current user, or will throw DeprecatedException)ContentConstants.AL_ADMIN,
ContentConstants.AL_EDITOR, ContentConstants.AL_INVALID_ID,
ContentConstants.AL_NONE, ContentConstants.AL_VIEWERInvalidUserException - if an invalid user is referencedInvalidContentException - if an invalid content item is referencedInvalidTypeMaskException - if an invalid typemask was passed inDeprecatedException@Deprecated Content[] getWhatsNew(java.lang.Long root_, java.lang.Integer maxResults_, ContentFilter filter_) throws InvalidTypeMaskException, InvalidContentException
getWhatsNewPaging(Long, Integer, ContentFilter, int, int, Integer, Integer) insteadroot_ - content idmaxResults_ - max number of content items to returnfilter_ - only content matching the filter will be returnedInvalidTypeMaskException - if the filter contains an invalid typemaskInvalidContentException - if an invalid content item is referencedgetWhatsNewPaging(Long, Integer, ContentFilter, int, int, Integer, Integer)java.lang.Long[] getWhatsNewIds(java.lang.Long root_,
java.lang.Integer maxResults_,
ContentFilter filter_)
throws InvalidTypeMaskException,
InvalidContentException
root_ - content idmaxResults_ - max number of content items to returnfilter_ - only content matching the filter will be returnedInvalidTypeMaskException - if the filter contains an invalid typemaskInvalidContentException - if an invalid content item is referencedResultPage getWhatsNewPaging(java.lang.Long root_, java.lang.Integer maxResults_, ContentFilter filter_, int startIndex_, int batchSize_, java.lang.Integer sortProperty_, java.lang.Integer sortOrder_) throws InvalidTypeMaskException, InvalidContentException
root_ - content idmaxResults_ - max number of content items to returnfilter_ - only content matching the filter will be returnedstartIndex_ - the index into the collection of total results at which
to start. Negative numbers are treated as zeros.batchSize_ - the number of results to return.
Use Constants.COUNT_ALL
to return the entire collection, but this is STRONGLY discouraged.sortProperty_ - the property by which the results will be sorted.
This is one of the COLUMN_XXX constants in ContentConstants.sortOrder_ - the order in which to sort the results.This is one of
Constants.SORT_ORDER_ASCENDING
or Constants.SORT_ORDER_DESCENDINGInvalidTypeMaskException - if the filter contains an invalid typemaskInvalidContentException - if an invalid content item is referencedgetWhatsNew(Long, Integer, ContentFilter)void setPersonalId(java.lang.Long id_)
throws InvalidContentException
id_ - of the content object to set as your personal contentInvalidContentException - if an invalid content item is referencedgetPersonalId()java.lang.Long getPersonalId()
throws InvalidPersonalContentException
InvalidPersonalContentException - if Personal Content does not exist for this usersetPersonalId(Long)Content getPersonal() throws InvalidPersonalContentException
InvalidPersonalContentException - if Personal Content does not exist for this userjava.lang.Long[] getPersonalAndTeamsIds(ContentFilter filter_) throws InvalidPersonalContentException
filter_ - only content matching the filter will be returnedInvalidPersonalContentException - if Personal Content does not exist for this user@Deprecated Content[] getPersonalAndTeams(ContentFilter filter_) throws InvalidPersonalContentException
getPersonalAndTeamsPaging(ContentFilter, int, int, Integer, Integer) insteadfilter_ - only content matching the filter will be returnedInvalidPersonalContentException - if Personal Content does not exist for this usergetPersonalAndTeamsPaging(ContentFilter, int, int, Integer, Integer)ResultPage getPersonalAndTeamsPaging(ContentFilter filter_, int startIndex_, int batchSize_, java.lang.Integer sortProperty_, java.lang.Integer sortOrder_) throws InvalidPersonalContentException
filter_ - only content matching the filter will be returnedstartIndex_ - the index into the collection of total results at which
to start. Negative numbers are treated as zeros.batchSize_ - the number of results to return.
Use Constants.COUNT_ALL
to return the entire collection, but this is STRONGLY discouraged.sortProperty_ - the property by which the results will be sorted.
This is one of the COLUMN_XXX constants in ContentConstants.sortOrder_ - the order in which to sort the results.This is one of
Constants.SORT_ORDER_ASCENDING
or Constants.SORT_ORDER_DESCENDINGInvalidPersonalContentException - if Personal Content does not exist for this usergetPersonalAndTeams(ContentFilter)@Deprecated Content[] browse(java.lang.Long root, ContentFilter filter) throws InvalidContentException, PrivilegeException
browsePaging(Long, ContentFilter, int, int, Integer, Integer) insteadroot - content idfilter - Only content matching the filter will be returnedInvalidContentException - if an invalid content item is referencedPrivilegeException - if the user does not have permission to take this actionjava.lang.Long[] browseIds(java.lang.Long root,
ContentFilter filter)
throws InvalidContentException,
PrivilegeException
root - content idfilter - Only content matching the filter will be returnedInvalidContentException - if an invalid content item is referencedPrivilegeException - if the user does not have permission to take this actionResultPage browsePaging(java.lang.Long root, ContentFilter filter, int startIndex_, int batchSize_, java.lang.Integer sortProperty_, java.lang.Integer sortOrder_) throws InvalidContentException, PrivilegeException
root - content idfilter - Only content matching the filter will be returnedstartIndex_ - the index into the collection of total results at which
to start. Negative numbers are treated as zeros.batchSize_ - the number of results to return.
Use Constants.COUNT_ALL
to return the entire collection, but this is STRONGLY discouraged.sortProperty_ - the property by which the results will be sorted.
This is one of the COLUMN_XXX constants in ContentConstants.sortOrder_ - the order in which to sort the results.This is one of
Constants.SORT_ORDER_ASCENDING
or Constants.SORT_ORDER_DESCENDINGInvalidContentException - if an invalid content item is referencedPrivilegeException - if the user does not have permission to take this actionbrowse(Long, ContentFilter)java.lang.Integer getDownloadLogType()
@Deprecated
void updateUsernames(java.lang.String[] oldUsernames_,
java.lang.String[] newUsernames_,
long maxExpirationTimeInSeconds_)
throws java.lang.IllegalArgumentException,
PrivilegeException,
DuplicateNameException
UserService.renameUsersByUuid(java.lang.String[], java.lang.String[])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.
Note: Only this or the CollaborationService updateUsernames must be called. Do not call both.
oldUsernames_ - the usernames to be updatednewUsernames_ - the usernames to which the old usernames will be
updatedmaxExpirationTimeInSeconds_ - 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.java.lang.IllegalArgumentException - if the length of
oldUsernames_ is not the same as the length of
newUsernames_.PrivilegeException - if the current user is not a system
administratorDuplicateNameException - if any oldUsernames_ or
newUsernames_ contain any duplicates, or if an old
username is being updated to a username that already existsServiceException - if any system-level error occurs@Deprecated void rollbackUpdateUsernames()
UserService.renameUsersByUuid(java.lang.String[], java.lang.String[])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.
ServiceException - if any system-level error occurs@Deprecated void commitUpdateUsernames()
UserService.renameUsersByUuid(java.lang.String[], java.lang.String[])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.
ServiceException - if any system-level error occurs@Deprecated java.lang.Long getSystemId(java.lang.String name_)
getIdByUuid(String) instead. This method will be removed
in a future releasename_ - this is a known name for a system Content idsetSystemId(String, Long)@Deprecated java.lang.Long[] getSystemIds(java.lang.String[] names_)
getIdsByUuid(String[]) instead. This method will be removed
in a future releasenames_ - these are the known names for a system Content idsetSystemIds(String[], Long[])@Deprecated java.lang.String[] getSystemNames()
getIdByUuid(String)@Deprecated
void setSystemId(java.lang.String name_,
java.lang.Long id_)
throws InvalidContentException
create(Content, Integer) with a pre-populated UUID and the flag
ContentConstants.VIS_SYSTEM.name_ - system name, must globally uniqueid_ - content idInvalidContentException - if an invalid content item is referencedgetSystemId(String)@Deprecated
void setSystemIds(java.lang.String[] names_,
java.lang.Long[] ids_)
throws InvalidContentException,
java.lang.IllegalArgumentException
create(Content[], Integer) with pre-populated UUIDs and the flag
ContentConstants.VIS_SYSTEM.names_ - system names, must globally uniqueids_ - content idsInvalidContentException - if an invalid content item is referencedjava.lang.IllegalArgumentException - if the length of names_
is different from the length of ids_getSystemIds(String[])@Deprecated
void setRoot(java.lang.String name_,
java.lang.Long id_)
throws InvalidContentException
setAsRoot(Long)name_ - root nameid_ - root idInvalidContentException - if an invalid content item is referencedvoid setAsRoot(java.lang.Long id)
throws InvalidContentException
id - root idInvalidContentException - if an invalid content item is referencedjava.lang.String suggest(java.lang.String query_,
int maxItems_,
SuggestParam[] params_,
java.lang.Boolean groupResults_)
query_ - querymaxItems_ - max number of items to returnparams_ - list of information on what is being suggested and what format the results should be in. valid types are rules.groupResults_ - if specifying more than one SuggestParam, would you like to group the results by type, or mixed together and
sorted? Default is true. If grouped, order of types matches the order of the suggestParams passed in.java.lang.String suggest(java.lang.String query_,
int maxItems_,
SuggestParam[] params_,
java.lang.Boolean groupResults_,
java.lang.Long[] allowList)
query_ - querymaxItems_ - max number of items to returnparams_ - list of information on what is being suggested and what format the results should be in. valid types are rules.groupResults_ - if specifying more than one SuggestParam, would you like to group the results by type, or mixed together and
sorted? Default is true. If grouped, order of types matches the order of the suggestParams passed in.allowList - list of IDs that will be automatically added to returned results, filtered by query. Ignored if null or empty.java.lang.Integer adjustCounter(java.lang.Long id_,
java.lang.Integer value)
throws InvalidContentException,
PrivilegeException,
InvalidTypeMaskException
id_ - rule id of integer or double constantvalue_ - adjustment value (e.g., 1 to increase by 1, -1 to decrease by 1, etc.)InvalidContentException - if an invalid content item is referencedPrivilegeException - if the user does not have permission to take this actionInvalidTypeMaskException - for any type error, including adjusting non-rule, non-constant, non-integer or -double.java.lang.Double adjustCounter(java.lang.Long id_,
java.lang.Double value)
throws InvalidContentException,
PrivilegeException,
InvalidTypeMaskException
id_ - rule id of integer or double constantvalue_ - adjustment value (e.g., 1 to increase by 1, -1 to decrease by 1, etc.)InvalidContentException - if an invalid content item is referencedPrivilegeException - if the user does not have permission to take this actionInvalidTypeMaskException - for any type error, including adjusting non-rule, non-constant, non-integer or -double.void moveKnowledgeCenter(java.lang.Long kcId_,
java.lang.Long communityId_)
throws InvalidContentException,
PrivilegeException,
IllegalRecursionException,
InvalidStateException
kcId_ - content id of the Knowledge Center to movecommunityId_ - id of community under which to move the Knowledge CenterInvalidContentException - if an invalid content item is referencedPrivilegeException - if the user does not have permission to take this actionIllegalRecursionException - if the destination is a descendant of the item you are movingInvalidStateException - Deprecated. If the move succeeds, the KC will be updated to a Community KC.void moveKnowledgeCenters(java.lang.Long[] kcIds_,
java.lang.Long communityId_)
throws InvalidContentException,
PrivilegeException,
IllegalRecursionException,
InvalidStateException
kcIds_ - content ids of the Knowledge Centers to movecommunityId_ - id of community under which to move the Knowledge CentersInvalidContentException - if an invalid content item is referencedPrivilegeException - if the user does not have permission to take this actionIllegalRecursionException - if the destination is a descendant of the item you are movingInvalidStateException - Deprecated. If the move succeeds, the KC will be updated to a Community KC.boolean validateTypedValues(TypedValue[] typedValues) throws InvalidDocumentException, InvalidFolderException, InvalidKnowledgeCenterException, InvalidCommunityException
typedValues - InvalidDocumentExceptionInvalidFolderExceptionInvalidKnowledgeCenterExceptionInvalidCommunityExceptionjava.lang.Long getIdByUuid(@ConvertWith(value=com.appiancorp.kougar.mapper.parameters.UuidParameterConverter.class)
java.lang.String uuid)
ContentConstants.VERSION_CURRENT).
Consider using getVersionId(String, Integer) instead.uuid - content UUIDnull if the UUID is not foundconstants for System UUIDsjava.lang.Long[] getIdsByUuid(@ConvertWith(value=com.appiancorp.kougar.mapper.parameters.UuidParameterConverter[].class[])
java.lang.String[] uuids)
ContentConstants.VERSION_CURRENT).uuids - content UUIDsnull items for UUIDs not foundjava.lang.NullPointerException - if uuids is nullconstants for System UUIDsjava.lang.Long[] getDatatypeIds(java.lang.Long... contentIds)
ContentConstants.TYPE_RULE type and ContentConstants.SUBTYPE_RULE_QUERY
subtype maps to a AppianType.QUERY_RULE datatypecontentIds - content idsDocumentInputStream getDocumentInputStream(long id_) throws InvalidContentException, AppianStorageException
id_ - the content ID of the version of the document;
use getVersionId(Long, Integer) to obtain the id of the version of the documentInvalidContentException - if an invalid content item is referencedAppianStorageException - if an error occurs while opening the input stream for the filegetDocumentInputStream(long[]),
download(Long, Integer, Boolean),
Document.getInputStream()DocumentInputStream[] getDocumentInputStream(long[] ids_) throws InvalidContentException, AppianStorageException
ids_ - the content IDs of the versions of the documents;
use getVersionIds(Long, Integer[]) to obtain the ids of the versions of the documentInvalidContentException - if an invalid content item is referencedAppianStorageException - if an error occurs while opening an input stream for a filegetDocumentInputStream(long),
download(Long, Integer, Boolean),
Document.getInputStream()ContentUploadOutputStream uploadDocument(Document doc, java.lang.Integer unique) throws InvalidContentException, StorageLimitException, PrivilegeException, InsufficientNameUniquenessException, DuplicateUuidException, AppianStorageException
createApproval(Content, Integer) API.
The caller must write the document's data to the returned output stream and complete the upload by
calling ContentUploadOutputStream.close(). Invoking the stream's close method will calculate the size
of the data written to the stream and save it as metadata for the document.doc - The Document to create.unique - How unique the name must be.InvalidContentExceptionStorageLimitExceptionPrivilegeExceptionInsufficientNameUniquenessExceptionDuplicateUuidExceptionAppianStorageExceptionCopyright © 2003-2024 Appian Corporation. All Rights Reserved.