com.gentics.contentnode.rest.model
Class File

java.lang.Object
  extended by com.gentics.contentnode.rest.model.ContentNodeItem
      extended by com.gentics.contentnode.rest.model.File
All Implemented Interfaces:
java.io.Serializable
Direct Known Subclasses:
Image

public class File
extends ContentNodeItem
implements java.io.Serializable

File object, represents a File 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
 
Field Summary
protected  boolean broken
          True if the file is broken
protected  java.lang.Object channelId
           
protected  java.lang.String description
          Description of the file
protected  java.lang.Integer fileSize
          Filesize of the file
protected  java.lang.String fileType
          Mimetype of the File
protected  java.lang.Integer folderId
          Id of the folder of the file
protected  java.lang.String folderName
          the folder name
protected  java.lang.Boolean forceOnline
          True if the file shall be force to go online, even if nothing depends on it
protected  boolean inherited
          true when the file is inherited from a master channel, false if not
protected  boolean online
          True if the file is online (for the node it was fetched for)
protected  java.util.Map<java.lang.String,Tag> tags
          Tags in the file (objecttags)
protected  java.lang.String url
          URL to the file.
 
Constructor Summary
File()
          Constructor used by JAXB
 
Method Summary
 java.lang.Object getChannelId()
          Channel ID
 java.lang.String getCls()
          This is a file cls
 java.lang.String getDescription()
          Description
 java.lang.Integer getFileSize()
          File size
 java.lang.String getFileType()
          File type
 java.lang.Integer getFolderId()
          Folder ID
 java.lang.String getFolderName()
          Name of the folder of this file
 java.lang.String getIconCls()
          Define attribute to select the appropriate class
 java.lang.String getInheritedFrom()
          Name of the node, this file was inherited from
 boolean getLeaf()
          This is a file so leaf is true
 java.lang.String getLiveUrl()
          Live URL to the page
 java.lang.String getMasterNode()
          Name of the node, the master object belongs to
 java.lang.String getPath()
          Folder path of this file
 java.util.Map<java.lang.String,Tag> getTags()
          Map of object tags of this file
 java.lang.String getText()
          Name of the file
 java.lang.Integer getTypeId()
          Type ID
 java.lang.String getUrl()
          URL to the file
 boolean isBroken()
          True for broken files
 java.lang.Boolean isForceOnline()
          Get the force online status (may be null if status is not determined)
 boolean isInherited()
           
 boolean isOnline()
          True if the file is online, false if it is offline
 void setBroken(boolean broken)
          Set the broken status
 void setChannelId(java.lang.Object channelId)
           
 void setCls(java.lang.String cls)
           
 void setDescription(java.lang.String description)
           
 void setFileSize(java.lang.Integer fileSize)
           
 void setFileType(java.lang.String fileType)
           
 void setFolderId(java.lang.Integer folderId)
           
 void setFolderName(java.lang.String folderName)
           
 void setForceOnline(boolean forceOnline)
          Set the force online status
 void setIconCls(java.lang.String iconCls)
           
 void setInherited(boolean inherited)
           
 void setInheritedFrom(java.lang.String inheritedFrom)
          sets inherited from
 void setLeaf(boolean leaf)
           
 void setLiveUrl(java.lang.String liveUrl)
          Set the live URL of the page
 void setMasterNode(java.lang.String masterNode)
          Set the name of the node, the master object belongs to
 void setOnline(boolean online)
          Set the online status
 void setPath(java.lang.String path)
          Set the path
 void setTags(java.util.Map<java.lang.String,Tag> tags)
           
 void setText(java.lang.String text)
           
 void setTypeId(java.lang.Integer typeId)
           
 void setUrl(java.lang.String url)
           
 
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
 

Field Detail

fileType

protected java.lang.String fileType
Mimetype of the File


description

protected java.lang.String description
Description of the file


folderId

protected java.lang.Integer folderId
Id of the folder of the file


folderName

protected java.lang.String folderName
the folder name


fileSize

protected java.lang.Integer fileSize
Filesize of the file


channelId

protected java.lang.Object channelId

inherited

protected boolean inherited
true when the file is inherited from a master channel, false if not


tags

protected java.util.Map<java.lang.String,Tag> tags
Tags in the file (objecttags)


url

protected java.lang.String url
URL to the file.


forceOnline

protected java.lang.Boolean forceOnline
True if the file shall be force to go online, even if nothing depends on it


online

protected boolean online
True if the file is online (for the node it was fetched for)


broken

protected boolean broken
True if the file is broken

Constructor Detail

File

public File()
Constructor used by JAXB

Method Detail

getTypeId

public java.lang.Integer getTypeId()
Type ID

Returns:
the typeId

setTypeId

public void setTypeId(java.lang.Integer typeId)

getInheritedFrom

public java.lang.String getInheritedFrom()
Name of the node, this file was 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

getFolderName

public java.lang.String getFolderName()
Name of the folder of this file

Returns:

setFolderName

public void setFolderName(java.lang.String folderName)

getChannelId

public java.lang.Object getChannelId()
Channel ID

Returns:

setChannelId

public void setChannelId(java.lang.Object channelId)

getText

public java.lang.String getText()
Name of the file

Returns:

setText

public void setText(java.lang.String text)

getLeaf

public boolean getLeaf()
This is a file so leaf is true

Returns:

setLeaf

public void setLeaf(boolean leaf)

getCls

public java.lang.String getCls()
This is a file cls


setCls

public void setCls(java.lang.String cls)

getIconCls

public java.lang.String getIconCls()
Define attribute to select the appropriate class

Returns:

setIconCls

public void setIconCls(java.lang.String iconCls)

getFileType

public java.lang.String getFileType()
File type

Returns:
the fileType

getDescription

public java.lang.String getDescription()
Description

Returns:
the description

getFolderId

public java.lang.Integer getFolderId()
Folder ID

Returns:
the folderId

getFileSize

public java.lang.Integer getFileSize()
File size

Returns:
the fileSize

getTags

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

Returns:

getUrl

public java.lang.String getUrl()
URL to the file

Returns:
the url to the file

setLiveUrl

public void setLiveUrl(java.lang.String liveUrl)
Set the live URL of the page


getLiveUrl

public java.lang.String getLiveUrl()
Live URL to the page

Returns:

setFileType

public void setFileType(java.lang.String fileType)
Parameters:
fileType - the fileType to set

setDescription

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

setFolderId

public void setFolderId(java.lang.Integer folderId)
Parameters:
folderId - the folderId to set

setFileSize

public void setFileSize(java.lang.Integer fileSize)
Parameters:
fileSize - the fileSize to set

setTags

public void setTags(java.util.Map<java.lang.String,Tag> tags)

setUrl

public void setUrl(java.lang.String url)
Parameters:
url - the url to the file.

isInherited

public boolean isInherited()

setInherited

public void setInherited(boolean inherited)

getPath

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

Returns:
path

setPath

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

Parameters:
path - the path

isForceOnline

public java.lang.Boolean isForceOnline()
Get the force online status (may be null if status is not determined)

Returns:
true to force the file online

setForceOnline

public void setForceOnline(boolean forceOnline)
Set the force online status

Parameters:
forceOnline - new force online status

isOnline

public boolean isOnline()
True if the file is online, false if it is offline

Returns:
online status

setOnline

public void setOnline(boolean online)
Set the online status

Parameters:
online - online status

isBroken

public boolean isBroken()
True for broken files

Returns:
true for broken

setBroken

public void setBroken(boolean broken)
Set the broken status

Parameters:
broken - true for broken


Copyright © 2015 Gentics Software GmbH. All Rights Reserved.