|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface FolderResource
Resource for loading and manipulating folders in GCN
Method Summary | |
---|---|
FolderLoadResponse |
create(FolderCreateRequest request)
|
GenericResponse |
delete(java.lang.String id,
java.lang.Integer nodeId)
Delete a single folder. |
FoundFilesListResponse |
findFiles(java.lang.Integer folderId,
java.lang.String query,
java.lang.Integer skipCount,
java.lang.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(java.lang.Integer folderId,
java.lang.String query,
java.lang.Integer skipCount,
java.lang.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(java.lang.String id,
java.lang.Integer nodeId)
Load the breadcrumb to the given folder |
FileListResponse |
getFiles(java.lang.String folderId,
int skipCount,
int maxItems,
java.lang.Integer nodeId,
java.lang.String search,
boolean recursive,
java.lang.String sortBy,
java.lang.String sortOrder,
java.lang.String editor,
java.lang.String creator,
int editedSince,
int createdSince,
java.lang.Boolean inherited,
java.lang.Boolean online,
java.lang.Boolean broken)
get a list of files for this folder |
FolderListResponse |
getFolders(java.lang.String id,
java.lang.Integer nodeId,
int skipCount,
int maxItems,
boolean recursive,
java.lang.String sortBy,
java.lang.String sortOrder,
java.lang.Boolean inherited,
java.lang.String search,
java.lang.String editor,
java.lang.String creator,
int editedSince,
int createdSince,
boolean tree,
java.util.List<java.lang.String> recursiveIds)
Get the list of folders in this folder |
FileListResponse |
getImages(java.lang.String folderId,
int skipCount,
int maxItems,
java.lang.Integer nodeId,
java.lang.String search,
boolean recursive,
java.lang.String sortBy,
java.lang.String sortOrder,
java.lang.String editor,
java.lang.String creator,
int editedSince,
int createdSince,
java.lang.Boolean inherited,
java.lang.Boolean online,
java.lang.Boolean broken)
get a list of images for this folder |
ItemListResponse |
getItems(java.lang.String folderId,
java.util.List<ContentNodeItem.ItemType> types,
int skipCount,
int maxItems,
java.lang.Integer nodeId,
boolean languageVariants,
java.lang.String language,
boolean langFallback,
java.lang.String search,
boolean recursive,
java.lang.String sortBy,
java.lang.String sortOrder,
java.lang.String editor,
java.lang.String creator,
int editedSince,
int createdSince)
Get a list of items for this folder |
LocalizationInfo |
getLocalizationInfo(java.lang.String id,
java.lang.Integer nodeId,
boolean recursive)
Get localization info for a folder and all subitems for a given channel and all master channels |
FolderObjectCountResponse |
getObjectCounts(java.lang.Integer id,
java.lang.Integer nodeId,
java.lang.String language)
Get the object counts for objects in the specified folder |
PageListResponse |
getPages(java.lang.String id,
java.lang.Integer skipCount,
java.lang.Integer maxItems,
java.lang.Integer nodeId,
boolean template,
boolean folder,
boolean languageVariants,
java.lang.String language,
boolean langFallback,
boolean contentTags,
boolean objectTags,
java.lang.String search,
boolean searchContent,
java.lang.String filename,
boolean recursive,
java.lang.String sortBy,
java.lang.String sortOrder,
boolean isEditor,
boolean isCreator,
boolean isPublisher,
java.lang.String editor,
java.lang.String creator,
java.lang.String publisher,
int timeDue,
boolean workflowOwn,
boolean workflowWatch,
java.lang.Boolean inSync,
boolean translationStatus,
java.util.List<PageStatus> status,
int priority,
java.util.List<java.lang.Integer> templateIds,
int editedSince,
int createdSince,
int publishedSince,
java.lang.Boolean inherited)
get a list of pages for this folder |
PrivilegesResponse |
getPrivileges(java.lang.Integer id)
Get the privileges of the current user on the given folder |
TemplateListResponse |
getTemplates(java.lang.String folderId,
java.lang.Integer nodeId,
java.lang.String search,
boolean recursive,
boolean reduce,
java.lang.String sortBy,
java.lang.String sortOrder,
java.lang.String editor,
java.lang.String creator,
int editedSince,
int createdSince,
boolean checkPermission,
java.lang.Boolean inherited,
java.lang.Integer skipCount,
java.lang.Integer maxItems)
Get the templates which are linked into the given folder |
FolderLoadResponse |
load(java.lang.String folderId,
boolean update,
boolean addPrivileges,
java.lang.Integer nodeId)
Load a single folder |
GenericResponse |
localize(java.lang.Integer id,
LocalizeRequest request)
Localize the given folder |
GenericResponse |
pushToMaster(java.lang.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 |
save(java.lang.String id,
FolderSaveRequest request)
Save a single folder |
GenericResponse |
setStartpage(java.lang.String id,
StartpageRequest request)
Request to set a startpage for a page |
GenericResponse |
unlocalize(java.lang.Integer id,
UnlocalizeRequest request)
Unlocalize the given folder |
GenericResponse |
unlocalize(MultiUnlocalizeRequest request)
Unlocalize folders in a channel |
Methods inherited from interface com.gentics.contentnode.rest.resource.AuthenticatedResource |
---|
setSessionId |
Method Detail |
---|
FolderLoadResponse create(FolderCreateRequest request)
FolderLoadResponse load(java.lang.String folderId, boolean update, boolean addPrivileges, java.lang.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)
FolderListResponse getBreadcrumb(java.lang.String id, java.lang.Integer nodeId)
id
- id of the folder. This can either be a localid or a globalidnodeId
- node id (for multichannelling)
PageListResponse getPages(java.lang.String id, java.lang.Integer skipCount, java.lang.Integer maxItems, java.lang.Integer nodeId, boolean template, boolean folder, boolean languageVariants, java.lang.String language, boolean langFallback, boolean contentTags, boolean objectTags, java.lang.String search, boolean searchContent, java.lang.String filename, boolean recursive, java.lang.String sortBy, java.lang.String sortOrder, boolean isEditor, boolean isCreator, boolean isPublisher, java.lang.String editor, java.lang.String creator, java.lang.String publisher, int timeDue, boolean workflowOwn, boolean workflowWatch, java.lang.Boolean inSync, boolean translationStatus, java.util.List<PageStatus> status, int priority, java.util.List<java.lang.Integer> templateIds, int editedSince, int createdSince, int publishedSince, java.lang.Boolean inherited)
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 idseditedSince
- timestamp to search pages, which were edited since a given time (0 for all pages)createdSince
- timestamp to search pages, which were created since 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 pages
FileListResponse getFiles(java.lang.String folderId, int skipCount, int maxItems, java.lang.Integer nodeId, java.lang.String search, boolean recursive, java.lang.String sortBy, java.lang.String sortOrder, java.lang.String editor, java.lang.String creator, int editedSince, int createdSince, java.lang.Boolean inherited, java.lang.Boolean online, java.lang.Boolean broken)
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 creatoreditedSince
- (optional) timestamp for searching images edited after 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 both
FileListResponse getImages(java.lang.String folderId, int skipCount, int maxItems, java.lang.Integer nodeId, java.lang.String search, boolean recursive, java.lang.String sortBy, java.lang.String sortOrder, java.lang.String editor, java.lang.String creator, int editedSince, int createdSince, java.lang.Boolean inherited, java.lang.Boolean online, java.lang.Boolean broken)
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 creatoreditedSince
- (optional) timestamp for searching images edited after 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 both
FolderListResponse getFolders(java.lang.String id, java.lang.Integer nodeId, int skipCount, int maxItems, boolean recursive, java.lang.String sortBy, java.lang.String sortOrder, java.lang.Boolean inherited, java.lang.String search, java.lang.String editor, java.lang.String creator, int editedSince, int createdSince, boolean tree, java.util.List<java.lang.String> recursiveIds)
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 creatoreditedSince
- timestamp for restricting to folders that were edited since 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.
NodeException
TemplateListResponse getTemplates(java.lang.String folderId, java.lang.Integer nodeId, java.lang.String search, boolean recursive, boolean reduce, java.lang.String sortBy, java.lang.String sortOrder, java.lang.String editor, java.lang.String creator, int editedSince, int createdSince, boolean checkPermission, java.lang.Boolean inherited, java.lang.Integer skipCount, java.lang.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 creatoreditedSince
- (optional) timestamp for searching images edited after 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 templates
NodeException
ItemListResponse getItems(java.lang.String folderId, java.util.List<ContentNodeItem.ItemType> types, int skipCount, int maxItems, java.lang.Integer nodeId, boolean languageVariants, java.lang.String language, boolean langFallback, java.lang.String search, boolean recursive, java.lang.String sortBy, java.lang.String sortOrder, java.lang.String editor, java.lang.String creator, int editedSince, 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 creatoreditedSince
- (optional) timestamp for searching images edited after a specific timecreatedSince
- (optional) timestamp for searching images created after a specific time
PageListResponse findPages(java.lang.Integer folderId, java.lang.String query, java.lang.Integer skipCount, java.lang.Integer maxItems, LinksType links, boolean recursive)
#getPages(Integer, Integer, Integer, Integer, boolean, boolean, boolean, String, String, boolean, String, String, boolean, int, boolean, 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 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 folder
FoundFilesListResponse findFiles(java.lang.Integer folderId, java.lang.String query, java.lang.Integer skipCount, java.lang.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 folder
GenericResponse save(java.lang.String id, FolderSaveRequest request)
id
- folder id. This can either be a local or globalidrequest
- folder save request
GenericResponse delete(java.lang.String id, java.lang.Integer nodeId)
id
- id of the folder to be deleted. This can either be local or global id
PrivilegesResponse getPrivileges(java.lang.Integer id)
id
- id of the folder.
FolderObjectCountResponse getObjectCounts(java.lang.Integer id, java.lang.Integer nodeId, java.lang.String language)
id
- id of the foldernodeId
- node idlanguage
- language code
GenericResponse pushToMaster(java.lang.Integer id, PushToMasterRequest request)
id
- id of the folderrequest
- request
GenericResponse pushToMaster(MultiPushToMasterRequest request)
request
- request
GenericResponse unlocalize(java.lang.Integer id, UnlocalizeRequest request)
id
- id of the folder to unlocalizerequest
- request
GenericResponse unlocalize(MultiUnlocalizeRequest request)
request
- request
GenericResponse localize(java.lang.Integer id, LocalizeRequest request)
id
- id of the folder to localizerequest
- request
LocalizationInfo getLocalizationInfo(java.lang.String id, java.lang.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 not
GenericResponse setStartpage(java.lang.String id, StartpageRequest request)
id
- id of the pagerequest
- request containing the requested startpage
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |