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

Interface IPublication

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

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

Method Summary

Modifier and Type	Method and Description
java.util.List<? extends IGroupofPerson>	getGroupofPersonChildren() Returns the group of person children.
java.util.List<? extends IGroupofPerson>	getGroupofPersonChildren(int sortingCriterion) Returns the group of person children.
java.util.List<? extends IGroupofPerson>	getGroupofPersonChildren(java.lang.String sortingProperty) Returns the group of person children.
java.util.List<? extends IGroupofPerson>	getGroupofPersonChildrenWithCategory(java.lang.String categoryID) Returns the group of person children that belong to the specified category.
java.util.List<? extends IGroupofPerson>	getGroupofPersonChildrenWithCategory(java.lang.String categoryID, int sortingCriterion) Returns the group of person children that belong to the specified category.
java.util.List<? extends IGroupofPerson>	getGroupofPersonChildrenWithCategory(java.lang.String categoryID, java.lang.String sortingProperty) Returns the group of person children that belong to the specified category.
java.util.List<? extends IGroupofPerson>	getGroupofPersonChildrenWithDefaultCategory() Returns the group of person children that belong to the default category.
java.util.List<? extends IGroupofPerson>	getGroupofPersonChildrenWithDefaultCategory(int sortingCriterion) Returns the group of person children that belong to the default category.
java.util.List<? extends IGroupofPerson>	getGroupofPersonChildrenWithDefaultCategory(java.lang.String sortingProperty) Returns the group of person children that belong to the default category.
java.lang.String	getID() Returns the id of the publication.
java.lang.String	getIDandTitle() Returns the id and title of the publication.
IPublicationsFolder	getParentPublicationsFolder() Returns the parent publications folder.
ITypeofPublication	getPublicationType() Returns the linked publication type or null if none is linked.
java.lang.String	getTitle() Returns the title of the publication.
java.util.List<? extends IVersion>	getVersionChildren() Returns the version children.
java.util.List<? extends IVersion>	getVersionChildren(int sortingCriterion) Returns the version children.
java.util.List<? extends IVersion>	getVersionChildren(java.lang.String sortingProperty) Returns the version children.
java.util.List<? extends IVersion>	getVersionChildrenWithCategory(java.lang.String categoryID) Returns the version children that belong to the specified category.
java.util.List<? extends IVersion>	getVersionChildrenWithCategory(java.lang.String categoryID, int sortingCriterion) Returns the version children that belong to the specified category.
java.util.List<? extends IVersion>	getVersionChildrenWithCategory(java.lang.String categoryID, java.lang.String sortingProperty) Returns the version children that belong to the specified category.
java.util.List<? extends IVersion>	getVersionChildrenWithDefaultCategory() Returns the version children that belong to the default category.
java.util.List<? extends IVersion>	getVersionChildrenWithDefaultCategory(int sortingCriterion) Returns the version children that belong to the default category.
java.util.List<? extends IVersion>	getVersionChildrenWithDefaultCategory(java.lang.String sortingProperty) Returns the version children that belong to the default category.
boolean	hasGroupofPersonChildren() Returns whether this publication has children of type group of person.
boolean	hasPublicationsFolderParent() Returns whether this publication has a parent of type publications folder.
boolean	hasVersionChildren() Returns whether this publication has children of type version.

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

getID

java.lang.String getID()

Returns the id of the publication.

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

Returns:

id of the publication (!= null)

getTitle

java.lang.String getTitle()

Returns the title of the publication.

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

Returns:

title of the publication (!= null)

getIDandTitle

java.lang.String getIDandTitle()

Returns the id and title of the publication.

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

Returns:

id and title of the publication (!= null)

hasPublicationsFolderParent

boolean hasPublicationsFolderParent()

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

Returns:

whether this publication has a parent of type publications folder

getParentPublicationsFolder

IPublicationsFolder getParentPublicationsFolder()

Returns the parent publications folder.

Returns:

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

hasGroupofPersonChildren

boolean hasGroupofPersonChildren()

Returns whether this publication has children of type group of person.

Returns:

whether this publication has children of type group of person

getGroupofPersonChildren

java.util.List<? extends IGroupofPerson> getGroupofPersonChildren()

Returns the group of person children.

The group of person items are returned in their natural order.

Returns:

list of IGroupofPerson objects (!= null)

getGroupofPersonChildren

java.util.List<? extends IGroupofPerson> getGroupofPersonChildren(int sortingCriterion)

Returns the group of person children.

Parameters:

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

Returns:

list of IGroupofPerson objects (!= null)

getGroupofPersonChildren

java.util.List<? extends IGroupofPerson> getGroupofPersonChildren(java.lang.String sortingProperty)

Returns the group of person children.

Parameters:

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

Returns:

list of IGroupofPerson objects (!= null)

getGroupofPersonChildrenWithCategory

java.util.List<? extends IGroupofPerson> getGroupofPersonChildrenWithCategory(java.lang.String categoryID)

Returns the group of person children that belong to the specified category.

The group of person items are returned in their natural order.

Parameters:

categoryID - the category ID

Returns:

list of IGroupofPerson objects (!= null)

getGroupofPersonChildrenWithCategory

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

Returns the group of person 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 IGroupofPerson objects (!= null)

getGroupofPersonChildrenWithCategory

java.util.List<? extends IGroupofPerson> getGroupofPersonChildrenWithCategory(java.lang.String categoryID,
                                                                              java.lang.String sortingProperty)

Returns the group of person 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 IGroupofPerson objects (!= null)

getGroupofPersonChildrenWithDefaultCategory

java.util.List<? extends IGroupofPerson> getGroupofPersonChildrenWithDefaultCategory()

Returns the group of person children that belong to the default category.

The group of person items are returned in their natural order.

Returns:

list of IGroupofPerson objects (!= null)

getGroupofPersonChildrenWithDefaultCategory

java.util.List<? extends IGroupofPerson> getGroupofPersonChildrenWithDefaultCategory(int sortingCriterion)

Returns the group of person 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 IGroupofPerson objects (!= null)

getGroupofPersonChildrenWithDefaultCategory

java.util.List<? extends IGroupofPerson> getGroupofPersonChildrenWithDefaultCategory(java.lang.String sortingProperty)

Returns the group of person 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 IGroupofPerson objects (!= null)

hasVersionChildren

boolean hasVersionChildren()

Returns whether this publication has children of type version.

Returns:

whether this publication has children of type version

getVersionChildren

java.util.List<? extends IVersion> getVersionChildren()

Returns the version children.

The version items are returned in their natural order.

Returns:

list of IVersion objects (!= null)

getVersionChildren

java.util.List<? extends IVersion> getVersionChildren(int sortingCriterion)

Returns the version children.

Parameters:

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

Returns:

list of IVersion objects (!= null)

getVersionChildren

java.util.List<? extends IVersion> getVersionChildren(java.lang.String sortingProperty)

Returns the version children.

Parameters:

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

Returns:

list of IVersion objects (!= null)

getVersionChildrenWithCategory

java.util.List<? extends IVersion> getVersionChildrenWithCategory(java.lang.String categoryID)

Returns the version children that belong to the specified category.

The version items are returned in their natural order.

Parameters:

categoryID - the category ID

Returns:

list of IVersion objects (!= null)

getVersionChildrenWithCategory

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

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

getVersionChildrenWithCategory

java.util.List<? extends IVersion> getVersionChildrenWithCategory(java.lang.String categoryID,
                                                                  java.lang.String sortingProperty)

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

getVersionChildrenWithDefaultCategory

java.util.List<? extends IVersion> getVersionChildrenWithDefaultCategory()

Returns the version children that belong to the default category.

The version items are returned in their natural order.

Returns:

list of IVersion objects (!= null)

getVersionChildrenWithDefaultCategory

java.util.List<? extends IVersion> getVersionChildrenWithDefaultCategory(int sortingCriterion)

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

getVersionChildrenWithDefaultCategory

java.util.List<? extends IVersion> getVersionChildrenWithDefaultCategory(java.lang.String sortingProperty)

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

getPublicationType

ITypeofPublication getPublicationType()

Returns the linked publication type or null if none is linked.

Returns:

the linked publication type or null if none is linked