com.gentics.contentnode.rest.model.response

Class AbstractListResponse<T>

java.lang.Object

com.gentics.contentnode.rest.model.response.GenericResponse

com.gentics.contentnode.rest.model.response.StagingResponse<String>

com.gentics.contentnode.rest.model.response.AbstractListResponse<T>

Type Parameters:

T - type of the objects contained in the list

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

ActionLogEntryList, ActionLogTypeList, ActionModelList, ConstructCategoryListResponse, ConstructList, ContentPackageListResponse, ContentRepositoryFragmentEntryListResponse, ContentRepositoryFragmentListResponse, ContentRepositoryListResponse, DatasourceEntryListResponse, DirtQueueEntryList, DirtQueueSummaryResponse, ErrorLogEntryList, ExecutionListResponse, ExternalLinkList, FeatureList, FeatureModelList, FileListResponse, FolderListResponse, FormListResponse, GroupList, ImageListResponse, IndexList, ItemVersionListResponse, JobsResponse, LanguageList, MarkupLanguageListResponse, NodeList, ObjectPropertyCategoryListResponse, ObjectPropertyListResponse, PackageListResponse, PagedConstructInPackageListResponse, PagedConstructListResponse, PagedContentRepositoryFragmentInPackageListResponse, PagedContentRepositoryInPackageListResponse, PagedDatasourceInPackageListResponse, PagedDatasourceListResponse, PagedFolderListResponse, PagedObjectPropertyInPackageListResponse, PagedObjectPropertyListResponse, PagedTemplateInPackageListResponse, PagedTemplateListResponse, PageList, PageListResponse, RoleListResponse, ScheduleListResponse, SyncItemList, TagmapEntryConsistencyResponse, TagmapEntryListResponse, TagStatusResponse, TaskListResponse, TemplateInNodeResponse, TypePermissionList, UILanguagesResponse, UserList

public abstract class AbstractListResponse<T>
extends StagingResponse<String>

Abstract list response

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
AbstractListResponse() Empty constructor needed by JAXB
AbstractListResponse(Message message, ResponseInfo responseInfo) Create an instance with message and response info

Method Summary

Modifier and Type	Method and Description
boolean	getHasMoreItems() True if more items are available to get (if paging was used)
List<T>	getItems() Items in the list
int	getNumItems() Get total number of items available
Map<Integer,Set<Permission>>	getPerms() User permissions on the returned items, if applicable and requested
void	setHasMoreItems(boolean hasMoreItems) Set whether more items are available
void	setItems(List<T> items) Set the list of items
void	setNumItems(int numItems) Set total number of items available
void	setPerms(Map<Integer,Set<Permission>> perms) Set user permissions

Methods inherited from class com.gentics.contentnode.rest.model.response.StagingResponse

getStagingStatus, setStagingStatus

Methods inherited from class com.gentics.contentnode.rest.model.response.GenericResponse

addMessage, getMessages, getResponseInfo, setMessages, setResponseInfo

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AbstractListResponse

public AbstractListResponse()

Empty constructor needed by JAXB

AbstractListResponse

public AbstractListResponse(Message message,
                            ResponseInfo responseInfo)

Create an instance with message and response info

Parameters:

message - message

responseInfo - response info

Method Detail

getItems

public List<T> getItems()

Items in the list

Returns:

list of items

setItems

public void setItems(List<T> items)

Set the list of items

Parameters:

items - list of items

getHasMoreItems

public boolean getHasMoreItems()

True if more items are available to get (if paging was used)

Returns:

true for more items

setHasMoreItems

public void setHasMoreItems(boolean hasMoreItems)

Set whether more items are available

Parameters:

hasMoreItems - true for more items

getNumItems

public int getNumItems()

Get total number of items available

Returns:

total number of items available

setNumItems

public void setNumItems(int numItems)

Set total number of items available

Parameters:

numItems - total number of items

getPerms

public Map<Integer,Set<Permission>> getPerms()

User permissions on the returned items, if applicable and requested

Returns:

map of permissions

setPerms

public void setPerms(Map<Integer,Set<Permission>> perms)

Set user permissions

Parameters:

perms - permissions