com.arcway.cockpit.docgen.provider.interfaces

Interface IDataModelProvider

public interface IDataModelProvider

Data Model Provider

Provides information concerning the data model of the Cockpit project. So far, only the custom parts of the data model can be retrieved. I.e. the defined custom properties for each object type including the data type and in the case of enumeration properties the value range. The custom value range for fix enumeration properties as they occur in some project data types (like e.g. priority and status for requirements) can be retrieved from the data provider of the according project data module (e.g. IRequirementDataProvider for the requirement module). Hint: The required objectTypeID constants can be found in the documentation of the respective object type interface (IPlan, IFolder, IRequirement, ...). If a concrete data item (implementing ICockpitData) is available, then the objectTypeID of this item can also be retrieved by calling "getTypeID()" on this item. The IDataModelProvider can be referenced directly within a document template by its name dataModelProvider.

Method Summary

Modifier and Type	Method and Description
java.util.List<java.lang.String>	getAllowedValuesOfCustomProperty(java.lang.String objectTypeID, java.lang.String propertyTypeID) Returns the value range of the data type of the specified custom property of the specified object type.
java.util.List<java.lang.String>	getCategoryIDsForObjectType(java.lang.String objectTypeID) Returns the ids of all categories of an object type.
java.util.List<java.lang.String>	getCustomPropertiesForObjectTypeCategory(java.lang.String objectTypeID, java.lang.String categoryID) Returns the ids of all custom properties of the specified object type that are visible for the specified category.
java.util.List<java.lang.String>	getCustomPropertyIdsForObjectType(java.lang.String objectTypeID) Returns a list with the IDs of all custom properties of the specified object type.
java.lang.String	getDatatypeDisplaynameOfProperty(java.lang.String objectTypeID, java.lang.String propertyTypeID) Returns the display name of the data type of the specified custom property of the specified object type.
java.lang.String	getDatatypeIDOfProperty(java.lang.String objectTypeID, java.lang.String propertyTypeID) Returns the data type id of the specified custom property of the specified object type.
java.lang.String	getDisplaynameOfCategory(java.lang.String objectTypeID, java.lang.String categoryID) Returns the display name of a category.
java.lang.String	getDisplaynameOfProperty(java.lang.String objectTypeID, java.lang.String propertyTypeID) Returns the displayname of the specified custom property of the specified object type.
java.lang.String	getIconOfCategory(java.lang.String objectTypeID, java.lang.String categoryID) Returns the icon of a category.
boolean	hasCategory(java.lang.String objectTypeID, java.lang.String categoryID) Returns whether an object type has a specific category.
boolean	hasCustomProperties(java.lang.String objectTypeID) Returns whether any custom properties are defined for the specified object type.
boolean	hasCustomProperty(java.lang.String objectTypeID, java.lang.String propertyTypeID) Returns whether the specified custom property is defined for the specified object type.
boolean	hasNonDefaultCategories(java.lang.String objectTypeID) Returns whether an object type has non-default categories.
boolean	isEnumerationCustomProperty(java.lang.String objectTypeID, java.lang.String propertyTypeID) Returns whether the specified custom property of the specified object type is an enumeration property.
boolean	isFileCustomProperty(java.lang.String objectTypeID, java.lang.String propertyTypeID) Returns whether the specified custom property of the specified object type is a file property.

Method Detail

hasCustomProperties

boolean hasCustomProperties(java.lang.String objectTypeID)

Returns whether any custom properties are defined for the specified object type.

Parameters:

objectTypeID - ID of the object type (see main description of this interface)

Returns:

whether any custom properties are defined

getCustomPropertyIdsForObjectType

java.util.List<java.lang.String> getCustomPropertyIdsForObjectType(java.lang.String objectTypeID)

Returns a list with the IDs of all custom properties of the specified object type.

Parameters:

objectTypeID - ID of the object type (see main description of this interface)

Returns:

list of custom property IDs

hasCustomProperty

boolean hasCustomProperty(java.lang.String objectTypeID,
                          java.lang.String propertyTypeID)

Returns whether the specified custom property is defined for the specified object type.

Parameters:

objectTypeID - ID of the object type (see main description of this interface)

propertyTypeID - ID of the custom property

Returns:

whether the specified custom property is defined

getDisplaynameOfProperty

java.lang.String getDisplaynameOfProperty(java.lang.String objectTypeID,
                                          java.lang.String propertyTypeID)

Returns the displayname of the specified custom property of the specified object type.

Parameters:

objectTypeID - ID of the object type (see main description of this interface)

propertyTypeID - ID of the custom property (as retrieved from getCustomPropertyIdsForObjectType(String))

Returns:

the displayname

getDatatypeIDOfProperty

java.lang.String getDatatypeIDOfProperty(java.lang.String objectTypeID,
                                         java.lang.String propertyTypeID)

Returns the data type id of the specified custom property of the specified object type. The following property data types are supported in the moment: - integer (integer number) - double (floating point number) - boolean (boolean value) - string (single line string) - text (multi line string) - date (date) - url (URL) - file (file) - enumeration_integer_single (single choice of a list of integer values) - enumeration_string_single (single choice of a list of string values) - enumeration_integer_multiple (multiple choice of a list of integer values) - enumeration_string_multiple (multiple choice of a list of string values)

Parameters:

objectTypeID - ID of the object type (see main description of this interface)

propertyTypeID - ID of the custom property (as retrieved from getCustomPropertyIdsForObjectType(String))

Returns:

the data type id

getDatatypeDisplaynameOfProperty

java.lang.String getDatatypeDisplaynameOfProperty(java.lang.String objectTypeID,
                                                  java.lang.String propertyTypeID)

Returns the display name of the data type of the specified custom property of the specified object type.

Parameters:

objectTypeID - ID of the object type (see main description of this interface)

propertyTypeID - ID of the custom property (as retrieved from getCustomPropertyIdsForObjectType(String))

Returns:

the display name of data type

isFileCustomProperty

boolean isFileCustomProperty(java.lang.String objectTypeID,
                             java.lang.String propertyTypeID)

Returns whether the specified custom property of the specified object type is a file property.

Parameters:

objectTypeID - ID of the object type (see main description of this interface)

propertyTypeID - ID of the custom property (as retrieved from getCustomPropertyIdsForObjectType(String))

Returns:

whether the specified custom property is a file property

isEnumerationCustomProperty

boolean isEnumerationCustomProperty(java.lang.String objectTypeID,
                                    java.lang.String propertyTypeID)

Returns whether the specified custom property of the specified object type is an enumeration property.

Parameters:

objectTypeID - ID of the object type (see main description of this interface)

propertyTypeID - ID of the custom property (as retrieved from getCustomPropertyIdsForObjectType(String))

Returns:

whether the specified custom property is an enumeration property

getAllowedValuesOfCustomProperty

java.util.List<java.lang.String> getAllowedValuesOfCustomProperty(java.lang.String objectTypeID,
                                                                  java.lang.String propertyTypeID)

Returns the value range of the data type of the specified custom property of the specified object type. Precondition: the specified custom property is an enumeration property (check using isEnumerationCustomProperty(String, String))

Parameters:

objectTypeID - ID of the object type (see main description of this interface)

propertyTypeID - ID of the custom property (as retrieved from getCustomPropertyIdsForObjectType(String))

Returns:

the value range

getCategoryIDsForObjectType

java.util.List<java.lang.String> getCategoryIDsForObjectType(java.lang.String objectTypeID)

Returns the ids of all categories of an object type.

Parameters:

objectTypeID - ID of the object type (see main description of this interface)

Returns:

all category IDs of the object type

getDisplaynameOfCategory

java.lang.String getDisplaynameOfCategory(java.lang.String objectTypeID,
                                          java.lang.String categoryID)

Returns the display name of a category.

Parameters:

objectTypeID - objectTypeID ID of the object type (see main description of this interface)

categoryID - the category ID

Returns:

the display name of the category

getIconOfCategory

java.lang.String getIconOfCategory(java.lang.String objectTypeID,
                                   java.lang.String categoryID)

Returns the icon of a category.

Parameters:

objectTypeID - objectTypeID ID of the object type (see main description of this interface)

categoryID - the category ID

Returns:

the icon of the category (null for none)

hasNonDefaultCategories

boolean hasNonDefaultCategories(java.lang.String objectTypeID)

Returns whether an object type has non-default categories.

Parameters:

objectTypeID - ID of the object type (see main description of this interface)

Returns:

true, if the object type has at least one non default category

hasCategory

boolean hasCategory(java.lang.String objectTypeID,
                    java.lang.String categoryID)

Returns whether an object type has a specific category.

Parameters:

objectTypeID - ID of the object type (see main description of this interface)

categoryID - the category ID

Returns:

true, if the object type has the specified category

getCustomPropertiesForObjectTypeCategory

java.util.List<java.lang.String> getCustomPropertiesForObjectTypeCategory(java.lang.String objectTypeID,
                                                                          java.lang.String categoryID)

Returns the ids of all custom properties of the specified object type that are visible for the specified category.

Parameters:

objectTypeID - ID of the object type (see main description of this interface)

categoryID - the category ID

Returns:

list with all custom properties that belong to the specified category