com.arcway.cockpit.documentmodule.docgen.provider.interfaces

Interface IResourceLocator

All Superinterfaces:

com.arcway.cockpit.docgen.provider.interfaces.ICockpitData, com.arcway.cockpit.modulelib2.client.docgen.provider.interfaces.IModuleData

public interface IResourceLocator
extends com.arcway.cockpit.modulelib2.client.docgen.provider.interfaces.IModuleData

The IResourceLocator object allows to read attribute values of a resource locator from the COCKPIT document module.

Item type constant: "dcm.resourceLocator" (to request information on defined custom properties, the more specific constants "dcm.webLink" and "dcm.fileSystemLink" must be used).

Method Summary

Modifier and Type	Method and Description
java.lang.String	getCategoryID() Returns the (human readable) category ID
java.lang.String	getUniqueIdentifier() Returns a unique identifier that uniquely identifies this object within its project.
java.lang.String	getURL() Returns the URL.
boolean	isFileLink() Returns if the ResourceLocater contains a file link
boolean	isWebLink() Returns if the ResourceLocater contains a web link

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, getModificationCount, getProjectUniqueIdentifier, getTypeID, getTypeName, toRecord, toRecord

Method Detail

getUniqueIdentifier

java.lang.String getUniqueIdentifier()

Returns a unique identifier that uniquely identifies this object within its project.

Specified by:

getUniqueIdentifier in interface com.arcway.cockpit.docgen.provider.interfaces.ICockpitData

Returns:

unique identifier

getURL

java.lang.String getURL()

Returns the URL.

Returns:

the URL

getCategoryID

java.lang.String getCategoryID()

Returns the (human readable) category ID

Returns:

the (human readable) category ID

isFileLink

boolean isFileLink()

Returns if the ResourceLocater contains a file link

Returns:

true, if the ResourceLocater contains a file link

isWebLink

boolean isWebLink()

Returns if the ResourceLocater contains a web link

Returns:

true, if the ResourceLocater contains a web link