|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface PageResource
Resource used for loading, saving and manipulating GCN pages.
Method Summary | |
---|---|
GenericResponse |
cancel(java.lang.Integer id)
Cancel editing the page. |
PageLoadResponse |
create(PageCreateRequest request)
Create a page based on the given pagecreaterequest |
TagCreateResponse |
createTag(java.lang.String id,
java.lang.Integer constructId,
java.lang.String keyword,
ContentTagCreateRequest request)
Create a new tag in the given page |
GenericResponse |
delete(java.lang.String id,
java.lang.Integer nodeId)
Delete the page denoted by id. |
LocalizationInfo |
getLocalizationInfo(java.lang.Integer id,
java.lang.Integer nodeId)
Get localization info for a page for a given channel and all master channels |
LocalizationInfo |
getLocalizationInfo(java.util.List<java.lang.Integer> ids,
java.lang.Integer nodeId)
Get localization info for a list of pages for a given channel and all master channels |
PageUsageListResponse |
getPagetagUsageInfo(java.lang.Integer skipCount,
java.lang.Integer maxItems,
java.lang.String sortBy,
java.lang.String sortOrder,
java.util.List<java.lang.Integer> pageId,
java.lang.Integer nodeId,
boolean returnPages,
boolean template,
boolean folder,
boolean languageVariants)
Get the pages containing pagetags pointing to one of the given pages |
PageUsageListResponse |
getPageUsageInfo(java.lang.Integer skipCount,
java.lang.Integer maxItems,
java.lang.String sortBy,
java.lang.String sortOrder,
java.util.List<java.lang.Integer> pageId,
java.lang.Integer nodeId,
boolean returnPages,
boolean template,
boolean folder,
boolean languageVariants)
Get the pages using one of the given pages |
PrivilegesResponse |
getPrivileges(java.lang.Integer id)
Get the privileges of the current user on the given page |
TagListResponse |
getTags(java.lang.Integer id,
java.lang.Integer skipCount,
java.lang.Integer maxItems,
TagSortAttribute sortBy,
SortOrder sortOrder,
java.lang.String search)
Get the list of tags (contenttags and templatetags) for this page |
TemplateUsageListResponse |
getTemplateUsageInfo(java.lang.Integer skipCount,
java.lang.Integer maxItems,
java.lang.String sortBy,
java.lang.String sortOrder,
java.util.List<java.lang.Integer> pageId,
java.lang.Integer nodeId,
boolean returnTemplates)
Get the templates using one of the given pages |
PageUsageListResponse |
getVariantsUsageInfo(java.lang.Integer skipCount,
java.lang.Integer maxItems,
java.lang.String sortBy,
java.lang.String sortOrder,
java.util.List<java.lang.Integer> pageId,
java.lang.Integer nodeId,
boolean returnPages,
boolean template,
boolean folder,
boolean languageVariants)
Get the page variants of the given pages |
PageLoadResponse |
load(java.lang.String id,
boolean update,
boolean template,
boolean folder,
boolean languageVariants,
boolean pageVariants,
boolean workflow,
boolean translationStatus,
boolean versionInfo,
java.lang.Integer nodeId)
Loads a page from GCN. |
GenericResponse |
localize(java.lang.Integer id,
LocalizeRequest request)
Localize the given page |
PagePreviewResponse |
preview(PagePreviewRequest request)
Render given page in a preview (before actually saving it) |
GenericResponse |
publish(MultiPagePublishRequest request)
Publish a list of pages. |
GenericResponse |
publish(java.lang.String id,
PagePublishRequest request)
Publish the page denoted by id (or send it in the queue when the User has not permission to publish the page). |
GenericResponse |
pushToMaster(java.lang.Integer id,
PushToMasterRequest request)
Push a page from a channel into a master |
GenericResponse |
pushToMaster(MultiPushToMasterRequest request)
Push a list of pages from a channel into a master |
PageRenderResponse |
render(java.lang.String id,
java.lang.Integer nodeId,
java.lang.String template,
boolean editMode,
java.lang.String proxyprefix,
LinksType linksType,
boolean tagmap)
Render the given page Info: This currently doesn't return tag render errors. |
TagListResponse |
restoreTag(java.lang.String pageId,
java.lang.String tag,
java.lang.Integer versionTimestamp)
Restore a single tag in the page with the given version timestamp |
PageLoadResponse |
restoreVersion(java.lang.String id,
java.lang.Integer versionTimestamp)
Restore the page version with the given version timestamp |
GenericResponse |
save(java.lang.String id,
PageSaveRequest request)
Saves a page into GCN |
GenericResponse |
takeOffline(java.lang.String id)
Take a specific page offline |
PageLoadResponse |
translate(java.lang.Integer id,
java.lang.String languageCode,
boolean locked,
java.lang.Integer channelId)
Translate the page into the given language. |
GenericResponse |
unlocalize(java.lang.Integer id,
UnlocalizeRequest request)
Unlocalize the given page |
GenericResponse |
unlocalize(MultiUnlocalizeRequest request)
Unlocalize pages in a channel |
GenericResponse |
workflowDecline(java.lang.String id,
WorkflowRequest request)
Decline the workflow for the page (i.e. |
GenericResponse |
workflowRevoke(java.lang.Integer id)
Revoke the last step of the workflow |
Methods inherited from interface com.gentics.contentnode.rest.resource.AuthenticatedResource |
---|
setSessionId |
Method Detail |
---|
PageLoadResponse create(PageCreateRequest request)
request
- containing data for creating the page
GenericResponse save(java.lang.String id, PageSaveRequest request)
id
- Id of the page to save. This can either be a local or global idrequest
- page save request
PageLoadResponse load(java.lang.String id, boolean update, boolean template, boolean folder, boolean languageVariants, boolean pageVariants, boolean workflow, boolean translationStatus, boolean versionInfo, java.lang.Integer nodeId)
id
- The id of the page to load. This can either be a localid or a globalidupdate
- true when the page shall be locked, false if nottemplate
- true if the template information shall be addedfolder
- true if the folder information shall be addedlanguageVariants
- true if the language variants shall be addedworkflow
- true if the workflow information shall be addedtranslationStatus
- true if the translationstatus information shall be addedversionInfo
- true if version information shall be addednodeId
- channel id
PagePreviewResponse preview(PagePreviewRequest request)
NodeException
GenericResponse publish(MultiPagePublishRequest request)
request
- publish request
GenericResponse publish(java.lang.String id, PagePublishRequest request)
id
- id of the Page to publish. This can either be a local or globalidrequest
- publish page request
GenericResponse delete(java.lang.String id, java.lang.Integer nodeId)
id
- id of the Page to delete. This can either be a local or global idnodeId
- channel id
GenericResponse cancel(java.lang.Integer id)
id
- id of the Page which is currently edited
PageRenderResponse render(java.lang.String id, java.lang.Integer nodeId, java.lang.String template, boolean editMode, java.lang.String proxyprefix, LinksType linksType, boolean tagmap)
id
- id of the pagenodeId
- node id (if rendering a page for a channel)template
- template to render (if not set, the page's template will be rendered)editMode
- true for rendering in edit mode, false for preview modeproxyprefix
- proxyprefixlinksType
- type of links (frontend or backend)tagmap
- true to also render the tagmap entries
TagListResponse getTags(java.lang.Integer id, java.lang.Integer skipCount, java.lang.Integer maxItems, TagSortAttribute sortBy, SortOrder sortOrder, java.lang.String search)
id
- id of the page
PrivilegesResponse getPrivileges(java.lang.Integer id)
id
- id of the page
TagCreateResponse createTag(java.lang.String id, java.lang.Integer constructId, java.lang.String keyword, ContentTagCreateRequest request)
id
- id of the page. This can either be a local or globalidconstructId
- id of the tags constructkeyword
- keyword of the constructrequest
- tag create request
PageLoadResponse restoreVersion(java.lang.String id, java.lang.Integer versionTimestamp)
id
- The id of the page that should be restored. This can either be a local or globalidversionTimestamp
- version timestampTagListResponse restoreTag(java.lang.String pageId, java.lang.String tag, java.lang.Integer versionTimestamp)
pageId
- id of the page. This can either be a local or globalidtag
- id or name of the tagversionTimestamp
- version timestamp
PageLoadResponse translate(java.lang.Integer id, java.lang.String languageCode, boolean locked, java.lang.Integer channelId)
id
- id of the page to translatelanguageCode
- code of the language into which the page shall be translatedlocked
- true if the translation shall be locked, false if notchannelId
- for multichannelling, specify channel in which to create page (can be 0 or equal to node ID to be ignored)
GenericResponse workflowRevoke(java.lang.Integer id)
id
- id of the page
GenericResponse workflowDecline(java.lang.String id, WorkflowRequest request)
id
- id of the page. This can either be a local or globalidrequest
- request object containing what should be changed about the workflow
PageUsageListResponse getPagetagUsageInfo(java.lang.Integer skipCount, java.lang.Integer maxItems, java.lang.String sortBy, java.lang.String sortOrder, java.util.List<java.lang.Integer> pageId, java.lang.Integer nodeId, boolean returnPages, boolean template, boolean folder, boolean languageVariants)
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 itemssortby
- (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".pageId
- list of page idsnodeId
- id of the nodereturnPages
- true (default) if the pages shall be returned, false for only returning the countstemplate
- true for adding template info to the pages, default is falsefolder
- true for adding folder info to the pages, default is falselanguageVariants
- true for adding the language variants to the pages, default is false
PageUsageListResponse getVariantsUsageInfo(java.lang.Integer skipCount, java.lang.Integer maxItems, java.lang.String sortBy, java.lang.String sortOrder, java.util.List<java.lang.Integer> pageId, java.lang.Integer nodeId, boolean returnPages, boolean template, boolean folder, boolean languageVariants)
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 itemssortby
- (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".pageId
- list of page idsnodeId
- id of the nodereturnPages
- true (default) if the pages shall be returned, false for only returning the countstemplate
- true for adding template info to the pages, default is falsefolder
- true for adding folder info to the pages, default is falselanguageVariants
- true for adding the language variants to the pages, default is false
PageUsageListResponse getPageUsageInfo(java.lang.Integer skipCount, java.lang.Integer maxItems, java.lang.String sortBy, java.lang.String sortOrder, java.util.List<java.lang.Integer> pageId, java.lang.Integer nodeId, boolean returnPages, boolean template, boolean folder, boolean languageVariants)
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 itemssortby
- (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".pageId
- list of page ids, for which the usage shall be fetchednodeId
- id of the nodereturnPages
- true (default) if the pages shall be returned, false for only returning the countstemplate
- true for adding template info to the pages, default is falsefolder
- true for adding folder info to the pages, default is falselanguageVariants
- true for adding the language variants to the pages, default is false
TemplateUsageListResponse getTemplateUsageInfo(java.lang.Integer skipCount, java.lang.Integer maxItems, java.lang.String sortBy, java.lang.String sortOrder, java.util.List<java.lang.Integer> pageId, java.lang.Integer nodeId, boolean returnTemplates)
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 itemssortby
- (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".pageId
- list of page ids, for which the usage shall be fetchednodeId
- id of the nodereturnTemplates
- true (default) if the templates shall be returned, false for only returning the counts
GenericResponse pushToMaster(java.lang.Integer id, PushToMasterRequest request)
id
- id of the pagerequest
- request
GenericResponse pushToMaster(MultiPushToMasterRequest request)
request
- request
GenericResponse unlocalize(java.lang.Integer id, UnlocalizeRequest request)
id
- id of the page to unlocalizerequest
- request
GenericResponse unlocalize(MultiUnlocalizeRequest request)
request
- request
GenericResponse localize(java.lang.Integer id, LocalizeRequest request)
id
- id of the page to localizerequest
- request
LocalizationInfo getLocalizationInfo(java.util.List<java.lang.Integer> ids, java.lang.Integer nodeId)
ids
- list of page idsnodeId
- id of the node to start with
LocalizationInfo getLocalizationInfo(java.lang.Integer id, java.lang.Integer nodeId)
id
- id of the pagenodeId
- id of the node to start with
GenericResponse takeOffline(java.lang.String id)
id
- ID of the page
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |