com.gentics.contentnode.rest.model.response

Class LocalizationsResponse

java.lang.Object

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

com.gentics.contentnode.rest.model.response.LocalizationsResponse

All Implemented Interfaces:

Serializable

public class LocalizationsResponse
extends GenericResponse

Response containing localization info

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
LocalizationsResponse() Default constructor for an empty response.
LocalizationsResponse(Message message, int masterId, int masterNodeId, Map<Integer,Integer> nodeIds) Create a response with all fields set.
LocalizationsResponse(Message message, ResponseInfo responseInfo) Create a response containing only a message and response information.

Method Summary

Modifier and Type	Method and Description
int	getHidden() Number of localizations the user has no permission to see
int	getMasterId() The ID of the master object.
int	getMasterNodeId() The ID of the node the master object resides in.
Map<Integer,Integer>	getNodeIds() A map from object IDs to the respective channels of the objects.
List<Integer>	getOffline() IDs of pages, that are offline
List<Integer>	getOnline() IDs of pages, that are online
int	getTotal() Total number of localizations (including localizations in channels without permission and for folders localizations of subitems)
LocalizationsResponse	setHidden(int hidden) Set number of hidden localizations
LocalizationsResponse	setMasterId(int masterId) Set the master object ID.
LocalizationsResponse	setMasterNodeId(int masterNodeId) Set the ID of the node the master object resides in.
LocalizationsResponse	setNodeIds(Map<Integer,Integer> nodeIds) Set the map from object IDs to the respective channels of the objects.
LocalizationsResponse	setOffline(List<Integer> offline) Set offline pages
LocalizationsResponse	setOnline(List<Integer> online) Set online pages
LocalizationsResponse	setTotal(int total) Set total number of localizations

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

LocalizationsResponse

public LocalizationsResponse()

Default constructor for an empty response.

LocalizationsResponse

public LocalizationsResponse(Message message,
                             ResponseInfo responseInfo)

Create a response containing only a message and response information.

Parameters:

message - The response message.

responseInfo - The response information.

LocalizationsResponse

public LocalizationsResponse(Message message,
                             int masterId,
                             int masterNodeId,
                             Map<Integer,Integer> nodeIds)

Create a response with all fields set.

Parameters:

message - The response message.

masterId - The ID of the master object.

masterNodeId - The node ID of the master object.

nodeIds - A map of IDs of localized copies to their channel IDs.

Method Detail

getMasterId

public int getMasterId()

The ID of the master object.

Returns:

The ID of the master object.

setMasterId

public LocalizationsResponse setMasterId(int masterId)

Set the master object ID.

Parameters:

masterId - The new master object id.

Returns:

fluent API

getMasterNodeId

public int getMasterNodeId()

The ID of the node the master object resides in.

Returns:

The node the master object resides in.

setMasterNodeId

public LocalizationsResponse setMasterNodeId(int masterNodeId)

Set the ID of the node the master object resides in.

Parameters:

masterNodeId - The ID of the node the master object resides in.

Returns:

fluent API

getNodeIds

public Map<Integer,Integer> getNodeIds()

A map from object IDs to the respective channels of the objects.

Returns:

A map from object IDs to the respective channels of the objects.

setNodeIds

public LocalizationsResponse setNodeIds(Map<Integer,Integer> nodeIds)

Set the map from object IDs to the respective channels of the objects.

Parameters:

nodeIds - A map from object IDs to the respective channels of the objects.

Returns:

fluent API

getTotal

public int getTotal()

Total number of localizations (including localizations in channels without permission and for folders localizations of subitems)

Returns:

total number

setTotal

public LocalizationsResponse setTotal(int total)

Set total number of localizations

Parameters:

total - total number

Returns:

fluent API

getHidden

public int getHidden()

Number of localizations the user has no permission to see

Returns:

hidden number

setHidden

public LocalizationsResponse setHidden(int hidden)

Set number of hidden localizations

Parameters:

hidden - hidden number

Returns:

fluent API

getOnline

public List<Integer> getOnline()

IDs of pages, that are online

Returns:

list of page IDs

setOnline

public LocalizationsResponse setOnline(List<Integer> online)

Set online pages

Parameters:

online - list of page IDs

Returns:

fluent API

getOffline

public List<Integer> getOffline()

IDs of pages, that are offline

Returns:

list of page IDs

setOffline

public LocalizationsResponse setOffline(List<Integer> offline)

Set offline pages

Parameters:

offline - list of page IDs

Returns:

fluent API