com.dotmarketing.portlets.structure.model
Class Structure

java.lang.Object
  com.dotmarketing.beans.Inode
      com.dotmarketing.portlets.structure.model.Structure

All Implemented Interfaces:

Exportable, Importable, UUIDable, Permissionable, Treeable, Versionable, Categorizable, java.io.Serializable, java.lang.Comparable

public class Structure
extends Inode
implements Permissionable, Exportable, Importable, Treeable

See Also:

Serialized Form

Field Summary

static int	STRUCTURE_TYPE_CONTENT
static int	STRUCTURE_TYPE_FILEASSET
static int	STRUCTURE_TYPE_FORM
static int	STRUCTURE_TYPE_WIDGET

Fields inherited from class com.dotmarketing.beans.Inode

identifier, inode, owner

Constructor Summary

Structure()

Method Summary

java.util.List<PermissionSummary>	acceptedPermissions() List of permissions it accepts
void	delete()
void	delete(boolean recursive)
java.util.List<Exportable>	getDependencies()
java.lang.String	getDescription()
java.lang.String	getDetailPage()
java.lang.String	getExpireDateVar()
Field	getField(java.lang.String fieldName) Deprecated. This is a not recommended way to obtain a field since the field label name can be changed by the user
java.util.List<Field>	getFields() Deprecated. As of version dotCMS 1.2, this will be have private access, replaced by {FieldsCache.getFields(inode)}
java.util.List<Field>	getFieldsBySortOrder()
Field	getFieldVar(java.lang.String velocityVarName) Retrieves a field by the velocity variable name, This should be the preferred method to obtain a field since the velocity variable name of the field never changes after it gets created.
java.lang.String	getFolder()
java.lang.String	getHost()
java.util.Map<java.lang.String,java.lang.Object>	getMap() Returns a hashmap with all the inode fields
java.lang.String	getName()
java.lang.String	getPagedetail()
Permissionable	getParentPermissionable() Retrieves the parent permissionable in the chain of permissions inheritance
java.lang.String	getPublishDateVar()
java.lang.String	getReviewerRole()
java.lang.String	getReviewInterval()
int	getStructureType()
java.lang.String	getUrlMapPattern()
java.lang.String	getVelocityVarName()
boolean	isContent()
boolean	isDefaultStructure()
boolean	isDependenciesMet()
boolean	isFileAsset()
boolean	isFixed()
boolean	isForm()
boolean	isParentPermissionable() Returns true if other asset could inherit permissions from it
boolean	isSystem()
boolean	isWidget()
void	setDefaultStructure(boolean defaultStructure)
void	setDescription(java.lang.String description)
void	setDetailPage(java.lang.String pagedetail)
void	setExpireDateVar(java.lang.String expireDateVar)
void	setFixed(boolean fixed)
void	setFolder(java.lang.String folder)
void	setHost(java.lang.String host)
void	setName(java.lang.String name)
void	setPagedetail(java.lang.String pagedetail)
void	setPublishDateVar(java.lang.String publishDateVar)
void	setReviewerRole(java.lang.String reviewerRole)
void	setReviewInterval(java.lang.String reviewInterval)
void	setStructureType(int structureType)
void	setSystem(boolean system)
void	setUrlMapPattern(java.lang.String urlMapPattern)
void	setVelocityVarName(java.lang.String velocityVarName)
java.lang.String	toString()

Methods inherited from class com.dotmarketing.beans.Inode

addChild, addChild, addChild, addChild, addChild, addParent, addParent, addParent, compareTo, deleteChild, deleteChild, deleteChild, deleteChild, deleteParent, deleteParent, equals, getCategoryId, getiDate, getIDate, getIdentifier, getInode, getModDate, getModUser, getOwner, getPermissionId, getPermissionType, getTitle, getType, getVersionId, getVersionType, hasChildren, hashCode, hasParents, isArchived, isLive, isLocked, isNew, isWorking, permissionDependencies, setiDate, setIDate, setIDate, setIdentifier, setInode, setOwner, setParents, setType, setVersionId

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, permissionDependencies, setOwner

Methods inherited from interface com.dotmarketing.business.Treeable

getIdentifier, getType

Field Detail

STRUCTURE_TYPE_CONTENT

public static final int STRUCTURE_TYPE_CONTENT

See Also:

Constant Field Values

STRUCTURE_TYPE_WIDGET

public static final int STRUCTURE_TYPE_WIDGET

See Also:

Constant Field Values

STRUCTURE_TYPE_FORM

public static final int STRUCTURE_TYPE_FORM

See Also:

Constant Field Values

STRUCTURE_TYPE_FILEASSET

public static final int STRUCTURE_TYPE_FILEASSET

See Also:

Constant Field Values

Constructor Detail

Structure

public Structure()

Method Detail

getDependencies

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

isDependenciesMet

public boolean isDependenciesMet()
                          throws DotDependencyException

Throws:

DotDependencyException

getDetailPage

public java.lang.String getDetailPage()

setDetailPage

public void setDetailPage(java.lang.String pagedetail)

getPagedetail

public java.lang.String getPagedetail()

setPagedetail

public void setPagedetail(java.lang.String pagedetail)

isDefaultStructure

public boolean isDefaultStructure()

setDefaultStructure

public void setDefaultStructure(boolean defaultStructure)

getDescription

public java.lang.String getDescription()

setDescription

public void setDescription(java.lang.String description)

getName

public java.lang.String getName()

setName

public void setName(java.lang.String name)

delete

public void delete()
            throws DotHibernateException,
                   DotDataException

Throws:

DotHibernateException

DotDataException

delete

public void delete(boolean recursive)
            throws DotHibernateException,
                   DotDataException

Throws:

DotHibernateException

DotDataException

getFields

public java.util.List<Field> getFields()

Deprecated. As of version dotCMS 1.2, this will be have private access, replaced by {FieldsCache.getFields(inode)}

getFieldsBySortOrder

public java.util.List<Field> getFieldsBySortOrder()

getReviewerRole

public java.lang.String getReviewerRole()

setReviewerRole

public void setReviewerRole(java.lang.String reviewerRole)

getReviewInterval

public java.lang.String getReviewInterval()

setReviewInterval

public void setReviewInterval(java.lang.String reviewInterval)

getField

public Field getField(java.lang.String fieldName)

Deprecated. This is a not recommended way to obtain a field since the field label name can be changed by the user

Retrieves a structure field based on the field label name This is a not recommended way to obtain a field since the field label name can be changed by the user

Parameters:

fieldName -

Returns:

getFieldVar

public Field getFieldVar(java.lang.String velocityVarName)

Retrieves a field by the velocity variable name, This should be the preferred method to obtain a field since the velocity variable name of the field never changes after it gets created.

Parameters:

velocityVarName -

Returns:

The field or null if the field doesn't exist

isContent

public boolean isContent()

isWidget

public boolean isWidget()

isForm

public boolean isForm()

isFileAsset

public boolean isFileAsset()

isSystem

public boolean isSystem()

setSystem

public void setSystem(boolean system)

isFixed

public boolean isFixed()

setFixed

public void setFixed(boolean fixed)

getStructureType

public int getStructureType()

setStructureType

public void setStructureType(int structureType)

getMap

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

Description copied from class: Inode

Returns a hashmap with all the inode fields

Overrides:

getMap in class Inode

Returns:

the map

acceptedPermissions

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

List of permissions it accepts

Specified by:

acceptedPermissions in interface Permissionable

Overrides:

acceptedPermissions in class Inode

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 Inode

Returns:

Throws:

DotDataException

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

Overrides:

isParentPermissionable in class Inode

Returns:

setVelocityVarName

public void setVelocityVarName(java.lang.String velocityVarName)

getVelocityVarName

public java.lang.String getVelocityVarName()

setUrlMapPattern

public void setUrlMapPattern(java.lang.String urlMapPattern)

getUrlMapPattern

public java.lang.String getUrlMapPattern()

getFolder

public java.lang.String getFolder()

setFolder

public void setFolder(java.lang.String folder)

getHost

public java.lang.String getHost()

setHost

public void setHost(java.lang.String host)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getPublishDateVar

public java.lang.String getPublishDateVar()

setPublishDateVar

public void setPublishDateVar(java.lang.String publishDateVar)

getExpireDateVar

public java.lang.String getExpireDateVar()

setExpireDateVar

public void setExpireDateVar(java.lang.String expireDateVar)