com.dotmarketing.beans
Class Host

java.lang.Object
  extended by com.dotmarketing.portlets.contentlet.model.Contentlet
      extended by com.dotmarketing.beans.Host
All Implemented Interfaces:
Exportable, Importable, Permissionable, Treeable, Versionable, Categorizable, java.io.Serializable
Direct Known Subclasses:
HostWrapper

public class Host
extends Contentlet
implements Permissionable

This is just a wrapper class over a contentlet, it just offers nice methods to access host content specific fields like the host name but it underneath is just a piece of content

Author:
David H Torres
See Also:
Serialized Form

Field Summary
static java.lang.String ALIASES_KEY
           
static java.lang.String HOST_NAME_KEY
           
static java.lang.String HOST_THUMB_KEY
           
static java.lang.String IS_DEFAULT_KEY
           
static java.lang.String SYSTEM_HOST
           
static java.lang.String SYSTEM_HOST_KEY
           
static java.lang.String TAG_STORAGE
           
 
Fields inherited from class com.dotmarketing.portlets.contentlet.model.Contentlet
ARCHIVED_KEY, DISABLED_WYSIWYG_KEY, FOLDER_KEY, HOST_KEY, IDENTIFIER_KEY, INODE_KEY, LANGUAGEID_KEY, LAST_REVIEW_KEY, LIVE_KEY, LOCKED_KEY, map, MOD_DATE_KEY, MOD_USER_KEY, NEXT_REVIEW_KEY, OWNER_KEY, REVIEW_INTERNAL_KEY, SORT_ORDER_KEY, STRUCTURE_INODE_KEY, WORKFLOW_ACTION_KEY, WORKFLOW_ASSIGN_KEY, WORKFLOW_COMMENTS_KEY, WORKFLOW_EXPIRE_DATE, WORKFLOW_EXPIRE_TIME, WORKFLOW_NEVER_EXPIRE, WORKFLOW_PUBLISH_DATE, WORKFLOW_PUBLISH_TIME, WORKING_KEY
 
Constructor Summary
Host()
           
Host(Contentlet c)
           
 
Method Summary
 java.util.List<PermissionSummary> acceptedPermissions()
          List of permissions it accepts
 java.lang.String getAliases()
           
 java.lang.String getHostname()
           
 java.lang.String getHostThumbnail()
           
 java.lang.String getInode()
          gets the inode (specific version id) of the versionable
 java.util.Map<java.lang.String,java.lang.Object> getMap()
          Returns a map of the contentlet properties based on the fields of the structure The keys used in the map will be the velocity variables names
 Permissionable getParentPermissionable()
          Retrieves the parent permissionable in the chain of permissions inheritance
 java.lang.String getStructureInode()
           
 java.lang.String getTagStorage()
           
 java.lang.String getVersionType()
          this returns the string "type" (the db table) of the versionable web asset.
 boolean isDefault()
           
 boolean isSystemHost()
           
 void setAliases(java.lang.String aliases)
           
 void setDefault(boolean isDefault)
           
 void setHostname(java.lang.String hostname)
           
 void setHostThumbnail(java.lang.String thumbnailInode)
           
 void setStructureInode(java.lang.String structureInode)
           
 void setSystemHost(boolean isSystemHost)
           
 void setTagStorage(java.lang.String tagStorageId)
           
 
Methods inherited from class com.dotmarketing.portlets.contentlet.model.Contentlet
equals, equals, get, getBinary, getBinaryStream, getBoolProperty, getCategoryId, getDateProperty, getDependencies, getDisabledWysiwyg, getFloatProperty, getFolder, getHost, getIdentifier, getKeyValueProperty, getLanguageId, getLastReview, getLongProperty, getModDate, getModUser, getNextReview, getOwner, getPermissionId, getPermissionType, getReviewInterval, getSerialVersionUID, getSortOrder, getStringProperty, getStructure, getTitle, getType, getVersionId, hashCode, isArchived, isDependenciesMet, isLive, isLocked, isLowIndexPriority, isParentPermissionable, isWorking, permissionDependencies, setBinary, setBoolProperty, setDateProperty, setDisabledWysiwyg, setFloatProperty, setFolder, setHost, setIdentifier, setInode, setLanguageId, setLastReview, setLongProperty, setLowIndexPriority, setModDate, setModUser, setNextReview, setOwner, setProperty, setReviewInterval, setSortOrder, setStringProperty, setVersionId, toString
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface com.dotmarketing.business.Permissionable
getOwner, getPermissionId, getPermissionType, isParentPermissionable, permissionDependencies, setOwner
 

Field Detail

HOST_NAME_KEY

public static final java.lang.String HOST_NAME_KEY
See Also:
Constant Field Values

IS_DEFAULT_KEY

public static final java.lang.String IS_DEFAULT_KEY
See Also:
Constant Field Values

ALIASES_KEY

public static final java.lang.String ALIASES_KEY
See Also:
Constant Field Values

SYSTEM_HOST_KEY

public static final java.lang.String SYSTEM_HOST_KEY
See Also:
Constant Field Values

HOST_THUMB_KEY

public static final java.lang.String HOST_THUMB_KEY
See Also:
Constant Field Values

SYSTEM_HOST

public static final java.lang.String SYSTEM_HOST
See Also:
Constant Field Values

TAG_STORAGE

public static final java.lang.String TAG_STORAGE
See Also:
Constant Field Values
Constructor Detail

Host

public Host()

Host

public Host(Contentlet c)
Method Detail

getInode

public java.lang.String getInode()
Description copied from interface: Versionable
gets the inode (specific version id) of the versionable

Specified by:
getInode in interface Versionable
Overrides:
getInode in class Contentlet
Returns:

getVersionType

public java.lang.String getVersionType()
Description copied from interface: Versionable
this returns the string "type" (the db table) of the versionable web asset. Contentlet will return 'Contentlet' Folder will return folder HTMLPage will return htmlpage Template will return template File will return file_asset Link will return links Container will return containers

Specified by:
getVersionType in interface Versionable
Overrides:
getVersionType in class Contentlet
Returns:

getAliases

public java.lang.String getAliases()

setAliases

public void setAliases(java.lang.String aliases)

getHostname

public java.lang.String getHostname()

setHostname

public void setHostname(java.lang.String hostname)

getHostThumbnail

public java.lang.String getHostThumbnail()

setHostThumbnail

public void setHostThumbnail(java.lang.String thumbnailInode)

isDefault

public boolean isDefault()

setDefault

public void setDefault(boolean isDefault)

getStructureInode

public java.lang.String getStructureInode()
Overrides:
getStructureInode in class Contentlet

isSystemHost

public boolean isSystemHost()

setSystemHost

public void setSystemHost(boolean isSystemHost)

setStructureInode

public void setStructureInode(java.lang.String structureInode)
Overrides:
setStructureInode in class Contentlet

getMap

public java.util.Map<java.lang.String,java.lang.Object> getMap()
Description copied from class: Contentlet
Returns a map of the contentlet properties based on the fields of the structure The keys used in the map will be the velocity variables names

Overrides:
getMap in class Contentlet

acceptedPermissions

public java.util.List<PermissionSummary> acceptedPermissions()
Description copied from class: Contentlet
List of permissions it accepts

Specified by:
acceptedPermissions in interface Permissionable
Overrides:
acceptedPermissions in class Contentlet
Returns:

getParentPermissionable

public Permissionable getParentPermissionable()
                                       throws DotDataException
Description copied from interface: Permissionable
Retrieves the parent permissionable in the chain of permissions inheritance

Specified by:
getParentPermissionable in interface Permissionable
Overrides:
getParentPermissionable in class Contentlet
Returns:
Throws:
DotDataException

getTagStorage

public java.lang.String getTagStorage()

setTagStorage

public void setTagStorage(java.lang.String tagStorageId)


Copyright © 2013 dotCMS Inc. All Rights Reserved.