com.jamasoftware.contour.domain
Class DocumentType

java.lang.Object
  com.jamasoftware.contour.domain.DomainObjectBaseSupport
      com.jamasoftware.contour.domain.DomainObjectSupport
          com.jamasoftware.contour.domain.DocumentType

All Implemented Interfaces:

DomainObject, DomainObjectBase, OrganizationAware, ScopedObject, java.io.Serializable

@Entity
public class DocumentType
extends DomainObjectSupport
implements ScopedObject

Document type.

Author:

Sean Tong

See Also:

Serialized Form

Field Summary

Fields inherited from interface com.jamasoftware.contour.domain.DomainObjectBase

ORGANIZATION_COLUMN_NAME

Constructor Summary

DocumentType()

DocumentType(java.lang.Integer id)

DocumentType(java.lang.String display, java.lang.String displayPlural, java.lang.String descripiton, java.lang.Integer scope, java.lang.Integer refId, java.lang.String components, java.lang.String documentTypeKey, java.lang.String image)

Method Summary

static DocumentType	createAttachmentDocumentTypeWithFields(java.lang.Integer scope, java.lang.Integer refId, com.jamasoftware.contour.service.DocumentTypeService documentTypeService, com.jamasoftware.contour.service.FieldLayoutService fieldLayoutService)
static java.util.List<DocumentTypeField>	createAttachmentFields(DocumentType attachmentType, com.jamasoftware.contour.service.DocumentTypeService documentTypeService, com.jamasoftware.contour.service.FieldLayoutService fieldLayoutService)
static DocumentType	createComponentDocumentTypeWithFields(java.lang.Integer scope, java.lang.Integer refId, com.jamasoftware.contour.service.DocumentTypeService documentTypeService, com.jamasoftware.contour.service.FieldLayoutService fieldLayoutService)
static DocumentType	createCoreDocumentTypeWithFields(java.lang.Integer scope, java.lang.Integer refId, com.jamasoftware.contour.service.DocumentTypeService documentTypeService, com.jamasoftware.contour.service.FieldLayoutService fieldLayoutService)
static java.util.List<DocumentTypeField>	createCoreFields(DocumentType coreType, com.jamasoftware.contour.service.DocumentTypeService documentTypeService, com.jamasoftware.contour.service.FieldLayoutService fieldLayoutService)
static DocumentType	createSectionDocumentTypeWithFields(java.lang.Integer scope, java.lang.Integer refId, com.jamasoftware.contour.service.DocumentTypeService documentTypeService, com.jamasoftware.contour.service.FieldLayoutService fieldLayoutService)
static DocumentType	createSetDocumentTypeWithFields(java.lang.Integer scope, java.lang.Integer refId, com.jamasoftware.contour.service.DocumentTypeService documentTypeService, com.jamasoftware.contour.service.FieldLayoutService fieldLayoutService)
static java.util.List<DocumentType>	createSystemDocumentTypesWithFields(java.lang.Integer scope, java.lang.Integer refId, com.jamasoftware.contour.service.DocumentTypeService documentTypeService, com.jamasoftware.contour.service.FieldLayoutService fieldLayoutService)
static DocumentType	createTestCycleDocumentTypeWithFields(DocumentType testPlanType, java.lang.Integer scope, java.lang.Integer refId, com.jamasoftware.contour.service.DocumentTypeService documentTypeService, com.jamasoftware.contour.service.FieldLayoutService fieldLayoutService)
static DocumentType	createTestPlanDocumentTypeWithFields(java.lang.Integer scope, java.lang.Integer refId, com.jamasoftware.contour.service.DocumentTypeService documentTypeService, com.jamasoftware.contour.service.FieldLayoutService fieldLayoutService)
static DocumentType	createTestRunDocumentTypeWithFields(DocumentType testPlanType, DocumentType testCycleType, java.lang.Integer scope, java.lang.Integer refId, com.jamasoftware.contour.service.DocumentTypeService documentTypeService, com.jamasoftware.contour.service.FieldLayoutService fieldLayoutService)
static DocumentType	createTextDocumentTypeWithFields(java.lang.Integer scope, java.lang.Integer refId, com.jamasoftware.contour.service.DocumentTypeService documentTypeService, com.jamasoftware.contour.service.FieldLayoutService fieldLayoutService)
boolean	equals(java.lang.Object obj)
java.lang.Boolean	getActive()
DocumentTypeCategory	getCategory()
java.lang.Integer	getCategoryDEPRECATED() Deprecated. Use getCategory()
java.lang.String	getComponents()
java.lang.String	getDefaultDisplayDEPRECATED() Deprecated. Use getDisplay()
java.lang.String	getDefaultDisplayPluralDEPRECATED() Deprecated. Use getDisplayPlural()
java.lang.String	getDefaultPrefixDEPRECATED() Deprecated. Use #getPrefix()
java.lang.String	getDescription()
java.lang.String	getDisplay()
static java.lang.String	getDisplayFor(DocumentType type, DocumentType childType)
java.lang.String	getDisplayPlural()
java.util.List<DocumentTypeField>	getDocumentTypeFields()
java.lang.String	getDocumentTypeKey()
java.lang.Integer	getId()
java.lang.String	getImage()
java.lang.String	getNameDEPRECATED() Deprecated. Name has been replaced by display
java.lang.Integer	getOrganizationId()
java.lang.Integer	getRefId()
java.lang.Integer	getScopeId()
java.lang.String	getXmlToString()
int	hashCode()
void	setActive(java.lang.Boolean active)
void	setCategory(DocumentTypeCategory category)
void	setCategoryDEPRECATED(java.lang.Integer categoryDEPRECATED) Deprecated. Use setCategory(DocumentTypeCategory)
void	setComponents(java.lang.String components)
void	setDefaultDisplayDEPRECATED(java.lang.String defaultDisplayDEPRECATED) Deprecated. Use setDisplay(String)
void	setDefaultDisplayPluralDEPRECATED(java.lang.String defaultDisplayPluralDEPRECATED) Deprecated. Use setDisplayPlural(String)
void	setDefaultPrefixDEPRECATED(java.lang.String defaultPrefixDEPRECATED) Deprecated. Use #setPrefix(String)
void	setDescription(java.lang.String descripiton)
void	setDisplay(java.lang.String display)
void	setDisplayPlural(java.lang.String displayPlural)
void	setDocumentTypeFields(java.util.List<DocumentTypeField> documentTypeFields)
void	setDocumentTypeKey(java.lang.String documentTypeKey)
void	setId(java.lang.Integer id)
void	setImage(java.lang.String image)
void	setNameDEPRECATED(java.lang.String name) Deprecated. Name has been replaced by display
void	setOrganizationId(java.lang.Integer organizationId)
void	setRefId(java.lang.Integer referenceId)
void	setScopeId(java.lang.Integer scope)
java.lang.String	toString()

Methods inherited from class com.jamasoftware.contour.domain.DomainObjectSupport

getCreatedBy, getCreatedDate, getModifiedBy, getModifiedDate, setCreatedBy, setCreatedDate, setModifiedBy, setModifiedDate

Methods inherited from class com.jamasoftware.contour.domain.DomainObjectBaseSupport

isNewObject, obtainAclObjectIdentity

Methods inherited from class java.lang.Object

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

Constructor Detail

DocumentType

public DocumentType()

DocumentType

public DocumentType(java.lang.Integer id)

DocumentType

public DocumentType(java.lang.String display,
                    java.lang.String displayPlural,
                    java.lang.String descripiton,
                    java.lang.Integer scope,
                    java.lang.Integer refId,
                    java.lang.String components,
                    java.lang.String documentTypeKey,
                    java.lang.String image)

Method Detail

createSystemDocumentTypesWithFields

public static final java.util.List<DocumentType> createSystemDocumentTypesWithFields(java.lang.Integer scope,
                                                                                     java.lang.Integer refId,
                                                                                     com.jamasoftware.contour.service.DocumentTypeService documentTypeService,
                                                                                     com.jamasoftware.contour.service.FieldLayoutService fieldLayoutService)

createCoreDocumentTypeWithFields

public static final DocumentType createCoreDocumentTypeWithFields(java.lang.Integer scope,
                                                                  java.lang.Integer refId,
                                                                  com.jamasoftware.contour.service.DocumentTypeService documentTypeService,
                                                                  com.jamasoftware.contour.service.FieldLayoutService fieldLayoutService)

createCoreFields

public static final java.util.List<DocumentTypeField> createCoreFields(DocumentType coreType,
                                                                       com.jamasoftware.contour.service.DocumentTypeService documentTypeService,
                                                                       com.jamasoftware.contour.service.FieldLayoutService fieldLayoutService)

createAttachmentDocumentTypeWithFields

public static final DocumentType createAttachmentDocumentTypeWithFields(java.lang.Integer scope,
                                                                        java.lang.Integer refId,
                                                                        com.jamasoftware.contour.service.DocumentTypeService documentTypeService,
                                                                        com.jamasoftware.contour.service.FieldLayoutService fieldLayoutService)

createAttachmentFields

public static final java.util.List<DocumentTypeField> createAttachmentFields(DocumentType attachmentType,
                                                                             com.jamasoftware.contour.service.DocumentTypeService documentTypeService,
                                                                             com.jamasoftware.contour.service.FieldLayoutService fieldLayoutService)

createComponentDocumentTypeWithFields

public static final DocumentType createComponentDocumentTypeWithFields(java.lang.Integer scope,
                                                                       java.lang.Integer refId,
                                                                       com.jamasoftware.contour.service.DocumentTypeService documentTypeService,
                                                                       com.jamasoftware.contour.service.FieldLayoutService fieldLayoutService)

createSetDocumentTypeWithFields

public static final DocumentType createSetDocumentTypeWithFields(java.lang.Integer scope,
                                                                 java.lang.Integer refId,
                                                                 com.jamasoftware.contour.service.DocumentTypeService documentTypeService,
                                                                 com.jamasoftware.contour.service.FieldLayoutService fieldLayoutService)

createSectionDocumentTypeWithFields

public static final DocumentType createSectionDocumentTypeWithFields(java.lang.Integer scope,
                                                                     java.lang.Integer refId,
                                                                     com.jamasoftware.contour.service.DocumentTypeService documentTypeService,
                                                                     com.jamasoftware.contour.service.FieldLayoutService fieldLayoutService)

createTextDocumentTypeWithFields

public static final DocumentType createTextDocumentTypeWithFields(java.lang.Integer scope,
                                                                  java.lang.Integer refId,
                                                                  com.jamasoftware.contour.service.DocumentTypeService documentTypeService,
                                                                  com.jamasoftware.contour.service.FieldLayoutService fieldLayoutService)

createTestPlanDocumentTypeWithFields

public static final DocumentType createTestPlanDocumentTypeWithFields(java.lang.Integer scope,
                                                                      java.lang.Integer refId,
                                                                      com.jamasoftware.contour.service.DocumentTypeService documentTypeService,
                                                                      com.jamasoftware.contour.service.FieldLayoutService fieldLayoutService)

createTestCycleDocumentTypeWithFields

public static final DocumentType createTestCycleDocumentTypeWithFields(DocumentType testPlanType,
                                                                       java.lang.Integer scope,
                                                                       java.lang.Integer refId,
                                                                       com.jamasoftware.contour.service.DocumentTypeService documentTypeService,
                                                                       com.jamasoftware.contour.service.FieldLayoutService fieldLayoutService)

createTestRunDocumentTypeWithFields

public static final DocumentType createTestRunDocumentTypeWithFields(DocumentType testPlanType,
                                                                     DocumentType testCycleType,
                                                                     java.lang.Integer scope,
                                                                     java.lang.Integer refId,
                                                                     com.jamasoftware.contour.service.DocumentTypeService documentTypeService,
                                                                     com.jamasoftware.contour.service.FieldLayoutService fieldLayoutService)

getDisplayFor

public static java.lang.String getDisplayFor(DocumentType type,
                                             DocumentType childType)

getId

public java.lang.Integer getId()

Specified by:

getId in interface DomainObjectBase

setId

public void setId(java.lang.Integer id)

Specified by:

setId in interface DomainObjectBase

getDescription

public java.lang.String getDescription()

setDescription

public void setDescription(java.lang.String descripiton)

getRefId

public java.lang.Integer getRefId()

Specified by:

getRefId in interface ScopedObject

setRefId

public void setRefId(java.lang.Integer referenceId)

Specified by:

setRefId in interface ScopedObject

getOrganizationId

public java.lang.Integer getOrganizationId()

Specified by:

getOrganizationId in interface DomainObjectBase

Specified by:

getOrganizationId in interface OrganizationAware

setOrganizationId

public void setOrganizationId(java.lang.Integer organizationId)

Specified by:

setOrganizationId in interface DomainObjectBase

getScopeId

public java.lang.Integer getScopeId()

Specified by:

getScopeId in interface ScopedObject

setScopeId

public void setScopeId(java.lang.Integer scope)

Specified by:

setScopeId in interface ScopedObject

getComponents

public java.lang.String getComponents()

setComponents

public void setComponents(java.lang.String components)

getDisplay

public java.lang.String getDisplay()

setDisplay

public void setDisplay(java.lang.String display)

getDisplayPlural

public java.lang.String getDisplayPlural()

setDisplayPlural

public void setDisplayPlural(java.lang.String displayPlural)

getDocumentTypeKey

public java.lang.String getDocumentTypeKey()

setDocumentTypeKey

public void setDocumentTypeKey(java.lang.String documentTypeKey)

getCategory

public DocumentTypeCategory getCategory()

setCategory

public void setCategory(DocumentTypeCategory category)

getActive

public java.lang.Boolean getActive()

setActive

public void setActive(java.lang.Boolean active)

getDocumentTypeFields

public java.util.List<DocumentTypeField> getDocumentTypeFields()

Returns:

the documentTypeFields

setDocumentTypeFields

public void setDocumentTypeFields(java.util.List<DocumentTypeField> documentTypeFields)

Parameters:

documentTypeFields - the documentTypeFields to set

getImage

public java.lang.String getImage()

setImage

public void setImage(java.lang.String image)

getXmlToString

public java.lang.String getXmlToString()

Specified by:

getXmlToString in interface DomainObject

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

Returns:

a String representation of this object.

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class DomainObjectBaseSupport

hashCode

public int hashCode()

Overrides:

hashCode in class DomainObjectBaseSupport

getNameDEPRECATED

@Deprecated
public java.lang.String getNameDEPRECATED()

Deprecated. Name has been replaced by display

setNameDEPRECATED

@Deprecated
public void setNameDEPRECATED(java.lang.String name)

Deprecated. Name has been replaced by display

getDefaultDisplayDEPRECATED

@Deprecated
public java.lang.String getDefaultDisplayDEPRECATED()

Deprecated. Use getDisplay()

setDefaultDisplayDEPRECATED

@Deprecated
public void setDefaultDisplayDEPRECATED(java.lang.String defaultDisplayDEPRECATED)

Deprecated. Use setDisplay(String)

getDefaultDisplayPluralDEPRECATED

@Deprecated
public java.lang.String getDefaultDisplayPluralDEPRECATED()

Deprecated. Use getDisplayPlural()

setDefaultDisplayPluralDEPRECATED

@Deprecated
public void setDefaultDisplayPluralDEPRECATED(java.lang.String defaultDisplayPluralDEPRECATED)

Deprecated. Use setDisplayPlural(String)

getDefaultPrefixDEPRECATED

@Deprecated
public java.lang.String getDefaultPrefixDEPRECATED()

Deprecated. Use #getPrefix()

setDefaultPrefixDEPRECATED

@Deprecated
public void setDefaultPrefixDEPRECATED(java.lang.String defaultPrefixDEPRECATED)

Deprecated. Use #setPrefix(String)

setCategoryDEPRECATED

@Deprecated
public void setCategoryDEPRECATED(java.lang.Integer categoryDEPRECATED)

Deprecated. Use setCategory(DocumentTypeCategory)

getCategoryDEPRECATED

@Deprecated
public java.lang.Integer getCategoryDEPRECATED()

Deprecated. Use getCategory()