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

Interface IPublicationsFolder

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 IPublicationsFolder
extends com.arcway.cockpit.genericmodule.docgen.provider.interfaces.IGenericModuleData

The IPublicationsFolder object allows to read attribute values of a publications folder as well as accessing child items and related items. Item type constant: "gm.changedocumentationmodule.publicationFolder"

Method Summary

Modifier and Type	Method and Description
java.util.List<? extends IApproval>	getApprovalChildren() Returns the approval children.
java.util.List<? extends IApproval>	getApprovalChildren(int sortingCriterion) Returns the approval children.
java.util.List<? extends IApproval>	getApprovalChildren(java.lang.String sortingProperty) Returns the approval children.
java.util.List<? extends IApproval>	getApprovalChildrenWithCategory(java.lang.String categoryID) Returns the approval children that belong to the specified category.
java.util.List<? extends IApproval>	getApprovalChildrenWithCategory(java.lang.String categoryID, int sortingCriterion) Returns the approval children that belong to the specified category.
java.util.List<? extends IApproval>	getApprovalChildrenWithCategory(java.lang.String categoryID, java.lang.String sortingProperty) Returns the approval children that belong to the specified category.
java.util.List<? extends IApproval>	getApprovalChildrenWithDefaultCategory() Returns the approval children that belong to the default category.
java.util.List<? extends IApproval>	getApprovalChildrenWithDefaultCategory(int sortingCriterion) Returns the approval children that belong to the default category.
java.util.List<? extends IApproval>	getApprovalChildrenWithDefaultCategory(java.lang.String sortingProperty) Returns the approval children that belong to the default category.
java.util.List<? extends ICoordination>	getCoordinationChildren() Returns the coordination children.
java.util.List<? extends ICoordination>	getCoordinationChildren(int sortingCriterion) Returns the coordination children.
java.util.List<? extends ICoordination>	getCoordinationChildren(java.lang.String sortingProperty) Returns the coordination children.
java.util.List<? extends ICoordination>	getCoordinationChildrenWithCategory(java.lang.String categoryID) Returns the coordination children that belong to the specified category.
java.util.List<? extends ICoordination>	getCoordinationChildrenWithCategory(java.lang.String categoryID, int sortingCriterion) Returns the coordination children that belong to the specified category.
java.util.List<? extends ICoordination>	getCoordinationChildrenWithCategory(java.lang.String categoryID, java.lang.String sortingProperty) Returns the coordination children that belong to the specified category.
java.util.List<? extends ICoordination>	getCoordinationChildrenWithDefaultCategory() Returns the coordination children that belong to the default category.
java.util.List<? extends ICoordination>	getCoordinationChildrenWithDefaultCategory(int sortingCriterion) Returns the coordination children that belong to the default category.
java.util.List<? extends ICoordination>	getCoordinationChildrenWithDefaultCategory(java.lang.String sortingProperty) Returns the coordination children that belong to the default category.
IPublicationsFolder	getParentPublicationsFolder() Returns the parent publications folder.
java.util.List<? extends IPublication>	getPublicationChildren() Returns the publication children.
java.util.List<? extends IPublication>	getPublicationChildren(int sortingCriterion) Returns the publication children.
java.util.List<? extends IPublication>	getPublicationChildren(java.lang.String sortingProperty) Returns the publication children.
java.util.List<? extends IPublication>	getPublicationChildrenWithCategory(java.lang.String categoryID) Returns the publication children that belong to the specified category.
java.util.List<? extends IPublication>	getPublicationChildrenWithCategory(java.lang.String categoryID, int sortingCriterion) Returns the publication children that belong to the specified category.
java.util.List<? extends IPublication>	getPublicationChildrenWithCategory(java.lang.String categoryID, java.lang.String sortingProperty) Returns the publication children that belong to the specified category.
java.util.List<? extends IPublication>	getPublicationChildrenWithDefaultCategory() Returns the publication children that belong to the default category.
java.util.List<? extends IPublication>	getPublicationChildrenWithDefaultCategory(int sortingCriterion) Returns the publication children that belong to the default category.
java.util.List<? extends IPublication>	getPublicationChildrenWithDefaultCategory(java.lang.String sortingProperty) Returns the publication children that belong to the default category.
java.lang.String	getPublicationIDPrefix() Returns the id prefix for new publication child items.
java.util.List<? extends IPublicationsFolder>	getPublicationsFolderChildren() Returns the publications folder children.
java.util.List<? extends IPublicationsFolder>	getPublicationsFolderChildren(int sortingCriterion) Returns the publications folder children.
java.util.List<? extends IPublicationsFolder>	getPublicationsFolderChildren(java.lang.String sortingProperty) Returns the publications folder children.
java.util.List<? extends IPublicationsFolder>	getPublicationsFolderChildrenWithCategory(java.lang.String categoryID) Returns the publications folder children that belong to the specified category.
java.util.List<? extends IPublicationsFolder>	getPublicationsFolderChildrenWithCategory(java.lang.String categoryID, int sortingCriterion) Returns the publications folder children that belong to the specified category.
java.util.List<? extends IPublicationsFolder>	getPublicationsFolderChildrenWithCategory(java.lang.String categoryID, java.lang.String sortingProperty) Returns the publications folder children that belong to the specified category.
java.util.List<? extends IPublicationsFolder>	getPublicationsFolderChildrenWithDefaultCategory() Returns the publications folder children that belong to the default category.
java.util.List<? extends IPublicationsFolder>	getPublicationsFolderChildrenWithDefaultCategory(int sortingCriterion) Returns the publications folder children that belong to the default category.
java.util.List<? extends IPublicationsFolder>	getPublicationsFolderChildrenWithDefaultCategory(java.lang.String sortingProperty) Returns the publications folder children that belong to the default category.
java.lang.String	getTitle() Returns the title of the publications folder.
boolean	hasApprovalChildren() Returns whether this publications folder has children of type approval.
boolean	hasCoordinationChildren() Returns whether this publications folder has children of type coordination.
boolean	hasPublicationChildren() Returns whether this publications folder has children of type publication.
boolean	hasPublicationsFolderChildren() Returns whether this publications folder has children of type publications folder.
boolean	hasPublicationsFolderParent() Returns whether this publications folder has a parent of type publications folder.

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

Method Detail

getTitle

java.lang.String getTitle()

Returns the title of the publications folder.

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

Returns:

title of the publications folder (!= null)

getPublicationIDPrefix

java.lang.String getPublicationIDPrefix()

Returns the id prefix for new publication child items.

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

Returns:

the id prefix for new publication child items (!= null)

hasPublicationsFolderParent

boolean hasPublicationsFolderParent()

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

Returns:

whether this publications folder has a parent of type publications folder

getParentPublicationsFolder

IPublicationsFolder getParentPublicationsFolder()

Returns the parent publications folder.

Returns:

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

hasPublicationsFolderChildren

boolean hasPublicationsFolderChildren()

Returns whether this publications folder has children of type publications folder.

Returns:

whether this publications folder has children of type publications folder

getPublicationsFolderChildren

java.util.List<? extends IPublicationsFolder> getPublicationsFolderChildren()

Returns the publications folder children.

The publications folder items are returned in their natural order.

Returns:

list of IPublicationsFolder objects (!= null)

getPublicationsFolderChildren

java.util.List<? extends IPublicationsFolder> getPublicationsFolderChildren(int sortingCriterion)

Returns the publications folder children.

Parameters:

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

Returns:

list of IPublicationsFolder objects (!= null)

getPublicationsFolderChildren

java.util.List<? extends IPublicationsFolder> getPublicationsFolderChildren(java.lang.String sortingProperty)

Returns the publications folder children.

Parameters:

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

Returns:

list of IPublicationsFolder objects (!= null)

getPublicationsFolderChildrenWithCategory

java.util.List<? extends IPublicationsFolder> getPublicationsFolderChildrenWithCategory(java.lang.String categoryID)

Returns the publications folder children that belong to the specified category.

The publications folder items are returned in their natural order.

Parameters:

categoryID - the category ID

Returns:

list of IPublicationsFolder objects (!= null)

getPublicationsFolderChildrenWithCategory

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

Returns the publications folder 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 IPublicationsFolder objects (!= null)

getPublicationsFolderChildrenWithCategory

java.util.List<? extends IPublicationsFolder> getPublicationsFolderChildrenWithCategory(java.lang.String categoryID,
                                                                                        java.lang.String sortingProperty)

Returns the publications folder 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 IPublicationsFolder objects (!= null)

getPublicationsFolderChildrenWithDefaultCategory

java.util.List<? extends IPublicationsFolder> getPublicationsFolderChildrenWithDefaultCategory()

Returns the publications folder children that belong to the default category.

The publications folder items are returned in their natural order.

Returns:

list of IPublicationsFolder objects (!= null)

getPublicationsFolderChildrenWithDefaultCategory

java.util.List<? extends IPublicationsFolder> getPublicationsFolderChildrenWithDefaultCategory(int sortingCriterion)

Returns the publications folder 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 IPublicationsFolder objects (!= null)

getPublicationsFolderChildrenWithDefaultCategory

java.util.List<? extends IPublicationsFolder> getPublicationsFolderChildrenWithDefaultCategory(java.lang.String sortingProperty)

Returns the publications folder 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 IPublicationsFolder objects (!= null)

hasPublicationChildren

boolean hasPublicationChildren()

Returns whether this publications folder has children of type publication.

Returns:

whether this publications folder has children of type publication

getPublicationChildren

java.util.List<? extends IPublication> getPublicationChildren()

Returns the publication children.

The publication items are returned in their natural order.

Returns:

list of IPublication objects (!= null)

getPublicationChildren

java.util.List<? extends IPublication> getPublicationChildren(int sortingCriterion)

Returns the publication children.

Parameters:

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

Returns:

list of IPublication objects (!= null)

getPublicationChildren

java.util.List<? extends IPublication> getPublicationChildren(java.lang.String sortingProperty)

Returns the publication children.

Parameters:

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

Returns:

list of IPublication objects (!= null)

getPublicationChildrenWithCategory

java.util.List<? extends IPublication> getPublicationChildrenWithCategory(java.lang.String categoryID)

Returns the publication children that belong to the specified category.

The publication items are returned in their natural order.

Parameters:

categoryID - the category ID

Returns:

list of IPublication objects (!= null)

getPublicationChildrenWithCategory

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

Returns the publication 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 IPublication objects (!= null)

getPublicationChildrenWithCategory

java.util.List<? extends IPublication> getPublicationChildrenWithCategory(java.lang.String categoryID,
                                                                          java.lang.String sortingProperty)

Returns the publication 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 IPublication objects (!= null)

getPublicationChildrenWithDefaultCategory

java.util.List<? extends IPublication> getPublicationChildrenWithDefaultCategory()

Returns the publication children that belong to the default category.

The publication items are returned in their natural order.

Returns:

list of IPublication objects (!= null)

getPublicationChildrenWithDefaultCategory

java.util.List<? extends IPublication> getPublicationChildrenWithDefaultCategory(int sortingCriterion)

Returns the publication 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 IPublication objects (!= null)

getPublicationChildrenWithDefaultCategory

java.util.List<? extends IPublication> getPublicationChildrenWithDefaultCategory(java.lang.String sortingProperty)

Returns the publication 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 IPublication objects (!= null)

hasCoordinationChildren

boolean hasCoordinationChildren()

Returns whether this publications folder has children of type coordination.

Returns:

whether this publications folder has children of type coordination

getCoordinationChildren

java.util.List<? extends ICoordination> getCoordinationChildren()

Returns the coordination children.

The coordination items are returned in their natural order.

Returns:

list of ICoordination objects (!= null)

getCoordinationChildren

java.util.List<? extends ICoordination> getCoordinationChildren(int sortingCriterion)

Returns the coordination children.

Parameters:

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

Returns:

list of ICoordination objects (!= null)

getCoordinationChildren

java.util.List<? extends ICoordination> getCoordinationChildren(java.lang.String sortingProperty)

Returns the coordination children.

Parameters:

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

Returns:

list of ICoordination objects (!= null)

getCoordinationChildrenWithCategory

java.util.List<? extends ICoordination> getCoordinationChildrenWithCategory(java.lang.String categoryID)

Returns the coordination children that belong to the specified category.

The coordination items are returned in their natural order.

Parameters:

categoryID - the category ID

Returns:

list of ICoordination objects (!= null)

getCoordinationChildrenWithCategory

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

Returns the coordination 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 ICoordination objects (!= null)

getCoordinationChildrenWithCategory

java.util.List<? extends ICoordination> getCoordinationChildrenWithCategory(java.lang.String categoryID,
                                                                            java.lang.String sortingProperty)

Returns the coordination 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 ICoordination objects (!= null)

getCoordinationChildrenWithDefaultCategory

java.util.List<? extends ICoordination> getCoordinationChildrenWithDefaultCategory()

Returns the coordination children that belong to the default category.

The coordination items are returned in their natural order.

Returns:

list of ICoordination objects (!= null)

getCoordinationChildrenWithDefaultCategory

java.util.List<? extends ICoordination> getCoordinationChildrenWithDefaultCategory(int sortingCriterion)

Returns the coordination 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 ICoordination objects (!= null)

getCoordinationChildrenWithDefaultCategory

java.util.List<? extends ICoordination> getCoordinationChildrenWithDefaultCategory(java.lang.String sortingProperty)

Returns the coordination 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 ICoordination objects (!= null)

hasApprovalChildren

boolean hasApprovalChildren()

Returns whether this publications folder has children of type approval.

Returns:

whether this publications folder has children of type approval

getApprovalChildren

java.util.List<? extends IApproval> getApprovalChildren()

Returns the approval children.

The approval items are returned in their natural order.

Returns:

list of IApproval objects (!= null)

getApprovalChildren

java.util.List<? extends IApproval> getApprovalChildren(int sortingCriterion)

Returns the approval children.

Parameters:

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

Returns:

list of IApproval objects (!= null)

getApprovalChildren

java.util.List<? extends IApproval> getApprovalChildren(java.lang.String sortingProperty)

Returns the approval children.

Parameters:

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

Returns:

list of IApproval objects (!= null)

getApprovalChildrenWithCategory

java.util.List<? extends IApproval> getApprovalChildrenWithCategory(java.lang.String categoryID)

Returns the approval children that belong to the specified category.

The approval items are returned in their natural order.

Parameters:

categoryID - the category ID

Returns:

list of IApproval objects (!= null)

getApprovalChildrenWithCategory

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

Returns the approval 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 IApproval objects (!= null)

getApprovalChildrenWithCategory

java.util.List<? extends IApproval> getApprovalChildrenWithCategory(java.lang.String categoryID,
                                                                    java.lang.String sortingProperty)

Returns the approval 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 IApproval objects (!= null)

getApprovalChildrenWithDefaultCategory

java.util.List<? extends IApproval> getApprovalChildrenWithDefaultCategory()

Returns the approval children that belong to the default category.

The approval items are returned in their natural order.

Returns:

list of IApproval objects (!= null)

getApprovalChildrenWithDefaultCategory

java.util.List<? extends IApproval> getApprovalChildrenWithDefaultCategory(int sortingCriterion)

Returns the approval 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 IApproval objects (!= null)

getApprovalChildrenWithDefaultCategory

java.util.List<? extends IApproval> getApprovalChildrenWithDefaultCategory(java.lang.String sortingProperty)

Returns the approval 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 IApproval objects (!= null)