com.arcway.cockpit.genericmodule.docgen.provider.interfaces

Interface IGenericModuleData

All Superinterfaces:

com.arcway.cockpit.docgen.provider.interfaces.ICockpitData, com.arcway.cockpit.docgen.provider.interfaces.ICustomPropertiesAccess, com.arcway.cockpit.docgen.provider.interfaces.IGraphic, com.arcway.cockpit.modulelib2.client.docgen.provider.interfaces.IModuleData

public interface IGenericModuleData
extends com.arcway.cockpit.modulelib2.client.docgen.provider.interfaces.IModuleData, com.arcway.cockpit.docgen.provider.interfaces.ICustomPropertiesAccess, com.arcway.cockpit.docgen.provider.interfaces.IGraphic

The IGenericModuleData object allows to read attribute values of an item from a ARCWAY Cockpit module that is based on the Generic Module. Starting with this object, you can get references to its parent object, child objects and related objects.

Item type constant: "gm." + [module id] + "." + [object type id] (module id and object type id are taken from the generic module specification) Attention: This type implements the IGraphic interface, but the methods contained in this interface may only be used in a report template, if a graphical representation is specified for the object type.

Method Summary

Modifier and Type	Method and Description
java.util.List<? extends IGenericModuleData>	getAncestorObjects() Returns the ancestor objects of this object, i.e. the parent object and its parents recursively.
java.util.List<java.lang.String>	getAttribute_asParagraphList(java.lang.String attributeID) Returns the value of the specified attribute as List of String.
java.lang.String	getAttribute_asSingleLine(java.lang.String attributeID) Returns the value of the specified attribute as String.
java.lang.Long	getAttribute_asTimestamp_MilliSecondsSince_01_01_1970(java.lang.String attributeID) Returns the value of the specified attribute as time stamp.
java.lang.Object	getAttribute(java.lang.String attributeID) Returns the value of the specified attribute.
java.util.List<? extends IGenericModuleData>	getChildObjects(java.lang.String objectType) Returns the direct child objects of the given type of this object.
java.util.List<? extends IGenericModuleData>	getChildObjects(java.lang.String objectType, java.lang.String attributeToSortBy) Returns the direct child objects of the given type of this object.
java.util.List<? extends IGenericModuleData>	getChildObjectsOfTypeRank(int typeRank) Returns the direct child objects of the given type rank of this object.
java.util.List<? extends IGenericModuleData>	getChildObjectsWithCategory(java.lang.String objectType, java.lang.String categoryID) Returns the direct child objects of the given type of this object that belong to the specified category.
java.util.List<? extends IGenericModuleData>	getChildObjectsWithCategory(java.lang.String objectType, java.lang.String categoryID, java.lang.String attributeToSortBy) Returns the direct child objects of the given type of this object that belong to the specified category.
java.util.List<? extends IGenericModuleData>	getChildObjectsWithDefaultCategory(java.lang.String objectType) Returns the direct child objects of the given type of this object that belong to the default category.
java.util.List<? extends IGenericModuleData>	getChildObjectsWithDefaultCategory(java.lang.String objectType, java.lang.String attributeToSortBy) Returns the direct child objects of the given type of this object that belong to the default category.
java.lang.String	getChildrenIDPrefix(java.lang.String childObjectTypeID) Returns the prefix that will be used for the id of a new child item of the specified type.
java.util.List<? extends com.arcway.cockpit.docgen.provider.interfaces.IModelElement>	getLinkedModelElements() Returns the linked model elements.
java.lang.String	getObjectType() Returns the id of the object type of this object.
IGenericModuleData	getParentObject() Returns the parent object of this object.
java.util.List<? extends IGenericModuleData>	getRelatedLOObjects(java.lang.String relationTypeID) Returns the related linkable objects for this object based on the specified relation type.
java.util.List<? extends IGenericModuleData>	getRelatedLOObjects(java.lang.String relationTypeID, java.lang.String attributeToSortBy) Returns the related linkable objects for this object based on the specified relation type.
java.util.List<? extends IGenericModuleData>	getRelatedLOObjectsWithCategory(java.lang.String relationTypeID, java.lang.String categoryID) Returns the related linkable objects for this object based on the specified relation type and that belong to the specified category.
java.util.List<? extends IGenericModuleData>	getRelatedLOObjectsWithCategory(java.lang.String relationTypeID, java.lang.String categoryID, java.lang.String attributeToSortBy) Returns the related linkable objects for this object based on the specified relation type and that belong to the sepcified category.
java.util.List<? extends IGenericModuleData>	getRelatedLOObjectsWithDefaultCategory(java.lang.String relationTypeID) Returns the related linkable objects for this object based on the specified relation type and that belong to the default category.
java.util.List<? extends IGenericModuleData>	getRelatedLOObjectsWithDefaultCategory(java.lang.String relationTypeID, java.lang.String attributeToSortBy) Returns the related linkable objects for this object based on the specified relation type and that belong to the default category.
java.util.List<? extends IGenericModuleData>	getRelatedMDObjects(java.lang.String relationTypeID) Returns the related module data objects for this object based on the specified relation type.
java.util.List<? extends IGenericModuleData>	getRelatedMDObjects(java.lang.String relationTypeID, java.lang.String attributeToSortBy) Returns the related module data objects for this object based on the specified relation type.
java.util.List<? extends IGenericModuleData>	getRelatedMDObjectsWithCategory(java.lang.String relationTypeID, java.lang.String categoryID) Returns the related module data objects for this object based on the specified relation type and that belong to the specified category.
java.util.List<? extends IGenericModuleData>	getRelatedMDObjectsWithCategory(java.lang.String relationTypeID, java.lang.String categoryID, java.lang.String attributeToSortBy) Returns the related module data objects for this object based on the specified relation type and that belong to the specified category.
java.util.List<? extends IGenericModuleData>	getRelatedMDObjectsWithDefaultCategory(java.lang.String relationTypeID) Returns the related module data objects for this object based on the specified relation type and that belong to the default category.
java.util.List<? extends IGenericModuleData>	getRelatedMDObjectsWithDefaultCategory(java.lang.String relationTypeID, java.lang.String attributeToSortBy) Returns the related module data objects for this object based on the specified relation type and that belong to the default category.
java.lang.String	getUniqueIdentifier() Returns a unique identifier that uniquely identifies this object within its project.
boolean	isLinkedToAnyModelElement() Whether this item is linked to any model element.
com.arcway.cockpit.docgen.provider.interfaces.IRecord	toRecord() Converts this generic module data into a record.

Methods inherited from interface com.arcway.cockpit.docgen.provider.interfaces.IGraphic

getImage, getPNGFile, getSVGFile, getWMFFile

Methods inherited from interface com.arcway.cockpit.docgen.provider.interfaces.ICustomPropertiesAccess

getCategoryID, getCategoryLabel, getDateTimeProperty_MilliSecondsSince_01_01_1970, getFileProperty, getFileProperty, getFilePropertyAsBase64StringList, getFilePropertyAsFileName, getFilePropertyAsFileName, getFilePropertyAsRawStringList, getFilePropertyAsStringList, getPropertyAsString, getPropertyAsStringArray, getPropertyAsStringList, hasCustomPropertyValues, hasDefaultCategory, hasPropertyValue, readImageInfoOfFileProperty

Methods inherited from interface com.arcway.cockpit.docgen.provider.interfaces.ICockpitData

getCommitVersion, getCreationDate_MilliSecondsSince_01_01_1970, getCreationDate, getCreator, getDateOfLastModification_MilliSecondsSince_01_01_1970, getDateOfLastModification, getDisplayName, getLastModifier, getModificationCount, getProjectUniqueIdentifier, getTypeID, getTypeName, toRecord

Method Detail

getUniqueIdentifier

java.lang.String getUniqueIdentifier()

Returns a unique identifier that uniquely identifies this object within its project.

Specified by:

getUniqueIdentifier in interface com.arcway.cockpit.docgen.provider.interfaces.ICockpitData

Returns:

unique identifier

getObjectType

java.lang.String getObjectType()

Returns the id of the object type of this object.

Returns:

the object type id

getAttribute

java.lang.Object getAttribute(java.lang.String attributeID)

Returns the value of the specified attribute.

The property is returned either as String or List of Strings, depending on whether it comprises of multiple lines or not.

Parameters:

attributeID - the attributeID

Returns:

HTML encoded reprensentation of the attribute's value (String or List of String)

getAttribute_asSingleLine

java.lang.String getAttribute_asSingleLine(java.lang.String attributeID)

Returns the value of the specified attribute as String.

Parameters:

attributeID - the attributeID

Returns:

HTML encoded reprensentation of the attribute's value (String)

getAttribute_asParagraphList

java.util.List<java.lang.String> getAttribute_asParagraphList(java.lang.String attributeID)

Returns the value of the specified attribute as List of String.

Parameters:

attributeID - the attributeID

Returns:

the attribute's value as List of HTML encoded paragraphs(!= null)

getAttribute_asTimestamp_MilliSecondsSince_01_01_1970

java.lang.Long getAttribute_asTimestamp_MilliSecondsSince_01_01_1970(java.lang.String attributeID)

Returns the value of the specified attribute as time stamp.

Only for attributes of type Date or DateTime.

Parameters:

attributeID - the attributeID

Returns:

the time stamp as milliseconds since 1/1/1970

getParentObject

IGenericModuleData getParentObject()

Returns the parent object of this object.

Returns:

the parent object or null if this is a root object

getChildObjects

java.util.List<? extends IGenericModuleData> getChildObjects(java.lang.String objectType)

Returns the direct child objects of the given type of this object.

The children are in natural order.

Parameters:

objectType - the object type

Returns:

the child objects (not null)

getChildObjectsOfTypeRank

java.util.List<? extends IGenericModuleData> getChildObjectsOfTypeRank(int typeRank)

Returns the direct child objects of the given type rank of this object.

The children are in natural order.

Parameters:

typeRank - the type rank of the objects

Returns:

the child objects (not null)

getChildObjectsWithCategory

java.util.List<? extends IGenericModuleData> getChildObjectsWithCategory(java.lang.String objectType,
                                                                         java.lang.String categoryID)

Returns the direct child objects of the given type of this object that belong to the specified category.

The children are in natural order.

Parameters:

objectType - the object type

categoryID - the category ID

Returns:

the child objects (not null)

getChildObjectsWithDefaultCategory

java.util.List<? extends IGenericModuleData> getChildObjectsWithDefaultCategory(java.lang.String objectType)

Returns the direct child objects of the given type of this object that belong to the default category.

The children are in natural order.

Parameters:

objectType - the object type

Returns:

the child objects (not null)

getChildObjects

java.util.List<? extends IGenericModuleData> getChildObjects(java.lang.String objectType,
                                                             java.lang.String attributeToSortBy)

Returns the direct child objects of the given type of this object.

The children are sorted by the specified attribute's value.

Parameters:

objectType - the object type

attributeToSortBy - the id attribute to sort by (may be a fix attribute or a custom property)

Returns:

the child objects (not null)

getChildObjectsWithCategory

java.util.List<? extends IGenericModuleData> getChildObjectsWithCategory(java.lang.String objectType,
                                                                         java.lang.String categoryID,
                                                                         java.lang.String attributeToSortBy)

Returns the direct child objects of the given type of this object that belong to the specified category.

The children are sorted by the specified attribute's value.

Parameters:

objectType - the object type

categoryID - the category ID

attributeToSortBy - the id attribute to sort by (may be a fix attribute or a custom property)

Returns:

the child objects (not null)

getChildObjectsWithDefaultCategory

java.util.List<? extends IGenericModuleData> getChildObjectsWithDefaultCategory(java.lang.String objectType,
                                                                                java.lang.String attributeToSortBy)

Returns the direct child objects of the given type of this object that belong to the default category.

The children are sorted by the specified attribute's value.

Parameters:

objectType - the object type

attributeToSortBy - the id attribute to sort by (may be a fix attribute or a custom property)

Returns:

the child objects (not null)

getAncestorObjects

java.util.List<? extends IGenericModuleData> getAncestorObjects()

Returns the ancestor objects of this object, i.e. the parent object and its parents recursively.

Returns:

the ancestor objects (not null)

getRelatedLOObjects

java.util.List<? extends IGenericModuleData> getRelatedLOObjects(java.lang.String relationTypeID)

Returns the related linkable objects for this object based on the specified relation type.

(The "linkable object" relation participant is the second specified relation participant of a module data relation type.)

Parameters:

relationTypeID - the id of the relation type

Returns:

the related linkable objects (not null)

getRelatedLOObjectsWithCategory

java.util.List<? extends IGenericModuleData> getRelatedLOObjectsWithCategory(java.lang.String relationTypeID,
                                                                             java.lang.String categoryID)

Returns the related linkable objects for this object based on the specified relation type and that belong to the specified category.

(The "linkable object" relation participant is the second specified relation participant of a module data relation type.)

Parameters:

categoryID - the category ID

relationTypeID - the id of the relation type

Returns:

the related linkable objects (not null)

getRelatedLOObjectsWithDefaultCategory

java.util.List<? extends IGenericModuleData> getRelatedLOObjectsWithDefaultCategory(java.lang.String relationTypeID)

Returns the related linkable objects for this object based on the specified relation type and that belong to the default category.

(The "linkable object" relation participant is the second specified relation participant of a module data relation type.)

Parameters:

relationTypeID - the id of the relation type

Returns:

the related linkable objects (not null)

getRelatedLOObjects

java.util.List<? extends IGenericModuleData> getRelatedLOObjects(java.lang.String relationTypeID,
                                                                 java.lang.String attributeToSortBy)

Returns the related linkable objects for this object based on the specified relation type.

(The "linkable object" relation participant is the second specified relation participant of a module data relation type.)

The returned linkable objects are sorted by the specified attribute's value.

Parameters:

relationTypeID - the id of the relation type

attributeToSortBy - the id attribute to sort by (may be a fix attribute or a custom property)

Returns:

the related linkable objects (not null)

getRelatedLOObjectsWithCategory

java.util.List<? extends IGenericModuleData> getRelatedLOObjectsWithCategory(java.lang.String relationTypeID,
                                                                             java.lang.String categoryID,
                                                                             java.lang.String attributeToSortBy)

Returns the related linkable objects for this object based on the specified relation type and that belong to the sepcified category.

(The "linkable object" relation participant is the second specified relation participant of a module data relation type.)

The returned linkable objects are sorted by the specified attribute's value.

Parameters:

relationTypeID - the id of the relation type

categoryID - the category ID

attributeToSortBy - the id attribute to sort by (may be a fix attribute or a custom property)

Returns:

the related linkable objects (not null)

getRelatedLOObjectsWithDefaultCategory

java.util.List<? extends IGenericModuleData> getRelatedLOObjectsWithDefaultCategory(java.lang.String relationTypeID,
                                                                                    java.lang.String attributeToSortBy)

Returns the related linkable objects for this object based on the specified relation type and that belong to the default category.

(The "linkable object" relation participant is the second specified relation participant of a module data relation type.)

The returned linkable objects are sorted by the specified attribute's value.

Parameters:

relationTypeID - the id of the relation type

attributeToSortBy - the id attribute to sort by (may be a fix attribute or a custom property)

Returns:

the related linkable objects (not null)

getRelatedMDObjects

java.util.List<? extends IGenericModuleData> getRelatedMDObjects(java.lang.String relationTypeID)

Returns the related module data objects for this object based on the specified relation type.

(The "module data" relation participant is the first specified relation participant of a module data relation type.)

Parameters:

relationTypeID - the id of the relation type

Returns:

the related module data objects (not null)

getRelatedMDObjectsWithCategory

java.util.List<? extends IGenericModuleData> getRelatedMDObjectsWithCategory(java.lang.String relationTypeID,
                                                                             java.lang.String categoryID)

Returns the related module data objects for this object based on the specified relation type and that belong to the specified category.

(The "module data" relation participant is the first specified relation participant of a module data relation type.)

Parameters:

categoryID - the category ID

relationTypeID - the id of the relation type

Returns:

the related module data objects (not null)

getRelatedMDObjectsWithDefaultCategory

java.util.List<? extends IGenericModuleData> getRelatedMDObjectsWithDefaultCategory(java.lang.String relationTypeID)

Returns the related module data objects for this object based on the specified relation type and that belong to the default category.

(The "module data" relation participant is the first specified relation participant of a module data relation type.)

Parameters:

relationTypeID - the id of the relation type

Returns:

the related module data objects (not null)

getRelatedMDObjects

java.util.List<? extends IGenericModuleData> getRelatedMDObjects(java.lang.String relationTypeID,
                                                                 java.lang.String attributeToSortBy)

Returns the related module data objects for this object based on the specified relation type.

(The "module data" relation participant is the first specified relation participant of a module data relation type.)

The returned module data objects are sorted by the specified attribute's value.

Parameters:

relationTypeID - the id of the relation type

attributeToSortBy - the id attribute to sort by (may be a fix attribute or a custom property)

Returns:

the related module data objects (not null)

getRelatedMDObjectsWithCategory

java.util.List<? extends IGenericModuleData> getRelatedMDObjectsWithCategory(java.lang.String relationTypeID,
                                                                             java.lang.String categoryID,
                                                                             java.lang.String attributeToSortBy)

Returns the related module data objects for this object based on the specified relation type and that belong to the specified category.

(The "module data" relation participant is the first specified relation participant of a module data relation type.)

The returned module data objects are sorted by the specified attribute's value.

Parameters:

relationTypeID - the id of the relation type

categoryID - the category ID

attributeToSortBy - the id attribute to sort by (may be a fix attribute or a custom property)

Returns:

the related module data objects (not null)

getRelatedMDObjectsWithDefaultCategory

java.util.List<? extends IGenericModuleData> getRelatedMDObjectsWithDefaultCategory(java.lang.String relationTypeID,
                                                                                    java.lang.String attributeToSortBy)

Returns the related module data objects for this object based on the specified relation type and that belong to the default category.

(The "module data" relation participant is the first specified relation participant of a module data relation type.)

The returned module data objects are sorted by the specified attribute's value.

Parameters:

relationTypeID - the id of the relation type

attributeToSortBy - the id attribute to sort by (may be a fix attribute or a custom property)

Returns:

the related module data objects (not null)

isLinkedToAnyModelElement

boolean isLinkedToAnyModelElement()

Whether this item is linked to any model element.

Returns:

whether this item is linked to any model element

getLinkedModelElements

java.util.List<? extends com.arcway.cockpit.docgen.provider.interfaces.IModelElement> getLinkedModelElements()

Returns the linked model elements.

Returns:

the linked model elements (not null)

getChildrenIDPrefix

java.lang.String getChildrenIDPrefix(java.lang.String childObjectTypeID)

Returns the prefix that will be used for the id of a new child item of the specified type.

Parameters:

childObjectTypeID -

Returns:

the prefix that will be used for the id of a new child item of the specified type (or null if the specified child type does not have an id attribute)

toRecord

com.arcway.cockpit.docgen.provider.interfaces.IRecord toRecord()

Converts this generic module data into a record.

In addition to all fields documented at ICustomPropertiesAccess.toRecord(), in the created record, the following fields are filled accoring to the wrapped cockpit data:

• IRecord.OBJECT_TYPE_KEY
• all fixed attributes of this data

Concrete types may fill in further fields (see there).

Specified by:

toRecord in interface com.arcway.cockpit.docgen.provider.interfaces.ICockpitData

Specified by:

toRecord in interface com.arcway.cockpit.docgen.provider.interfaces.ICustomPropertiesAccess

Returns:

converted cockpit project data