oracle.webcenter.doclib.model

Interface DocumentDescriptor

All Superinterfaces:

ResourceDescriptor, WebCenterResource

public interface DocumentDescriptor
extends ResourceDescriptor

An object providing information on a content repository item (folder, document, web content, wiki or blog).

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	BLOG_RESOURCE_TYPE Blog entry resource type
static java.lang.String	BLOG_SERVICE_ID The blogs service ID
static java.lang.String	CONTENT_SERVICE_ID The web content service ID
static java.lang.String	DOCUMENT_RESOURCE_TYPE Document resource type.
static java.lang.String	DOCUMENTS_SERVICE_ID The documents service ID
static java.lang.String	FOLDER_RESOURCE_TYPE Folder resource type
static java.lang.String	WEB_CONTENT_RESOURCE_TYPE Web content resource type
static java.lang.String	WIKI_RESOURCE_TYPE Wiki document resource type

Method Summary

Modifier and Type	Method and Description
java.util.Map<java.lang.String,java.lang.Object>	getAttrs() A map of additional attributes that describe this item
java.lang.String	getConnectionName() The repository connection name this item belongs to.
java.util.Calendar	getCreateDate() Gets the Creation Date of this item.
java.lang.String	getCreatedBy() Gets the user name of the user who created this item.
java.lang.String	getDescription() Gets the Description of this item.
java.lang.String	getFileExtension() Gets the file extension from the item name.
java.lang.String	getIcon() Get's the icon for that item (16px).
java.lang.String	getLargeIcon() Get's the icon for that item (32px).
java.lang.String	getLastModifiedBy() Gets the user name of the user who modified this item most recently.
java.util.Calendar	getLastModifiedDate() Gets the Last Modified Date of this item.
java.lang.String	getMimeType() Gets the MIME type for that item.
java.lang.String	getPath() Gets the path of this item (including the item name itself) May return null when the item is an unfoldered document.
java.lang.String	getPermanentUrl() Gets the download URL for this item.
long	getSize() Gets the size of this item.
java.lang.String	getTagWords() Gets the tag words associated with this item.
java.lang.String	getTitle() Gets the title for this resource (usually an alternative to the file name)
java.lang.String	getUrl() Gets the download URL for this item
boolean	isFile() If the item is a File return true.
boolean	isFolder() If the item is a Folder return true.

Methods inherited from interface oracle.webcenter.framework.resource.ResourceDescriptor

getGoLink, getIconSource, getResourceType

Methods inherited from interface oracle.webcenter.framework.resource.WebCenterResource

getName, getResourceId, getScope, getServiceId, getShortDescription

Field Detail

DOCUMENTS_SERVICE_ID

static final java.lang.String DOCUMENTS_SERVICE_ID

The documents service ID

CONTENT_SERVICE_ID

static final java.lang.String CONTENT_SERVICE_ID

The web content service ID

BLOG_SERVICE_ID

static final java.lang.String BLOG_SERVICE_ID

The blogs service ID

FOLDER_RESOURCE_TYPE

static final java.lang.String FOLDER_RESOURCE_TYPE

Folder resource type

DOCUMENT_RESOURCE_TYPE

static final java.lang.String DOCUMENT_RESOURCE_TYPE

Document resource type. This is used for any document that does not have a more specialized type

WIKI_RESOURCE_TYPE

static final java.lang.String WIKI_RESOURCE_TYPE

Wiki document resource type

WEB_CONTENT_RESOURCE_TYPE

static final java.lang.String WEB_CONTENT_RESOURCE_TYPE

Web content resource type

BLOG_RESOURCE_TYPE

static final java.lang.String BLOG_RESOURCE_TYPE

Blog entry resource type

Method Detail

isFolder

boolean isFolder()

If the item is a Folder return true.

Returns:

true if the item is a Folder

isFile

boolean isFile()

If the item is a File return true.

Returns:

true if the item is a File

getConnectionName

java.lang.String getConnectionName()

The repository connection name this item belongs to.

Returns:

The repository connection name

getPath

java.lang.String getPath()

Gets the path of this item (including the item name itself) May return null when the item is an unfoldered document.

Returns:

The item's path.

getTitle

java.lang.String getTitle()

Gets the title for this resource (usually an alternative to the file name)

Returns:

The item's title

getIcon

java.lang.String getIcon()

Get's the icon for that item (16px).

Returns:

The item's icon.

getLargeIcon

java.lang.String getLargeIcon()

Get's the icon for that item (32px).

Returns:

The item's icon.

getSize

long getSize()

Gets the size of this item.

Returns:

The item's size.

getDescription

java.lang.String getDescription()

Gets the Description of this item. If there is no description then return an empty string so comparisons don't need to special case null values.

Returns:

The item's Description.

getTagWords

java.lang.String getTagWords()

Gets the tag words associated with this item. This returns only public tag words that have been replicated to the repository, not the full set of WebCenter tags

Returns:

The item's tag words.

getMimeType

java.lang.String getMimeType()

Gets the MIME type for that item.

Returns:

The item's MIME Type.

getUrl

java.lang.String getUrl()

Gets the download URL for this item

Returns:

The item's download URL

getPermanentUrl

java.lang.String getPermanentUrl()

Gets the download URL for this item. This returns a URL that is based on a stable ID and does not change when the item is moved or renamed

Returns:

The item's stable download URL

getCreatedBy

java.lang.String getCreatedBy()

Gets the user name of the user who created this item.

Returns:

The item's "created by" user name.

getCreateDate

java.util.Calendar getCreateDate()

Gets the Creation Date of this item.

Returns:

The item's Creation Date.

getLastModifiedBy

java.lang.String getLastModifiedBy()

Gets the user name of the user who modified this item most recently.

Returns:

The item's "last modify by" user name.

getLastModifiedDate

java.util.Calendar getLastModifiedDate()

Gets the Last Modified Date of this item.

Returns:

The item's Last Modified Date.

getAttrs

java.util.Map<java.lang.String,java.lang.Object> getAttrs()

A map of additional attributes that describe this item

Returns:

map of extended attributes

getFileExtension

java.lang.String getFileExtension()

Gets the file extension from the item name.

Returns:

file extension