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

Interface IResource

All Superinterfaces:

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

public interface IResource
extends com.arcway.cockpit.genericmodule.docgen.provider.interfaces.IGenericModuleData

The IResource object allows to read attribute values of a resource as well as accessing child items and related items. Item type constant: "gm.organisationmodule.resource"

Method Summary

Modifier and Type	Method and Description
java.util.List<? extends ICapability>	getCapabilitiess() Returns the capabilities items.
java.util.List<? extends ICapability>	getCapabilitiess(int sortingCriterion) Returns the capabilities items.
java.util.List<? extends ICapability>	getCapabilitiess(java.lang.String sortingProperty) Returns the capabilities items.
java.util.List<? extends ICapability>	getCapabilitiessWithCategory(java.lang.String categoryID) Returns the capabilities items that belong to the specified category.
java.util.List<? extends ICapability>	getCapabilitiessWithCategory(java.lang.String categoryID, int sortingCriterion) Returns the capabilities items that belong to the specified category.
java.util.List<? extends ICapability>	getCapabilitiessWithCategory(java.lang.String categoryID, java.lang.String sortingProperty) Returns the capabilities items that belong to the specified category.
java.util.List<? extends ICapability>	getCapabilitiessWithDefaultCategory() Returns the capabilities items that belong to the default category.
java.util.List<? extends ICapability>	getCapabilitiessWithDefaultCategory(int sortingCriterion) Returns the capabilities items that belong to the default category.
java.util.List<? extends ICapability>	getCapabilitiessWithDefaultCategory(java.lang.String sortingProperty) Returns the capabilities items that belong to the default category.
java.util.List<java.lang.String>	getDescription() Returns the description of the resource.
java.lang.String	getID() Returns the id of the resource.
java.lang.String	getIDandName() Returns the id and name of the resource.
java.lang.String	getName() Returns the name of the resource.
IResourceFolder	getParentResourceFolder() Returns the parent resource folder.
java.util.List<? extends IQuantifiedCapability>	getQuantifiedCapabilitiess() Returns the quantified capabilities items.
java.util.List<? extends IQuantifiedCapability>	getQuantifiedCapabilitiess(int sortingCriterion) Returns the quantified capabilities items.
java.util.List<? extends IQuantifiedCapability>	getQuantifiedCapabilitiess(java.lang.String sortingProperty) Returns the quantified capabilities items.
java.util.List<? extends IQuantifiedCapability>	getQuantifiedCapabilitiessWithCategory(java.lang.String categoryID) Returns the quantified capabilities items that belong to the specified category.
java.util.List<? extends IQuantifiedCapability>	getQuantifiedCapabilitiessWithCategory(java.lang.String categoryID, int sortingCriterion) Returns the quantified capabilities items that belong to the specified category.
java.util.List<? extends IQuantifiedCapability>	getQuantifiedCapabilitiessWithCategory(java.lang.String categoryID, java.lang.String sortingProperty) Returns the quantified capabilities items that belong to the specified category.
java.util.List<? extends IQuantifiedCapability>	getQuantifiedCapabilitiessWithDefaultCategory() Returns the quantified capabilities items that belong to the default category.
java.util.List<? extends IQuantifiedCapability>	getQuantifiedCapabilitiessWithDefaultCategory(int sortingCriterion) Returns the quantified capabilities items that belong to the default category.
java.util.List<? extends IQuantifiedCapability>	getQuantifiedCapabilitiessWithDefaultCategory(java.lang.String sortingProperty) Returns the quantified capabilities items that belong to the default category.
java.util.List<? extends IResourceNote>	getResourceNoteChildren() Returns the note children.
java.util.List<? extends IResourceNote>	getResourceNoteChildren(int sortingCriterion) Returns the note children.
java.util.List<? extends IResourceNote>	getResourceNoteChildren(java.lang.String sortingProperty) Returns the note children.
java.util.List<? extends IResourceNote>	getResourceNoteChildrenWithCategory(java.lang.String categoryID) Returns the note children that belong to the specified category.
java.util.List<? extends IResourceNote>	getResourceNoteChildrenWithCategory(java.lang.String categoryID, int sortingCriterion) Returns the note children that belong to the specified category.
java.util.List<? extends IResourceNote>	getResourceNoteChildrenWithCategory(java.lang.String categoryID, java.lang.String sortingProperty) Returns the note children that belong to the specified category.
java.util.List<? extends IResourceNote>	getResourceNoteChildrenWithDefaultCategory() Returns the note children that belong to the default category.
java.util.List<? extends IResourceNote>	getResourceNoteChildrenWithDefaultCategory(int sortingCriterion) Returns the note children that belong to the default category.
java.util.List<? extends IResourceNote>	getResourceNoteChildrenWithDefaultCategory(java.lang.String sortingProperty) Returns the note children that belong to the default category.
boolean	hasResourceFolderParent() Returns whether this resource has a parent of type resource folder.
boolean	hasResourceNoteChildren() Returns whether this resource has children of type note.

Methods inherited from interface com.arcway.cockpit.genericmodule.docgen.provider.interfaces.IGenericModuleData

getAncestorObjects, getAttribute_asParagraphList, getAttribute_asSingleLine, getAttribute_asTimestamp_MilliSecondsSince_01_01_1970, getAttribute, getChildObjects, getChildObjects, getChildObjectsOfTypeRank, getChildObjectsWithCategory, getChildObjectsWithCategory, getChildObjectsWithDefaultCategory, getChildObjectsWithDefaultCategory, getChildrenIDPrefix, getLinkedModelElements, getObjectType, getParentObject, getRelatedLOObjects, getRelatedLOObjects, getRelatedLOObjectsWithCategory, getRelatedLOObjectsWithCategory, getRelatedLOObjectsWithDefaultCategory, getRelatedLOObjectsWithDefaultCategory, getRelatedMDObjects, getRelatedMDObjects, getRelatedMDObjectsWithCategory, getRelatedMDObjectsWithCategory, getRelatedMDObjectsWithDefaultCategory, getRelatedMDObjectsWithDefaultCategory, getUniqueIdentifier, isLinkedToAnyModelElement, toRecord

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

getEMFFile, 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, getCommitVersions, getCreationDate_MilliSecondsSince_01_01_1970, getCreationDate, getCreator, getDateOfLastModification_MilliSecondsSince_01_01_1970, getDateOfLastModification, getDisplayName, getLastModifier, getLinkForShow, getModificationCount, getProjectUniqueIdentifier, getTypeID, getTypeName, toRecord

Method Detail

getID

java.lang.String getID()

Returns the id of the resource.

The returned string is already HTML encoded so that it can be inserted into the document without any further transformations.

Returns:

id of the resource (!= null)

getName

java.lang.String getName()

Returns the name of the resource.

The returned string is already HTML encoded so that it can be inserted into the document without any further transformations.

Returns:

name of the resource (!= null)

getDescription

java.util.List<java.lang.String> getDescription()

Returns the description of the resource.

If the text consists of multiple paragraphs (separated by carriage return) each paragraph is represented by a single element in the String list.

The returned string is already HTML encoded so that it can be inserted into the document without any further transformations.

Returns:

description of the resource (!= null)

getIDandName

java.lang.String getIDandName()

Returns the id and name of the resource.

The returned string is already HTML encoded so that it can be inserted into the document without any further transformations.

Returns:

id and name of the resource (!= null)

hasResourceFolderParent

boolean hasResourceFolderParent()

Returns whether this resource has a parent of type resource folder.

Returns:

whether this resource has a parent of type resource folder

getParentResourceFolder

IResourceFolder getParentResourceFolder()

Returns the parent resource folder.

Returns:

the parent resource folder (or null if this resource has no parent or a parent of a different type)

hasResourceNoteChildren

boolean hasResourceNoteChildren()

Returns whether this resource has children of type note.

Returns:

whether this resource has children of type note

getResourceNoteChildren

java.util.List<? extends IResourceNote> getResourceNoteChildren()

Returns the note children.

The note items are returned in their natural order.

Returns:

list of IResourceNote objects (!= null)

getResourceNoteChildren

java.util.List<? extends IResourceNote> getResourceNoteChildren(int sortingCriterion)

Returns the note children.

Parameters:

sortingCriterion - specifies the criterion to be used for sorting (use the integer constants defined above)

Returns:

list of IResourceNote objects (!= null)

getResourceNoteChildren

java.util.List<? extends IResourceNote> getResourceNoteChildren(java.lang.String sortingProperty)

Returns the note children.

Parameters:

sortingProperty - specifies the custom property which shall be used as a criterion for sorting

Returns:

list of IResourceNote objects (!= null)

getResourceNoteChildrenWithCategory

java.util.List<? extends IResourceNote> getResourceNoteChildrenWithCategory(java.lang.String categoryID)

Returns the note children that belong to the specified category.

The note items are returned in their natural order.

Parameters:

categoryID - the category ID

Returns:

list of IResourceNote objects (!= null)

getResourceNoteChildrenWithCategory

java.util.List<? extends IResourceNote> getResourceNoteChildrenWithCategory(java.lang.String categoryID,
                                                                            int sortingCriterion)

Returns the note children that belong to the specified category.

Parameters:

categoryID - the category ID

sortingCriterion - specifies the criterion to be used for sorting (use the integer constants defined above)

Returns:

list of IResourceNote objects (!= null)

getResourceNoteChildrenWithCategory

java.util.List<? extends IResourceNote> getResourceNoteChildrenWithCategory(java.lang.String categoryID,
                                                                            java.lang.String sortingProperty)

Returns the note children that belong to the specified category.

Parameters:

categoryID - the category ID

sortingProperty - specifies the custom property which shall be used as a criterion for sorting

Returns:

list of IResourceNote objects (!= null)

getResourceNoteChildrenWithDefaultCategory

java.util.List<? extends IResourceNote> getResourceNoteChildrenWithDefaultCategory()

Returns the note children that belong to the default category.

The note items are returned in their natural order.

Returns:

list of IResourceNote objects (!= null)

getResourceNoteChildrenWithDefaultCategory

java.util.List<? extends IResourceNote> getResourceNoteChildrenWithDefaultCategory(int sortingCriterion)

Returns the note children that belong to the default category.

Parameters:

sortingCriterion - specifies the criterion to be used for sorting (use the integer constants defined above)

Returns:

list of IResourceNote objects (!= null)

getResourceNoteChildrenWithDefaultCategory

java.util.List<? extends IResourceNote> getResourceNoteChildrenWithDefaultCategory(java.lang.String sortingProperty)

Returns the note children that belong to the default category.

Parameters:

sortingProperty - specifies the custom property which shall be used as a criterion for sorting

Returns:

list of IResourceNote objects (!= null)

getCapabilitiess

java.util.List<? extends ICapability> getCapabilitiess()

Returns the capabilities items.

The capability items are sorted by id and name.

Returns:

list of ICapability objects (!= null)

getCapabilitiess

java.util.List<? extends ICapability> getCapabilitiess(int sortingCriterion)

Returns the capabilities items.

Parameters:

sortingCriterion - specifies the criterion to be used for sorting (use the integer constants defined above)

Returns:

list of ICapability objects (!= null)

getCapabilitiess

java.util.List<? extends ICapability> getCapabilitiess(java.lang.String sortingProperty)

Returns the capabilities items.

Parameters:

sortingProperty - specifies the custom property which shall be used as a criterion for sorting

Returns:

list of ICapability objects (!= null)

getCapabilitiessWithCategory

java.util.List<? extends ICapability> getCapabilitiessWithCategory(java.lang.String categoryID)

Returns the capabilities items that belong to the specified category.

The capability items are sorted by id and name.

Parameters:

categoryID - the category ID

Returns:

list of ICapability objects (!= null)

getCapabilitiessWithCategory

java.util.List<? extends ICapability> getCapabilitiessWithCategory(java.lang.String categoryID,
                                                                   int sortingCriterion)

Returns the capabilities items that belong to the specified category.

Parameters:

categoryID - the category ID

sortingCriterion - specifies the criterion to be used for sorting (use the integer constants defined above)

Returns:

list of ICapability objects (!= null)

getCapabilitiessWithCategory

java.util.List<? extends ICapability> getCapabilitiessWithCategory(java.lang.String categoryID,
                                                                   java.lang.String sortingProperty)

Returns the capabilities items that belong to the specified category.

Parameters:

categoryID - the category ID

sortingProperty - specifies the custom property which shall be used as a criterion for sorting

Returns:

list of ICapability objects (!= null)

getCapabilitiessWithDefaultCategory

java.util.List<? extends ICapability> getCapabilitiessWithDefaultCategory()

Returns the capabilities items that belong to the default category.

The capability items are sorted by id and name.

Returns:

list of ICapability objects (!= null)

getCapabilitiessWithDefaultCategory

java.util.List<? extends ICapability> getCapabilitiessWithDefaultCategory(int sortingCriterion)

Returns the capabilities items that belong to the default category.

Parameters:

sortingCriterion - specifies the criterion to be used for sorting (use the integer constants defined above)

Returns:

list of ICapability objects (!= null)

getCapabilitiessWithDefaultCategory

java.util.List<? extends ICapability> getCapabilitiessWithDefaultCategory(java.lang.String sortingProperty)

Returns the capabilities items that belong to the default category.

Parameters:

sortingProperty - specifies the custom property which shall be used as a criterion for sorting

Returns:

list of ICapability objects (!= null)

getQuantifiedCapabilitiess

java.util.List<? extends IQuantifiedCapability> getQuantifiedCapabilitiess()

Returns the quantified capabilities items.

The quantified capability items are sorted by id and name.

Returns:

list of IQuantifiedCapability objects (!= null)

getQuantifiedCapabilitiess

java.util.List<? extends IQuantifiedCapability> getQuantifiedCapabilitiess(int sortingCriterion)

Returns the quantified capabilities items.

Parameters:

sortingCriterion - specifies the criterion to be used for sorting (use the integer constants defined above)

Returns:

list of IQuantifiedCapability objects (!= null)

getQuantifiedCapabilitiess

java.util.List<? extends IQuantifiedCapability> getQuantifiedCapabilitiess(java.lang.String sortingProperty)

Returns the quantified capabilities items.

Parameters:

sortingProperty - specifies the custom property which shall be used as a criterion for sorting

Returns:

list of IQuantifiedCapability objects (!= null)

getQuantifiedCapabilitiessWithCategory

java.util.List<? extends IQuantifiedCapability> getQuantifiedCapabilitiessWithCategory(java.lang.String categoryID)

Returns the quantified capabilities items that belong to the specified category.

The quantified capability items are sorted by id and name.

Parameters:

categoryID - the category ID

Returns:

list of IQuantifiedCapability objects (!= null)

getQuantifiedCapabilitiessWithCategory

java.util.List<? extends IQuantifiedCapability> getQuantifiedCapabilitiessWithCategory(java.lang.String categoryID,
                                                                                       int sortingCriterion)

Returns the quantified capabilities items that belong to the specified category.

Parameters:

categoryID - the category ID

sortingCriterion - specifies the criterion to be used for sorting (use the integer constants defined above)

Returns:

list of IQuantifiedCapability objects (!= null)

getQuantifiedCapabilitiessWithCategory

java.util.List<? extends IQuantifiedCapability> getQuantifiedCapabilitiessWithCategory(java.lang.String categoryID,
                                                                                       java.lang.String sortingProperty)

Returns the quantified capabilities items that belong to the specified category.

Parameters:

categoryID - the category ID

sortingProperty - specifies the custom property which shall be used as a criterion for sorting

Returns:

list of IQuantifiedCapability objects (!= null)

getQuantifiedCapabilitiessWithDefaultCategory

java.util.List<? extends IQuantifiedCapability> getQuantifiedCapabilitiessWithDefaultCategory()

Returns the quantified capabilities items that belong to the default category.

The quantified capability items are sorted by id and name.

Returns:

list of IQuantifiedCapability objects (!= null)

getQuantifiedCapabilitiessWithDefaultCategory

java.util.List<? extends IQuantifiedCapability> getQuantifiedCapabilitiessWithDefaultCategory(int sortingCriterion)

Returns the quantified capabilities items that belong to the default category.

Parameters:

sortingCriterion - specifies the criterion to be used for sorting (use the integer constants defined above)

Returns:

list of IQuantifiedCapability objects (!= null)

getQuantifiedCapabilitiessWithDefaultCategory

java.util.List<? extends IQuantifiedCapability> getQuantifiedCapabilitiessWithDefaultCategory(java.lang.String sortingProperty)

Returns the quantified capabilities items that belong to the default category.

Parameters:

sortingProperty - specifies the custom property which shall be used as a criterion for sorting

Returns:

list of IQuantifiedCapability objects (!= null)