com.dotmarketing.portlets.contentlet.model
Class Contentlet

java.lang.Object
  com.dotmarketing.portlets.contentlet.model.Contentlet

All Implemented Interfaces:

Exportable, Importable, Permissionable, Treeable, Versionable, Categorizable, java.io.Serializable

Direct Known Subclasses:

ContentletAndBinary, Event, FileAsset, Host

public class Contentlet
extends java.lang.Object
implements java.io.Serializable, Permissionable, Categorizable, Versionable, Exportable, Importable, Treeable

Author:

Jason Tesser, David Tores

See Also:

Serialized Form

Field Summary

static java.lang.String	ARCHIVED_KEY
static java.lang.String	DISABLED_WYSIWYG_KEY
static java.lang.String	FOLDER_KEY
static java.lang.String	HOST_KEY
static java.lang.String	IDENTIFIER_KEY
static java.lang.String	INODE_KEY
static java.lang.String	LANGUAGEID_KEY
static java.lang.String	LAST_REVIEW_KEY
static java.lang.String	LIVE_KEY
static java.lang.String	LOCKED_KEY
protected java.util.Map<java.lang.String,java.lang.Object>	map
static java.lang.String	MOD_DATE_KEY
static java.lang.String	MOD_USER_KEY
static java.lang.String	NEXT_REVIEW_KEY
static java.lang.String	OWNER_KEY
static java.lang.String	REVIEW_INTERNAL_KEY
static java.lang.String	SORT_ORDER_KEY
static java.lang.String	STRUCTURE_INODE_KEY
static java.lang.String	WORKFLOW_ACTION_KEY
static java.lang.String	WORKFLOW_ASSIGN_KEY
static java.lang.String	WORKFLOW_COMMENTS_KEY
static java.lang.String	WORKFLOW_EXPIRE_DATE
static java.lang.String	WORKFLOW_EXPIRE_TIME
static java.lang.String	WORKFLOW_NEVER_EXPIRE
static java.lang.String	WORKFLOW_PUBLISH_DATE
static java.lang.String	WORKFLOW_PUBLISH_TIME
static java.lang.String	WORKING_KEY

Constructor Summary

Contentlet()
default constructor

Contentlet(java.util.Map<java.lang.String,java.lang.Object> map)

Method Summary

java.util.List<PermissionSummary>	acceptedPermissions() List of permissions it accepts
boolean	equals(Contentlet contentlet)
boolean	equals(java.lang.Object o)
java.lang.Object	get(java.lang.String key) Returns an object from the underlying contentlet Map
java.io.File	getBinary(java.lang.String velocityVarName)
java.io.InputStream	getBinaryStream(java.lang.String velocityVarName)
boolean	getBoolProperty(java.lang.String fieldVarName)
java.lang.String	getCategoryId()
java.util.Date	getDateProperty(java.lang.String fieldVarName)
java.util.List<Exportable>	getDependencies()
java.util.List<java.lang.String>	getDisabledWysiwyg()
float	getFloatProperty(java.lang.String fieldVarName)
java.lang.String	getFolder()
java.lang.String	getHost()
java.lang.String	getIdentifier()
java.lang.String	getInode() gets the inode (specific version id) of the versionable
java.util.Map<java.lang.String,java.lang.Object>	getKeyValueProperty(java.lang.String velocityVarName)
long	getLanguageId()
java.util.Date	getLastReview()
long	getLongProperty(java.lang.String fieldVarName)
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
java.util.Date	getModDate() Returns the modDate.
java.lang.String	getModUser() Returns the modUser.
java.util.Date	getNextReview()
java.lang.String	getOwner() Returns the owner.
Permissionable	getParentPermissionable() Retrieves the parent permissionable in the chain of permissions inheritance
java.lang.String	getPermissionId() Sets the id to be used for checking permissions
java.lang.String	getPermissionType() Returns the permission type which this permissionable can inherit from
java.lang.String	getReviewInterval()
static long	getSerialVersionUID()
long	getSortOrder()
java.lang.String	getStringProperty(java.lang.String fieldVarName)
Structure	getStructure()
java.lang.String	getStructureInode()
java.lang.String	getTitle() returns the title of the specific asset
java.lang.String	getType()
java.lang.String	getVersionId() The VersionId is the identifier of the versionable web asset every version of the particular webasset will share the same versionId/Identifier
java.lang.String	getVersionType() this returns the string "type" (the db table) of the versionable web asset.
int	hashCode()
boolean	isArchived() Returns the deleted.
boolean	isDependenciesMet()
boolean	isLive() Returns the live.
boolean	isLocked() Returns the locked.
boolean	isLowIndexPriority()
boolean	isParentPermissionable() Returns true if other asset could inherit permissions from it
boolean	isWorking() Returns the working.
java.util.List<RelatedPermissionableGroup>	permissionDependencies(int requiredPermission) Based on the given required permission bit, this method should return the list of dependencies that should be check as well on related permissionables before grant the requiredPermission
void	setBinary(java.lang.String velocityVarName, java.io.File newFile)
void	setBoolProperty(java.lang.String fieldVarName, boolean boolValue)
void	setDateProperty(java.lang.String fieldVarName, java.util.Date dateValue)
void	setDisabledWysiwyg(java.util.List<java.lang.String> disabledFields)
void	setFloatProperty(java.lang.String fieldVarName, float floatValue)
void	setFolder(java.lang.String folder)
void	setHost(java.lang.String host)
void	setIdentifier(java.lang.String identifier)
void	setInode(java.lang.String inode)
void	setLanguageId(long languageId)
void	setLastReview(java.util.Date lastReview)
void	setLongProperty(java.lang.String fieldVarName, long longValue)
void	setLowIndexPriority(boolean lowIndexPriority)
void	setModDate(java.util.Date modDate) Sets the modDate.
void	setModUser(java.lang.String modUser) Sets the modUser.
void	setNextReview(java.util.Date nextReview)
void	setOwner(java.lang.String owner) Sets the owner.
void	setProperty(java.lang.String fieldVarName, java.lang.Object objValue)
void	setReviewInterval(java.lang.String reviewInterval)
void	setSortOrder(long sortOrder) Sets the sort_order.
void	setStringProperty(java.lang.String fieldVarName, java.lang.String stringValue)
void	setStructureInode(java.lang.String structureInode)
void	setVersionId(java.lang.String versionId) sets the versionId (identifier) of the asset
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

INODE_KEY

public static final java.lang.String INODE_KEY

See Also:

Constant Field Values

LANGUAGEID_KEY

public static final java.lang.String LANGUAGEID_KEY

See Also:

Constant Field Values

STRUCTURE_INODE_KEY

public static final java.lang.String STRUCTURE_INODE_KEY

See Also:

Constant Field Values

LAST_REVIEW_KEY

public static final java.lang.String LAST_REVIEW_KEY

See Also:

Constant Field Values

NEXT_REVIEW_KEY

public static final java.lang.String NEXT_REVIEW_KEY

See Also:

Constant Field Values

REVIEW_INTERNAL_KEY

public static final java.lang.String REVIEW_INTERNAL_KEY

See Also:

Constant Field Values

DISABLED_WYSIWYG_KEY

public static final java.lang.String DISABLED_WYSIWYG_KEY

See Also:

Constant Field Values

LOCKED_KEY

public static final java.lang.String LOCKED_KEY

See Also:

Constant Field Values

ARCHIVED_KEY

public static final java.lang.String ARCHIVED_KEY

See Also:

Constant Field Values

LIVE_KEY

public static final java.lang.String LIVE_KEY

See Also:

Constant Field Values

WORKING_KEY

public static final java.lang.String WORKING_KEY

See Also:

Constant Field Values

MOD_DATE_KEY

public static final java.lang.String MOD_DATE_KEY

See Also:

Constant Field Values

MOD_USER_KEY

public static final java.lang.String MOD_USER_KEY

See Also:

Constant Field Values

OWNER_KEY

public static final java.lang.String OWNER_KEY

See Also:

Constant Field Values

IDENTIFIER_KEY

public static final java.lang.String IDENTIFIER_KEY

See Also:

Constant Field Values

SORT_ORDER_KEY

public static final java.lang.String SORT_ORDER_KEY

See Also:

Constant Field Values

HOST_KEY

public static final java.lang.String HOST_KEY

See Also:

Constant Field Values

FOLDER_KEY

public static final java.lang.String FOLDER_KEY

See Also:

Constant Field Values

WORKFLOW_ACTION_KEY

public static final java.lang.String WORKFLOW_ACTION_KEY

See Also:

Constant Field Values

WORKFLOW_ASSIGN_KEY

public static final java.lang.String WORKFLOW_ASSIGN_KEY

See Also:

Constant Field Values

WORKFLOW_COMMENTS_KEY

public static final java.lang.String WORKFLOW_COMMENTS_KEY

See Also:

Constant Field Values

WORKFLOW_PUBLISH_DATE

public static final java.lang.String WORKFLOW_PUBLISH_DATE

See Also:

Constant Field Values

WORKFLOW_PUBLISH_TIME

public static final java.lang.String WORKFLOW_PUBLISH_TIME

See Also:

Constant Field Values

WORKFLOW_EXPIRE_DATE

public static final java.lang.String WORKFLOW_EXPIRE_DATE

See Also:

Constant Field Values

WORKFLOW_EXPIRE_TIME

public static final java.lang.String WORKFLOW_EXPIRE_TIME

See Also:

Constant Field Values

WORKFLOW_NEVER_EXPIRE

public static final java.lang.String WORKFLOW_NEVER_EXPIRE

See Also:

Constant Field Values

map

protected java.util.Map<java.lang.String,java.lang.Object> map

Constructor Detail

Contentlet

public Contentlet(java.util.Map<java.lang.String,java.lang.Object> map)

Contentlet

public Contentlet()

default constructor

Method Detail

getCategoryId

public java.lang.String getCategoryId()

Specified by:

getCategoryId in interface Categorizable

getDependencies

public java.util.List<Exportable> getDependencies()

isDependenciesMet

public boolean isDependenciesMet()
                          throws DotDependencyException

Throws:

DotDependencyException

getTitle

public java.lang.String getTitle()

Description copied from interface: Versionable

returns the title of the specific asset

Specified by:

getTitle in interface Versionable

Returns:

getVersionId

public java.lang.String getVersionId()

Description copied from interface: Versionable

The VersionId is the identifier of the versionable web asset every version of the particular webasset will share the same versionId/Identifier

Specified by:

getVersionId in interface Versionable

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

Returns:

setVersionId

public void setVersionId(java.lang.String versionId)

Description copied from interface: Versionable

sets the versionId (identifier) of the asset

Specified by:

setVersionId in interface Versionable

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

Returns:

setInode

public void setInode(java.lang.String inode)

getLanguageId

public long getLanguageId()

setLanguageId

public void setLanguageId(long languageId)

getStructureInode

public java.lang.String getStructureInode()

setStructureInode

public void setStructureInode(java.lang.String structureInode)

getStructure

public Structure getStructure()

getLastReview

public java.util.Date getLastReview()

setLastReview

public void setLastReview(java.util.Date lastReview)

getNextReview

public java.util.Date getNextReview()

setNextReview

public void setNextReview(java.util.Date nextReview)

getReviewInterval

public java.lang.String getReviewInterval()

setReviewInterval

public void setReviewInterval(java.lang.String reviewInterval)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

equals

public boolean equals(Contentlet contentlet)
               throws DotRuntimeException

Throws:

DotRuntimeException

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

getSerialVersionUID

public static long getSerialVersionUID()

getDisabledWysiwyg

public java.util.List<java.lang.String> getDisabledWysiwyg()

setDisabledWysiwyg

public void setDisabledWysiwyg(java.util.List<java.lang.String> disabledFields)

getStringProperty

public java.lang.String getStringProperty(java.lang.String fieldVarName)
                                   throws DotRuntimeException

Throws:

DotRuntimeException

setStringProperty

public void setStringProperty(java.lang.String fieldVarName,
                              java.lang.String stringValue)
                       throws DotRuntimeException

Throws:

DotRuntimeException

setLongProperty

public void setLongProperty(java.lang.String fieldVarName,
                            long longValue)
                     throws DotRuntimeException

Throws:

DotRuntimeException

getLongProperty

public long getLongProperty(java.lang.String fieldVarName)
                     throws DotRuntimeException

Throws:

DotRuntimeException

setBoolProperty

public void setBoolProperty(java.lang.String fieldVarName,
                            boolean boolValue)
                     throws DotRuntimeException

Throws:

DotRuntimeException

getBoolProperty

public boolean getBoolProperty(java.lang.String fieldVarName)
                        throws DotRuntimeException

Throws:

DotRuntimeException

setDateProperty

public void setDateProperty(java.lang.String fieldVarName,
                            java.util.Date dateValue)
                     throws DotRuntimeException

Throws:

DotRuntimeException

getDateProperty

public java.util.Date getDateProperty(java.lang.String fieldVarName)
                               throws DotRuntimeException

Throws:

DotRuntimeException

setFloatProperty

public void setFloatProperty(java.lang.String fieldVarName,
                             float floatValue)
                      throws DotRuntimeException

Throws:

DotRuntimeException

getFloatProperty

public float getFloatProperty(java.lang.String fieldVarName)
                       throws DotRuntimeException

Throws:

DotRuntimeException

setProperty

public void setProperty(java.lang.String fieldVarName,
                        java.lang.Object objValue)
                 throws DotRuntimeException

Throws:

DotRuntimeException

getMap

public java.util.Map<java.lang.String,java.lang.Object> getMap()
                                                        throws DotRuntimeException

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

Throws:

DotRuntimeException

isArchived

public boolean isArchived()
                   throws DotStateException,
                          DotDataException,
                          DotSecurityException

Returns the deleted.

Specified by:

isArchived in interface Versionable

Returns:

boolean

Throws:

DotSecurityException

DotDataException

DotStateException

isLive

public boolean isLive()
               throws DotStateException,
                      DotDataException,
                      DotSecurityException

Returns the live.

Specified by:

isLive in interface Versionable

Returns:

boolean

Throws:

DotSecurityException

DotDataException

DotStateException

isLocked

public boolean isLocked()
                 throws DotStateException,
                        DotDataException,
                        DotSecurityException

Returns the locked.

Specified by:

isLocked in interface Versionable

Returns:

boolean

Throws:

DotSecurityException

DotDataException

DotStateException

getModDate

public java.util.Date getModDate()

Returns the modDate.

Specified by:

getModDate in interface Versionable

Returns:

java.util.Date

getModUser

public java.lang.String getModUser()

Returns the modUser.

Specified by:

getModUser in interface Versionable

Returns:

String

isWorking

public boolean isWorking()
                  throws DotStateException,
                         DotDataException,
                         DotSecurityException

Returns the working.

Specified by:

isWorking in interface Versionable

Returns:

boolean

Throws:

DotSecurityException

DotDataException

DotStateException

setModDate

public void setModDate(java.util.Date modDate)

Sets the modDate.

Parameters:

modDate - The modDate to set

setModUser

public void setModUser(java.lang.String modUser)

Sets the modUser.

Parameters:

modUser - The modUser to set

setOwner

public void setOwner(java.lang.String owner)

Sets the owner.

Specified by:

setOwner in interface Permissionable

Parameters:

owner - The owner to set

getOwner

public java.lang.String getOwner()

Returns the owner.

Specified by:

getOwner in interface Permissionable

Returns:

String owner

getIdentifier

public java.lang.String getIdentifier()

Specified by:

getIdentifier in interface Treeable

Returns:

Returns the identifier.

setIdentifier

public void setIdentifier(java.lang.String identifier)

Parameters:

identifier - The identifier to set.

setSortOrder

public void setSortOrder(long sortOrder)

Sets the sort_order.

Parameters:

sort_order - The sort_order to set

getSortOrder

public long getSortOrder()

getPermissionId

public java.lang.String getPermissionId()

Description copied from interface: Permissionable

Sets the id to be used for checking permissions

Specified by:

getPermissionId in interface Permissionable

Returns:

getHost

public java.lang.String getHost()

setHost

public void setHost(java.lang.String host)

getFolder

public java.lang.String getFolder()

setFolder

public void setFolder(java.lang.String folder)

acceptedPermissions

public java.util.List<PermissionSummary> acceptedPermissions()

List of permissions it accepts

Specified by:

acceptedPermissions in interface Permissionable

Returns:

permissionDependencies

public java.util.List<RelatedPermissionableGroup> permissionDependencies(int requiredPermission)

Description copied from interface: Permissionable

Based on the given required permission bit, this method should return the list of dependencies that should be check as well on related permissionables before grant the requiredPermission

Specified by:

permissionDependencies in interface Permissionable

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

Returns:

Throws:

DotDataException

getPermissionType

public java.lang.String getPermissionType()

Description copied from interface: Permissionable

Returns the permission type which this permissionable can inherit from

Specified by:

getPermissionType in interface Permissionable

Returns:

setBinary

public void setBinary(java.lang.String velocityVarName,
                      java.io.File newFile)
               throws java.io.IOException

Throws:

java.io.IOException

getBinary

public java.io.File getBinary(java.lang.String velocityVarName)
                       throws java.io.IOException

Throws:

java.io.IOException

getBinaryStream

public java.io.InputStream getBinaryStream(java.lang.String velocityVarName)
                                    throws java.io.IOException

Throws:

java.io.IOException

getKeyValueProperty

public java.util.Map<java.lang.String,java.lang.Object> getKeyValueProperty(java.lang.String velocityVarName)

isParentPermissionable

public boolean isParentPermissionable()

Description copied from interface: Permissionable

Returns true if other asset could inherit permissions from it

Specified by:

isParentPermissionable in interface Permissionable

Returns:

get

public java.lang.Object get(java.lang.String key)

Returns an object from the underlying contentlet Map

Parameters:

key -

Returns:

setLowIndexPriority

public void setLowIndexPriority(boolean lowIndexPriority)

Parameters:

lowIndexPriority - the lowIndexPriority to set

isLowIndexPriority

public boolean isLowIndexPriority()

Returns:

the lowIndexPriority

getType

public java.lang.String getType()

Specified by:

getType in interface Treeable