java.lang.Object
- com.priint.pubserver.tagging.TaggingObject
- - com.priint.pubserver.comet.entity.CometEntity
  - - com.priint.pubserver.comet.entity.template.CometTemplate

All Implemented Interfaces:: java.io.Serializable

Direct Known Subclasses:: CometSnippet, CometTableTemplate

@CometTypeConstraints(referenceBinding=TIGHT,
                      dependencies=@CometReferences(references=@CometReference(restriction=TWIN,targetClass=CometTemplateData.class)))
public class CometTemplate
extends CometEntity

Java class for the Template configuration type

.

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`static class`	`CometTemplate.PageBreak`	The Enum PageBreak.
`static class`	`CometTemplate.Position`	The Enum Position.
`static class`	`CometTemplate.Record`	The Class Record.
`static class`	`CometTemplate.Spread`	The Class Spread.
`static class`	`CometTemplate.Visibility`	The Enum Visibility.

Nested classes/interfaces inherited from class com.priint.pubserver.comet.entity.CometEntity
CometEntity.Category

Nested classes/interfaces inherited from class com.priint.pubserver.tagging.TaggingObject
TaggingObject.LinkedSetWrapper<T>

Field Summary
- Fields inherited from class com.priint.pubserver.comet.entity.CometEntity
  id, TAG_DOMAIN_QUALIFIER, TAG_GROUP_QUALIFIER, TAG_TYPE_QUALIFIER
- Fields inherited from class com.priint.pubserver.tagging.TaggingObject
  tagsSet

Constructor Summary

Constructors
Constructor Description

CometTemplate()
Instantiates a new comet template.

CometTemplate(int id)
Instantiates a new comet template.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`checkMinimalConstraints()`	Check minimal constraints.
`static boolean`	`contains(java.util.List<CometTemplate> templates, int id)`	Contains.
`static boolean`	`contains(java.util.List<CometTemplate> templates, CometTemplate search)`	Contains.
`boolean`	`discards(CometTemplate other)`	Discards.
`java.lang.Boolean`	`getActive()`	Gets the active.
`java.lang.Double`	`getBottomPos()`	Gets the bottom pos.
`CometBuildSupportScript`	`getBuildSupportScript()`	Gets the builds the support script.
`java.lang.Integer`	`getBuildSupportScriptId()`	Gets the builds the support script id.
`java.lang.Integer`	`getColorId()`	Gets the color id.
`java.lang.String`	`getDescription()`	Gets the description.
`java.lang.String`	`getEntityId()`	Gets the entity id.
`java.lang.Integer`	`getFormat()`	Gets the format.
`java.lang.Boolean`	`getHasMinSize()`	Gets the checks for min size.
`java.lang.Boolean`	`getHasShapes()`	Gets the checks for shapes.
`java.lang.String`	`getLabel()`	Gets the label.
`java.lang.Double`	`getLeftPos()`	Gets the left pos.
`java.lang.Boolean`	`getMagnets()`	Gets the magnets.
`java.lang.String`	`getMemberships()`	Gets the memberships.
`java.lang.Boolean`	`getMirrored()`	Gets the mirrored.
`CometTemplate.PageBreak`	`getPageBreak()`	Gets the page break.
`static CometTemplate.PageBreak`	`getPageBreakEnum(int externValue)`	Gets the page break enum.
`java.lang.Double`	`getRealHeight()`	Gets the real height.
`java.lang.Double`	`getRealWidth()`	Gets the real width.
`CometTemplate.Record`	`getRecord()`	Gets the record.
`java.lang.String`	`getRepositoryFilename()`	Gets the repository filename.
`java.lang.String`	`getRepositoryPath()`	Gets the repository path.
`java.lang.Double`	`getRightPos()`	Gets the right pos.
`CometTemplate.Spread`	`getSpread()`	Gets the spread.
`java.lang.Integer`	`getStateId()`	Gets the state id.
`java.lang.String`	`getTextflowPrefix1()`	Gets the textflow prefix 1.
`CometTemplateTextPrefixScript`	`getTextflowPrefix1Script()`	Gets the textflow prefix 1 script.
`java.lang.Integer`	`getTextflowPrefix1ScriptId()`	Gets the textflow prefix 1 script id.
`java.lang.String`	`getTextflowPrefixN()`	Gets the textflow prefix N.
`CometTemplateTextPrefixScript`	`getTextflowPrefixNScript()`	Gets the textflow prefix N script.
`java.lang.Integer`	`getTextflowPrefixNScriptId()`	Gets the textflow prefix N script id.
`java.lang.Double`	`getTopPos()`	Gets the top pos.
`static java.util.Collection<CometTemplate>`	`getTopTemplates(java.util.Collection<CometTemplate> in)`	Gets the top templates.
`java.lang.Integer`	`getTypeId()`	Gets the type id.
`CometTemplate.Visibility`	`getVisibility()`	Gets the visibility.
`boolean`	`isTemplateMaster()`	Checks if is template master.
`boolean`	`references(CometTemplate other)`	References.
`void`	`setActive(java.lang.Boolean active)`	Sets the active.
`void`	`setBottomPos(java.lang.Double bottomPos)`	Sets the bottom pos.
`void`	`setBuildSupportScript(CometBuildSupportScript buildSupportScript)`	Sets the builds the support script.
`void`	`setBuildSupportScriptId(java.lang.Integer buildSupportScriptId)`	Sets the builds the support script id.
`void`	`setColorId(java.lang.Integer colorId)`	Sets the color id.
`void`	`setDescription(java.lang.String description)`	Sets the description.
`void`	`setEntityId(java.lang.String entityId)`	Sets the entity id.
`void`	`setFormat(java.lang.Integer format)`	Sets the format.
`void`	`setHasMinSize(java.lang.Boolean hasMinSize)`	Sets the checks for min size.
`void`	`setHasShapes(java.lang.Boolean hasShapes)`	Sets the checks for shapes.
`void`	`setLabel(java.lang.String label)`	Sets the label.
`void`	`setLeftPos(java.lang.Double leftPos)`	Sets the left pos.
`void`	`setMagnets(java.lang.Boolean magnets)`	Sets the magnets.
`void`	`setMemberships(java.lang.String memberships)`	Sets the memberships.
`void`	`setMirrored(java.lang.Boolean mirrored)`	Sets the mirrored.
`void`	`setPageBreak(CometTemplate.PageBreak pageBreak)`	Sets the page break.
`void`	`setRealHeight(java.lang.Double realHeight)`	Sets the real height.
`void`	`setRealWidth(java.lang.Double realWidth)`	Sets the real width.
`void`	`setRecord(CometTemplate.Record record)`	Sets the record.
`void`	`setRightPos(java.lang.Double rightPos)`	Sets the right pos.
`void`	`setSpread(CometTemplate.Spread spread)`	Sets the spread.
`void`	`setStateId(java.lang.Integer stateId)`	Sets the state id.
`void`	`setTextflowPrefix1(java.lang.String textflowPrefix1)`	Sets the textflow prefix 1.
`void`	`setTextflowPrefix1Script(CometTemplateTextPrefixScript textflowPrefix1Script)`	Sets the textflow prefix 1 script.
`void`	`setTextflowPrefix1ScriptId(java.lang.Integer textflowPrefix1ScriptId)`	Sets the textflow prefix 1 script id.
`void`	`setTextflowPrefixN(java.lang.String textflowPrefixN)`	Sets the textflow prefix N.
`void`	`setTextflowPrefixNScript(CometTemplateTextPrefixScript textflowPrefixNScript)`	Sets the textflow prefix N script.
`void`	`setTextflowPrefixNScriptId(java.lang.Integer textflowPrefixNScriptId)`	Sets the textflow prefix N script id.
`void`	`setTopPos(java.lang.Double topPos)`	Sets the top pos.
`void`	`setTypeId(java.lang.Integer typeId)`	Sets the type id.
`void`	`setVisibility(CometTemplate.Visibility visibility)`	Sets the visibility.

Methods inherited from class com.priint.pubserver.comet.entity.CometEntity
entityEquals, equals, getEntityDescription, getEntityLabel, getId, getReferenceConstraints, hashCode, initDefaultValues, initDefaultValues, setId

Methods inherited from class com.priint.pubserver.tagging.TaggingObject
addToTags, getTags, getTagValue, inTags, isA, removeFromTags, searchListByTags, setTags, setTags

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - CometTemplate
```
public CometTemplate()
```
    Instantiates a new comet template.
  - CometTemplate
```
public CometTemplate(int id)
```
    Instantiates a new comet template.
    
    Parameters:
    
    id - the id
- Method Detail
  - getPageBreakEnum
```
public static CometTemplate.PageBreak getPageBreakEnum(int externValue)
```
    Gets the page break enum.
    
    Parameters:
    
    externValue - the extern value
    
    Returns:
    
    the page break enum
  - checkMinimalConstraints
```
public void checkMinimalConstraints()
                             throws CometException
```
    Check minimal constraints.
    
    Overrides:
    
    checkMinimalConstraints in class CometEntity
    
    Throws:
    
    CometException - the comet exception
  - getActive
```
public java.lang.Boolean getActive()
```
    Gets the active.
    
    Returns:
    
    the active
  - getVisibility
```
public CometTemplate.Visibility getVisibility()
```
    Gets the visibility.
    
    Returns:
    
    the visibility
  - getBottomPos
```
public java.lang.Double getBottomPos()
```
    Gets the bottom pos.
    
    Returns:
    
    the bottom pos
  - getBuildSupportScript
```
public CometBuildSupportScript getBuildSupportScript()
```
    Gets the builds the support script.
    
    Returns:
    
    the builds the support script
  - getBuildSupportScriptId
```
public java.lang.Integer getBuildSupportScriptId()
```
    Gets the builds the support script id.
    
    Returns:
    
    the builds the support script id
  - getHasShapes
```
public java.lang.Boolean getHasShapes()
```
    Gets the checks for shapes.
    
    Returns:
    
    the checks for shapes
  - setHasShapes
```
public void setHasShapes(java.lang.Boolean hasShapes)
```
    Sets the checks for shapes.
    
    Parameters:
    
    hasShapes - the new checks for shapes
  - getColorId
```
public java.lang.Integer getColorId()
```
    Gets the color id.
    
    Returns:
    
    the color id
  - getRealWidth
```
public java.lang.Double getRealWidth()
```
    Gets the real width.
    
    Returns:
    
    the real width
  - setRealWidth
```
public void setRealWidth(java.lang.Double realWidth)
```
    Sets the real width.
    
    Parameters:
    
    realWidth - the new real width
  - getRealHeight
```
public java.lang.Double getRealHeight()
```
    Gets the real height.
    
    Returns:
    
    the real height
  - setRealHeight
```
public void setRealHeight(java.lang.Double realHeight)
```
    Sets the real height.
    
    Parameters:
    
    realHeight - the new real height
  - getDescription
```
@CometDescription
public java.lang.String getDescription()
```
    Gets the description.
    
    Returns:
    
    the description
  - getEntityId
```
public java.lang.String getEntityId()
```
    Gets the entity id.
    
    Returns:
    
    the entity id
  - getFormat
```
public java.lang.Integer getFormat()
```
    Gets the format.
    
    Returns:
    
    the format
  - getLabel
```
public java.lang.String getLabel()
```
    Gets the label.
    
    Returns:
    
    the label
  - getLeftPos
```
public java.lang.Double getLeftPos()
```
    Gets the left pos.
    
    Returns:
    
    the left pos
  - getMagnets
```
public java.lang.Boolean getMagnets()
```
    Gets the magnets.
    
    Returns:
    
    the magnets
  - getMemberships
```
public java.lang.String getMemberships()
```
    Gets the memberships.
    
    Returns:
    
    the memberships
  - getMirrored
```
public java.lang.Boolean getMirrored()
```
    Gets the mirrored.
    
    Returns:
    
    the mirrored
  - getRecord
```
public CometTemplate.Record getRecord()
```
    Gets the record.
    
    Returns:
    
    the record
  - getRepositoryFilename
```
public java.lang.String getRepositoryFilename()
                                       throws CometException
```
    Gets the repository filename.
    
    Overrides:
    
    getRepositoryFilename in class CometEntity
    
    Returns:
    
    the repository filename
    
    Throws:
    
    CometException - the comet exception
  - getRepositoryPath
```
public java.lang.String getRepositoryPath()
                                   throws CometException
```
    Gets the repository path.
    
    Overrides:
    
    getRepositoryPath in class CometEntity
    
    Returns:
    
    the repository path
    
    Throws:
    
    CometException - the comet exception
  - getRightPos
```
public java.lang.Double getRightPos()
```
    Gets the right pos.
    
    Returns:
    
    the right pos
  - getSpread
```
public CometTemplate.Spread getSpread()
```
    Gets the spread.
    
    Returns:
    
    the spread
  - getStateId
```
public java.lang.Integer getStateId()
```
    Gets the state id.
    
    Returns:
    
    the state id
  - getTextflowPrefix1
```
public java.lang.String getTextflowPrefix1()
```
    Gets the textflow prefix 1.
    
    Returns:
    
    the textflow prefix 1
  - getTextflowPrefix1Script
```
public CometTemplateTextPrefixScript getTextflowPrefix1Script()
```
    Gets the textflow prefix 1 script.
    
    Returns:
    
    the textflow prefix 1 script
  - getTextflowPrefix1ScriptId
```
public java.lang.Integer getTextflowPrefix1ScriptId()
```
    Gets the textflow prefix 1 script id.
    
    Returns:
    
    the textflow prefix 1 script id
  - getTextflowPrefixN
```
public java.lang.String getTextflowPrefixN()
```
    Gets the textflow prefix N.
    
    Returns:
    
    the textflow prefix N
  - getTextflowPrefixNScript
```
public CometTemplateTextPrefixScript getTextflowPrefixNScript()
```
    Gets the textflow prefix N script.
    
    Returns:
    
    the textflow prefix N script
  - getTextflowPrefixNScriptId
```
public java.lang.Integer getTextflowPrefixNScriptId()
```
    Gets the textflow prefix N script id.
    
    Returns:
    
    the textflow prefix N script id
  - getTopPos
```
public java.lang.Double getTopPos()
```
    Gets the top pos.
    
    Returns:
    
    the top pos
  - getTypeId
```
public java.lang.Integer getTypeId()
```
    Gets the type id.
    
    Returns:
    
    the type id
  - setActive
```
public void setActive(java.lang.Boolean active)
```
    Sets the active.
    
    Parameters:
    
    active - the new active
  - setVisibility
```
public void setVisibility(CometTemplate.Visibility visibility)
```
    Sets the visibility.
    
    Parameters:
    
    visibility - the new visibility
  - setBottomPos
```
public void setBottomPos(java.lang.Double bottomPos)
```
    Sets the bottom pos.
    
    Parameters:
    
    bottomPos - the new bottom pos
  - setBuildSupportScript
```
public void setBuildSupportScript(CometBuildSupportScript buildSupportScript)
```
    Sets the builds the support script.
    
    Parameters:
    
    buildSupportScript - the new builds the support script
  - setBuildSupportScriptId
```
public void setBuildSupportScriptId(java.lang.Integer buildSupportScriptId)
```
    Sets the builds the support script id.
    
    Parameters:
    
    buildSupportScriptId - the new builds the support script id
  - setColorId
```
public void setColorId(java.lang.Integer colorId)
```
    Sets the color id.
    
    Parameters:
    
    colorId - the new color id
  - setDescription
```
public void setDescription(java.lang.String description)
```
    Sets the description.
    
    Parameters:
    
    description - the new description
  - setEntityId
```
public void setEntityId(java.lang.String entityId)
```
    Sets the entity id.
    
    Parameters:
    
    entityId - the new entity id
  - setFormat
```
public void setFormat(java.lang.Integer format)
```
    Sets the format.
    
    Parameters:
    
    format - the new format
  - setLabel
```
public void setLabel(java.lang.String label)
```
    Sets the label.
    
    Parameters:
    
    label - the new label
  - setLeftPos
```
public void setLeftPos(java.lang.Double leftPos)
```
    Sets the left pos.
    
    Parameters:
    
    leftPos - the new left pos
  - setMagnets
```
public void setMagnets(java.lang.Boolean magnets)
```
    Sets the magnets.
    
    Parameters:
    
    magnets - the new magnets
  - setMemberships
```
public void setMemberships(java.lang.String memberships)
```
    Sets the memberships.
    
    Parameters:
    
    memberships - the new memberships
  - setMirrored
```
public void setMirrored(java.lang.Boolean mirrored)
```
    Sets the mirrored.
    
    Parameters:
    
    mirrored - the new mirrored
  - setRecord
```
public void setRecord(CometTemplate.Record record)
```
    Sets the record.
    
    Parameters:
    
    record - the new record
  - setRightPos
```
public void setRightPos(java.lang.Double rightPos)
```
    Sets the right pos.
    
    Parameters:
    
    rightPos - the new right pos
  - setSpread
```
public void setSpread(CometTemplate.Spread spread)
```
    Sets the spread.
    
    Parameters:
    
    spread - the new spread
  - setStateId
```
public void setStateId(java.lang.Integer stateId)
```
    Sets the state id.
    
    Parameters:
    
    stateId - the new state id
  - setTextflowPrefix1
```
public void setTextflowPrefix1(java.lang.String textflowPrefix1)
```
    Sets the textflow prefix 1.
    
    Parameters:
    
    textflowPrefix1 - the new textflow prefix 1
  - setTextflowPrefix1Script
```
public void setTextflowPrefix1Script(CometTemplateTextPrefixScript textflowPrefix1Script)
```
    Sets the textflow prefix 1 script.
    
    Parameters:
    
    textflowPrefix1Script - the new textflow prefix 1 script
  - setTextflowPrefix1ScriptId
```
public void setTextflowPrefix1ScriptId(java.lang.Integer textflowPrefix1ScriptId)
```
    Sets the textflow prefix 1 script id.
    
    Parameters:
    
    textflowPrefix1ScriptId - the new textflow prefix 1 script id
  - setTextflowPrefixN
```
public void setTextflowPrefixN(java.lang.String textflowPrefixN)
```
    Sets the textflow prefix N.
    
    Parameters:
    
    textflowPrefixN - the new textflow prefix N
  - setTextflowPrefixNScript
```
public void setTextflowPrefixNScript(CometTemplateTextPrefixScript textflowPrefixNScript)
```
    Sets the textflow prefix N script.
    
    Parameters:
    
    textflowPrefixNScript - the new textflow prefix N script
  - setTextflowPrefixNScriptId
```
public void setTextflowPrefixNScriptId(java.lang.Integer textflowPrefixNScriptId)
```
    Sets the textflow prefix N script id.
    
    Parameters:
    
    textflowPrefixNScriptId - the new textflow prefix N script id
  - setTopPos
```
public void setTopPos(java.lang.Double topPos)
```
    Sets the top pos.
    
    Parameters:
    
    topPos - the new top pos
  - setTypeId
```
public void setTypeId(java.lang.Integer typeId)
```
    Sets the type id.
    
    Parameters:
    
    typeId - the new type id
  - getPageBreak
```
public CometTemplate.PageBreak getPageBreak()
```
    Gets the page break.
    
    Returns:
    
    the page break
  - setPageBreak
```
public void setPageBreak(CometTemplate.PageBreak pageBreak)
```
    Sets the page break.
    
    Parameters:
    
    pageBreak - the new page break
  - isTemplateMaster
```
public boolean isTemplateMaster()
```
    Checks if is template master.
    
    Returns:
    
    true, if is template master
  - references
```
public final boolean references(CometTemplate other)
```
    References.
    
    Parameters:
    
    other - the other
    
    Returns:
    
    true, if successful
  - discards
```
public final boolean discards(CometTemplate other)
```
    Discards.
    
    Parameters:
    
    other - the other
    
    Returns:
    
    true, if successful
  - getTopTemplates
```
public static final java.util.Collection<CometTemplate> getTopTemplates(java.util.Collection<CometTemplate> in)
```
    Gets the top templates.
    
    Parameters:
    
    in - the in
    
    Returns:
    
    the top templates
  - contains
```
public static final boolean contains(java.util.List<CometTemplate> templates,
                                     int id)
```
    Contains.
    
    Parameters:
    
    templates - the templates
    
    id - the id
    
    Returns:
    
    true, if successful
  - contains
```
public static final boolean contains(java.util.List<CometTemplate> templates,
                                     CometTemplate search)
```
    Contains.
    
    Parameters:
    
    templates - the templates
    
    search - the search
    
    Returns:
    
    true, if successful
  - getHasMinSize
```
public java.lang.Boolean getHasMinSize()
```
    Gets the checks for min size.
    
    Returns:
    
    the checks for min size
  - setHasMinSize
```
public void setHasMinSize(java.lang.Boolean hasMinSize)
```
    Sets the checks for min size.
    
    Parameters:
    
    hasMinSize - the new checks for min size

Constructor	Description
`CometTemplate()`	Instantiates a new comet template.
`CometTemplate(int id)`	Instantiates a new comet template.

Class CometTemplate

Nested Class Summary

Nested classes/interfaces inherited from class com.priint.pubserver.comet.entity.CometEntity

Nested classes/interfaces inherited from class com.priint.pubserver.tagging.TaggingObject

Field Summary

Fields inherited from class com.priint.pubserver.comet.entity.CometEntity

Fields inherited from class com.priint.pubserver.tagging.TaggingObject

Constructor Summary

Method Summary

Methods inherited from class com.priint.pubserver.comet.entity.CometEntity

Methods inherited from class com.priint.pubserver.tagging.TaggingObject

Methods inherited from class java.lang.Object

Constructor Detail

CometTemplate

CometTemplate

Method Detail

getPageBreakEnum

checkMinimalConstraints

getActive

getVisibility

getBottomPos

getBuildSupportScript

getBuildSupportScriptId

getHasShapes

setHasShapes

getColorId

getRealWidth

setRealWidth

getRealHeight

setRealHeight

getDescription

getEntityId

getFormat

getLabel

getLeftPos

getMagnets

getMemberships

getMirrored

getRecord

getRepositoryFilename

getRepositoryPath

getRightPos

getSpread

getStateId

getTextflowPrefix1

getTextflowPrefix1Script

getTextflowPrefix1ScriptId

getTextflowPrefixN

getTextflowPrefixNScript

getTextflowPrefixNScriptId

getTopPos

getTypeId

setActive

setVisibility

setBottomPos

setBuildSupportScript

setBuildSupportScriptId

setColorId

setDescription

setEntityId

setFormat

setLabel

setLeftPos

setMagnets

setMemberships

setMirrored

setRecord

setRightPos

setSpread

setStateId

setTextflowPrefix1

setTextflowPrefix1Script

setTextflowPrefix1ScriptId

setTextflowPrefixN

setTextflowPrefixNScript

setTextflowPrefixNScriptId

setTopPos

setTypeId

getPageBreak

setPageBreak