com.gentics.contentnode.rest.resource
Interface ConstructResource

All Superinterfaces:
AuthenticatedResource

public interface ConstructResource
extends AuthenticatedResource

Resource for handling constructs


Method Summary
 GenericResponse deletePart(java.lang.String constructId, java.lang.String idOrKeyname)
          Delete a part of a construct.
 ConstructListResponse list(java.lang.Integer skipCount, java.lang.Integer maxItems, java.lang.String search, java.lang.Boolean changeable, java.lang.Integer pageId, java.lang.Integer nodeId, java.lang.Integer categoryId, ConstructSortAttribute sortBy, SortOrder sortOrder)
          Get the list of constructs that are used by the tags in the given page.
 ConstructLoadResponse load(java.lang.Integer id)
          Load the insertable construct and it's categories for a given constructId
 
Methods inherited from interface com.gentics.contentnode.rest.resource.AuthenticatedResource
setSessionId
 

Method Detail

load

ConstructLoadResponse load(java.lang.Integer id)
Load the insertable construct and it's categories for a given constructId


list

ConstructListResponse list(java.lang.Integer skipCount,
                           java.lang.Integer maxItems,
                           java.lang.String search,
                           java.lang.Boolean changeable,
                           java.lang.Integer pageId,
                           java.lang.Integer nodeId,
                           java.lang.Integer categoryId,
                           ConstructSortAttribute sortBy,
                           SortOrder sortOrder)
Get the list of constructs that are used by the tags in the given page. This includes any constructs that exist in other nodes but are nevertheless used by tags in this page.

Parameters:
skipCount - number of items to be skipped (paging)
maxItems - maximum number of items to be returned (paging). -1 for getting all items.
search - search string for filtering items
changeable - true to only get changeable constructs, false for only getting not changeable items. Leave empty to get all
pageId - ID of the page form which to get constructs.
nodeId - ID of the node for getting constructs linked to a node
categoryId - ID of the category for filtering
sortBy - attribute for sorting
sortOrder - sort order
Returns:
list of constructs

deletePart

GenericResponse deletePart(java.lang.String constructId,
                           java.lang.String idOrKeyname)
Delete a part of a construct. Since the passed part ID is unique across all constructs, the construct doesn't have to be specified. This will not delete the datasource entries for an overview part, they are deleted when the construct is deleted.

Parameters:
constructId - The ID of the construct where the part is in
idOrKeyname - The ID or the keyword of the part to delete. It will first try to delete by ID, if the value is numeric.
Returns:
Response object


Copyright © 2014 Gentics Software GmbH. All Rights Reserved.