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

Interface ITypeofPublication

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

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

Method Summary

Modifier and Type	Method and Description
java.lang.String	getID() Returns the id of the type of publication.
java.lang.String	getIDandName() Returns the id and name of the type of publication.
java.lang.String	getName() Returns the name of the type of publication.
IDomain	getParentDomain() Returns the parent domain.
java.util.List<? extends IPublication>	getPublications() Returns the publication items.
java.util.List<? extends IPublication>	getPublications(int sortingCriterion) Returns the publication items.
java.util.List<? extends IPublication>	getPublications(java.lang.String sortingProperty) Returns the publication items.
java.util.List<? extends IPublication>	getPublicationsWithCategory(java.lang.String categoryID) Returns the publication items that belong to the specified category.
java.util.List<? extends IPublication>	getPublicationsWithCategory(java.lang.String categoryID, int sortingCriterion) Returns the publication items that belong to the specified category.
java.util.List<? extends IPublication>	getPublicationsWithCategory(java.lang.String categoryID, java.lang.String sortingProperty) Returns the publication items that belong to the specified category.
java.util.List<? extends IPublication>	getPublicationsWithDefaultCategory() Returns the publication items that belong to the default category.
java.util.List<? extends IPublication>	getPublicationsWithDefaultCategory(int sortingCriterion) Returns the publication items that belong to the default category.
java.util.List<? extends IPublication>	getPublicationsWithDefaultCategory(java.lang.String sortingProperty) Returns the publication items that belong to the default category.
boolean	hasDomainParent() Returns whether this type of publication has a parent of type domain.

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 type of 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 type of publication (!= null)

getName

java.lang.String getName()

Returns the name of the type of publication.

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

Returns:

name of the type of publication (!= null)

getIDandName

java.lang.String getIDandName()

Returns the id and name of the type of publication.

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 type of publication (!= null)

hasDomainParent

boolean hasDomainParent()

Returns whether this type of publication has a parent of type domain.

Returns:

whether this type of publication has a parent of type domain

getParentDomain

IDomain getParentDomain()

Returns the parent domain.

Returns:

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

getPublications

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

Returns the publication items.

The publication items are sorted by id and title.

Returns:

list of IPublication objects (!= null)

getPublications

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

Returns the publication items.

Parameters:

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

Returns:

list of IPublication objects (!= null)

getPublications

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

Returns the publication items.

Parameters:

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

Returns:

list of IPublication objects (!= null)

getPublicationsWithCategory

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

Returns the publication items that belong to the specified category.

The publication items are sorted by id and title.

Parameters:

categoryID - the category ID

Returns:

list of IPublication objects (!= null)

getPublicationsWithCategory

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

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

getPublicationsWithCategory

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

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

getPublicationsWithDefaultCategory

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

Returns the publication items that belong to the default category.

The publication items are sorted by id and title.

Returns:

list of IPublication objects (!= null)

getPublicationsWithDefaultCategory

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

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

getPublicationsWithDefaultCategory

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

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