com.gentics.contentnode.rest.model
Class Folder

java.lang.Object
  extended by com.gentics.contentnode.rest.model.ContentNodeItem
      extended by com.gentics.contentnode.rest.model.Folder
All Implemented Interfaces:
java.io.Serializable

public class Folder
extends ContentNodeItem
implements java.io.Serializable

Folder object, representing a Folder in GCN

Author:
norbert
See Also:
Serialized Form

Nested Class Summary
 
Nested classes/interfaces inherited from class com.gentics.contentnode.rest.model.ContentNodeItem
ContentNodeItem.ItemType
 
Constructor Summary
Folder()
          Constructor used by JAXB
 
Method Summary
 java.lang.String getAtposidx()
          Position of the folder in the folder tree
 java.lang.Integer getChannelId()
          Channel ID.
 java.lang.Integer getChannelsetId()
          Channelset ID.
 java.lang.String getDescription()
          Description
 java.lang.String getInheritedFrom()
          Name of the node this folder is inherited from
 java.lang.Boolean getIsMaster()
          True if the folder is a master, false otherwise.
 java.lang.Integer getMasterId()
          Master ID.
 java.lang.String getMasterNode()
          Name of the node, the master object belongs to
 java.lang.Integer getMotherId()
          Mother id of the folder
 java.lang.Integer getNodeId()
          Node id
 java.lang.String getPath()
          Folder path of this folder
 java.lang.String getPrivilegeBits()
          Privilege bits
 java.util.List<Privilege> getPrivileges()
          Folder privileges
 java.lang.String getPublishDir()
          Publish directory of the folder
 java.lang.Object getStartPageId()
          ID of the startpage
 java.util.List<Folder> getSubfolders()
          List of subfolders
 java.util.Map<java.lang.String,Tag> getTags()
          Map of object tags of the folder
 boolean isHasSubfolders()
          True if the folder has subfolders (regardless of whether they have been fetched), false if not
 boolean isInherited()
          True if the folder is inherited, false if not
 void setAtposidx(java.lang.String atposidx)
          Set the position of the folder in the folder tree
 void setChannelId(java.lang.Integer channelId)
          Sets the Channel ID
 void setChannelsetId(java.lang.Integer channelsetId)
          Sets the Chnanelset ID
 void setDescription(java.lang.String description)
           
 void setHasSubfolders(boolean hasSubfolders)
          Set whether the folder has subfolders
 void setInherited(boolean inherited)
          Set whether the folder is inherited
 void setInheritedFrom(java.lang.String inheritedFrom)
          sets inherited from
 void setIsMaster(java.lang.Boolean isMaster)
          Sets is_master
 void setMasterId(java.lang.Integer masterId)
          Sets the Master ID
 void setMasterNode(java.lang.String masterNode)
          Set the name of the node, the master object belongs to
 void setMotherId(java.lang.Integer motherId)
           
 void setNodeId(java.lang.Integer nodeId)
          Set the node id
 void setPath(java.lang.String path)
          Set the path
 void setPrivilegeBits(java.lang.String privilegeBits)
          Set the privilege bits
 void setPrivileges(java.util.List<Privilege> privileges)
          Set the folder privileges
 void setPublishDir(java.lang.String publishDir)
           
 void setStartPageId(java.lang.Object startPageId)
          set startpage id
 void setSubfolders(java.util.List<Folder> subfolders)
           
 void setTags(java.util.Map<java.lang.String,Tag> tags)
           
 
Methods inherited from class com.gentics.contentnode.rest.model.ContentNodeItem
getCdate, getCreator, getEdate, getEditor, getId, getName, getType, setCdate, setCreator, setEdate, setEditor, setId, setName, setType
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

Folder

public Folder()
Constructor used by JAXB

Method Detail

getInheritedFrom

public java.lang.String getInheritedFrom()
Name of the node this folder is inherited from

Returns:

setInheritedFrom

public void setInheritedFrom(java.lang.String inheritedFrom)
sets inherited from

Parameters:
inheritedFrom -

getMasterNode

public java.lang.String getMasterNode()
Name of the node, the master object belongs to

Returns:
node name

setMasterNode

public void setMasterNode(java.lang.String masterNode)
Set the name of the node, the master object belongs to

Parameters:
masterNode - node name

getMotherId

public java.lang.Integer getMotherId()
Mother id of the folder

Returns:
the motherId

getPublishDir

public java.lang.String getPublishDir()
Publish directory of the folder

Returns:
the publishDir

getDescription

public java.lang.String getDescription()
Description

Returns:
the description

getNodeId

public java.lang.Integer getNodeId()
Node id

Returns:
node id

isInherited

public boolean isInherited()
True if the folder is inherited, false if not

Returns:
true if the folder is inherited, false if not

getAtposidx

public java.lang.String getAtposidx()
Position of the folder in the folder tree

Returns:
position of the folder in the folder tree

setMotherId

public void setMotherId(java.lang.Integer motherId)
Parameters:
motherId - the motherId to set

setPublishDir

public void setPublishDir(java.lang.String publishDir)
Parameters:
publishDir - the pubDir to set

setDescription

public void setDescription(java.lang.String description)
Parameters:
description - the description to set

getStartPageId

public java.lang.Object getStartPageId()
ID of the startpage

Returns:
startpage id

setStartPageId

public void setStartPageId(java.lang.Object startPageId)
set startpage id

Parameters:
startPageId -

getTags

public java.util.Map<java.lang.String,Tag> getTags()
Map of object tags of the folder

Returns:
the tags

setTags

public void setTags(java.util.Map<java.lang.String,Tag> tags)
Parameters:
tags - the tags to set

getSubfolders

public java.util.List<Folder> getSubfolders()
List of subfolders

Returns:
the subfolders

isHasSubfolders

public boolean isHasSubfolders()
True if the folder has subfolders (regardless of whether they have been fetched), false if not

Returns:
true for folders having subfolders

setSubfolders

public void setSubfolders(java.util.List<Folder> subfolders)
Parameters:
subfolders - the subfolders to set

setHasSubfolders

public void setHasSubfolders(boolean hasSubfolders)
Set whether the folder has subfolders

Parameters:
hasSubfolders - true if the folder has subfolders, false if not

setNodeId

public void setNodeId(java.lang.Integer nodeId)
Set the node id

Parameters:
nodeId - node id

setInherited

public void setInherited(boolean inherited)
Set whether the folder is inherited

Parameters:
inherited - true if the folder is inherited, false if not

getPrivileges

public java.util.List<Privilege> getPrivileges()
Folder privileges

Returns:
the folder privileges

setPrivileges

public void setPrivileges(java.util.List<Privilege> privileges)
Set the folder privileges

Parameters:
privileges - Folder privileges

getPrivilegeBits

public java.lang.String getPrivilegeBits()
Privilege bits

Returns:
privilege bits

setPrivilegeBits

public void setPrivilegeBits(java.lang.String privilegeBits)
Set the privilege bits

Parameters:
privilegeBits -

setAtposidx

public void setAtposidx(java.lang.String atposidx)
Set the position of the folder in the folder tree

Parameters:
atposidx - position of the folder in the folder tree

getPath

public java.lang.String getPath()
Folder path of this folder

Returns:
path

setPath

public void setPath(java.lang.String path)
Set the path

Parameters:
path - the path

getMasterId

public java.lang.Integer getMasterId()
Master ID. The master is the next folder up in the channel hierarchy with the same Channelset ID. The Master ID is 0 if there is no master. Read only.

Returns:
Master ID

setMasterId

public void setMasterId(java.lang.Integer masterId)
Sets the Master ID

Parameters:
masterId - Master ID

getChannelsetId

public java.lang.Integer getChannelsetId()
Channelset ID. All copies of the same folder in different channels share the same Channelset ID. Read only.

Returns:
Channelset ID

setChannelsetId

public void setChannelsetId(java.lang.Integer channelsetId)
Sets the Chnanelset ID

Parameters:
channelsetId - Channelset ID

getChannelId

public java.lang.Integer getChannelId()
Channel ID. It identifies different versions of the same folder in different channels. Equals to the node id for which the folder is defined, or to 0 if it is defined in the topost node of the channel hierarchy. Read only.

Returns:
Channel ID

setChannelId

public void setChannelId(java.lang.Integer channelId)
Sets the Channel ID

Parameters:
channelId - Channel ID

getIsMaster

public java.lang.Boolean getIsMaster()
True if the folder is a master, false otherwise. A folder is a master if it isn't a localized copy of another folder. Read only.

Returns:
is_master

setIsMaster

public void setIsMaster(java.lang.Boolean isMaster)
Sets is_master

Parameters:
isMaster - is_master


Copyright © 2015 Gentics Software GmbH. All Rights Reserved.