public enum DocumentTypeCategory extends Enum<DocumentTypeCategory>
Enum Constant and Description |
---|
ATTACHMENT |
COMPONENT |
CORE |
PROGRESSABLE |
SECTION |
SET |
TEST_CASE |
TEST_CYCLE |
TEST_PLAN |
TEST_RUN |
TEXT |
Modifier and Type | Field and Description |
---|---|
static List<DocumentTypeCategory> |
CHILD_TYPE_CATEGORIES
Child type categories are those that specify the type of children they can contain
|
static List<DocumentTypeCategory> |
DOCUMENT_CATEGORIES
Categories that are represented in the back end by Document.java
|
static List<DocumentTypeCategory> |
FOLDER_CATEGORIES
Folder categories are those documents which act as high-level folders.
|
static List<DocumentTypeCategory> |
MIXED_TYPE_CHILDREN_CATEGORIES
Categories that have Mixed Item Type children
|
static List<DocumentTypeCategory> |
NO_RELATIONSHIP_CATEGORIES
System categories that are not allowed to have relationships.
|
static List<DocumentTypeCategory> |
PERMISSION_CATEGORIES
Permission categories are those that can have permissions associated with them
|
static List<DocumentTypeCategory> |
REQUIRE_A_SET_CATEGORIES
These categories need to live under a Set.
|
static List<DocumentTypeCategory> |
SYSTEM_CATEGORIES
System categories are managed by Contour and their Document Types shouldn't be edited or deleted
|
static List<DocumentTypeCategory> |
TEST_CENTER_CATEGORIES
Categories of "Test Center" things
|
static List<DocumentTypeCategory> |
TREE_CATEGORIES
Categories of items that live inside the tree hierarchy
|
Modifier and Type | Method and Description |
---|---|
Boolean |
getConfigurable() |
Integer |
getDbId() |
static Integer |
getDbIdFromCategoryName(String name)
Convert the Name to the id.
|
Boolean |
getDeletable() |
String |
getDisplay() |
static DocumentTypeCategory |
getDocumentTypeCategoryById(Integer id) |
Boolean |
getEditable() |
Boolean |
getIsSystem() |
String |
getName() |
Boolean |
getUserAssignable() |
Boolean |
getUsesDocNodes() |
static boolean |
hasMixedTypeChildren(DocumentType documentType) |
static boolean |
isCategory(DocumentTypeCategory docTypeCategory,
DocumentTypeCategory category) |
static boolean |
isCategory(DocumentType docType,
DocumentTypeCategory category) |
static boolean |
isChildTypeCategory(DocumentTypeCategory category)
Given a category id (from
DocumentType.getCategory() ), returns whether or not the category represents a
type that has a specified child document type. |
static boolean |
isFolderCategory(DocumentTypeCategory category)
Given a
DocumentType.getCategory() , returns whether or not the category represents a
folder type |
static boolean |
isFolderType(DocumentType documentType)
Determine if a
DocumentType is a folder type |
static boolean |
isInListOfCategories(DocumentType docType,
List<DocumentTypeCategory> categories,
boolean allowNull) |
static boolean |
isNoRelationshipType(DocumentType documentType)
Determine if a
DocumentType is a no-relationship type |
static boolean |
isPermissionCategory(DocumentTypeCategory category)
Given a category id (from
DocumentType.getCategory() ), returns whether or not the category represents a
permission type (where permissions can be specified) |
static boolean |
isPermissionType(DocumentType documentType)
Determine if a
DocumentType is a permission type (a "permission" type is any type of document where
permissions are placed) |
static boolean |
isRelatableTreeType(DocumentType type) |
static boolean |
isSystemCategory(DocumentTypeCategory category) |
static boolean |
isSystemType(DocumentType documentType)
Determine if a
DocumentType is a system controlled type |
static boolean |
isTestCenterType(DocumentType docType) |
static boolean |
isTestCenterTypeCategory(DocumentTypeCategory category) |
static boolean |
isWorkItemType(DocumentType documentType) |
static boolean |
needsParentSet(DocumentType documentType) |
static DocumentTypeCategory |
valueOf(String name)
Returns the enum constant of this type with the specified name.
|
static DocumentTypeCategory[] |
values()
Returns an array containing the constants of this enum type, in
the order they are declared.
|
public static final DocumentTypeCategory CORE
public static final DocumentTypeCategory ATTACHMENT
public static final DocumentTypeCategory COMPONENT
public static final DocumentTypeCategory SET
public static final DocumentTypeCategory SECTION
public static final DocumentTypeCategory TEXT
public static final DocumentTypeCategory TEST_PLAN
public static final DocumentTypeCategory TEST_CYCLE
public static final DocumentTypeCategory TEST_RUN
public static final DocumentTypeCategory TEST_CASE
public static final DocumentTypeCategory PROGRESSABLE
public static final List<DocumentTypeCategory> SYSTEM_CATEGORIES
public static final List<DocumentTypeCategory> TREE_CATEGORIES
public static final List<DocumentTypeCategory> DOCUMENT_CATEGORIES
public static final List<DocumentTypeCategory> TEST_CENTER_CATEGORIES
public static final List<DocumentTypeCategory> NO_RELATIONSHIP_CATEGORIES
public static final List<DocumentTypeCategory> PERMISSION_CATEGORIES
public static final List<DocumentTypeCategory> CHILD_TYPE_CATEGORIES
public static final List<DocumentTypeCategory> FOLDER_CATEGORIES
public static final List<DocumentTypeCategory> REQUIRE_A_SET_CATEGORIES
public static final List<DocumentTypeCategory> MIXED_TYPE_CHILDREN_CATEGORIES
public static DocumentTypeCategory[] values()
for (DocumentTypeCategory c : DocumentTypeCategory.values()) System.out.println(c);
public static DocumentTypeCategory valueOf(String name)
name
- the name of the enum constant to be returned.IllegalArgumentException
- if this enum type has no constant
with the specified nameNullPointerException
- if the argument is nullpublic Integer getDbId()
public String getDisplay()
public String getName()
public Boolean getIsSystem()
public Boolean getConfigurable()
public Boolean getEditable()
public Boolean getDeletable()
public Boolean getUsesDocNodes()
public Boolean getUserAssignable()
public static DocumentTypeCategory getDocumentTypeCategoryById(Integer id)
public static boolean needsParentSet(DocumentType documentType)
public static boolean hasMixedTypeChildren(DocumentType documentType)
public static boolean isSystemType(DocumentType documentType)
DocumentType
is a system controlled typedocumentType
- A document typepublic static boolean isRelatableTreeType(DocumentType type)
public static boolean isSystemCategory(DocumentTypeCategory category)
public static boolean isPermissionType(DocumentType documentType)
DocumentType
is a permission type (a "permission" type is any type of document where
permissions are placed)documentType
- The DocumentType
public static boolean isPermissionCategory(DocumentTypeCategory category)
DocumentType.getCategory()
), returns whether or not the category represents a
permission type (where permissions can be specified)category
- The category of a DocumentType
public static boolean isChildTypeCategory(DocumentTypeCategory category)
DocumentType.getCategory()
), returns whether or not the category represents a
type that has a specified child document type. Documents of a type with this category can expect
Document.getChildDocumentType()
()} to always be populatedcategory
- The category of a DocumentType
public static boolean isFolderType(DocumentType documentType)
DocumentType
is a folder typedocumentType
- The DocumentType
public static boolean isFolderCategory(DocumentTypeCategory category)
DocumentType.getCategory()
, returns whether or not the category represents a
folder typecategory
- The category of a DocumentType
public static boolean isNoRelationshipType(DocumentType documentType)
DocumentType
is a no-relationship typedocumentType
- The DocumentType
public static boolean isTestCenterTypeCategory(DocumentTypeCategory category)
public static boolean isTestCenterType(DocumentType docType)
public static boolean isInListOfCategories(DocumentType docType, List<DocumentTypeCategory> categories, boolean allowNull)
public static boolean isCategory(DocumentType docType, DocumentTypeCategory category)
public static boolean isCategory(DocumentTypeCategory docTypeCategory, DocumentTypeCategory category)
public static boolean isWorkItemType(DocumentType documentType)
Copyright (c) 2013-2014 Jama Software, Inc. All Rights Reserved.