public interface FolderResource extends AuthenticatedResource
Modifier and Type | Method and Description |
---|---|
FolderLoadResponse |
create(FolderCreateRequest request) |
GenericResponse |
delete(String id,
Integer nodeId)
Delete a single folder.
|
GenericResponse |
deleteFromWastebin(IdSetRequest request,
long waitMs)
Delete folders denoted by the set of IDs from the wastebin
|
GenericResponse |
deleteFromWastebin(String id,
long waitMs)
Remove the folder denoted by the given id from the wastebin.
|
MultiDisinheritResponse |
disinherit(List<String> ids,
Integer nodeId)
Get the multichannelling exclusion and disinherit status for a list of folders
|
GenericResponse |
disinherit(List<String> ids,
Integer nodeId,
long waitMs,
DisinheritRequest request)
Set the multichannelling exclusion and disinherit status for a list of folders
|
DisinheritResponse |
disinherit(String id,
Integer nodeId)
Get the multichannelling exclusion and disinherit status of the folder
|
GenericResponse |
disinherit(String id,
Integer nodeId,
long waitMs,
DisinheritRequest request)
Set the multichannelling exclusion and disinherit status
|
FoundFilesListResponse |
findFiles(Integer folderId,
String query,
Integer skipCount,
Integer maxItems,
LinksType links,
boolean recursive)
Deprecated.
use
#getFiles(String, int, int, Integer, String, boolean, String, String, String, String, int, int, Boolean) instead. |
PageListResponse |
findPages(Integer folderId,
String query,
Integer skipCount,
Integer maxItems,
LinksType links,
boolean recursive)
Deprecated.
use
#getPages(Integer, Integer, Integer, Integer, boolean, boolean, boolean, String, String, boolean, String, String, boolean, int, boolean, boolean) instead |
FolderListResponse |
getBreadcrumb(String id,
Integer nodeId,
boolean includeWastebin)
Load the breadcrumb to the given folder
|
FolderExternalLinksResponse |
getExternalLinks(Integer folderId,
boolean recursive)
Get externals links from all the pages inside the folder with id `folderId`.
|
FileListResponse |
getFiles(String folderId,
int skipCount,
int maxItems,
Integer nodeId,
String search,
boolean recursive,
String sortBy,
String sortOrder,
String editor,
String creator,
int editedBefore,
int editedSince,
int createdBefore,
int createdSince,
Boolean inherited,
Boolean online,
Boolean broken,
Boolean used,
WastebinSearch wastebinSearch)
get a list of files for this folder
|
FolderListResponse |
getFolders(FolderListRequest folderListRequest)
Get the list of folders in this folder
|
FolderListResponse |
getFolders(String id,
Integer nodeId,
int skipCount,
int maxItems,
boolean recursive,
String sortBy,
String sortOrder,
Boolean inherited,
String search,
String editor,
String creator,
int editedBefore,
int editedSince,
int createdBefore,
int createdSince,
boolean tree,
List<String> recursiveIds,
boolean addPrivileges,
WastebinSearch wastebinSearch)
Get the list of folders in this folder
|
FileListResponse |
getImages(String folderId,
int skipCount,
int maxItems,
Integer nodeId,
String search,
boolean recursive,
String sortBy,
String sortOrder,
String editor,
String creator,
int editedBefore,
int editedSince,
int createdBefore,
int createdSince,
Boolean inherited,
Boolean online,
Boolean broken,
Boolean used,
WastebinSearch wastebinSearch)
get a list of images for this folder
|
ItemListResponse |
getItems(String folderId,
List<ContentNodeItem.ItemType> types,
int skipCount,
int maxItems,
Integer nodeId,
boolean template,
boolean languageVariants,
String language,
boolean langFallback,
String search,
boolean recursive,
String sortBy,
String sortOrder,
String editor,
String creator,
int editedBefore,
int editedSince,
int createdBefore,
int createdSince)
Get a list of items for this folder
|
LocalizationInfo |
getLocalizationInfo(String id,
Integer nodeId,
boolean recursive)
Get localization info for a folder and all subitems for a given channel and all master channels
|
FolderObjectCountResponse |
getObjectCounts(Integer id,
Integer nodeId,
String language,
boolean recursive,
Boolean inherited,
WastebinSearch wastebinSearch)
Get the object counts for objects in the specified folder
|
PageListResponse |
getPages(String id,
Integer skipCount,
Integer maxItems,
Integer nodeId,
boolean template,
boolean folder,
boolean languageVariants,
String language,
boolean langFallback,
boolean contentTags,
boolean objectTags,
String search,
boolean searchContent,
String filename,
boolean recursive,
String sortBy,
String sortOrder,
boolean isEditor,
boolean isCreator,
boolean isPublisher,
String editor,
String creator,
String publisher,
int timeDue,
boolean workflowOwn,
boolean workflowWatch,
Boolean inSync,
boolean translationStatus,
List<PageStatus> status,
int priority,
List<Integer> templateIds,
int editedBefore,
int editedSince,
int createdBefore,
int createdSince,
int publishedBefore,
int publishedSince,
Boolean inherited,
WastebinSearch wastebinSearch)
get a list of pages for this folder
|
PrivilegesResponse |
getPrivileges(Integer id)
Get the privileges of the current user on the given folder
|
TemplateListResponse |
getTemplates(String folderId,
Integer nodeId,
String search,
boolean recursive,
boolean reduce,
String sortBy,
String sortOrder,
String editor,
String creator,
int editedBefore,
int editedSince,
int createdBefore,
int createdSince,
boolean checkPermission,
Boolean inherited,
Integer skipCount,
Integer maxItems)
Get the templates which are linked into the given folder
|
MultiFolderLoadResponse |
load(MultiFolderLoadRequest request)
Load a list of folders specified in the given
request . |
FolderLoadResponse |
load(String folderId,
boolean update,
boolean addPrivileges,
Integer nodeId)
Load a single folder
|
GenericResponse |
localize(Integer id,
LocalizeRequest request)
Localize the given folder
|
GenericResponse |
move(MultiFolderMoveRequest request)
Move multiple folders to a different location
|
GenericResponse |
move(String id,
FolderMoveRequest request)
Move the folder with id to a different location
|
GenericResponse |
pushToMaster(Integer id,
PushToMasterRequest request)
Push a folder from a channel into a master
|
GenericResponse |
pushToMaster(MultiPushToMasterRequest request)
Push a list of folders from a channel into a master
|
GenericResponse |
restoreFromWastebin(IdSetRequest request,
long waitMs)
Restore the denoted folders from the wastebin
|
GenericResponse |
restoreFromWastebin(String id,
long waitMs)
Restore the given folder from the wastebin
|
GenericResponse |
save(String id,
FolderSaveRequest request)
Save a single folder
|
GenericResponse |
setStartpage(String id,
StartpageRequest request)
Request to set a startpage for a page
|
GenericResponse |
unlocalize(Integer id,
UnlocalizeRequest request)
Unlocalize the given folder
|
GenericResponse |
unlocalize(MultiUnlocalizeRequest request)
Unlocalize folders in a channel
|
setSessionId
FolderLoadResponse create(FolderCreateRequest request)
FolderLoadResponse load(String folderId, boolean update, boolean addPrivileges, Integer nodeId)
id
- id of the folder to load. This can be either the localid or a globalidupdate
- true when the folder is fetched for updating. Currently, folders
cannot be locked in the backend, but it is still recommended
to set this parameter to true when the folder shall be modified.addPrivileges
- flag whether the privileges should be added to the reponsenodeId
- id of the node (channel) for which the folder shall be loaded (when multichannelling is used)MultiFolderLoadResponse load(MultiFolderLoadRequest request)
request
.
Folder ids for which no folders exist, or the user does not have the necessary
permissions, are silently ignored.request
- The request with he list of folder ids to load.FolderListResponse getBreadcrumb(String id, Integer nodeId, boolean includeWastebin)
id
- id of the folder. This can either be a localid or a globalidnodeId
- node id (for multichannelling)includeWastebin
- true to include folders from the wastebin, false (default) if notPageListResponse getPages(String id, Integer skipCount, Integer maxItems, Integer nodeId, boolean template, boolean folder, boolean languageVariants, String language, boolean langFallback, boolean contentTags, boolean objectTags, String search, boolean searchContent, String filename, boolean recursive, String sortBy, String sortOrder, boolean isEditor, boolean isCreator, boolean isPublisher, String editor, String creator, String publisher, int timeDue, boolean workflowOwn, boolean workflowWatch, Boolean inSync, boolean translationStatus, List<PageStatus> status, int priority, List<Integer> templateIds, int editedBefore, int editedSince, int createdBefore, int createdSince, int publishedBefore, int publishedSince, Boolean inherited, WastebinSearch wastebinSearch)
id
- id of the folder. This can be the local or global id of the folderskipCount
- number of items to be skipped, set to 0 for skipping no itemsmaxItems
- maximum number of items to be returned, set to -1 for
returning all itemsnodeId
- node id of the channel when used in multichannellingtemplate
- true when the template information should be added to the
pagesfolder
- true when the folder information should be added to the pageslanguageVariants
- true when the language variants should be added to the pageslanguage
- code of the language in which the pages shall be fetched.langFallback
- true if the language fallback shall be done when getting pages
in a language, false if not. If a page is not present in the
given language and langFallback is true, the language variant
with highest priority in the node is used instead, otherwise
the page will not be present in the listcontentTags
- true if the contenttags shall be attached to all returned pages.
Default is falseobjectTags
- true if the objecttags shall be attached to all returned pages.
Default is falsesearch
- (optional) search string (may be empty for no search) - this will
filter the results if either the ID, the name (partial match or
the description (partial match) matches the given search string.searchContent
- (optional) true, if also the content shall be searched, false if notfilename
- (optional) search string for filenames (may be empty)recursive
- (optional) true when the pages shall be fetched recursively,
false if not. Defaults to falsesortBy
- (optional) attribute to sort by. defaults to namesortOrder
- (optional) result sort order - may be "asc" for ascending or
"desc" for descending other strings will be ignored. defaults
to "asc".isEditor
- (optional) true when only the pages last edited by the user
shall be returnedisCreator
- (optional) true when only the pages created by the user shall
be returnedisPublisher
- (optional) true when only the pages which were last published
by the user shall be returnededitor
- pattern for restricting pages by editorcreator
- pattern for restricting pages by creatorpublisher
- pattern for restricting pages by publishertimeDue
- (optional) difference in seconds for searching pages, that
will change their status due to timemanagement within the
given timespan. When set to 0 (default), the timemanagement
will not be considered.workflowOwn
- (optional) true to restrict to pages owned by the user in a
workflow. Defaults to false.workflowWatch
- (optional) true to restrict to pages watched by the user in a
workflow. Defaults to false.inSync
- (optional) Boolean.TRUE
to restrict to pages that are
currently in sync with their translation masters,
Boolean.FALSE
to restrict to pages that are currently
not in sync with their translation masters, and NULL to not
consider the translation status information at all. Setting
this flag (to either true or false) will also add the
translation status information.translationStatus
- true if the translationstatus information shall be added for
every page, false if not.status
- list of page statipriority
- priority of the pagetemplateIds
- list of template idseditedBefore
- timestamp to search pages, which were edited before a given time (0 for all pages)editedSince
- timestamp to search pages, which were edited since a given time (0 for all pages)createdBefore
- timestamp to search pages, which were created before a given time (0 for all pages)createdSince
- timestamp to search pages, which were created since a given time (0 for all pages)publishedBefore
- timestamp to search pages, which were published before a given time (0 for all pages)publishedSince
- timestamp to search pages, which were published since a given time (0 for all pages)inherited
- true to only return inherited pages in the given node, false to only get local/localized pages, null to get local and inherited pageswastebinSearch
- exclude (default) to exclude deleted objects, include to include
deleted objects, only to return only deleted objectsFileListResponse getFiles(String folderId, int skipCount, int maxItems, Integer nodeId, String search, boolean recursive, String sortBy, String sortOrder, String editor, String creator, int editedBefore, int editedSince, int createdBefore, int createdSince, Boolean inherited, Boolean online, Boolean broken, Boolean used, WastebinSearch wastebinSearch)
folderId
- id of the folderskipCount
- number of items to skip from the start of the list (paging). 0 to not skip items (default)maxItems
- maximum number of items to be returned (paging). -1 to return all items (default)nodeId
- node id for this folder - for use with multichannellingsearch
- (optional) string to search files for - this will
filter the results if either the ID, the name (partial match or
the description (partial match) matches the given search string.recursive
- (optional) true, if subfolders should be integrated into searchsortBy
- (optional) attribute to sort by. defaults to namesortOrder
- (optional) result sort order - may be "asc" for ascending or "desc" for descending
other strings will be ignored. defaults to "asc".editor
- (optional) pattern for searching images by editorcreator
- (optional) pattern for searching images by creatoreditedBefore
- (optional) timestamp for searching images edited before a specific timeeditedSince
- (optional) timestamp for searching images edited after a specific timecreatedBefore
- (optional) timestamp for searching images created before a specific timecreatedSince
- (optional) timestamp for searching images created after a specific timeinherited
- true to only return inherited files in the given node, false to only get local/localized files, null to get local and inherited filesonline
- true to only return online files, false to only get offline files, null to get both online and offline filesbroken
- true to only return broken files (where the binary data is missing), false to only get non-broken files, null to get bothused
- true if only used files that are referenced somewhere shall be fetched, false for unused fileswastebinSearch
- exclude (default) to exclude deleted objects, include to include
deleted objects, only to return only deleted objectsFileListResponse getImages(String folderId, int skipCount, int maxItems, Integer nodeId, String search, boolean recursive, String sortBy, String sortOrder, String editor, String creator, int editedBefore, int editedSince, int createdBefore, int createdSince, Boolean inherited, Boolean online, Boolean broken, Boolean used, WastebinSearch wastebinSearch)
folderId
- id of the folderskipCount
- number of items to skip from the start of the list (paging). 0 to not skip items (default)maxItems
- maximum number of items to be returned (paging). -1 to return all items (default)nodeId
- node id for this folder - for use with multichannellingsearch
- (optional) string to search files for - this will
filter the results if either the ID, the name (partial match or
the description (partial match) matches the given search string.recursive
- (optional) true, if subfolders should be integrated into searchsortBy
- (optional) attribute to sort by. defaults to namesortOrder
- (optional) result sort order - may be "asc" for ascending or "desc" for descending
other strings will be ignored. defaults to "asc".editor
- (optional) pattern for searching images by editorcreator
- (optional) pattern for searching images by creatoreditedBefore
- (optional) timestamp for searching images edited before a specific timeeditedSince
- (optional) timestamp for searching images edited after a specific timecreatedBefore
- (optional) timestamp for searching images created before a specific timecreatedSince
- (optional) timestamp for searching images created after a specific timeinherited
- true to only return inherited images in the given node, false to only get local/localized images, null to get local and inherited imagesonline
- true to only return online files, false to only get offline files, null to get both online and offline filesbroken
- true to only return broken files (where the binary data is missing), false to only get non-broken files, null to get bothused
- true if only used files that are referenced somewhere shall be fetched, false for unused fileswastebinSearch
- exclude (default) to exclude deleted objects, include to include
deleted objects, only to return only deleted objectsFolderListResponse getFolders(FolderListRequest folderListRequest)
folderListRequest
- FolderListResponse getFolders(String id, Integer nodeId, int skipCount, int maxItems, boolean recursive, String sortBy, String sortOrder, Boolean inherited, String search, String editor, String creator, int editedBefore, int editedSince, int createdBefore, int createdSince, boolean tree, List<String> recursiveIds, boolean addPrivileges, WastebinSearch wastebinSearch)
id
- local id of the folder. This can either be the local or
globalid.nodeId
- node id (for multichannelling)skipCount
- number of items to be skipped, set to 0 for skipping no itemsmaxItems
- maximum number of items to be returned, set to -1 for
returning all itemsrecursive
- true when the folders shall be fetched recursivelysortBy
- name of the sorted attribute, defaults to "name"sortOrder
- sorting order, defaults to "asc"inherited
- true to only return inherited folders in the given node, false
to only get local/localized folders, null to get local and
inherited folderssearch
- search string to search for in name, null if not searching -
this will filter the results if either the ID, the name
(partial match or the description (partial match) matches the
given search string.editor
- pattern for restricting folders by editorcreator
- pattern for restricting folders by creatoreditedBefore
- timestamp for restricting to folders that were edited before a
given time, 0 for all folderseditedSince
- timestamp for restricting to folders that were edited since a
given time, 0 for all folderscreatedBefore
- timestamp for restricting to folders that were created before a
given time, 0 for all folderscreatedSince
- timestamp for restricting to folders that were created since a
given time, 0 for all folderstree
- true when folders shall be returned as tree(s). Subfolders
will be attached to their mothers. This only makes sense, when
recursive is true.recursiveIds
- optional list of folder ids, for which the children shall be
fetched. if recursive is true (ignored if recursive is false).
The ids might be composed as nodeId/folderId to get children
for folders in specific channels only.addPrivileges
- true if the privileges shall be added to the folders, false if notwastebinSearch
- exclude (default) to exclude deleted objects, include to include
deleted objects, only to return only deleted objectsNodeException
TemplateListResponse getTemplates(String folderId, Integer nodeId, String search, boolean recursive, boolean reduce, String sortBy, String sortOrder, String editor, String creator, int editedBefore, int editedSince, int createdBefore, int createdSince, boolean checkPermission, Boolean inherited, Integer skipCount, Integer maxItems)
folderId
- id of the folder. This can either be a localid or a globalidnodeId
- id of the channel, if the list shall be fetched for a
channelsearch
- (optional) search string (may be empty for no search),
defaults to null - this will filter the results if either the ID,
the name (partial match or the description (partial match) matches the given search string.recursive
- (optional) true when the search shall be done recursively, false if not, defaults to falsereduce
- (optional) true when each template shall only be returned once, even when searching recursively, defaults to falsesortBy
- (optional) attribute to sort by. defaults to namesortOrder
- (optional) result sort order - may be "asc" for ascending or "desc" for descending
other strings will be ignored. defaults to "asc".editor
- (optional) pattern for searching images by editorcreator
- (optional) pattern for searching images by creatoreditedBefore
- (optional) timestamp for searching images edited before a specific timeeditedSince
- (optional) timestamp for searching images edited after a specific timecreatedBefore
- (optional) timestamp for searching images created before a specific timecreatedSince
- (optional) timestamp for searching images created after a specific timecheckPermission
- (optional) flag to check for permissions. Optional, defaults to trueinherited
- true to only return inherited templates in the given node, false to only get local/localized templates, null to get local and inherited templatesNodeException
ItemListResponse getItems(String folderId, List<ContentNodeItem.ItemType> types, int skipCount, int maxItems, Integer nodeId, boolean template, boolean languageVariants, String language, boolean langFallback, String search, boolean recursive, String sortBy, String sortOrder, String editor, String creator, int editedBefore, int editedSince, int createdBefore, int createdSince)
folderId
- id of the foldertype
- list of types to returnskipCount
- number of items to skip from the start of the list (paging). 0 to not skip items (default)maxItems
- maximum number of items to be returned (paging). -1 to return all items (default)nodeId
- node id for this folder - for use with multichannelinglangvars
- true when the language variants should be added to the pageslanguage
- code of the language in which the pages shall be fetched.langFallback
- true if the language fallback shall be done when getting pages
in a language, false if not. If a page is not present in the
given language and langFallback is true, the language variant
with highest priority in the node is used instead, otherwise
the page will not be present in the listsearch
- (optional) string to search items for - this will
filter the results if either the ID, the name (partial match or
the description (partial match) matches the given search string.recursive
- (optional) true, if subfolders should be integrated into searchsortby
- (optional) attribute to sort by. defaults to namesortorder
- (optional) result sort order - may be "asc" for ascending or "desc" for descending
other strings will be ignored. defaults to "asc".editor
- (optional) pattern for searching images by editorcreator
- (optional) pattern for searching images by creatoreditedBefore
- (optional) timestamp for searching images edited before a specific timeeditedSince
- (optional) timestamp for searching images edited after a specific timecreatedBefore
- (optional) timestamp for searching images created before a specific timecreatedSince
- (optional) timestamp for searching images created after a specific timePageListResponse findPages(Integer folderId, String query, Integer skipCount, Integer maxItems, LinksType links, boolean recursive)
#getPages(Integer, Integer, Integer, Integer, boolean, boolean, boolean, String, String, boolean, String, String, boolean, int, boolean, boolean)
insteadfolderId
- start folder id, if set to 0, the search is done over all foldersquery
- string to be searched (currently, only page names are searched)skipCount
- number of items to be skipped, set to 0 for skipping no itemsmaxItems
- maximum number of items to be returned, set to -1 for returning all itemslinks
- type of the links to the page ("backend" for backend links, "frontend" for frontend links)recursive
- true when the search shall be done recursive, false if only flat in the given folderFoundFilesListResponse findFiles(Integer folderId, String query, Integer skipCount, Integer maxItems, LinksType links, boolean recursive)
#getFiles(String, int, int, Integer, String, boolean, String, String, String, String, int, int, Boolean)
instead.folderId
- start folder id, if set to 0, the search is done over all foldersquery
- string to be searched (currently, only page names are searched)skipCount
- number of items to be skipped, set to 0 for skipping no itemsmaxItems
- maximum number of items to be returned, set to -1 for returning all itemslinks
- type of the links to the file ("backend" for backend links, "frontend" for frontend links)recursive
- true when the search shall be done recursive, false if only flat in the given folderFolderExternalLinksResponse getExternalLinks(Integer folderId, boolean recursive)
folderId
- Id of the folder.recursive
- If true, pages in subfolders will be included in the response.FolderExternalLinksResponse
).GenericResponse save(String id, FolderSaveRequest request)
id
- folder id. This can either be a local or globalidrequest
- folder save requestGenericResponse delete(String id, Integer nodeId)
id
- id of the folder to be deleted. This can either be local or global idGenericResponse deleteFromWastebin(String id, long waitMs)
id
- id of the folder to remove from the wastebin. This can either be
a local or global idwaitMs
- time in ms for the request to be done in foregroundGenericResponse deleteFromWastebin(IdSetRequest request, long waitMs)
request
- request containing ID setwaitMs
- time in ms for the request to be done in foregroundGenericResponse restoreFromWastebin(String id, long waitMs)
id
- id of the folder to restore from the wastebin. This can either
be a local or global idwaitMs
- time in ms for the request to be done in foregroundGenericResponse restoreFromWastebin(IdSetRequest request, long waitMs)
request
- request containing ID setwaitMs
- time in ms for the request to be done in foregroundPrivilegesResponse getPrivileges(Integer id)
id
- id of the folder.FolderObjectCountResponse getObjectCounts(Integer id, Integer nodeId, String language, boolean recursive, Boolean inherited, WastebinSearch wastebinSearch)
id
- id of the foldernodeId
- node idlanguage
- language coderecursive
- true to count objects recursively, false (default) if notinherited
- true to only count inherited objects, false to count not inherited objects, null (default) to count bothwastebinSearch
- wastebin search optionGenericResponse pushToMaster(Integer id, PushToMasterRequest request)
id
- id of the folderrequest
- requestGenericResponse pushToMaster(MultiPushToMasterRequest request)
request
- requestGenericResponse unlocalize(Integer id, UnlocalizeRequest request)
id
- id of the folder to unlocalizerequest
- requestGenericResponse unlocalize(MultiUnlocalizeRequest request)
request
- requestGenericResponse localize(Integer id, LocalizeRequest request)
id
- id of the folder to localizerequest
- requestLocalizationInfo getLocalizationInfo(String id, Integer nodeId, boolean recursive)
id
- id of the folder. This can either be the local or global idnodeId
- id of the node to start withrecursive
- true if the localization info shall be fetched recursively, false if notGenericResponse setStartpage(String id, StartpageRequest request)
id
- id of the pagerequest
- request containing the requested startpageDisinheritResponse disinherit(String id, Integer nodeId) throws Exception
id
- folder IDnodeId
- node IDException
GenericResponse disinherit(String id, Integer nodeId, long waitMs, DisinheritRequest request) throws Exception
id
- folder IDnodeId
- node IDwaitMs
- wait timeout in millisecondsrequest
- request objectException
MultiDisinheritResponse disinherit(List<String> ids, Integer nodeId) throws Exception
ids
- list of folder IDsnodeId
- node IDException
GenericResponse disinherit(List<String> ids, Integer nodeId, long waitMs, DisinheritRequest request) throws Exception
ids
- list of folder IDsnodeId
- node IDwaitMs
- wait timeout in millisecondsrequest
- request objectException
GenericResponse move(String id, FolderMoveRequest request) throws Exception
id
- id of the folder to moverequest
- request containing target informationException
- in case of errorsGenericResponse move(MultiFolderMoveRequest request) throws Exception
request
- request containing source and target informationException
Copyright © 2015 Gentics Software GmbH. All rights reserved.