public interface IPublicationsFolder
extends com.arcway.cockpit.genericmodule.docgen.provider.interfaces.IGenericModuleData
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"| 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.
|
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, toRecordgetEMFFile, getImage, getPNGFile, getSVGFile, getWMFFilegetCategoryID, getCategoryLabel, getDateTimeProperty_MilliSecondsSince_01_01_1970, getFileProperty, getFileProperty, getFilePropertyAsBase64StringList, getFilePropertyAsFileName, getFilePropertyAsFileName, getFilePropertyAsRawStringList, getFilePropertyAsStringList, getPropertyAsString, getPropertyAsStringArray, getPropertyAsStringList, hasCustomPropertyValues, hasDefaultCategory, hasPropertyValue, readImageInfoOfFilePropertygetCommitVersion, getCreationDate_MilliSecondsSince_01_01_1970, getCreationDate, getCreator, getDateOfLastModification_MilliSecondsSince_01_01_1970, getDateOfLastModification, getDisplayName, getLastModifier, getLinkForShow, getModificationCount, getProjectUniqueIdentifier, getTypeID, getTypeName, toRecordjava.lang.String getTitle()
java.lang.String getPublicationIDPrefix()
boolean hasPublicationsFolderParent()
IPublicationsFolder getParentPublicationsFolder()
boolean hasPublicationsFolderChildren()
java.util.List<? extends IPublicationsFolder> getPublicationsFolderChildren()
java.util.List<? extends IPublicationsFolder> getPublicationsFolderChildren(int sortingCriterion)
sortingCriterion - specifies the criterion to be used for sorting (use the integer constants defined above)java.util.List<? extends IPublicationsFolder> getPublicationsFolderChildren(java.lang.String sortingProperty)
sortingProperty - specifies the custom property which shall be used as a criterion for sortingjava.util.List<? extends IPublicationsFolder> getPublicationsFolderChildrenWithCategory(java.lang.String categoryID)
categoryID - the category IDjava.util.List<? extends IPublicationsFolder> getPublicationsFolderChildrenWithCategory(java.lang.String categoryID, int sortingCriterion)
categoryID - the category IDsortingCriterion - specifies the criterion to be used for sorting (use the integer constants defined above)java.util.List<? extends IPublicationsFolder> getPublicationsFolderChildrenWithCategory(java.lang.String categoryID, java.lang.String sortingProperty)
categoryID - the category IDsortingProperty - specifies the custom property which shall be used as a criterion for sortingjava.util.List<? extends IPublicationsFolder> getPublicationsFolderChildrenWithDefaultCategory()
java.util.List<? extends IPublicationsFolder> getPublicationsFolderChildrenWithDefaultCategory(int sortingCriterion)
sortingCriterion - specifies the criterion to be used for sorting (use the integer constants defined above)java.util.List<? extends IPublicationsFolder> getPublicationsFolderChildrenWithDefaultCategory(java.lang.String sortingProperty)
sortingProperty - specifies the custom property which shall be used as a criterion for sortingboolean hasPublicationChildren()
java.util.List<? extends IPublication> getPublicationChildren()
java.util.List<? extends IPublication> getPublicationChildren(int sortingCriterion)
sortingCriterion - specifies the criterion to be used for sorting (use the integer constants defined above)java.util.List<? extends IPublication> getPublicationChildren(java.lang.String sortingProperty)
sortingProperty - specifies the custom property which shall be used as a criterion for sortingjava.util.List<? extends IPublication> getPublicationChildrenWithCategory(java.lang.String categoryID)
categoryID - the category IDjava.util.List<? extends IPublication> getPublicationChildrenWithCategory(java.lang.String categoryID, int sortingCriterion)
categoryID - the category IDsortingCriterion - specifies the criterion to be used for sorting (use the integer constants defined above)java.util.List<? extends IPublication> getPublicationChildrenWithCategory(java.lang.String categoryID, java.lang.String sortingProperty)
categoryID - the category IDsortingProperty - specifies the custom property which shall be used as a criterion for sortingjava.util.List<? extends IPublication> getPublicationChildrenWithDefaultCategory()
java.util.List<? extends IPublication> getPublicationChildrenWithDefaultCategory(int sortingCriterion)
sortingCriterion - specifies the criterion to be used for sorting (use the integer constants defined above)java.util.List<? extends IPublication> getPublicationChildrenWithDefaultCategory(java.lang.String sortingProperty)
sortingProperty - specifies the custom property which shall be used as a criterion for sortingboolean hasCoordinationChildren()
java.util.List<? extends ICoordination> getCoordinationChildren()
java.util.List<? extends ICoordination> getCoordinationChildren(int sortingCriterion)
sortingCriterion - specifies the criterion to be used for sorting (use the integer constants defined above)java.util.List<? extends ICoordination> getCoordinationChildren(java.lang.String sortingProperty)
sortingProperty - specifies the custom property which shall be used as a criterion for sortingjava.util.List<? extends ICoordination> getCoordinationChildrenWithCategory(java.lang.String categoryID)
categoryID - the category IDjava.util.List<? extends ICoordination> getCoordinationChildrenWithCategory(java.lang.String categoryID, int sortingCriterion)
categoryID - the category IDsortingCriterion - specifies the criterion to be used for sorting (use the integer constants defined above)java.util.List<? extends ICoordination> getCoordinationChildrenWithCategory(java.lang.String categoryID, java.lang.String sortingProperty)
categoryID - the category IDsortingProperty - specifies the custom property which shall be used as a criterion for sortingjava.util.List<? extends ICoordination> getCoordinationChildrenWithDefaultCategory()
java.util.List<? extends ICoordination> getCoordinationChildrenWithDefaultCategory(int sortingCriterion)
sortingCriterion - specifies the criterion to be used for sorting (use the integer constants defined above)java.util.List<? extends ICoordination> getCoordinationChildrenWithDefaultCategory(java.lang.String sortingProperty)
sortingProperty - specifies the custom property which shall be used as a criterion for sortingboolean hasApprovalChildren()
java.util.List<? extends IApproval> getApprovalChildren()
java.util.List<? extends IApproval> getApprovalChildren(int sortingCriterion)
sortingCriterion - specifies the criterion to be used for sorting (use the integer constants defined above)java.util.List<? extends IApproval> getApprovalChildren(java.lang.String sortingProperty)
sortingProperty - specifies the custom property which shall be used as a criterion for sortingjava.util.List<? extends IApproval> getApprovalChildrenWithCategory(java.lang.String categoryID)
categoryID - the category IDjava.util.List<? extends IApproval> getApprovalChildrenWithCategory(java.lang.String categoryID, int sortingCriterion)
categoryID - the category IDsortingCriterion - specifies the criterion to be used for sorting (use the integer constants defined above)java.util.List<? extends IApproval> getApprovalChildrenWithCategory(java.lang.String categoryID, java.lang.String sortingProperty)
categoryID - the category IDsortingProperty - specifies the custom property which shall be used as a criterion for sortingjava.util.List<? extends IApproval> getApprovalChildrenWithDefaultCategory()
java.util.List<? extends IApproval> getApprovalChildrenWithDefaultCategory(int sortingCriterion)
sortingCriterion - specifies the criterion to be used for sorting (use the integer constants defined above)java.util.List<? extends IApproval> getApprovalChildrenWithDefaultCategory(java.lang.String sortingProperty)
sortingProperty - specifies the custom property which shall be used as a criterion for sorting